include/sanity_check.php

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