]> git.wh0rd.org - tt-rss.git/blobdiff - include/sanity_check.php
remove $link
[tt-rss.git] / include / sanity_check.php
index 3de1593f35dbba6169afbdeec43b734e7fed8815..0477efd5077fb37d81ea5a7385fe1e061c0b0fe5 100644 (file)
 <?php
-       require_once "functions.php";
+       /*
+        * WARNING!
+        *
+        * If you modify this file, you are ON YOUR OWN!
+        *
+        * Believe it or not, all of the checks below are required to succeed for
+        * tt-rss to actually function properly.
+        *
+        * If you think you have a better idea about what is or isn't required, feel
+        * free to modify the file, note though that you are therefore automatically
+        * disqualified from any further support by official channels, e.g. tt-rss.org
+        * issue tracker or the forums.
+        *
+        * If you come crying when stuff inevitably breaks, you will be mocked and told
+        * to get out. */
+
+       function make_self_url_path() {
+               $url_path = ($_SERVER['HTTPS'] != "on" ? 'http://' :  'https://') . $_SERVER["HTTP_HOST"] . parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);
+
+               return $url_path;
+       }
 
-       if (!file_exists("config.php")) {
-               $err_msg = "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.";
-       } else {
+       function initial_sanity_check() {
 
-               define('EXPECTED_CONFIG_VERSION', 25);
-               define('SCHEMA_VERSION', 89);
+               $errors = array();
 
-               require_once "config.php";
-               require_once "sanity_config.php";
+               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 {
 
-               if (function_exists('posix_getuid') && posix_getuid() == 0) {
-                       $err_msg = "Please don't run this script as root.";
-               }
+                       require_once "sanity_config.php";
 
-               if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
-                       $err_msg = "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 (file_exists("install") && !file_exists("config.php")) {
+                               array_push($errors, "Please copy config.php-dist to config.php or run the installer in install/");
+                       }
 
-               $purifier_cache_dir = CACHE_DIR . "/htmlpurifier";
+                       if (strpos(PLUGINS, "auth_") === FALSE) {
+                               array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
+                       }
 
-               if (!is_writable($purifier_cache_dir)) {
-                       $err_msg = "HTMLPurifier cache directory should be writable by anyone (chmod -R 777 $purifier_cache_dir)";
-               }
+                       if (function_exists('posix_getuid') && posix_getuid() == 0) {
+                               array_push($errors, "Please don't run this script as root.");
+                       }
 
-               if (!is_writable(CACHE_DIR . "/images")) {
-                       $err_msg = "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)";
-               }
+                       if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+                               array_push($errors, "PHP version 5.3.0 or newer required.");
+                       }
 
-               if (!is_writable(CACHE_DIR . "/export")) {
-                       $err_msg = "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)";
-               }
+                       if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
+                               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 (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
-                       $err_msg = "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh";
-               }
+                       if (!is_writable(CACHE_DIR . "/images")) {
+                               array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
+                       }
 
-               foreach ($requred_defines as $d) {
-                       if (!defined($d)) {
-                               $err_msg = "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.";
+                       if (!is_writable(CACHE_DIR . "/upload")) {
+                               array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR."/upload)");
                        }
-               }
 
-               if (SESSION_EXPIRE_TIME < 60) {
-                       $err_msg = "SESSION_EXPIRE_TIME set in config.php is too low, please set it to an integer value >= 60";
-               }
+                       if (!is_writable(CACHE_DIR . "/export")) {
+                               array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
+                       }
 
-               if (SESSION_EXPIRE_TIME < SESSION_COOKIE_LIFETIME) {
-                       $err_msg = "SESSION_EXPIRE_TIME set in config.php should be >= to SESSION_COOKIE_LIFETIME";
-               }
+                       if (!is_writable(CACHE_DIR . "/js")) {
+                               array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR."/js)");
+                       }
+
+                       if (strlen(FEED_CRYPT_KEY) > 0 && strlen(FEED_CRYPT_KEY) != 24) {
+                               array_push($errors, "FEED_CRYPT_KEY should be exactly 24 characters in length.");
+                       }
 
-               if (SINGLE_USER_MODE) {
-                       $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
+                       if (strlen(FEED_CRYPT_KEY) > 0 && !function_exists("mcrypt_decrypt")) {
+                               array_push($errors, "FEED_CRYPT_KEY requires mcrypt functions which are not found.");
+                       }
 
-                       if ($link) {
-                               $result = db_query($link, "SELECT id FROM ttrss_users WHERE id = 1");
+                       if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
+                               array_push($errors,
+                                       "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
+                       }
+
+                       foreach ($requred_defines as $d) {
+                               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) {
+                               $result = db_query( "SELECT id FROM ttrss_users WHERE id = 1");
 
                                if (db_num_rows($result) != 1) {
-                                       $err_msg = "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.";
+                                       array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
                                }
                        }
-               }
 
-               if (SELF_URL_PATH == "http://yourserver/tt-rss/") {
-                       if ($_SERVER['HTTP_REFERER']) {
-                               $err_msg = "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>" . $_SERVER['HTTP_REFERER'] . "</b>)";
-                       } else {
-                               $err_msg = "Please set SELF_URL_PATH to the correct value for your server.";
+                       if (SELF_URL_PATH == "http://yourserver/tt-rss/") {
+                               $urlpath = preg_replace("/\w+\.php$/", "", make_self_url_path());
+
+                               array_push($errors,
+                                               "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$urlpath</b>)");
                        }
-               }
 
-               if (!is_writable(ICONS_DIR)) {
-                       $err_msg = "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n";
-               }
+                       if (!is_writable(ICONS_DIR)) {
+                               array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
+                       }
 
-               if (!is_writable(LOCK_DIRECTORY)) {
-                       $err_msg = "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n";
-               }
+                       if (!is_writable(LOCK_DIRECTORY)) {
+                               array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
+                       }
 
-               if (ini_get("open_basedir")) {
-                       $err_msg = "PHP configuration option open_basedir is not supported. Please disable this in PHP settings file (php.ini).";
-               }
+                       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("curl_init") && !ini_get("allow_url_fopen")) {
-                       $err_msg = "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 (!function_exists("json_encode")) {
-                       $err_msg = "PHP support for JSON is required, but was not found.";
-               }
+                       if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
+                               array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
+                       }
 
-               if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
-                       $err_msg = "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 (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
-                       $err_msg = "PHP support for PostgreSQL is required for configured DB_TYPE in config.php";
-               }
+                       if (!function_exists("mb_strlen")) {
+                               array_push($errors, "PHP support for mbstring functions is required but was not found.");
+                       }
 
-               if (!function_exists("mb_strlen")) {
-                       $err_msg = "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 (!function_exists("ctype_lower")) {
-                       $err_msg = "PHP support for ctype functions are required by HTMLPurifier.";
-               }
+                       if (!function_exists("ctype_lower")) {
+                               array_push($errors, "PHP support for ctype functions are required by HTMLPurifier.");
+                       }
 
-               if (ini_get("safe_mode")) {
-                       $err_msg = "PHP safe mode setting is not supported.";
-               }
+                       if (!function_exists("iconv")) {
+                               array_push($errors, "PHP support for iconv is required to handle multiple charsets.");
+                       }
 
-               if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
-                       $err_msg = "PHP support for CURL is required for PubSubHubbub.";
-               }
+                       /* if (ini_get("safe_mode")) {
+                               array_push($errors, "PHP safe mode setting is not supported.");
+                       } */
+
+                       if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
+                               array_push($errors, "PHP support for CURL is required for PubSubHubbub.");
+                       }
 
-               if (!class_exists("DOMDocument")) {
-                       $err_msg = "PHP support for DOMDocument is required, but was not found.";
+                       if (!class_exists("DOMDocument")) {
+                               array_push($errors, "PHP support for DOMDocument is required, but was not found.");
+                       }
                }
-       }
 
-       if ($err_msg && defined($_SERVER['REQUEST_URI'])) { ?>
-               <html>
-               <head>
-               <title>Fatal error</title>
-                       <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-                       <link rel="stylesheet" type="text/css" href="utility.css">
-               </head>
+               if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
+                       <html>
+                       <head>
+                       <title>Startup failed</title>
+                               <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+                               <link rel="stylesheet" type="text/css" href="utility.css">
+                       </head>
+               <body>
+               <div class="floatingLogo"><img src="images/logo_small.png"></div>
+                       <div class="content">
 
-       <div class="floatingLogo"><img src="images/logo_wide.png"></div>
+                       <h1>Startup failed</h1>
 
-               <h1>Fatal error</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>
 
-               <p>Tiny Tiny RSS was unable to initialize properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
-               the error indicated by the following message:</p>
+                       <?php foreach ($errors as $error) { echo format_error($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>
+                       <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>
 
-               <body>
-                       <?php echo format_error($err_msg) ?>
+               </div>
                </body>
                </html>
 
-       <?php
-               die;
-       } else if ($err_msg) {
-               die("[sanity_check] $err_msg\n");
+               <?php
+                       die;
+               } 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);
+               }
        }
 
+       initial_sanity_check();
+
 ?>