sanity_check.php 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  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_path() {
  17. $url_path = ($_SERVER['HTTPS'] != "on" ? 'http://' : 'https://') . $_SERVER["HTTP_HOST"] . parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);
  18. return $url_path;
  19. }
  20. /**
  21. * @SuppressWarnings(PHPMD.UnusedLocalVariable)
  22. */
  23. function initial_sanity_check() {
  24. $errors = array();
  25. if (!file_exists("config.php")) {
  26. array_push($errors, "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.");
  27. } else {
  28. require_once "sanity_config.php";
  29. if (file_exists("install") && !file_exists("config.php")) {
  30. array_push($errors, "Please copy config.php-dist to config.php or run the installer in install/");
  31. }
  32. if (strpos(PLUGINS, "auth_") === FALSE) {
  33. array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
  34. }
  35. if (function_exists('posix_getuid') && posix_getuid() == 0) {
  36. array_push($errors, "Please don't run this script as root.");
  37. }
  38. if (version_compare(PHP_VERSION, '5.4.0', '<')) {
  39. array_push($errors, "PHP version 5.4.0 or newer required.");
  40. }
  41. if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
  42. 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.");
  43. }
  44. if (!is_writable(CACHE_DIR . "/images")) {
  45. array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
  46. }
  47. if (!is_writable(CACHE_DIR . "/upload")) {
  48. array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR."/upload)");
  49. }
  50. if (!is_writable(CACHE_DIR . "/export")) {
  51. array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
  52. }
  53. if (!is_writable(CACHE_DIR . "/js")) {
  54. array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR."/js)");
  55. }
  56. if (strlen(FEED_CRYPT_KEY) > 0 && strlen(FEED_CRYPT_KEY) != 24) {
  57. array_push($errors, "FEED_CRYPT_KEY should be exactly 24 characters in length.");
  58. }
  59. if (strlen(FEED_CRYPT_KEY) > 0 && !function_exists("mcrypt_decrypt")) {
  60. array_push($errors, "FEED_CRYPT_KEY requires mcrypt functions which are not found.");
  61. }
  62. if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
  63. array_push($errors,
  64. "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
  65. }
  66. foreach ($requred_defines as $d) {
  67. if (!defined($d)) {
  68. array_push($errors,
  69. "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
  70. }
  71. }
  72. if (SINGLE_USER_MODE) {
  73. $result = db_query("SELECT id FROM ttrss_users WHERE id = 1");
  74. if (db_num_rows($result) != 1) {
  75. array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
  76. }
  77. }
  78. if (SELF_URL_PATH == "http://example.org/tt-rss/") {
  79. $urlpath = preg_replace("/\w+\.php$/", "", make_self_url_path());
  80. array_push($errors,
  81. "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$urlpath</b>)");
  82. }
  83. if (!is_writable(ICONS_DIR)) {
  84. array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
  85. }
  86. if (!is_writable(LOCK_DIRECTORY)) {
  87. array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
  88. }
  89. if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
  90. 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.");
  91. }
  92. if (!function_exists("json_encode")) {
  93. array_push($errors, "PHP support for JSON is required, but was not found.");
  94. }
  95. if (DB_TYPE == "mysql" && !function_exists("mysqli_connect")) {
  96. array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
  97. }
  98. if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
  99. array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
  100. }
  101. if (!function_exists("mb_strlen")) {
  102. array_push($errors, "PHP support for mbstring functions is required but was not found.");
  103. }
  104. if (!function_exists("hash")) {
  105. array_push($errors, "PHP support for hash() function is required but was not found.");
  106. }
  107. if (ini_get("safe_mode")) {
  108. array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
  109. }
  110. if (!class_exists("DOMDocument")) {
  111. array_push($errors, "PHP support for DOMDocument is required, but was not found.");
  112. }
  113. $self_scheme = parse_url(SELF_URL_PATH, PHP_URL_SCHEME);
  114. if ($_SERVER['HTTPS'] && $self_scheme == 'http') {
  115. array_push($errors, "You are accessing tt-rss over SSL but SELF_URL_PATH in config.php refers to a http:// URL.");
  116. }
  117. }
  118. if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
  119. <html>
  120. <head>
  121. <title>Startup failed</title>
  122. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  123. <link rel="stylesheet" type="text/css" href="css/utility.css">
  124. </head>
  125. <body>
  126. <div class="floatingLogo"><img src="images/logo_small.png"></div>
  127. <div class="content">
  128. <h1>Startup failed</h1>
  129. <p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
  130. errors indicated by the following messages:</p>
  131. <?php foreach ($errors as $error) { echo format_error($error); } ?>
  132. <p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
  133. <a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
  134. for your question.</p>
  135. </div>
  136. </body>
  137. </html>
  138. <?php
  139. die;
  140. } else if (count($errors) > 0) {
  141. echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
  142. echo "Please fix errors indicated by the following messages:\n\n";
  143. foreach ($errors as $error) {
  144. echo " * $error\n";
  145. }
  146. echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
  147. echo "Please search the forums before creating new topic for your question.\n";
  148. exit(-1);
  149. }
  150. }
  151. initial_sanity_check();
  152. ?>