include/sanity_check.php

   1 <?php
   2         // WARNING: Don't ask for help on tt-rss.org forums or the bugtracker if you have
   3         // modified this file.
   4
   5         function initial_sanity_check($link) {
   6
   7                 $errors = array();
   8
   9                 if (!file_exists("config.php")) {
  10                         array_push($errors, "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.");
  11                 } else {
  12
  13                         require_once "sanity_config.php";
  14
  15                         if (file_exists("install") && !file_exists("config.php")) {
  16                                 array_push($errors, "Please copy config.php-dist to config.php or run the installer in install/");
  17                         }
  18
  19                         if (strpos(PLUGINS, "auth_") === FALSE) {
  20                                 array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
  21                         }
  22
  23                         if (function_exists('posix_getuid') && posix_getuid() == 0) {
  24                                 array_push($errors, "Please don't run this script as root.");
  25                         }
  26
  27                         if (version_compare(PHP_VERSION, '5.3.0', '<')) {
  28                                 array_push($errors, "PHP version 5.3.0 or newer required.");
  29                         }
  30
  31                         if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
  32                                 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.");
  33                         }
  34
  35                         if (!is_writable(CACHE_DIR . "/images")) {
  36                                 array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
  37                         }
  38
  39                         if (!is_writable(CACHE_DIR . "/export")) {
  40                                 array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
  41                         }
  42
  43                         if (!is_writable(CACHE_DIR . "/js")) {
  44                                 array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR."/js)");
  45                         }
  46
  47                         if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
  48                                 array_push($errors,
  49                                         "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
  50                         }
  51
  52                         foreach ($requred_defines as $d) {
  53                                 if (!defined($d)) {
  54                                         array_push($errors,
  55                                                 "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
  56                                 }
  57                         }
  58
  59                         if (SESSION_EXPIRE_TIME < 60) {
  60                                 array_push($errors, "SESSION_EXPIRE_TIME set in config.php is too low, please set it to an integer value >= 60");
  61                         }
  62
  63                         if (SESSION_EXPIRE_TIME < SESSION_COOKIE_LIFETIME) {
  64                                 array_push($errors, "SESSION_EXPIRE_TIME set in config.php should be >= to SESSION_COOKIE_LIFETIME");
  65                         }
  66
  67                         if (SINGLE_USER_MODE) {
  68                                 $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
  69
  70                                 if ($link) {
  71                                         $result = db_query($link, "SELECT id FROM ttrss_users WHERE id = 1");
  72
  73                                         if (db_num_rows($result) != 1) {
  74                                                 array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
  75                                         }
  76                                 }
  77                         }
  78
  79                         if (SELF_URL_PATH == "http://yourserver/tt-rss/") {
  80                                 if ($_SERVER['HTTP_REFERER']) {
  81                                         array_push($errors,
  82                                                 "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>" . $_SERVER['HTTP_REFERER'] . "</b>)");
  83                                 } else {
  84                                         array_push($errors, "Please set SELF_URL_PATH to the correct value for your server.");
  85                                 }
  86                         }
  87
  88                         if (!is_writable(ICONS_DIR)) {
  89                                 array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
  90                         }
  91
  92                         if (!is_writable(LOCK_DIRECTORY)) {
  93                                 array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
  94                         }
  95
  96                         if (ini_get("open_basedir")) {
  97                                 array_push($errors, "PHP configuration option open_basedir is not supported. Please disable this in PHP settings file (php.ini).");
  98                         }
  99
 100                         if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
 101                                 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.");
 102                         }
 103
 104                         if (!function_exists("json_encode")) {
 105                                 array_push($errors, "PHP support for JSON is required, but was not found.");
 106                         }
 107
 108                         if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
 109                                 array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
 110                         }
 111
 112                         if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
 113                                 array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
 114                         }
 115
 116                         if (!function_exists("mb_strlen")) {
 117                                 array_push($errors, "PHP support for mbstring functions is required but was not found.");
 118                         }
 119
 120                         if (!function_exists("hash")) {
 121                                 array_push($errors, "PHP support for hash() function is required but was not found.");
 122                         }
 123
 124                         if (!function_exists("ctype_lower")) {
 125                                 array_push($errors, "PHP support for ctype functions are required by HTMLPurifier.");
 126                         }
 127
 128                         if (!function_exists("iconv")) {
 129                                 array_push($errors, "PHP support for iconv is required to handle multiple charsets.");
 130                         }
 131
 132                         /* if (ini_get("safe_mode")) {
 133                                 array_push($errors, "PHP safe mode setting is not supported.");
 134                         } */
 135
 136                         if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
 137                                 array_push($errors, "PHP support for CURL is required for PubSubHubbub.");
 138                         }
 139
 140                         if (!class_exists("DOMDocument")) {
 141                                 array_push($errors, "PHP support for DOMDocument is required, but was not found.");
 142                         }
 143                 }
 144
 145                 if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
 146                         <html>
 147                         <head>
 148                         <title>Startup failed</title>
 149                                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 150                                 <link rel="stylesheet" type="text/css" href="utility.css">
 151                         </head>
 152                 <body>
 153                 <div class="floatingLogo"><img src="images/logo_small.png"></div>
 154                         <div class="content">
 155
 156                         <h1>Startup failed</h1>
 157
 158                         <p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
 159                         errors indicated by the following messages:</p>
 160
 161                         <?php foreach ($errors as $error) { echo format_error($error); } ?>
 162
 163                         <p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
 164                                 <a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
 165                                 for your question.</p>
 166
 167                 </div>
 168                 </body>
 169                 </html>
 170
 171                 <?php
 172                         die;
 173                 } else if (count($errors) > 0) {
 174                         echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
 175                         echo "Please fix errors indicated by the following messages:\n\n";
 176
 177                         foreach ($errors as $error) {
 178                                 echo " * $error\n";
 179                         }
 180
 181                         echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
 182                         echo "Please search the forums before creating new topic for your question.\n";
 183
 184                         exit(-1);
 185                 }
 186         }
 187
 188         initial_sanity_check($link);
 189
 190 ?>