sanity_check.php 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  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. function make_self_url() {
  17. $proto = is_server_https() ? 'https' : 'http';
  18. return $proto . '://' . $_SERVER["HTTP_HOST"] . $_SERVER["REQUEST_URI"];
  19. }
  20. function make_self_url_path() {
  21. $proto = is_server_https() ? 'https' : 'http';
  22. $url_path = $proto . '://' . $_SERVER["HTTP_HOST"] . parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);
  23. return $url_path;
  24. }
  25. /**
  26. * @SuppressWarnings(PHPMD.UnusedLocalVariable)
  27. */
  28. function initial_sanity_check() {
  29. $errors = array();
  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. require_once "sanity_config.php";
  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. if (strpos(PLUGINS, "auth_") === FALSE) {
  38. array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
  39. }
  40. if (function_exists('posix_getuid') && posix_getuid() == 0) {
  41. array_push($errors, "Please don't run this script as root.");
  42. }
  43. if (version_compare(PHP_VERSION, '5.6.0', '<')) {
  44. array_push($errors, "PHP version 5.6.0 or newer required. You're using " . PHP_VERSION . ".");
  45. }
  46. if (!class_exists("UConverter")) {
  47. array_push($errors, "PHP UConverter class is missing, it's provided by the Internationalization (intl) module.");
  48. }
  49. if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
  50. 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.");
  51. }
  52. if (!is_writable(CACHE_DIR . "/images")) {
  53. array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
  54. }
  55. if (!is_writable(CACHE_DIR . "/upload")) {
  56. array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR."/upload)");
  57. }
  58. if (!is_writable(CACHE_DIR . "/export")) {
  59. array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
  60. }
  61. if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
  62. array_push($errors,
  63. "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
  64. }
  65. foreach ($required_defines as $d) {
  66. if (!defined($d)) {
  67. array_push($errors,
  68. "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
  69. }
  70. }
  71. if (SINGLE_USER_MODE && class_exists("PDO")) {
  72. $pdo = DB::pdo();
  73. $res = $pdo->query("SELECT id FROM ttrss_users WHERE id = 1");
  74. if (!$res->fetch()) {
  75. array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
  76. }
  77. }
  78. $ref_self_url_path = make_self_url_path();
  79. $ref_self_url_path = preg_replace("/\w+\.php$/", "", $ref_self_url_path);
  80. if (SELF_URL_PATH == "http://example.org/tt-rss/") {
  81. array_push($errors,
  82. "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$ref_self_url_path</b>)");
  83. }
  84. if (isset($_SERVER["HTTP_HOST"]) &&
  85. (!defined('_SKIP_SELF_URL_PATH_CHECKS') || !_SKIP_SELF_URL_PATH_CHECKS) &&
  86. SELF_URL_PATH != $ref_self_url_path && SELF_URL_PATH != mb_substr($ref_self_url_path, 0, mb_strlen($ref_self_url_path)-1)) {
  87. array_push($errors,
  88. "Please set SELF_URL_PATH to the correct value detected for your server: <b>$ref_self_url_path</b>");
  89. }
  90. if (!is_writable(ICONS_DIR)) {
  91. array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
  92. }
  93. if (!is_writable(LOCK_DIRECTORY)) {
  94. array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
  95. }
  96. if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
  97. 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.");
  98. }
  99. if (!function_exists("json_encode")) {
  100. array_push($errors, "PHP support for JSON is required, but was not found.");
  101. }
  102. if (DB_TYPE == "mysql" && !function_exists("mysqli_connect")) {
  103. array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
  104. }
  105. if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
  106. array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
  107. }
  108. if (!class_exists("PDO")) {
  109. array_push($errors, "PHP support for PDO is required but was not found.");
  110. }
  111. if (!function_exists("mb_strlen")) {
  112. array_push($errors, "PHP support for mbstring functions is required but was not found.");
  113. }
  114. if (!function_exists("hash")) {
  115. array_push($errors, "PHP support for hash() function is required but was not found.");
  116. }
  117. if (ini_get("safe_mode")) {
  118. array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
  119. }
  120. if (!function_exists("mime_content_type")) {
  121. array_push($errors, "PHP function mime_content_type() is missing, try enabling fileinfo module.");
  122. }
  123. if (!class_exists("DOMDocument")) {
  124. array_push($errors, "PHP support for DOMDocument is required, but was not found.");
  125. }
  126. if (DB_TYPE == "mysql") {
  127. $bad_tables = check_mysql_tables();
  128. if (count($bad_tables) > 0) {
  129. $bad_tables_fmt = [];
  130. foreach ($bad_tables as $bt) {
  131. array_push($bad_tables_fmt, sprintf("%s (%s)", $bt['table_name'], $bt['engine']));
  132. }
  133. $msg = "<p>The following tables use an unsupported MySQL engine: <b>" .
  134. implode(", ", $bad_tables_fmt) . "</b>.</p>";
  135. $msg .= "<p>The only supported engine on MySQL is InnoDB. MyISAM lacks functionality to run
  136. tt-rss.
  137. Please backup your data (via OPML) and re-import the schema before continuing.</p>
  138. <p><b>WARNING: importing the schema would mean LOSS OF ALL YOUR DATA.</b></p>";
  139. array_push($errors, $msg);
  140. }
  141. }
  142. }
  143. if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
  144. <!DOCTYPE html>
  145. <html>
  146. <head>
  147. <title>Startup failed</title>
  148. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  149. <link rel="stylesheet" type="text/css" href="css/default.css">
  150. </head>
  151. <body class='sanity_failed claro ttrss_utility'>
  152. <div class="content">
  153. <h1>Startup failed</h1>
  154. <p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
  155. errors indicated by the following messages:</p>
  156. <?php foreach ($errors as $error) { echo format_error($error); } ?>
  157. <p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
  158. <a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
  159. for your question.</p>
  160. </div>
  161. </body>
  162. </html>
  163. <?php
  164. die;
  165. } else if (count($errors) > 0) {
  166. echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
  167. echo "Please fix errors indicated by the following messages:\n\n";
  168. foreach ($errors as $error) {
  169. echo " * $error\n";
  170. }
  171. echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
  172. echo "Please search the forums before creating new topic for your question.\n";
  173. exit(-1);
  174. }
  175. }
  176. initial_sanity_check();
  177. ?>