class_setupStepChecks.inc 11.3 KB
Newer Older
1 2 3 4
<?php
/*
  This code is part of FusionDirectory (http://www.fusiondirectory.org/)
  Copyright (C) 2003  Cajus Pollmeier
5
  Copyright (C) 2011-2016  FusionDirectory
6 7 8 9 10 11 12 13 14 15 16 17 18

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
19
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
20 21
*/

22
class setupStepChecks extends setupStep
23
{
24
  var $header_image = 'geticon.php?context=categories&icon=checks&size=48';
25

26
  static function getAttributesInfo (): array
27
  {
28 29
    return [
      'modules' => [
30 31
        'name'      => _('PHP module and extension checks'),
        'template'  => get_template_path("setup_checks.tpl", TRUE, dirname(__FILE__)),
32
        'attrs'     => [
33
          new FakeAttribute('basic_checks')
34 35 36
        ]
      ],
      'setup' => [
Côme Chilliet's avatar
Côme Chilliet committed
37
        'name'      => _('PHP setup configuration (<a href="?info" target="_blank">show information</a>)'),
38
        'template'  => get_template_path("setup_checks.tpl", TRUE, dirname(__FILE__)),
39
        'attrs'     => [
40
          new FakeAttribute('config_checks')
41 42 43
        ]
      ]
    ];
44 45
  }

46
  function update_strings ()
47
  {
48 49 50
    $this->s_short_name   = _('Installation check');
    $this->s_title        = _('Installation check');
    $this->s_description  = _('Basic checks for PHP compatibility and extensions');
51
  }
52 53

  /* Execute and display template */
54
  function execute (): string
55 56
  {
    $this->run_checks();
57
    return parent::execute();
58 59
  }

60
  /* Execute all checks */
61
  function run_checks ()
62
  {
63 64
    $basic_checks   = [];
    $config_checks  = [];
65 66

    /* PHP version check */
67 68 69 70
    $N = _('Checking PHP version');
    $D = sprintf(_('PHP must be of version %s or above.'), PHP_MIN_VERSION);
    $S = _('Please upgrade to a supported version.');
    $R = version_compare(phpversion(), PHP_MIN_VERSION, '>=');
71
    $M = TRUE;
72
    $basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
73

74
    /* Check for LDAP extension */
75
    $N = msgPool::checkingFor("LDAP");
76
    $D = _("FusionDirectory requires this module to talk with your LDAP server.");
77 78 79
    $S = msgPool::installPhpModule("LDAP");
    $R = is_callable("ldap_bind");
    $M = TRUE;
80
    $basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
81 82 83

    /* Check for gettext support */
    $N = msgPool::checkingFor("gettext");
84
    $D = _("FusionDirectory requires this module for an internationalized interface.");
85 86 87
    $S = msgPool::installPhpModule("gettext");
    $R = is_callable("bindtextdomain");
    $M = TRUE;
88
    $basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
89

90 91 92 93 94
    /* Check for curl support */
    $N = msgPool::checkingFor('curl');
    $D = _('FusionDirectory requires this module to communicate with different types of servers and protocols.');
    $S = msgPool::installPhpModule('curl');
    $R = is_callable('curl_init');
Benoit Mortier's avatar
Benoit Mortier committed
95
    $M = TRUE;
96
    $basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
Benoit Mortier's avatar
Benoit Mortier committed
97

98 99 100 101 102 103
    /* Pseudo-random check */
    $N = _('Checking cryptographically secure pseudo-random integers');
    $D = _('You must use PHP>=7 or have openssl module activated so that FusionDirectory can generate cryptographically secure pseudo-random integers.');
    $S = _('Please upgrade to PHP7 or activate openssl module.');
    $R = (is_callable('random_int') || is_callable('openssl_random_pseudo_bytes'));
    $M = TRUE;
104
    $basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
105

106 107 108 109 110 111
    /* Check for json support */
    $N = msgPool::checkingFor('json');
    $D = _('FusionDirectory requires this module to encode variables for javascript use.');
    $S = msgPool::installPhpModule('json');
    $R = is_callable('json_encode');
    $M = TRUE;
112
    $basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
113

114 115 116 117 118 119
    /* Check for filter support */
    $N = msgPool::checkingFor('filter');
    $D = _('FusionDirectory requires this module to filters a variable with a specified filter.');
    $S = msgPool::installPhpModule('filter');
    $R = is_callable('filter_var');
    $M = TRUE;
120
    $basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
121

122
    /* Check for iconv */
123
    $N = msgPool::checkingFor("iconv");
124
    $D = _("FusionDirectory requires this module for the samba integration.");
125 126 127
    $S = msgPool::installPhpModule("iconv");
    $R = is_callable("iconv");
    $M = TRUE;
128
    $basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
129 130 131

    /* Check for installed mhash module */
    $N = msgPool::checkingFor("hash method");
132
    $D = _("FusionDirectory requires either 'mhash' or the 'sha1' module to make use of SSHA encryption.");
133 134 135
    $S = msgPool::installPhpModule("mhash/sha1");
    $R = is_callable('mhash') || is_callable('sha1');
    $M = FALSE;
136
    $basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
137

138
    /* Check if imap module is available */
139
    $N = msgPool::checkingFor("IMAP");
140
    $D = _("FusionDirectory requires this module to talk to an IMAP server.");
141 142 143
    $S = msgPool::installPhpModule("IMAP");
    $R = is_callable("imap_open");
    $M = TRUE;
144
    $basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
145

146
    /* Check if mbstring module is available */
147
    $N = msgPool::checkingFor(_("mbstring"));
148
    $D = _("FusionDirectory requires this module to handle unicode strings.");
149 150 151
    $S = msgPool::installPhpModule("mbstring");
    $R = is_callable("mb_strlen");
    $M = TRUE;
152
    $basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
153

154 155 156
    $N = msgPool::checkingFor(_('imagick'));
    $D = _('FusionDirectory requires this extension to handle images.');
    $S = msgPool::installPhpModule('imagick');
157
    $R = class_exists('Imagick', FALSE);
158
    $M = TRUE;
159
    $basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
160 161

    $N = msgPool::checkingFor(_("compression module"));
162
    $D = _("FusionDirectory requires this extension to handle snapshots.");
163 164 165
    $S = msgPool::installPhpModule("compile with --with-zlib");
    $R = is_callable("gzcompress");
    $M = FALSE;
166
    $basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
167 168 169 170 171 172 173 174 175

    /* PHP Configuration checks */

    /* Register_globals off */
    $N = "register_globals = <b>off</b>";
    $D = _("register_globals is a PHP mechanism to register all global variables to be accessible from scripts without changing the scope. This may be a security risk.");
    $S = _("Search for 'register_globals' in your php.ini and switch it to 'Off'.");
    $R = ini_get("register_globals") == 0;
    $M = FALSE;
176
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
177 178 179 180 181 182 183 184

    /* session lifetime set to >=86400 seconds ? */
    $N = "session.gc_maxlifetime &gt;= <b>86400</b>";
    $D = _("PHP uses this value for the garbage collector to delete old sessions.")." ".
         _("Setting this value to one day will prevent loosing session and cookies before they really timeout.");
    $S = _("Search for 'session.gc_maxlifetime' in your php.ini and set it to 86400 or higher.");
    $R = ini_get("session.gc_maxlifetime") >= 86400;
    $M = FALSE;
185
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
186 187 188 189

    /* Session auto start must be turned off */
    $session_auto_start = ini_get('session.auto_start');
    $N = "session.auto_start = <b>"._("Off")."</b>";
190
    $D = _("In Order to use FusionDirectory without any trouble, the session.auto_start option in your php.ini should be set to 'Off'.");
191
    $S = _("Search for 'session.auto_start' in your php.ini and set it to 'Off'.");
192
    $R = !$session_auto_start;
193
    $M = TRUE;
194
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
195

196 197 198 199 200
    /* Check if memory limit is set to 128 or > */
    $N = "memory_limit &gt;= <b>128</b>";
    $D = _("FusionDirectory needs at least 128MB of memory. Setting it below this limit may cause errors that are not reproducable! Increase it for larger setups.");
    $S = _("Search for 'memory_limit' in your php.ini and set it to '128M' or higher.");
    $R = ini_get('memory_limit') >= 128;
201
    $M = TRUE;
202
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
203 204 205 206

    /* Implicit Flush disabled can increase performance */
    $N = "implicit_flush = <b>"._("Off")."</b>";
    $D = _("This option influences the PHP output handling. Turn this Option off, to increase performance.");
207
    $S = _("Search for 'implicit_flush' in your php.ini and set it to 'Off'.");
208 209
    $R = !ini_get('implicit_flush');
    $M = FALSE;
210
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
211 212 213 214 215

    /* Check if execution time is set to 30 */
    $N = "max_execution_time &gt;= <b>30</b>";
    $D = _("The Execution time should be at least 30 seconds.");
    $S = _("Search for 'max_execution_time' in your php.ini and set it to '30' or higher.");
216
    $R = ini_get("max_execution_time") >= 30;
217
    $M = TRUE;
218
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
219 220 221 222 223 224 225

    /* Expose php should be set to off */
    $N = "expose_php = <b>"._("Off")."</b>";
    $D = _("Increase the server security by setting expose_php to 'off'. PHP won't send any information about the server you are running in this case.");
    $S = _("Search for 'expose_php' in your php.ini and set if to 'Off'.");
    $R = !ini_get("expose_php");
    $M = FALSE;
226
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
227 228 229

    /* Emulating old stuff? */
    $N = "zend.ze1_compatibility_mode = <b>"._("Off")."</b>";
230 231 232
    $D = _("Increase your server performance by setting magic_quotes_gpc to 'off'.");
    $S = _("Search for 'zend.ze1_compatibility_mode' in your php.ini and set it to 'Off'.");
    $R = !ini_get('zend.ze1_compatibility_mode');
233
    $M = FALSE;
234
    $config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
235

236 237
    $this->basic_checks   = $basic_checks;
    $this->config_checks  = $config_checks;
238
  }
239

240
  function save_object ()
241
  {
242
    parent::save_object();
243 244
    /* If everything is fine, set this step to completed
    *  and allow switching to next setup step */
245
    $failed = FALSE;
246
    foreach (['basic_checks','config_checks'] as $type) {
247 248 249
      foreach ($this->$type as $obj) {
        if ($obj['MUST'] && !$obj['RESULT']) {
          $failed = TRUE;
250 251 252 253 254 255 256
          break;
        }
      }
    }
    $this->is_completed = !$failed;
  }
}