]> git.wh0rd.org - tt-rss.git/blame - include/sanity_check.php
further stylesheet simplification related fixes
[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 17 function make_self_url_path() {
9f7bd151 18 $proto = is_server_https() ? 'https' : 'http';
643ebe42 19 $url_path = $proto . '://' . $_SERVER["HTTP_HOST"] . parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);
24ff3b44
AD
20
21 return $url_path;
22 }
23
7b55001e
AD
24 /**
25 * @SuppressWarnings(PHPMD.UnusedLocalVariable)
26 */
6322ac79 27 function initial_sanity_check() {
d8735fc8 28
5be0ba92 29 $errors = array();
d8735fc8 30
5be0ba92
AD
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.");
33 } else {
8fc26c41 34
5be0ba92 35 require_once "sanity_config.php";
c798704b 36
d0c6dd29
AD
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/");
39 }
40
72679db8
AD
41 if (strpos(PLUGINS, "auth_") === FALSE) {
42 array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
43 }
44
5be0ba92
AD
45 if (function_exists('posix_getuid') && posix_getuid() == 0) {
46 array_push($errors, "Please don't run this script as root.");
47 }
ef8be8ea 48
bfd902bb
AD
49 if (version_compare(PHP_VERSION, '5.4.0', '<')) {
50 array_push($errors, "PHP version 5.4.0 or newer required.");
79f946be
AD
51 }
52
5be0ba92 53 if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
545ca067 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.");
5be0ba92 55 }
ef8be8ea 56
5be0ba92
AD
57 if (!is_writable(CACHE_DIR . "/images")) {
58 array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
59 }
ef8be8ea 60
3306daec
AD
61 if (!is_writable(CACHE_DIR . "/upload")) {
62 array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR."/upload)");
63 }
64
5be0ba92
AD
65 if (!is_writable(CACHE_DIR . "/export")) {
66 array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
09e8bdfd 67 }
ef8be8ea 68
c670a80d
AD
69 if (!is_writable(CACHE_DIR . "/js")) {
70 array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR."/js)");
71 }
72
5276b7c7 73 if (strlen(FEED_CRYPT_KEY) > 0 && strlen(FEED_CRYPT_KEY) != 24) {
044cff2d
AD
74 array_push($errors, "FEED_CRYPT_KEY should be exactly 24 characters in length.");
75 }
76
5276b7c7 77 if (strlen(FEED_CRYPT_KEY) > 0 && !function_exists("mcrypt_decrypt")) {
044cff2d
AD
78 array_push($errors, "FEED_CRYPT_KEY requires mcrypt functions which are not found.");
79 }
80
5be0ba92
AD
81 if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
82 array_push($errors,
83 "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
84 }
ef8be8ea 85
5be0ba92
AD
86 foreach ($requred_defines as $d) {
87 if (!defined($d)) {
88 array_push($errors,
89 "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
90 }
91 }
92
5be0ba92 93 if (SINGLE_USER_MODE) {
bbd9e504 94 $pdo = DB::pdo();
50e7dd7d 95
bbd9e504
AD
96 $res = $pdo->query("SELECT id FROM ttrss_users WHERE id = 1");
97
98 if (!$res->fetch()) {
6322ac79 99 array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
09e8bdfd 100 }
50e7dd7d 101 }
b03b2631 102
7506b61a 103 $ref_self_url_path = make_self_url_path();
1f916958 104 $ref_self_url_path = preg_replace("/\w+\.php$/", "", $ref_self_url_path);
24ff3b44 105
7506b61a 106 if (SELF_URL_PATH == "http://example.org/tt-rss/") {
24ff3b44 107 array_push($errors,
7506b61a 108 "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$ref_self_url_path</b>)");
09e8bdfd 109 }
17c0eeba 110
948471a4
AD
111 if (isset($_SERVER["HTTP_HOST"]) &&
112 (!defined('_SKIP_SELF_URL_PATH_CHECKS') || !_SKIP_SELF_URL_PATH_CHECKS) &&
9f7bd151 113 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
114 array_push($errors,
115 "Please set SELF_URL_PATH to the correct value detected for your server: <b>$ref_self_url_path</b>");
116 }
7506b61a 117
1f916958 118 if (!is_writable(ICONS_DIR)) {
5be0ba92
AD
119 array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
120 }
17c0eeba 121
5be0ba92
AD
122 if (!is_writable(LOCK_DIRECTORY)) {
123 array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
124 }
2604ad7d 125
5be0ba92
AD
126 if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
127 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 }
78a5c296 129
5be0ba92
AD
130 if (!function_exists("json_encode")) {
131 array_push($errors, "PHP support for JSON is required, but was not found.");
132 }
edfab7bd 133
e54eb40a 134 if (DB_TYPE == "mysql" && !function_exists("mysqli_connect")) {
5be0ba92
AD
135 array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
136 }
f6370f36 137
5be0ba92
AD
138 if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
139 array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
140 }
7bb8d39a 141
5be0ba92
AD
142 if (!function_exists("mb_strlen")) {
143 array_push($errors, "PHP support for mbstring functions is required but was not found.");
144 }
fe2f004c 145
5be0ba92
AD
146 if (!function_exists("hash")) {
147 array_push($errors, "PHP support for hash() function is required but was not found.");
148 }
7bb8d39a 149
4c467026
AD
150 if (ini_get("safe_mode")) {
151 array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
5be0ba92 152 }
7bb8d39a 153
8716ec20
AD
154 if (!function_exists("mime_content_type")) {
155 array_push($errors, "PHP function mime_content_type() is missing, try enabling fileinfo module.");
156 }
157
5be0ba92
AD
158 if (!class_exists("DOMDocument")) {
159 array_push($errors, "PHP support for DOMDocument is required, but was not found.");
160 }
0b68b162
AD
161
162 if (DB_TYPE == "mysql") {
163 $bad_tables = check_mysql_tables();
164
165 if (count($bad_tables) > 0) {
166 $bad_tables_fmt = [];
167
168 foreach ($bad_tables as $bt) {
169 array_push($bad_tables_fmt, sprintf("%s (%s)", $bt['table_name'], $bt['engine']));
170 }
171
172 $msg = "<p>The following tables use an unsupported MySQL engine: <b>" .
173 implode(", ", $bad_tables_fmt) . "</b>.</p>";
174
175 $msg .= "<p>The only supported engine on MySQL is InnoDB. MyISAM lacks functionality to run
176 tt-rss.
820873de 177 Please backup your data (via OPML) and re-import the schema before continuing.</p>
0b68b162
AD
178 <p><b>WARNING: importing the schema would mean LOSS OF ALL YOUR DATA.</b></p>";
179
180
181 array_push($errors, $msg);
182 }
183 }
09e8bdfd 184 }
f5b429ef 185
5be0ba92
AD
186 if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
187 <html>
188 <head>
189 <title>Startup failed</title>
190 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
09bc54c6 191 <link rel="stylesheet" type="text/css" href="css/default.css">
5be0ba92 192 </head>
09bc54c6 193 <body class='sanity_failed claro ttrss_utility'>
884d1650
AD
194 <div class="floatingLogo"><img src="images/logo_small.png"></div>
195 <div class="content">
7bb8d39a 196
5be0ba92 197 <h1>Startup failed</h1>
e2bcd11b 198
5be0ba92
AD
199 <p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
200 errors indicated by the following messages:</p>
76a259c2 201
5be0ba92 202 <?php foreach ($errors as $error) { echo format_error($error); } ?>
e6a63a1c 203
5be0ba92
AD
204 <p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
205 <a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
206 for your question.</p>
884d1650
AD
207
208 </div>
09e8bdfd
AD
209 </body>
210 </html>
f56c6cd4 211
5be0ba92
AD
212 <?php
213 die;
214 } else if (count($errors) > 0) {
215 echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
216 echo "Please fix errors indicated by the following messages:\n\n";
217
218 foreach ($errors as $error) {
219 echo " * $error\n";
220 }
221
383b0090 222 echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
5be0ba92
AD
223 echo "Please search the forums before creating new topic for your question.\n";
224
225 exit(-1);
226 }
ef8be8ea
AD
227 }
228
6322ac79 229 initial_sanity_check();
5be0ba92 230
66581886 231?>