<?php
- require_once "functions.php";
+ /*
+ * WARNING!
+ *
+ * If you modify this file, you are ON YOUR OWN!
+ *
+ * Believe it or not, all of the checks below are required to succeed for
+ * tt-rss to actually function properly.
+ *
+ * If you think you have a better idea about what is or isn't required, feel
+ * free to modify the file, note though that you are therefore automatically
+ * disqualified from any further support by official channels, e.g. tt-rss.org
+ * issue tracker or the forums.
+ *
+ * If you come crying when stuff inevitably breaks, you will be mocked and told
+ * to get out. */
- if (!file_exists("config.php")) {
- print "<b>Fatal Error</b>: You forgot to copy
- <b>config.php-dist</b> to <b>config.php</b> and edit it.\n";
- exit;
+ function make_self_url_path() {
+ $url_path = ($_SERVER['HTTPS'] != "on" ? 'http://' : 'https://') . $_SERVER["HTTP_HOST"] . parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);
+
+ return $url_path;
}
- define('EXPECTED_CONFIG_VERSION', 23);
- define('SCHEMA_VERSION', 86);
+ function initial_sanity_check() {
- require_once "config.php";
- require_once "sanity_config.php";
+ $errors = array();
- if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
- $err_msg = "config: your config file version is incorrect. See config.php-dist.\n";
- }
+ if (!file_exists("config.php")) {
+ array_push($errors, "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.");
+ } else {
- $purifier_cache_dir = CACHE_DIR . "/htmlpurifier";
+ require_once "sanity_config.php";
- if (!is_writable($purifier_cache_dir)) {
- $err_msg = "config: HTMLPurifier cache directory should be writable by anyone (chmod -R 777 $purifier_cache_dir)";
- }
+ if (file_exists("install") && !file_exists("config.php")) {
+ array_push($errors, "Please copy config.php-dist to config.php or run the installer in install/");
+ }
- if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
- $err_msg = "config: your sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh";
- }
+ if (strpos(PLUGINS, "auth_") === FALSE) {
+ array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
+ }
- foreach ($requred_defines as $d) {
- if (!defined($d)) {
- $err_msg = "config: required constant $d is not defined. Please check config.php";
- }
- }
+ if (function_exists('posix_getuid') && posix_getuid() == 0) {
+ array_push($errors, "Please don't run this script as root.");
+ }
- if (defined('RSS_BACKEND_TYPE')) {
- print "<b>Fatal error</b>: RSS_BACKEND_TYPE is deprecated. Please remove this
- option from config.php\n";
- exit;
- }
+ if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+ array_push($errors, "PHP version 5.3.0 or newer required.");
+ }
- if (file_exists("xml-export.php") || file_exists("xml-import.php")) {
- print "<b>Fatal Error</b>: XML Import/Export tools (<b>xml-export.php</b>
- and <b>xml-import.php</b>) could be used maliciously. Please remove them
- from your TT-RSS instance.\n";
- exit;
- }
+ if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
+ 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.");
+ }
- if (SINGLE_USER_MODE && DAEMON_UPDATE_LOGIN_LIMIT > 0) {
- print "<b>Fatal Error</b>: Please set DAEMON_UPDATE_LOGIN_LIMIT
- to 0 in single user mode.\n";
- exit;
- }
+ if (!is_writable(CACHE_DIR . "/images")) {
+ array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
+ }
- if (!defined('SESSION_EXPIRE_TIME')) {
- $err_msg = "config: SESSION_EXPIRE_TIME is undefined";
- }
+ if (!is_writable(CACHE_DIR . "/upload")) {
+ array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR."/upload)");
+ }
- if (SESSION_EXPIRE_TIME < 60) {
- $err_msg = "config: SESSION_EXPIRE_TIME is too low (less than 60)";
- }
+ if (!is_writable(CACHE_DIR . "/export")) {
+ array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
+ }
- if (SESSION_EXPIRE_TIME < SESSION_COOKIE_LIFETIME) {
- $err_msg = "config: SESSION_EXPIRE_TIME should be greater or equal to" .
- "SESSION_COOKIE_LIFETIME";
- }
+ if (!is_writable(CACHE_DIR . "/js")) {
+ array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR."/js)");
+ }
-/* if (defined('DISABLE_SESSIONS')) {
- $err_msg = "config: you have enabled DISABLE_SESSIONS. Please disable this option.";
-} */
+ if (strlen(FEED_CRYPT_KEY) > 0 && strlen(FEED_CRYPT_KEY) != 24) {
+ array_push($errors, "FEED_CRYPT_KEY should be exactly 24 characters in length.");
+ }
- if (DATABASE_BACKED_SESSIONS && SINGLE_USER_MODE) {
- $err_msg = "config: DATABASE_BACKED_SESSIONS is incompatible with SINGLE_USER_MODE";
- }
+ if (strlen(FEED_CRYPT_KEY) > 0 && !function_exists("mcrypt_decrypt")) {
+ array_push($errors, "FEED_CRYPT_KEY requires mcrypt functions which are not found.");
+ }
- if (DATABASE_BACKED_SESSIONS && DB_TYPE == "mysql") {
- $err_msg = "config: DATABASE_BACKED_SESSIONS are currently broken with MySQL";
- }
+ if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
+ array_push($errors,
+ "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
+ }
- if (SINGLE_USER_MODE) {
- $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
+ foreach ($requred_defines as $d) {
+ if (!defined($d)) {
+ array_push($errors,
+ "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
+ }
+ }
- if ($link) {
- $result = db_query($link, "SELECT id FROM ttrss_users WHERE id = 1");
+ if (SINGLE_USER_MODE) {
+ $result = db_query( "SELECT id FROM ttrss_users WHERE id = 1");
- if (db_num_rows($result) != 1) {
- $err_msg = "config: SINGLE_USER_MODE is enabled but default admin account (UID=1) is not found.";
+ if (db_num_rows($result) != 1) {
+ array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
+ }
}
- }
- }
- if (defined('MAIL_FROM')) {
- $err_msg = "config: MAIL_FROM has been split into DIGEST_FROM_NAME and DIGEST_FROM_ADDRESS";
- }
+ if (SELF_URL_PATH == "http://yourserver/tt-rss/") {
+ $urlpath = preg_replace("/\w+\.php$/", "", make_self_url_path());
- if (!defined('COUNTERS_MAX_AGE')) {
- $err_msg = "config: option COUNTERS_MAX_AGE expected, but not defined";
- }
+ array_push($errors,
+ "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$urlpath</b>)");
+ }
- if (defined('DAEMON_REFRESH_ONLY')) {
- $err_msg = "config: option DAEMON_REFRESH_ONLY is obsolete. Please remove this option and read about other ways to update feeds on the <a href='http://tt-rss.org/wiki/UpdatingFeeds'>wiki</a>.";
+ if (!is_writable(ICONS_DIR)) {
+ array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
+ }
- }
+ if (!is_writable(LOCK_DIRECTORY)) {
+ array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
+ }
- if (defined('ENABLE_SIMPLEPIE')) {
- $err_msg = "config: ENABLE_SIMPLEPIE is obsolete and replaced with DEFAULT_UPDATE_METHOD. Please adjust your config.php.";
- }
+ if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
+ 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.");
+ }
- if (!defined('DEFAULT_UPDATE_METHOD') || (DEFAULT_UPDATE_METHOD != 0 &&
- DEFAULT_UPDATE_METHOD != 1)) {
- $err_msg = "config: DEFAULT_UPDATE_METHOD should be either 0 or 1.";
- }
+ if (!function_exists("json_encode")) {
+ array_push($errors, "PHP support for JSON is required, but was not found.");
+ }
- if (SELF_URL_PATH == "http://yourserver/tt-rss/") {
- $err_msg = "config: please set SELF_URL_PATH to the correct value.";
- }
+ if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
+ array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
+ }
- if (!is_writable(ICONS_DIR)) {
- $err_msg = "config: your ICONS_DIR (" . ICONS_DIR . ") is not writable.\n";
- }
+ if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
+ array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
+ }
- if (ini_get("open_basedir")) {
- $err_msg = "php.ini: open_basedir is not supported.";
- }
+ if (!function_exists("mb_strlen")) {
+ array_push($errors, "PHP support for mbstring functions is required but was not found.");
+ }
- if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
- $err_msg = "php.ini: either allow_url_fopen or CURL needs to be enabled.";
- }
+ if (!function_exists("hash")) {
+ array_push($errors, "PHP support for hash() function is required but was not found.");
+ }
- if (!function_exists("json_encode")) {
- $err_msg = "PHP: json functions not found.";
- }
+ if (!function_exists("ctype_lower")) {
+ array_push($errors, "PHP support for ctype functions are required by HTMLPurifier.");
+ }
- if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
- $err_msg = "PHP: MySQL functions not found.";
- }
+ if (!function_exists("iconv")) {
+ array_push($errors, "PHP support for iconv is required to handle multiple charsets.");
+ }
- if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
- $err_msg = "PHP: PostgreSQL functions not found.";
- }
+ /* if (ini_get("safe_mode")) {
+ array_push($errors, "PHP safe mode setting is not supported.");
+ } */
- if (!function_exists("mb_strlen")) {
- $err_msg = "PHP: mbstring functions not found.";
- }
+ if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
+ array_push($errors, "PHP support for CURL is required for PubSubHubbub.");
+ }
- if (!function_exists("ctype_lower")) {
- $err_msg = "PHP: ctype functions not found (required for HTMLPurifier).";
- }
+ if (!class_exists("DOMDocument")) {
+ array_push($errors, "PHP support for DOMDocument is required, but was not found.");
+ }
+ }
- if (ini_get("safe_mode")) {
- $err_msg = "php.ini: Safe mode is not supported. If you wish to continue, remove this test from sanity_check.php and proceeed at your own risk. Please note that your bug reports will not be accepted or reviewed.";
- }
+ if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
+ <html>
+ <head>
+ <title>Startup failed</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <link rel="stylesheet" type="text/css" href="utility.css">
+ </head>
+ <body>
+ <div class="floatingLogo"><img src="images/logo_small.png"></div>
+ <div class="content">
- if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
- $err_msg = "CURL is required for PubSubHubbub support.";
- }
+ <h1>Startup failed</h1>
- if (!class_exists("DOMDocument")) {
- $err_msg = "PHP: DOMDocument extension not found.";
- }
+ <p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
+ errors indicated by the following messages:</p>
- if (SELF_URL_PATH == "http://local.host/tt-rss") {
- $err_msg = "config: please set SELF_URL_PATH to the correct value";
- }
+ <?php foreach ($errors as $error) { echo format_error($error); } ?>
- if (!ISCONFIGURED) {
- $err_msg = "config: please read config.php completely.";
- }
+ <p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
+ <a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
+ for your question.</p>
+
+ </div>
+ </body>
+ </html>
+
+ <?php
+ die;
+ } else if (count($errors) > 0) {
+ echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
+ echo "Please fix errors indicated by the following messages:\n\n";
+
+ foreach ($errors as $error) {
+ echo " * $error\n";
+ }
+
+ echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
+ echo "Please search the forums before creating new topic for your question.\n";
- if ($err_msg) {
- print "<b>Fatal Error</b>: $err_msg\n";
- exit;
+ exit(-1);
+ }
}
+ initial_sanity_check();
+
?>
git.wh0rd.org / tt-rss.git / blobdiff