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 $url_path = ($_SERVER['HTTPS'] != "on" ?
'http://' : 'https://') . $_SERVER["HTTP_HOST"] . parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH
);
24 * @SuppressWarnings(PHPMD.UnusedLocalVariable)
26 function initial_sanity_check() {
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.");
34 require_once "sanity_config.php";
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/");
40 if (strpos(PLUGINS
, "auth_") === FALSE) {
41 array_push($errors, "Please enable at least one authentication module via PLUGINS constant in config.php");
44 if (function_exists('posix_getuid') && posix_getuid() == 0) {
45 array_push($errors, "Please don't run this script as root.");
48 if (version_compare(PHP_VERSION
, '5.4.0', '<')) {
49 array_push($errors, "PHP version 5.4.0 or newer required.");
52 if (CONFIG_VERSION
!= EXPECTED_CONFIG_VERSION
) {
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.");
56 if (!is_writable(CACHE_DIR
. "/images")) {
57 array_push($errors, "Image cache is not writable (chmod -R 777 ".CACHE_DIR
."/images)");
60 if (!is_writable(CACHE_DIR
. "/upload")) {
61 array_push($errors, "Upload cache is not writable (chmod -R 777 ".CACHE_DIR
."/upload)");
64 if (!is_writable(CACHE_DIR
. "/export")) {
65 array_push($errors, "Data export cache is not writable (chmod -R 777 ".CACHE_DIR
."/export)");
68 if (!is_writable(CACHE_DIR
. "/js")) {
69 array_push($errors, "Javascript cache is not writable (chmod -R 777 ".CACHE_DIR
."/js)");
72 if (strlen(FEED_CRYPT_KEY
) > 0 && strlen(FEED_CRYPT_KEY
) != 24) {
73 array_push($errors, "FEED_CRYPT_KEY should be exactly 24 characters in length.");
76 if (strlen(FEED_CRYPT_KEY
) > 0 && !function_exists("mcrypt_decrypt")) {
77 array_push($errors, "FEED_CRYPT_KEY requires mcrypt functions which are not found.");
80 if (GENERATED_CONFIG_CHECK
!= EXPECTED_CONFIG_VERSION
) {
82 "Configuration option checker sanity_config.php is outdated, please recreate it using ./utils/regen_config_checks.sh");
85 foreach ($requred_defines as $d) {
88 "Required configuration file parameter $d is not defined in config.php. You might need to copy it from config.php-dist.");
92 if (SINGLE_USER_MODE
) {
93 $result = db_query("SELECT id FROM ttrss_users WHERE id = 1");
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.");
100 $ref_self_url_path = make_self_url_path();
101 $ref_self_url_path = preg_replace("/\w+\.php$/", "", $ref_self_url_path);
103 if (SELF_URL_PATH
== "http://example.org/tt-rss/") {
105 "Please set SELF_URL_PATH to the correct value for your server (possible value: <b>$ref_self_url_path</b>)");
108 if (SELF_URL_PATH
!= $ref_self_url_path && (!defined('_SKIP_SELF_URL_PATH_CHECKS') ||
!_SKIP_SELF_URL_PATH_CHECKS
)) {
110 "Please set SELF_URL_PATH to the correct value detected for your server: <b>$ref_self_url_path</b>");
113 if (!is_writable(ICONS_DIR
)) {
114 array_push($errors, "ICONS_DIR defined in config.php is not writable (chmod -R 777 ".ICONS_DIR
.").\n");
117 if (!is_writable(LOCK_DIRECTORY
)) {
118 array_push($errors, "LOCK_DIRECTORY defined in config.php is not writable (chmod -R 777 ".LOCK_DIRECTORY
.").\n");
121 if (!function_exists("curl_init") && !ini_get("allow_url_fopen")) {
122 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 if (!function_exists("json_encode")) {
126 array_push($errors, "PHP support for JSON is required, but was not found.");
129 if (DB_TYPE
== "mysql" && !function_exists("mysqli_connect")) {
130 array_push($errors, "PHP support for MySQL is required for configured DB_TYPE in config.php.");
133 if (DB_TYPE
== "pgsql" && !function_exists("pg_connect")) {
134 array_push($errors, "PHP support for PostgreSQL is required for configured DB_TYPE in config.php");
137 if (!function_exists("mb_strlen")) {
138 array_push($errors, "PHP support for mbstring functions is required but was not found.");
141 if (!function_exists("hash")) {
142 array_push($errors, "PHP support for hash() function is required but was not found.");
145 if (ini_get("safe_mode")) {
146 array_push($errors, "PHP safe mode setting is obsolete and not supported by tt-rss.");
149 if (!class_exists("DOMDocument")) {
150 array_push($errors, "PHP support for DOMDocument is required, but was not found.");
153 $self_scheme = parse_url(SELF_URL_PATH
, PHP_URL_SCHEME
);
155 if ($_SERVER['HTTPS'] && $self_scheme == 'http') {
156 array_push($errors, "You are accessing tt-rss over SSL but SELF_URL_PATH in config.php refers to a http:// URL.");
160 if (count($errors) > 0 && $_SERVER['REQUEST_URI']) { ?
>
163 <title
>Startup failed
</title
>
164 <meta http
-equiv
="Content-Type" content
="text/html; charset=utf-8">
165 <link rel
="stylesheet" type
="text/css" href
="css/utility.css">
168 <div
class="floatingLogo"><img src
="images/logo_small.png"></div
>
169 <div
class="content">
171 <h1
>Startup failed
</h1
>
173 <p
>Tiny Tiny RSS was unable to start properly
. This usually means a misconfiguration
or an incomplete upgrade
. Please fix
174 errors indicated by the following messages
:</p
>
176 <?php
foreach ($errors as $error) { echo format_error($error); } ?
>
178 <p
>You might want to check tt
-rss
<a href
="http://tt-rss.org/wiki">wiki
</a
> or the
179 <a href
="http://tt-rss.org/forum">forums
</a
> for more information
. Please search the forums before creating
new topic
180 for your question
.</p
>
188 } else if (count($errors) > 0) {
189 echo "Tiny Tiny RSS was unable to start properly. This usually means a misconfiguration or an incomplete upgrade.\n";
190 echo "Please fix errors indicated by the following messages:\n\n";
192 foreach ($errors as $error) {
196 echo "\nYou might want to check tt-rss wiki or the forums for more information.\n";
197 echo "Please search the forums before creating new topic for your question.\n";
203 initial_sanity_check();