sanity_check.php 8.4 KB

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