]> git.wh0rd.org - tt-rss.git/blame - include/sanity_check.php
filters dialog: do not break markup on long feed names
[tt-rss.git] / include / sanity_check.php
CommitLineData
1d3a17c7 1<?php
7b55001e 2 /* WARNING!
b3b48f61
AD
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. */
618e2d35 16
24ff3b44
AD
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
20 return $url_path;
21 }
22
7b55001e
AD
23 /**
24 * @SuppressWarnings(PHPMD.UnusedLocalVariable)
25 */
6322ac79 26 function initial_sanity_check() {
d8735fc8 27
5be0ba92 28 $errors = array();
d8735fc8 29
5be0ba92
AD
30 if (!file_exists("config.php")) {
31 array_push($errors, "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.");
32 } else {
8fc26c41 33
5be0ba92 34 require_once "sanity_config.php";
c798704b 35
d0c6dd29
AD
36 if (file_exists("install") && !file_exists("config.php")) {
37 array_push($errors, "Please copy config.php-dist to config.php or run the installer in install/");
38 }
39
72679db8
AD
40 if (strpos(PLUGINS, "auth_") === FALSE) {
41 array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
42 }
43
5be0ba92
AD
44 if (function_exists('posix_getuid') && posix_getuid() == 0) {
45 array_push($errors, "Please don't run this script as root.");
46 }
ef8be8ea 47
bfd902bb
AD
48 if (version_compare(PHP_VERSION, '5.4.0', '<')) {
49 array_push($errors, "PHP version 5.4.0 or newer required.");
79f946be
AD
50 }
51
5be0ba92 52 if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
545ca067 53 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.");
5be0ba92 54 }
ef8be8ea 55
5be0ba92
AD
56 if (!is_writable(CACHE_DIR . "/images")) {
57 array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
58 }
ef8be8ea 59
3306daec
AD
60 if (!is_writable(CACHE_DIR . "/upload")) {
61 array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR."/upload)");
62 }
63
5be0ba92
AD
64 if (!is_writable(CACHE_DIR . "/export")) {
65 array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
09e8bdfd 66 }
ef8be8ea 67
c670a80d
AD
68 if (!is_writable(CACHE_DIR . "/js")) {
69 array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR."/js)");
70 }
71
5276b7c7 72 if (strlen(FEED_CRYPT_KEY) > 0 && strlen(FEED_CRYPT_KEY) != 24) {
044cff2d
AD
73 array_push($errors, "FEED_CRYPT_KEY should be exactly 24 characters in length.");
74 }
75
5276b7c7 76 if (strlen(FEED_CRYPT_KEY) > 0 && !function_exists("mcrypt_decrypt")) {
044cff2d
AD
77 array_push($errors, "FEED_CRYPT_KEY requires mcrypt functions which are not found.");
78 }
79
5be0ba92
AD
80 if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
81 array_push($errors,
82 "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
83 }
ef8be8ea 84
5be0ba92
AD
85 foreach ($requred_defines as $d) {
86 if (!defined($d)) {
87 array_push($errors,
88 "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
89 }
90 }
91
5be0ba92 92 if (SINGLE_USER_MODE) {
a42c55f0 93 $result = db_query("SELECT id FROM ttrss_users WHERE id = 1");
50e7dd7d 94
6322ac79
AD
95 if (db_num_rows($result) != 1) {
96 array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
09e8bdfd 97 }
50e7dd7d 98 }
b03b2631 99
7506b61a 100 $ref_self_url_path = make_self_url_path();
1f916958 101 $ref_self_url_path = preg_replace("/\w+\.php$/", "", $ref_self_url_path);
24ff3b44 102
7506b61a 103 if (SELF_URL_PATH == "http://example.org/tt-rss/") {
24ff3b44 104 array_push($errors,
7506b61a 105 "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$ref_self_url_path</b>)");
09e8bdfd 106 }
17c0eeba 107
948471a4
AD
108 if (isset($_SERVER["HTTP_HOST"]) &&
109 (!defined('_SKIP_SELF_URL_PATH_CHECKS') || !_SKIP_SELF_URL_PATH_CHECKS) &&
110 SELF_URL_PATH != $ref_self_url_path && SELF_URL_PATH != mb_substr($ref_self_url_path, 0, mb_strlen($ref_self_url_path)-1)) {
1f916958
AD
111 array_push($errors,
112 "Please set SELF_URL_PATH to the correct value detected for your server: <b>$ref_self_url_path</b>");
113 }
7506b61a 114
1f916958 115 if (!is_writable(ICONS_DIR)) {
5be0ba92
AD
116 array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
117 }
17c0eeba 118
5be0ba92
AD
119 if (!is_writable(LOCK_DIRECTORY)) {
120 array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
121 }
2604ad7d 122
5be0ba92
AD
123 if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
124 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.");
125 }
78a5c296 126
5be0ba92
AD
127 if (!function_exists("json_encode")) {
128 array_push($errors, "PHP support for JSON is required, but was not found.");
129 }
edfab7bd 130
e54eb40a 131 if (DB_TYPE == "mysql" && !function_exists("mysqli_connect")) {
5be0ba92
AD
132 array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
133 }
f6370f36 134
5be0ba92
AD
135 if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
136 array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
137 }
7bb8d39a 138
5be0ba92
AD
139 if (!function_exists("mb_strlen")) {
140 array_push($errors, "PHP support for mbstring functions is required but was not found.");
141 }
fe2f004c 142
5be0ba92
AD
143 if (!function_exists("hash")) {
144 array_push($errors, "PHP support for hash() function is required but was not found.");
145 }
7bb8d39a 146
4c467026
AD
147 if (ini_get("safe_mode")) {
148 array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
5be0ba92 149 }
7bb8d39a 150
5be0ba92
AD
151 if (!class_exists("DOMDocument")) {
152 array_push($errors, "PHP support for DOMDocument is required, but was not found.");
153 }
e35ba0e2
AD
154
155 $self_scheme = parse_url(SELF_URL_PATH, PHP_URL_SCHEME);
156
157 if ($_SERVER['HTTPS'] && $self_scheme == 'http') {
158 array_push($errors, "You are accessing tt-rss over SSL but SELF_URL_PATH in config.php refers to a http:// URL.");
159 }
09e8bdfd 160 }
f5b429ef 161
5be0ba92
AD
162 if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
163 <html>
164 <head>
165 <title>Startup failed</title>
166 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5bbc4bb4 167 <link rel="stylesheet" type="text/css" href="css/utility.css">
5be0ba92
AD
168 </head>
169 <body>
884d1650
AD
170 <div class="floatingLogo"><img src="images/logo_small.png"></div>
171 <div class="content">
7bb8d39a 172
5be0ba92 173 <h1>Startup failed</h1>
e2bcd11b 174
5be0ba92
AD
175 <p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
176 errors indicated by the following messages:</p>
76a259c2 177
5be0ba92 178 <?php foreach ($errors as $error) { echo format_error($error); } ?>
e6a63a1c 179
5be0ba92
AD
180 <p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
181 <a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
182 for your question.</p>
884d1650
AD
183
184 </div>
09e8bdfd
AD
185 </body>
186 </html>
f56c6cd4 187
5be0ba92
AD
188 <?php
189 die;
190 } else if (count($errors) > 0) {
191 echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
192 echo "Please fix errors indicated by the following messages:\n\n";
193
194 foreach ($errors as $error) {
195 echo " * $error\n";
196 }
197
383b0090 198 echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
5be0ba92
AD
199 echo "Please search the forums before creating new topic for your question.\n";
200
201 exit(-1);
202 }
ef8be8ea
AD
203 }
204
6322ac79 205 initial_sanity_check();
5be0ba92 206
66581886 207?>