codysnider / tt-rss

include/sanity_check.php

<?php

    function make_self_url() {
        $proto = is_server_https() ? 'https' : 'http';

        return $proto.'://'.$_SERVER["HTTP_HOST"].$_SERVER["REQUEST_URI"];
    }

    function make_self_url_path() {
        $proto = is_server_https() ? 'https' : 'http';
        $url_path = $proto.'://'.$_SERVER["HTTP_HOST"].parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);

        return $url_path;
    }

    function check_mysql_tables() {
        $pdo = Db::pdo();

        $sth = $pdo->prepare("SELECT engine, table_name FROM information_schema.tables WHERE
				table_schema = ? AND table_name LIKE 'ttrss_%' AND engine != 'InnoDB'");
        $sth->execute([DB_NAME]);

The constant DB_NAME was not found. Maybe you did not declare it correctly or list all dependencies?

        $bad_tables = [];

        while ($line = $sth->fetch()) {
            array_push($bad_tables, $line);
        }

        return $bad_tables;
    }

    function initial_sanity_check() {

        $errors = array();

        if (!file_exists("config.php")) {
            array_push($errors, "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.");
        } else {

            require_once "sanity_config.php";

            if (file_exists("install") && !file_exists("config.php")) {
                array_push($errors, "Please copy config.php-dist to config.php or run the installer in install/");
            }

            if (strpos(PLUGINS, "auth_") === false) {

The constant PLUGINS was not found. Maybe you did not declare it correctly or list all dependencies?

                array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
            }

            if (function_exists('posix_getuid') && posix_getuid() == 0) {
                array_push($errors, "Please don't run this script as root.");
            }

            if (version_compare(PHP_VERSION, '5.6.0', '<')) {
                array_push($errors, "PHP version 5.6.0 or newer required. You're using ".PHP_VERSION.".");
            }

            if (!class_exists("UConverter")) {
                array_push($errors, "PHP UConverter class is missing, it's provided by the Internationalization (intl) module.");
            }

            if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {

The constant CONFIG_VERSION was not found. Maybe you did not declare it correctly or list all dependencies?

                array_push($errors, "Configuration file (config.php) has incorrect version. Update it with new options from config.php-dist and set CONFIG_VERSION to the correct value.");
            }

            if (!is_writable(CACHE_DIR."/images")) {

The constant CACHE_DIR was not found. Maybe you did not declare it correctly or list all dependencies?

                array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
            }

            if (!is_writable(CACHE_DIR."/upload")) {
                array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR."/upload)");
            }

            if (!is_writable(CACHE_DIR."/export")) {
                array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
            }

            if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {

The condition GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION is always false.

                array_push($errors,
                    "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
            }

            foreach ($required_defines as $d) {

The variable $required_defines seems to be never defined.

                if (!defined($d)) {
                    array_push($errors,
                        "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
                }
            }

            if (SINGLE_USER_MODE && class_exists("PDO")) {

The constant SINGLE_USER_MODE was not found. Maybe you did not declare it correctly or list all dependencies?

                $pdo = DB::pdo();

                $res = $pdo->query("SELECT id FROM ttrss_users WHERE id = 1");

                if (!$res->fetch()) {
                    array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
                }
            }

            $ref_self_url_path = make_self_url_path();
            $ref_self_url_path = preg_replace("/\w+\.php$/", "", $ref_self_url_path);

            if (SELF_URL_PATH == "http://example.org/tt-rss/") {

The constant SELF_URL_PATH was not found. Maybe you did not declare it correctly or list all dependencies?

                array_push($errors,
                        "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$ref_self_url_path</b>)");
            }

            if (isset($_SERVER["HTTP_HOST"]) &&
                (!defined('_SKIP_SELF_URL_PATH_CHECKS') || !_SKIP_SELF_URL_PATH_CHECKS) &&

The constant _SKIP_SELF_URL_PATH_CHECKS was not found. Maybe you did not declare it correctly or list all dependencies?

                SELF_URL_PATH != $ref_self_url_path && SELF_URL_PATH != mb_substr($ref_self_url_path, 0, mb_strlen($ref_self_url_path) - 1)) {
                array_push($errors,
                    "Please set SELF_URL_PATH to the correct value detected for your server: <b>$ref_self_url_path</b>");
            }

            if (!is_writable(ICONS_DIR)) {

The constant ICONS_DIR was not found. Maybe you did not declare it correctly or list all dependencies?

                array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
            }

            if (!is_writable(LOCK_DIRECTORY)) {

The constant LOCK_DIRECTORY was not found. Maybe you did not declare it correctly or list all dependencies?

                array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
            }

            if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
                array_push($errors, "PHP configuration option allow_url_fopen is disabled, and CURL functions are not present. Either enable allow_url_fopen or install PHP extension for CURL.");
            }

            if (!function_exists("json_encode")) {
                array_push($errors, "PHP support for JSON is required, but was not found.");
            }

            if (DB_TYPE == "mysql" && !function_exists("mysqli_connect")) {

The constant DB_TYPE was not found. Maybe you did not declare it correctly or list all dependencies?

                array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
            }

            if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
                array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
            }

            if (!class_exists("PDO")) {
                array_push($errors, "PHP support for PDO is required but was not found.");
            }

            if (!function_exists("mb_strlen")) {
                array_push($errors, "PHP support for mbstring functions is required but was not found.");
            }

            if (!function_exists("hash")) {
                array_push($errors, "PHP support for hash() function is required but was not found.");
            }

            if (ini_get("safe_mode")) {
                array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
            }

            if (!function_exists("mime_content_type")) {
                array_push($errors, "PHP function mime_content_type() is missing, try enabling fileinfo module.");
            }

            if (!class_exists("DOMDocument")) {
                array_push($errors, "PHP support for DOMDocument is required, but was not found.");
            }

            if (DB_TYPE == "mysql") {
                $bad_tables = check_mysql_tables();

                if (count($bad_tables) > 0) {
                    $bad_tables_fmt = [];

                    foreach ($bad_tables as $bt) {
                        array_push($bad_tables_fmt, sprintf("%s (%s)", $bt['table_name'], $bt['engine']));
                    }

                    $msg = "<p>The following tables use an unsupported MySQL engine: <b>".
                        implode(", ", $bad_tables_fmt)."</b>.</p>";

                    $msg .= "<p>The only supported engine on MySQL is InnoDB. MyISAM lacks functionality to run
						tt-rss.
						Please backup your data (via OPML) and re-import the schema before continuing.</p>
						<p><b>WARNING: importing the schema would mean LOSS OF ALL YOUR DATA.</b></p>";


                    array_push($errors, $msg);
                }
            }
        }

        if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
			<!DOCTYPE html>
			<html>
			<head>
			<title>Startup failed</title>
				<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
				<link rel="stylesheet" type="text/css" href="css/default.css">
			</head>
		<body class='sanity_failed claro ttrss_utility'>
			<div class="content">

			<h1>Startup failed</h1>

			<p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
			errors indicated by the following messages:</p>

			<?php foreach ($errors as $error) { echo format_error($error); } ?>

The function format_error() has been deprecated: Use twig function errorMessage

Are you sure the usage of format_error($error) is correct as it seems to always return null.

The call to format_error() has too many arguments starting with $error.

			<p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
				<a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
				for your question.</p>

		</div>
		</body>
		</html>

		<?php
            die;

Using exit here is not recommended.

        } else if (count($errors) > 0) {
            echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
            echo "Please fix errors indicated by the following messages:\n\n";

            foreach ($errors as $error) {
                echo " * $error\n";
            }

            echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
            echo "Please search the forums before creating new topic for your question.\n";

            exit(-1);

Using exit here is not recommended.

        }
    }

    initial_sanity_check();

?>