4 * If you modify this file, you are ON YOUR OWN!
6 * Believe it or not, all of the checks below are required to succeed for
7 * tt-rss to actually function properly.
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.
14 * If you come crying when stuff inevitably breaks, you will be mocked and told
17 function make_self_url_path() {
18 $proto = is_server_https() ?
'https' : 'http';
19 $url_path = $proto . '://' . $_SERVER["HTTP_HOST"] . parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH
);
25 * @SuppressWarnings(PHPMD.UnusedLocalVariable)
27 function initial_sanity_check() {
31 if (!file_exists("config.php")) {
32 array_push($errors, "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.");
35 require_once "sanity_config.php";
37 if (file_exists("install") && !file_exists("config.php")) {
38 array_push($errors, "Please copy config.php-dist to config.php or run the installer in install/");
41 if (strpos(PLUGINS
, "auth_") === FALSE) {
42 array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
45 if (function_exists('posix_getuid') && posix_getuid() == 0) {
46 array_push($errors, "Please don't run this script as root.");
49 if (version_compare(PHP_VERSION
, '5.4.0', '<')) {
50 array_push($errors, "PHP version 5.4.0 or newer required.");
53 if (CONFIG_VERSION
!= EXPECTED_CONFIG_VERSION
) {
54 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.");
57 if (!is_writable(CACHE_DIR
. "/images")) {
58 array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR
."/images)");
61 if (!is_writable(CACHE_DIR
. "/upload")) {
62 array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR
."/upload)");
65 if (!is_writable(CACHE_DIR
. "/export")) {
66 array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR
."/export)");
69 if (!is_writable(CACHE_DIR
. "/js")) {
70 array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR
."/js)");
73 if (strlen(FEED_CRYPT_KEY
) > 0 && strlen(FEED_CRYPT_KEY
) != 24) {
74 array_push($errors, "FEED_CRYPT_KEY should be exactly 24 characters in length.");
77 if (strlen(FEED_CRYPT_KEY
) > 0 && !function_exists("mcrypt_decrypt")) {
78 array_push($errors, "FEED_CRYPT_KEY requires mcrypt functions which are not found.");
81 if (GENERATED_CONFIG_CHECK
!= EXPECTED_CONFIG_VERSION
) {
83 "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
86 foreach ($requred_defines as $d) {
89 "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
93 if (SINGLE_USER_MODE
) {
94 $result = db_query("SELECT id FROM ttrss_users WHERE id = 1");
96 if (db_num_rows($result) != 1) {
97 array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
101 $ref_self_url_path = make_self_url_path();
102 $ref_self_url_path = preg_replace("/\w+\.php$/", "", $ref_self_url_path);
104 if (SELF_URL_PATH
== "http://example.org/tt-rss/") {
106 "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$ref_self_url_path</b>)");
109 if (isset($_SERVER["HTTP_HOST"]) &&
110 (!defined('_SKIP_SELF_URL_PATH_CHECKS') ||
!_SKIP_SELF_URL_PATH_CHECKS
) &&
111 SELF_URL_PATH
!= $ref_self_url_path && SELF_URL_PATH
!= mb_substr($ref_self_url_path, 0, mb_strlen($ref_self_url_path)-1)) {
113 "Please set SELF_URL_PATH to the correct value detected for your server: <b>$ref_self_url_path</b>");
116 if (!is_writable(ICONS_DIR
)) {
117 array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR
.").\n");
120 if (!is_writable(LOCK_DIRECTORY
)) {
121 array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY
.").\n");
124 if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
125 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.");
128 if (!function_exists("json_encode")) {
129 array_push($errors, "PHP support for JSON is required, but was not found.");
132 if (DB_TYPE
== "mysql" && !function_exists("mysqli_connect")) {
133 array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
136 if (DB_TYPE
== "pgsql" && !function_exists("pg_connect")) {
137 array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
140 if (!function_exists("mb_strlen")) {
141 array_push($errors, "PHP support for mbstring functions is required but was not found.");
144 if (!function_exists("hash")) {
145 array_push($errors, "PHP support for hash() function is required but was not found.");
148 if (ini_get("safe_mode")) {
149 array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
152 if (!function_exists("mime_content_type")) {
153 array_push($errors, "PHP function mime_content_type() is missing, try enabling fileinfo module.");
156 if (!class_exists("DOMDocument")) {
157 array_push($errors, "PHP support for DOMDocument is required, but was not found.");
161 if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?
>
164 <title
>Startup failed
</title
>
165 <meta http
-equiv
="Content-Type" content
="text/html; charset=utf-8">
166 <link rel
="stylesheet" type
="text/css" href
="css/utility.css">
169 <div
class="floatingLogo"><img src
="images/logo_small.png"></div
>
170 <div
class="content">
172 <h1
>Startup failed
</h1
>
174 <p
>Tiny Tiny RSS was unable to start properly
. This usually means a misconfiguration
or an incomplete upgrade
. Please fix
175 errors indicated by the following messages
:</p
>
177 <?php
foreach ($errors as $error) { echo format_error($error); } ?
>
179 <p
>You might want to check tt
-rss
<a href
="http://tt-rss.org/wiki">wiki
</a
> or the
180 <a href
="http://tt-rss.org/forum">forums
</a
> for more information
. Please search the forums before creating
new topic
181 for your question
.</p
>
189 } else if (count($errors) > 0) {
190 echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
191 echo "Please fix errors indicated by the following messages:\n\n";
193 foreach ($errors as $error) {
197 echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
198 echo "Please search the forums before creating new topic for your question.\n";
204 initial_sanity_check();