PageRenderTime 59ms CodeModel.GetById 19ms RepoModel.GetById 1ms app.codeStats 0ms

/include/sanity_check.php

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