]> git.wh0rd.org - tt-rss.git/blobdiff - include/sanity_check.php
pref-feeds: apply patch by gmargo@forum to show/hide empty categories
[tt-rss.git] / include / sanity_check.php
index 3e5c0980358b25f0d51aa55262f8d777c401c5f7..5c631574decf02b8b5f6444cb4d4ae1a578ac965 100644 (file)
 <?php
        require_once "functions.php";
 
-       define('EXPECTED_CONFIG_VERSION', 23);
-       define('SCHEMA_VERSION', 86);
-
        if (!file_exists("config.php")) {
-               print "<b>Fatal Error</b>: You forgot to copy
-               <b>config.php-dist</b> to <b>config.php</b> and edit it.\n";
-               exit;
-       }
-
-       require_once "config.php";
-       require_once "sanity_config.php";
-
-       if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
-               $err_msg = "config: your config file version is incorrect. See config.php-dist.\n";
-       }
-
-       $purifier_cache_dir = CACHE_DIR . "/htmlpurifier";
+               $err_msg = "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.";
+       } else {
 
-       if (!is_writable($purifier_cache_dir)) {
-               $err_msg = "config: HTMLPurifier cache directory should be writable by anyone (chmod -R 777 $purifier_cache_dir)";
-       }
+               define('EXPECTED_CONFIG_VERSION', 25);
+               define('SCHEMA_VERSION', 90);
 
-       if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
-               $err_msg = "config: your sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh";
-       }
+               require_once "config.php";
+               require_once "sanity_config.php";
 
-       foreach ($requred_defines as $d) {
-               if (!defined($d)) {
-                       $err_msg = "config: required constant $d is not defined. Please check config.php";
+               if (function_exists('posix_getuid') && posix_getuid() == 0) {
+                       $err_msg = "Please don't run this script as root.";
                }
-       }
 
-       if (defined('RSS_BACKEND_TYPE')) {
-               print "<b>Fatal error</b>: RSS_BACKEND_TYPE is deprecated. Please remove this
-                       option from config.php\n";
-               exit;
-       }
+               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("xml-export.php") || file_exists("xml-import.php")) {
-               print "<b>Fatal Error</b>: XML Import/Export tools (<b>xml-export.php</b>
-               and <b>xml-import.php</b>) could be used maliciously. Please remove them
-               from your TT-RSS instance.\n";
-               exit;
-       }
+               $purifier_cache_dir = CACHE_DIR . "/htmlpurifier";
 
-       if (SINGLE_USER_MODE && DAEMON_UPDATE_LOGIN_LIMIT > 0) {
-               print "<b>Fatal Error</b>: Please set DAEMON_UPDATE_LOGIN_LIMIT
-                       to 0 in single user mode.\n";
-               exit;
-       }
+               if (!is_writable($purifier_cache_dir)) {
+                       $err_msg = "HTMLPurifier cache directory should be writable by anyone (chmod -R 777 $purifier_cache_dir)";
+               }
 
-       if (!defined('SESSION_EXPIRE_TIME')) {
-               $err_msg = "config: SESSION_EXPIRE_TIME is undefined";
-       }
+               if (!is_writable(CACHE_DIR . "/images")) {
+                       $err_msg = "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)";
+               }
 
-       if (SESSION_EXPIRE_TIME < 60) {
-               $err_msg = "config: SESSION_EXPIRE_TIME is too low (less than 60)";
-       }
+               if (!is_writable(CACHE_DIR . "/export")) {
+                       $err_msg = "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)";
+               }
 
-       if (SESSION_EXPIRE_TIME < SESSION_COOKIE_LIFETIME) {
-               $err_msg = "config: SESSION_EXPIRE_TIME should be greater or equal to" .
-                       "SESSION_COOKIE_LIFETIME";
-       }
+               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 (defined('DISABLE_SESSIONS')) {
-               $err_msg = "config: you have enabled DISABLE_SESSIONS. Please disable this option.";
-} */
+               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 (DATABASE_BACKED_SESSIONS && SINGLE_USER_MODE) {
-               $err_msg = "config: DATABASE_BACKED_SESSIONS is incompatible with SINGLE_USER_MODE";
-       }
+               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 (DATABASE_BACKED_SESSIONS && DB_TYPE == "mysql") {
-               $err_msg = "config: DATABASE_BACKED_SESSIONS are currently broken with MySQL";
-       }
+               if (SESSION_EXPIRE_TIME < SESSION_COOKIE_LIFETIME) {
+                       $err_msg = "SESSION_EXPIRE_TIME set in config.php should be >= to SESSION_COOKIE_LIFETIME";
+               }
 
-       if (SINGLE_USER_MODE) {
-               $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
+               if (SINGLE_USER_MODE) {
+                       $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
 
-               if ($link) {
-                       $result = db_query($link, "SELECT id FROM ttrss_users WHERE id = 1");
+                       if ($link) {
+                               $result = db_query($link, "SELECT id FROM ttrss_users WHERE id = 1");
 
-                       if (db_num_rows($result) != 1) {
-                               $err_msg = "config: SINGLE_USER_MODE is enabled but default admin account (UID=1) is not found.";
+                               if (db_num_rows($result) != 1) {
+                                       $err_msg = "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.";
+                               }
                        }
                }
-       }
 
-       if (defined('MAIL_FROM')) {
-               $err_msg = "config: MAIL_FROM has been split into DIGEST_FROM_NAME and DIGEST_FROM_ADDRESS";
-       }
-
-       if (!defined('COUNTERS_MAX_AGE')) {
-               $err_msg = "config: option COUNTERS_MAX_AGE expected, but not defined";
-       }
+               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 (defined('DAEMON_REFRESH_ONLY')) {
-               $err_msg = "config: option DAEMON_REFRESH_ONLY is obsolete. Please remove this option and read about other ways to update feeds on the <a href='http://tt-rss.org/wiki/UpdatingFeeds'>wiki</a>.";
+               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(LOCK_DIRECTORY)) {
+                       $err_msg = "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n";
+               }
 
-       if (defined('ENABLE_SIMPLEPIE')) {
-               $err_msg = "config: ENABLE_SIMPLEPIE is obsolete and replaced with DEFAULT_UPDATE_METHOD. Please adjust your config.php.";
-       }
+               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 (!defined('DEFAULT_UPDATE_METHOD') || (DEFAULT_UPDATE_METHOD != 0 &&
-                       DEFAULT_UPDATE_METHOD != 1)) {
-               $err_msg = "config: DEFAULT_UPDATE_METHOD should be either 0 or 1.";
-       }
+               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 (SELF_URL_PATH == "http://yourserver/tt-rss/") {
-               $err_msg = "config: please set SELF_URL_PATH to the correct value.";
-       }
+               if (!function_exists("json_encode")) {
+                       $err_msg = "PHP support for JSON is required, but was not found.";
+               }
 
-       if (!is_writable(ICONS_DIR)) {
-               $err_msg = "config: your ICONS_DIR (" . ICONS_DIR . ") is not writable.\n";
-       }
+               if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
+                       $err_msg = "PHP support for MySQL is required for configured DB_TYPE in config.php.";
+               }
 
-       if (ini_get("open_basedir")) {
-               $err_msg = "php.ini: open_basedir is not supported.";
-       }
+               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("curl_init") && !ini_get("allow_url_fopen")) {
-               $err_msg = "php.ini: either allow_url_fopen or CURL needs to be enabled.";
-       }
+               if (!function_exists("mb_strlen")) {
+                       $err_msg = "PHP support for mbstring functions is required, but was not found.";
+               }
 
-       if (!function_exists("json_encode")) {
-               $err_msg = "PHP: json functions not found.";
-       }
+               if (!function_exists("ctype_lower")) {
+                       $err_msg = "PHP support for ctype functions are required by HTMLPurifier.";
+               }
 
-       if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
-               $err_msg = "PHP: MySQL functions not found.";
-       }
+               if (ini_get("safe_mode")) {
+                       $err_msg = "PHP safe mode setting is not supported.";
+               }
 
-       if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
-               $err_msg = "PHP: PostgreSQL functions not found.";
-       }
+               if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
+                       $err_msg = "PHP support for CURL is required for PubSubHubbub.";
+               }
 
-       if (!function_exists("mb_strlen")) {
-               $err_msg = "PHP: mbstring functions not found.";
+               if (!class_exists("DOMDocument")) {
+                       $err_msg = "PHP support for DOMDocument is required, but was not found.";
+               }
        }
 
-       if (!function_exists("ctype_lower")) {
-               $err_msg = "PHP: ctype functions not found (required for HTMLPurifier).";
-       }
+       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 (ini_get("safe_mode")) {
-               $err_msg = "php.ini: Safe mode is not supported. If you wish to continue, remove this test from sanity_check.php and proceeed at your own risk. Please note that your bug reports will not be accepted or reviewed.";
-       }
+       <div class="floatingLogo"><img src="images/logo_wide.png"></div>
 
-       if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
-               $err_msg = "CURL is required for PubSubHubbub support.";
-       }
+               <h1>Fatal error</h1>
 
-       if (!class_exists("DOMDocument")) {
-               $err_msg = "PHP: DOMDocument extension not found.";
-       }
+               <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>
 
-       if (SELF_URL_PATH == "http://local.host/tt-rss") {
-               $err_msg = "config: please set SELF_URL_PATH to the correct value";
-       }
+               <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>
 
-       if (!ISCONFIGURED) {
-               $err_msg = "config: please read config.php completely.";
-       }
+               <body>
+                       <?php echo format_error($err_msg) ?>
+               </body>
+               </html>
 
-       if ($err_msg) {
-               print "<b>Fatal Error</b>: $err_msg\n";
-               exit;
+       <?php
+               die;
+       } else if ($err_msg) {
+               die("[sanity_check] $err_msg\n");
        }
 
 ?>