include/sanity_check.php

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