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
) {
96 $res = $pdo->query("SELECT id FROM ttrss_users WHERE id = 1");
99 array_push($errors, "SINGLE_USER_MODE is enabled in config.php but default admin account is not found.");
103 $ref_self_url_path = make_self_url_path();
104 $ref_self_url_path = preg_replace("/\w+\.php$/", "", $ref_self_url_path);
106 if (SELF_URL_PATH
== "http://example.org/tt-rss/") {
108 "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$ref_self_url_path</b>)");
111 if (isset($_SERVER["HTTP_HOST"]) &&
112 (!defined('_SKIP_SELF_URL_PATH_CHECKS') ||
!_SKIP_SELF_URL_PATH_CHECKS
) &&
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)) {
115 "Please set SELF_URL_PATH to the correct value detected for your server: <b>$ref_self_url_path</b>");
118 if (!is_writable(ICONS_DIR
)) {
119 array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR
.").\n");
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");
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.");
130 if (!function_exists("json_encode")) {
131 array_push($errors, "PHP support for JSON is required, but was not found.");
134 if (DB_TYPE
== "mysql" && !function_exists("mysqli_connect")) {
135 array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
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");
142 if (!function_exists("mb_strlen")) {
143 array_push($errors, "PHP support for mbstring functions is required but was not found.");
146 if (!function_exists("hash")) {
147 array_push($errors, "PHP support for hash() function is required but was not found.");
150 if (ini_get("safe_mode")) {
151 array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
154 if (!function_exists("mime_content_type")) {
155 array_push($errors, "PHP function mime_content_type() is missing, try enabling fileinfo module.");
158 if (!class_exists("DOMDocument")) {
159 array_push($errors, "PHP support for DOMDocument is required, but was not found.");
162 if (DB_TYPE
== "mysql") {
163 $bad_tables = check_mysql_tables();
165 if (count($bad_tables) > 0) {
166 $bad_tables_fmt = [];
168 foreach ($bad_tables as $bt) {
169 array_push($bad_tables_fmt, sprintf("%s (%s)", $bt['table_name'], $bt['engine']));
172 $msg = "<p>The following tables use an unsupported MySQL engine: <b>" .
173 implode(", ", $bad_tables_fmt) . "</b>.</p>";
175 $msg .= "<p>The only supported engine on MySQL is InnoDB. MyISAM lacks functionality to run
177 Please backup your data (via OPML) and re-import the schema before continuing.</p>
178 <p><b>WARNING: importing the schema would mean LOSS OF ALL YOUR DATA.</b></p>";
181 array_push($errors, $msg);
186 if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?
>
189 <title
>Startup failed
</title
>
190 <meta http
-equiv
="Content-Type" content
="text/html; charset=utf-8">
191 <link rel
="stylesheet" type
="text/css" href
="css/utility.css">
193 <body
class='sanity_failed'>
194 <div
class="floatingLogo"><img src
="images/logo_small.png"></div
>
195 <div
class="content">
197 <h1
>Startup failed
</h1
>
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
>
202 <?php
foreach ($errors as $error) { echo format_error($error); } ?
>
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
>
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";
218 foreach ($errors as $error) {
222 echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
223 echo "Please search the forums before creating new topic for your question.\n";
229 initial_sanity_check();