1 <?php
3 /*
4 This code is part of GOsa (https://gosa.gonicus.de)
5 Copyright (C) 2007 Fabian Hickert
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
23 class Step_Checks extends setup_step
24 {
25 var $basic_checks = array();
26 var $config_checks= array();
27 var $is_writeable = array();
28 var $header_image = "images/system.png";
30 function Step_Checks()
31 {
32 $this->update_strings();
33 }
36 function update_strings()
37 {
38 $this->s_title = _("Installation check");
39 $this->s_title_long = _("Basic installation checks");
40 $this->s_info = _("Some basic checks for PHP version, ldap extension...");
41 }
44 /* Execute and display template */
45 function execute()
46 {
47 $this->run_checks();
48 $smarty = get_smarty();
49 $smarty->assign("basic" ,$this->basic_checks);
50 $smarty->assign("config" ,$this->config_checks);
51 $smarty->assign("is_writeable",$this->is_writeable);
52 return($smarty->fetch(get_template_path("setup_checks.tpl",TRUE,dirname(__FILE__))));
53 }
56 /* Execute all checks */
57 function run_checks()
58 {
59 $this->basic_checks = array();
60 $this->config_checks = array();
61 $this->is_writeable = array();
63 /* PHP version check */
64 $N = _("Checking PHP version");
65 $D = sprintf(_("PHP must be of version %s or %s or above for some functions."),"4.3.10","5.2.0");
66 $S = _("GOsa requires functions that may not be available in older PHP versions, just update to a supported PHP version.");
67 $R = $this->check_php_version();
68 $M = TRUE;
69 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
71 /* Checking imap extension */
72 $N = _("Checking for ldap module");
73 $D = _("This is the main module used by GOsa and therefore really required.");
74 $S = _("The ldap module (PHP4-ldap/PHP5-ldap) is required to communicate with your ldap server.");
75 $R = is_callable("ldap_bind");
76 $M = TRUE;
77 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
79 /* Check for gettext support */
80 $N = _("Checking for gettext support");
81 $D = _("Gettext support is required for internationalized GOsa.");
82 $S = _("This should be activated while compiling your PHP. (--with-gettext)");
83 $R = is_callable("bindtextdomain");
84 $M = TRUE;
85 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
87 /* Checing for iconv */
88 $N = _("Checking for iconv support");
89 $D = _("This module is used by GOsa to convert samba munged dial informations and is therefore required. ");
90 $S = _("This should be activated while compiling your PHP. (--with-iconv)");
91 $R = is_callable("iconv");
92 $M = TRUE;
93 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
95 /* Check for installed mhash module */
96 $N = _("Checking for mhash module");
97 $D = _("To use SSHA encryption, you'll need this module. GOsa will run without it.");
98 $S = _("The mhash module for PHP 4/5 is not available, please install it. (php4-mhash/php5-mhash)");
99 $R = is_callable("mhash");
100 $M = FALSE;
101 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
103 /* Is imap module available */
104 $N = _("Checking for imap module");
105 $D = _("The IMAP module is needed to communicate with the IMAP server. It gets status informations, creates and deletes mail users.");
106 $S = _("This module is used to communicate with your mail server. Please install (PHP4-imap PHP5-imap)");
107 $R = is_callable("imap_open");
108 $M = TRUE;
109 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
111 /* Check getacl in imap module */
112 $N = _("Checking for getacl in imap");
113 $D = _("The getacl support is needed for shared folder permissions. The standard IMAP module is not capable of reading acl's. You need a recend PHP version for this feature.");
114 $S = $D;
115 $R = is_callable("imap_getacl");
116 $M = TRUE;
117 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
119 /* Mysql module loaded ? */
120 $N = _("Checking for mysql module");
121 $D = _("MySQL support is needed for reading GOfax reports from databases.");
122 $S = _("This module is required to communicate with database servers, for example used in phone and fax addons. Please install (PHP4-mysql PHP5-mysql)");
123 $R = is_callable("mysql_query");
124 $M = TRUE;
125 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
127 /* Checking for kadm5 module */
128 $N = _("Checking for kadm5 module");
129 $D = _("Managing users in kerberos requires the kadm5 module which is downloadable via PEAR network.");
130 $S = _("This module is required to manage user in kerberos, it is downloadable via PEAR network");
131 $R = is_callable("kadm5_init_with_password");
132 $M = FALSE;
133 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
135 /* Snmp module available ? */
136 $N = _("Checking for snmp Module");
137 $D = _("Simple Network Management Protocol (SNMP) is required for client monitoring.");
138 $S = _("This module is required for client monitoring. (PHP4-snmp/PHP5-snmp)");
139 $R = is_callable("snmpget");
140 $M = FALSE;
141 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
143 /* Checking for Cups module */
144 $N = _("Checking for cups module");
145 $D = _("In order to read available printers from IPP protocol instead of printcap files, you've to install the CUPS module.");
146 $S = $D;
147 $R = is_callable("cups_get_dest_list");
148 $M = FALSE;
149 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
151 /* Checking for F ping utility */
152 $query= "LC_ALL=C LANG=C fping -v 2>&1";
153 $output= shell_exec ($query);
154 $N = _("Checking for fping utility");
155 $D = _("The fping utility is only used if you've got a thin client based terminal environment running.");
156 $S = _("The fping utility is only used in thin client based terminal environment.");
157 $R = preg_match("/^fping:/", $output);
158 $M = FALSE;
159 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
161 /* Checking generate LM/NT password hashes */
162 $query= "mkntpwd 2>&1";
163 $output= shell_exec ($query);
164 $have_mkntpwd= preg_match("/^Usage: mkntpwd /", $output);
165 if (!$have_mkntpwd){
166 $query= 'LC_ALL=C LANG=C perl -MCrypt::SmbHash -e "print join(q[:], ntlmgen $ARGV[0]), $/;" &>/dev/null';
167 system ($query, $ret);
168 $have_mkntpwd |= ($ret == 0);
169 }
171 $N = _("Password hashes");
172 $D = _("In order to use SAMBA 2/3, you've to install some additional packages to generate password hashes.");
173 $S = _("In order to use samba 2/3 you've to install some additional packages to generate password hashes. (e.g. libmhash2)");
174 $R = $have_mkntpwd;
175 $M = TRUE;
176 $this->basic_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
179 /* PHP Configuration checks
180 */
182 /* Register_globals off */
183 $N = _("register_globals"." "."<b>"._("Off")."</b>");
184 $D = _("register_globals is a PHP mechanism to register all global varibales to be accessible from scripts without changing the scope. This may be a security risk. GOsa will run in both modes.");
185 $S = _("Search for 'register_globals' in your php.ini and switch it to 'Off'.");
186 $R = ini_get("register_globals") == 0;
187 $M = FALSE;
188 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
191 /* session lifetime set to >=86400 seconds ? */
192 $N = ("session.gc_maxlifetime"." "."<b> >= 86400</b>");
193 $D = _("PHP uses this value for the garbage collector to delete old sessions.")." ".
194 _("Setting this value to one day will prevent loosing session and cookie before they really timeout.");
195 $S = _("Search for 'session.gc_maxlifetime' in your php.ini and set it to 86400 or higher.");
196 $R = ini_get("session.gc_maxlifetime") >= 86400;
197 $M = FALSE;
198 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
200 /* Session auto start must be turned off */
201 $session_auto_start = ini_get('session.auto_start');
202 $N = _("session.auto_start"." "."<b>"._("Off")."</b>");
203 $D = _("In Order to use GOsa without any trouble, the session.auto_register option in your php.ini must be set to 'Off'.");
204 $S = _("Search for 'session.auto_start' in your php.ini and set it to 'Off'.");
205 $R = !$session_auto_start['local_value'];
206 $M = TRUE;
207 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
209 /* Check if memory limit is set to 32 or > */
210 $N = _("memory_limit")." "."<b> >= 32</b>";
211 $D = _("GOsa needs at least 32MB of memory, less will cause unpredictable errors! Increase it for larger setups.");
212 $S = _("Search for 'memory_limit' in your php.ini and set it to '32M' or higher.");
213 $R = ini_get('memory_limit') >= 32 ;
214 $M = TRUE;
215 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
217 /* Implicit Flush disabled can increase performance */
218 $N = _("implicit_flush")." "."<b>"._("Off")."</b>";
219 $D = _("This option influences the Output handling. Turn this Option off, to increase performance.");
220 $S = _("Search for 'implicit_flush' in your php.ini and set it to 'Off'.");
221 $R = ini_get('implicit_flush');
222 $M = FALSE;
223 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
225 /* Check if execution time is set to 30 */
226 $N = _("max_execution_time")." "."<b> >= 30</b>";
227 $D = _("The Execution time should be at least 30 seconds, because some actions may consume more time.");
228 $S = _("Search for 'max_execution_time' in your php.ini and set it to '30' or higher.");
229 $R = ini_get("max_execution_time") >= 30 ;
230 $M = TRUE;
231 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
233 /* Expose php should be set to off */
234 $N = _("expose_php")." <b>"._("Off")."</b>";
235 $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.");
236 $S = _("Search for 'expose_php' in your php.ini and set if to 'Off'.");
237 $R = !ini_get("expose_php");
238 $M = FALSE;
239 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
241 /* Automatic quoting must be turned on */
242 $N = _("magic_quotes_gpc")." <b>"._("On")."</b>";
243 $D = _("Increase your server security by setting magic_quotes_gpc to 'on'. PHP will escape all quotes in strings in this case.");
244 $S = _("Search for 'magic_quotes_gpc' in your php.ini and set it to 'On'.");
245 $R = ini_get('magic_quotes_gpc');
246 $M = TRUE;
247 $this->config_checks[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
250 /* Configuration file
251 */
253 /* Check if we can create a config file.*/
254 $N = _("Configuration file writeable.");
255 $D = _("The Configuration file can't be written");
256 $S = sprintf(_("The GOsa reads its configuration from a file located in (%s/%s). The setup can write the configuration directly in this file, if it is writeable."),CONFIG_DIR,CONFIG_FILE);
257 $R = ( file_exists(CONFIG_DIR."/".CONFIG_FILE) && is_writeable(CONFIG_DIR."/".CONFIG_FILE)) // is there a config file ?
258 || (!file_exists(CONFIG_DIR."/".CONFIG_FILE) && is_writeable(CONFIG_DIR)); // There is non, but can we create a file there ?
259 $M = FALSE;
260 $this->is_writeable[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
262 /* If we have writeaccess to the config dir, check if there is already a config file */
263 # if($R){
264 #
265 # /* check if there is already a config file. */
266 # $N = _("No old configuration file.");
267 # $D = "";//_("");
268 # $S = _("If there is already a configuration file, this file will be overwritten when GOsa setup finishes. Please move your old config file away.");
269 # $R = !file_exists(CONFIG_DIR."/".CONFIG_FILE);
270 # $M = FALSE;
271 # $this->is_writeable[] = array("NAME" => $N , "DESC" => $D , "RESULT" => $R , "SOLUTION" => $S , "MUST" => $M );
272 # }
273 }
276 function save_object()
277 {
278 /* If everything is fine, set this step to completed
279 * and allow switching to next setup step
280 */
281 $failed = false;
282 foreach(array("basic_checks","config_checks","is_writeable") as $type){
283 foreach($this->$type as $obj){
285 if($obj['MUST'] && !$obj['RESULT']){
286 $failed = true;
287 break;
288 }
289 }
290 }
291 $this->is_completed = !$failed;
292 }
295 /* Check if current PHP version is compatible
296 with the current version of GOsa */
297 function check_php_version()
298 {
299 if(preg_match("/^5/",phpversion())){
300 return(version_compare(phpversion(),"5.2.0",">="));
301 }else{
302 return(version_compare(phpversion(),"4.3.10",">="));
303 }
304 }
305 }
307 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
308 ?>