-
Côme Chilliet authoredThis replaces save_object and execute methods by 3 methods: readPost - Reads POST data update - Update object state render - Render HTML UI The point is to avoid reading POST and rendering HTML when this is not needed (when doing stuff through the webservice for instance). It’s also more consisent across FD with all classes handling some kind of dialog implementing the new interface FusionDirectoryDialog which makes sure these 3 methods are implemented. issue #6072
Unverified94eaa6ba
<?php/* This code is part of FusionDirectory (http://www.fusiondirectory.org/) Copyright (C) 2003 Cajus Pollmeier Copyright (C) 2011-2016 FusionDirectory 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 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.*/class setupStepChecks extends setupStep{ var $header_image = 'geticon.php?context=categories&icon=checks&size=48'; static function getAttributesInfo (): array { return [ 'modules' => [ 'name' => _('PHP module and extension checks'), 'template' => get_template_path("setup_checks.tpl", TRUE, dirname(__FILE__)), 'attrs' => [ new FakeAttribute('basic_checks') ] ], 'setup' => [ 'name' => _('PHP setup configuration (<a href="?info" target="_blank">show information</a>)'), 'template' => get_template_path("setup_checks.tpl", TRUE, dirname(__FILE__)), 'attrs' => [ new FakeAttribute('config_checks') ] ] ]; } function update_strings () { $this->s_short_name = _('Installation check'); $this->s_title = _('Installation check'); $this->s_description = _('Basic checks for PHP compatibility and extensions'); } /* Execute all checks */ function run_checks () { $basic_checks = []; $config_checks = []; /* PHP version check */ $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, '>='); $M = TRUE; $basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ]; /* Check for LDAP extension */ $N = msgPool::checkingFor("LDAP"); $D = _("FusionDirectory requires this module to talk with your LDAP server."); $S = msgPool::installPhpModule("LDAP");7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
$R = is_callable("ldap_bind");
$M = TRUE;
$basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Check for gettext support */
$N = msgPool::checkingFor("gettext");
$D = _("FusionDirectory requires this module for an internationalized interface.");
$S = msgPool::installPhpModule("gettext");
$R = is_callable("bindtextdomain");
$M = TRUE;
$basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* 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');
$M = TRUE;
$basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
/* 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;
$basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
/* 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;
$basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
/* Check for iconv */
$N = msgPool::checkingFor("iconv");
$D = _("FusionDirectory requires this module for the samba integration.");
$S = msgPool::installPhpModule("iconv");
$R = is_callable("iconv");
$M = TRUE;
$basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Check for installed mhash module */
$N = msgPool::checkingFor("hash method");
$D = _("FusionDirectory requires either 'mhash' or the 'sha1' module to make use of SSHA encryption.");
$S = msgPool::installPhpModule("mhash/sha1");
$R = is_callable('mhash') || is_callable('sha1');
$M = FALSE;
$basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Check if imap module is available */
$N = msgPool::checkingFor("IMAP");
$D = _("FusionDirectory requires this module to talk to an IMAP server.");
$S = msgPool::installPhpModule("IMAP");
$R = is_callable("imap_open");
$M = TRUE;
$basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Check if mbstring module is available */
$N = msgPool::checkingFor(_("mbstring"));
$D = _("FusionDirectory requires this module to handle unicode strings.");
$S = msgPool::installPhpModule("mbstring");
$R = is_callable("mb_strlen");
$M = TRUE;
$basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
$N = msgPool::checkingFor(_('imagick'));
$D = _('FusionDirectory requires this extension to handle images.');
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
$S = msgPool::installPhpModule('imagick');
$R = class_exists('Imagick', FALSE);
$M = TRUE;
$basic_checks[] = ['NAME' => $N , 'DESC' => $D , 'RESULT' => $R , 'SOLUTION' => $S , 'MUST' => $M ];
$N = msgPool::checkingFor(_("compression module"));
$D = _("FusionDirectory requires this extension to handle snapshots.");
$S = msgPool::installPhpModule("compile with --with-zlib");
$R = is_callable("gzcompress");
$M = FALSE;
$basic_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* 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;
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* session lifetime set to >=86400 seconds ? */
$N = "session.gc_maxlifetime >= <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;
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Session auto start must be turned off */
$session_auto_start = ini_get('session.auto_start');
$N = "session.auto_start = <b>"._("Off")."</b>";
$D = _("In Order to use FusionDirectory without any trouble, the session.auto_start option in your php.ini should be set to 'Off'.");
$S = _("Search for 'session.auto_start' in your php.ini and set it to 'Off'.");
$R = !$session_auto_start;
$M = TRUE;
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Check if memory limit is set to 128 or > */
$N = "memory_limit >= <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;
$M = TRUE;
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* 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.");
$S = _("Search for 'implicit_flush' in your php.ini and set it to 'Off'.");
$R = !ini_get('implicit_flush');
$M = FALSE;
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Check if execution time is set to 30 */
$N = "max_execution_time >= <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.");
$R = ini_get("max_execution_time") >= 30;
$M = TRUE;
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* 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;
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
/* Emulating old stuff? */
$N = "zend.ze1_compatibility_mode = <b>"._("Off")."</b>";
$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');
$M = FALSE;
$config_checks[] = ["NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M ];
$this->basic_checks = $basic_checks;
$this->config_checks = $config_checks;
}
public function update (): bool
{
parent::update();
$this->run_checks();
/* If everything is fine, set this step to completed
* and allow switching to next setup step */
$failed = FALSE;
foreach (['basic_checks','config_checks'] as $type) {
foreach ($this->$type as $obj) {
if ($obj['MUST'] && !$obj['RESULT']) {
$failed = TRUE;
break;
}
}
}
$this->is_completed = !$failed;
return TRUE;
}
}