]> git.wh0rd.org Git - tt-rss.git/blob - include/sanity_check.php
mention that modifying sanity_check.php makes instance unsupported
[tt-rss.git] / include / sanity_check.php
1 <?php
2         // WARNING: Don't ask for help on tt-rss.org forums or the bugtracker if you have
3         // modified this file.
4
5         function initial_sanity_check($link) {
6
7                 $errors = array();
8
9                 if (!file_exists("config.php")) {
10                         array_push($errors, "Configuration file not found. Looks like you forgot to copy config.php-dist to config.php and edit it.");
11                 } else {
12
13                         require_once "sanity_config.php";
14
15                         if (function_exists('posix_getuid') && posix_getuid() == 0) {
16                                 array_push($errors, "Please don't run this script as root.");
17                         }
18
19                         if (version_compare("5.3.0", phpversion()) == 1) {
20                                 array_push($errors, "PHP version 5.3.0 or newer required.");
21                         }
22
23                         if (CONFIG_VERSION != EXPECTED_CONFIG_VERSION) {
24                                 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.");
25                         }
26
27                         if (!is_writable(CACHE_DIR . "/images")) {
28                                 array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR."/images)");
29                         }
30
31                         if (!is_writable(CACHE_DIR . "/export")) {
32                                 array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR."/export)");
33                         }
34
35                         if (GENERATED_CONFIG_CHECK != EXPECTED_CONFIG_VERSION) {
36                                 array_push($errors,
37                                         "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
38                         }
39
40                         foreach ($requred_defines as $d) {
41                                 if (!defined($d)) {
42                                         array_push($errors,
43                                                 "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
44                                 }
45                         }
46
47                         if (SESSION_EXPIRE_TIME < 60) {
48                                 array_push($errors, "SESSION_EXPIRE_TIME set in config.php is too low, please set it to an integer value >= 60");
49                         }
50
51                         if (SESSION_EXPIRE_TIME < SESSION_COOKIE_LIFETIME) {
52                                 array_push($errors, "SESSION_EXPIRE_TIME set in config.php should be >= to SESSION_COOKIE_LIFETIME");
53                         }
54
55                         if (SINGLE_USER_MODE) {
56                                 $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
57
58                                 if ($link) {
59                                         $result = db_query($link, "SELECT id FROM ttrss_users WHERE id = 1");
60
61                                         if (db_num_rows($result) != 1) {
62                                                 array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
63                                         }
64                                 }
65                         }
66
67                         if (SELF_URL_PATH == "http://yourserver/tt-rss/") {
68                                 if ($_SERVER['HTTP_REFERER']) {
69                                         array_push($errors,
70                                                 "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>" . $_SERVER['HTTP_REFERER'] . "</b>)");
71                                 } else {
72                                         array_push($errors, "Please set SELF_URL_PATH to the correct value for your server.");
73                                 }
74                         }
75
76                         if (!is_writable(ICONS_DIR)) {
77                                 array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR.").\n");
78                         }
79
80                         if (!is_writable(LOCK_DIRECTORY)) {
81                                 array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY.").\n");
82                         }
83
84                         if (ini_get("open_basedir")) {
85                                 array_push($errors, "PHP configuration option open_basedir is not supported. Please disable this in PHP settings file (php.ini).");
86                         }
87
88                         if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
89                                 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.");
90                         }
91
92                         if (!function_exists("json_encode")) {
93                                 array_push($errors, "PHP support for JSON is required, but was not found.");
94                         }
95
96                         if (DB_TYPE == "mysql" && !function_exists("mysql_connect")) {
97                                 array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
98                         }
99
100                         if (DB_TYPE == "pgsql" && !function_exists("pg_connect")) {
101                                 array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
102                         }
103
104                         if (!function_exists("mb_strlen")) {
105                                 array_push($errors, "PHP support for mbstring functions is required but was not found.");
106                         }
107
108                         if (!function_exists("hash")) {
109                                 array_push($errors, "PHP support for hash() function is required but was not found.");
110                         }
111
112                         if (!function_exists("ctype_lower")) {
113                                 array_push($errors, "PHP support for ctype functions are required by HTMLPurifier.");
114                         }
115
116                         if (ini_get("safe_mode")) {
117                                 array_push($errors, "PHP safe mode setting is not supported.");
118                         }
119
120                         if ((PUBSUBHUBBUB_HUB || PUBSUBHUBBUB_ENABLED) && !function_exists("curl_init")) {
121                                 array_push($errors, "PHP support for CURL is required for PubSubHubbub.");
122                         }
123
124                         if (!class_exists("DOMDocument")) {
125                                 array_push($errors, "PHP support for DOMDocument is required, but was not found.");
126                         }
127                 }
128
129                 if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?>
130                         <html>
131                         <head>
132                         <title>Startup failed</title>
133                                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
134                                 <link rel="stylesheet" type="text/css" href="utility.css">
135                         </head>
136                 <body>
137                 <div class="floatingLogo"><img src="images/logo_wide.png"></div>
138
139                         <h1>Startup failed</h1>
140
141                         <p>Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade. Please fix
142                         errors indicated by the following messages:</p>
143
144                         <?php foreach ($errors as $error) { echo format_error($error); } ?>
145
146                         <p>You might want to check tt-rss <a href="http://tt-rss.org/wiki">wiki</a> or the
147                                 <a href="http://tt-rss.org/forum">forums</a> for more information. Please search the forums before creating new topic
148                                 for your question.</p>
149                 </body>
150                 </html>
151
152                 <?php
153                         die;
154                 } else if (count($errors) > 0) {
155                         echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
156                         echo "Please fix errors indicated by the following messages:\n\n";
157
158                         foreach ($errors as $error) {
159                                 echo " * $error\n";
160                         }
161
162                         echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
163                         echo "Please search the forums before creating new topic for your question.\n";
164
165                         exit(-1);
166                 }
167         }
168
169         initial_sanity_check($link);
170
171 ?>