test
[squirrelmail.git] / include / init.php
1 <?php
2
3 /**
4 * init.php -- initialisation file
5 *
6 * File should be loaded in every file in src/ or plugins that occupate an entire frame
7 *
8 * @copyright &copy; 2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
10 * @version $Id$
11 * @package squirrelmail
12 */
13
14 /**
15 * This is a development version so in order to track programmer mistakes we
16 * set the error reporting to E_ALL
17 */
18 error_reporting(E_ALL);
19
20
21 /**
22 * If register_globals are on, unregister globals.
23 * Second test covers boolean set as string (php_value register_globals off).
24 */
25 if ((bool) ini_get('register_globals') &&
26 strtolower(ini_get('register_globals'))!='off') {
27 /**
28 * Remove all globals that are not reserved by PHP
29 * 'value' and 'key' are used by foreach. Don't unset them inside foreach.
30 */
31 foreach ($GLOBALS as $key => $value) {
32 switch($key) {
33 case 'HTTP_POST_VARS':
34 case '_POST':
35 case 'HTTP_GET_VARS':
36 case '_GET':
37 case 'HTTP_COOKIE_VARS':
38 case '_COOKIE':
39 case 'HTTP_SERVER_VARS':
40 case '_SERVER':
41 case 'HTTP_ENV_VARS':
42 case '_ENV':
43 case 'HTTP_POST_FILES':
44 case '_FILES':
45 case '_REQUEST':
46 case 'HTTP_SESSION_VARS':
47 case '_SESSION':
48 case 'GLOBALS':
49 case 'key':
50 case 'value':
51 break;
52 case 'sInitLocation':
53 // FIXME: variable must be set only in src/login.php
54 break;
55 default:
56 unset($GLOBALS[$key]);
57 }
58 }
59 // Unset variables used in foreach
60 unset($GLOBALS['key']);
61 unset($GLOBALS['value']);
62 }
63
64 /**
65 * Used as a dummy value, e.g., for passing as an empty
66 * hook argument.
67 */
68 global $null;
69 $null = NULL;
70
71 /**
72 * [#1518885] session.use_cookies = off breaks SquirrelMail
73 *
74 * When session cookies are not used, all http redirects, meta refreshes,
75 * src/download.php and javascript URLs are broken. Setting must be set
76 * before session is started.
77 */
78 if (!(bool)ini_get('session.use_cookies') ||
79 ini_get('session.use_cookies') == 'off') {
80 ini_set('session.use_cookies','1');
81 }
82
83 /**
84 * calculate SM_PATH and calculate the base_uri
85 * assumptions made: init.php is only called from plugins or from the src dir.
86 * files in the plugin directory may not be part of a subdirectory called "src"
87 *
88 */
89 if (isset($_SERVER['SCRIPT_NAME'])) {
90 $a = explode('/',$_SERVER['SCRIPT_NAME']);
91 } elseif (isset($HTTP_SERVER_VARS['SCRIPT_NAME'])) {
92 $a = explode('/',$HTTP_SERVER_VARS['SCRIPT_NAME']);
93 } else {
94 $error = 'Unable to detect script environment. '
95 .'Please test your PHP settings and send PHP core config, $_SERVER '
96 .'and $HTTP_SERVER_VARS to SquirrelMail developers.';
97 die($error);
98 }
99 $sSM_PATH = '';
100 for($i = count($a) -2;$i > -1; --$i) {
101 $sSM_PATH .= '../';
102 if ($a[$i] === 'src' || $a[$i] === 'plugins') {
103 break;
104 }
105 }
106
107 $base_uri = implode('/',array_slice($a,0,$i)). '/';
108
109 define('SM_PATH',$sSM_PATH);
110 define('SM_BASE_URI', $base_uri);
111 /**
112 * global var $bInit is used to check if initialisation took place.
113 * At this moment it's a workarounf for the include of addrbook_search_html
114 * inside compose.php. If we found a better way then remove this. Do only use
115 * this var if you know for sure a page can be called stand alone and be included
116 * in another file.
117 */
118 $bInit = true;
119
120 /**
121 * This theme as a failsafe if no themes were found, or if we error
122 * out before anything could be initialised.
123 */
124 $color = array();
125 $color[0] = '#DCDCDC'; /* light gray TitleBar */
126 $color[1] = '#800000'; /* red */
127 $color[2] = '#CC0000'; /* light red Warning/Error Messages */
128 $color[3] = '#A0B8C8'; /* green-blue Left Bar Background */
129 $color[4] = '#FFFFFF'; /* white Normal Background */
130 $color[5] = '#FFFFCC'; /* light yellow Table Headers */
131 $color[6] = '#000000'; /* black Text on left bar */
132 $color[7] = '#0000CC'; /* blue Links */
133 $color[8] = '#000000'; /* black Normal text */
134 $color[9] = '#ABABAB'; /* mid-gray Darker version of #0 */
135 $color[10] = '#666666'; /* dark gray Darker version of #9 */
136 $color[11] = '#770000'; /* dark red Special Folders color */
137 $color[12] = '#EDEDED';
138 $color[13] = '#800000'; /* (dark red) Color for quoted text -- > 1 quote */
139 $color[14] = '#ff0000'; /* (red) Color for quoted text -- >> 2 or more */
140 $color[15] = '#002266'; /* (dark blue) Unselectable folders */
141 $color[16] = '#ff9933'; /* (orange) Highlight color */
142
143 require(SM_PATH . 'functions/global.php');
144 require(SM_PATH . 'functions/arrays.php');
145
146 /* load default configuration */
147 require(SM_PATH . 'config/config_default.php');
148 /* reset arrays in default configuration */
149 $ldap_server = array();
150 $plugins = array();
151 $fontsets = array();
152 $aTemplateSet = array();
153 $aTemplateSet[0]['ID'] = 'default';
154 $aTemplateSet[0]['NAME'] = 'Default';
155
156 /* load site configuration */
157 require(SM_PATH . 'config/config.php');
158 /* load local configuration overrides */
159 if (file_exists(SM_PATH . 'config/config_local.php')) {
160 require(SM_PATH . 'config/config_local.php');
161 }
162
163 require(SM_PATH . 'functions/plugin.php');
164 require(SM_PATH . 'include/constants.php');
165 require(SM_PATH . 'include/languages.php');
166 require(SM_PATH . 'class/template/Template.class.php');
167 require(SM_PATH . 'class/error.class.php');
168
169 /**
170 * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
171 * Force magic_quotes_runtime off.
172 * tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
173 * If there's a better place, please let me know.
174 */
175 ini_set('magic_quotes_runtime','0');
176
177
178 /* if running with magic_quotes_gpc then strip the slashes
179 from POST and GET global arrays */
180 if (get_magic_quotes_gpc()) {
181 sqstripslashes($_GET);
182 sqstripslashes($_POST);
183 }
184
185
186 /* strip any tags added to the url from PHP_SELF.
187 This fixes hand crafted url XXS expoits for any
188 page that uses PHP_SELF as the FORM action */
189 $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
190
191 $PHP_SELF = php_self();
192
193 /**
194 * Initialize the session
195 */
196
197 /** set the name of the session cookie */
198 if (!isset($session_name) || !$session_name) {
199 $session_name = 'SQMSESSID';
200 }
201
202 /**
203 * if session.auto_start is On then close the session
204 */
205 $sSessionAutostartName = session_name();
206 if ((isset($sSessionAutostartName) || $sSessionAutostartName == '') &&
207 $sSessionAutostartName !== $session_name) {
208 $sCookiePath = ini_get('session.cookie_path');
209 $sCookieDomain = ini_get('session.cookie_domain');
210 // reset the cookie
211 setcookie($sSessionAutostartName,'',time() - 604800,$sCookiePath,$sCookieDomain);
212 @session_destroy();
213 session_write_close();
214 }
215
216 /**
217 * includes from classes stored in the session
218 */
219 require(SM_PATH . 'class/mime.class.php');
220
221 ini_set('session.name' , $session_name);
222 session_set_cookie_params (0, $base_uri);
223 sqsession_is_active();
224
225 /**
226 * SquirrelMail version number -- DO NOT CHANGE
227 */
228 $version = '1.5.2 [CVS]';
229
230 /**
231 * SquirrelMail internal version number -- DO NOT CHANGE
232 * $sm_internal_version = array (release, major, minor)
233 */
234 $SQM_INTERNAL_VERSION = array(1,5,2);
235
236
237 /* if plugins are disabled only for one user and
238 * the current user is NOT that user, turn them
239 * back on
240 */
241 sqgetGlobalVar('username',$username,SQ_SESSION);
242 if ($disable_plugins && !empty($disable_plugins_user)
243 && $username != $disable_plugins_user) {
244 $disable_plugins = false;
245 }
246
247 /* remove all plugins if they are disabled */
248 if ($disable_plugins) {
249 $plugins = array();
250 }
251
252
253 /**
254 * Include Compatibility plugin if available.
255 */
256 if (!$disable_plugins && file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
257 include_once(SM_PATH . 'plugins/compatibility/functions.php');
258
259 /**
260 * MAIN PLUGIN LOADING CODE HERE
261 * On init, we no longer need to load all plugin setup files.
262 * Now, we load the statically generated hook registrations here
263 * and let the hook calls include only the plugins needed.
264 */
265 $squirrelmail_plugin_hooks = array();
266 if (!$disable_plugins && file_exists(SM_PATH . 'config/plugin_hooks.php')) {
267 require(SM_PATH . 'config/plugin_hooks.php');
268 }
269
270 /**
271 * allow plugins to override main configuration; hook is placed
272 * here to allow plugins to use session information to do their work
273 */
274 do_hook('config_override', $null);
275
276 /**
277 * DISABLED.
278 * Remove globalized session data in rg=on setups
279 *
280 * Code can be utilized when session is started, but data is not loaded.
281 * We have already loaded configuration and other important vars. Can't
282 * clean session globals here.
283 if ((bool) @ini_get('register_globals') &&
284 strtolower(ini_get('register_globals'))!='off') {
285 foreach ($_SESSION as $key => $value) {
286 unset($GLOBALS[$key]);
287 }
288 }
289 */
290
291 sqsession_register(SM_BASE_URI,'base_uri');
292
293 /**
294 * Retrieve the language cookie
295 */
296 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
297 $squirrelmail_language = '';
298 }
299
300
301 /**
302 * @var $sInitlocation From where do we include.
303 */
304 if (!isset($sInitLocation)) {
305 $sInitLocation=NULL;
306 }
307
308 switch ($sInitLocation) {
309 case 'style':
310
311 // need to get the right template set up
312 //
313 sqGetGlobalVar('templateid', $templateid, SQ_GET);
314
315 // sanitize just in case...
316 //
317 $templateid = preg_replace('/(\.\.\/){1,}/', '', $templateid);
318
319 // make sure given template actually is available
320 //
321 $found_templateset = false;
322 for ($i = 0; $i < count($aTemplateSet); ++$i) {
323 if ($aTemplateSet[$i]['ID'] == $templateid) {
324 $found_templateset = true;
325 break;
326 }
327 }
328
329 // FIXME: do we need/want to check here for actual (physical) presence of template sets?
330 // selected template not available, fall back to default template
331 //
332 if (!$found_templateset) {
333 $sTemplateID = Template::get_default_template_set();
334 } else {
335 $sTemplateID = $templateid;
336 }
337
338 session_write_close();
339 break;
340
341 case 'redirect':
342 /**
343 * directory hashing functions are needed for all setups in case
344 * plugins use own pref files.
345 */
346 require(SM_PATH . 'functions/prefs.php');
347 require(SM_PATH . 'functions/auth.php');
348 /* hook loads custom prefs backend plugins */
349 $prefs_backend = do_hook('prefs_backend', $null);
350 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
351 require(SM_PATH . $prefs_backend);
352 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
353 require(SM_PATH . 'functions/db_prefs.php');
354 } else {
355 require(SM_PATH . 'functions/file_prefs.php');
356 }
357 //nobreak;
358 case 'login':
359 require(SM_PATH . 'functions/display_messages.php' );
360 require(SM_PATH . 'functions/page_header.php');
361 require(SM_PATH . 'functions/html.php');
362
363 // reset template file cache
364 //
365 $sTemplateID = Template::get_default_template_set();
366 Template::cache_template_file_hierarchy(TRUE);
367
368 /**
369 * Make sure icon variables are setup for the login page.
370 */
371 $icon_theme = $icon_themes[$icon_theme_def]['PATH'];
372 /*
373 * NOTE: The $icon_theme_path var should contain the path to the icon
374 * theme to use. If the admin has disabled icons, or the user has
375 * set the icon theme to "None," no icons will be used.
376 */
377 $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
378
379 /**
380 * cleanup old cookies with a cookie path the same as the standard php.ini
381 * cookie path. All previous SquirrelMail version used the standard php.ini
382 * cookie path for storing the session name. That behaviour changed.
383 */
384 if ($sCookiePath !== SM_BASE_URI) {
385 /**
386 * do not delete the standard sessions with session.name is i.e. PHPSESSID
387 * because they probably belong to other php apps
388 */
389 if (ini_get('session.name') !== $sSessionAutostartName) {
390 // This does not work. Sometimes the cookie with SQSESSID=deleted and path /
391 // is picked up in webmail.php => login will fail
392 //sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
393 }
394 }
395 break;
396 default:
397 require(SM_PATH . 'functions/display_messages.php' );
398 require(SM_PATH . 'functions/page_header.php');
399 require(SM_PATH . 'functions/html.php');
400 require(SM_PATH . 'functions/strings.php');
401
402
403 /**
404 * Check if we are logged in
405 */
406 require(SM_PATH . 'functions/auth.php');
407
408 if ( !sqsession_is_registered('user_is_logged_in') ) {
409 // First we store some information in the new session to prevent
410 // information-loss.
411 //
412 $session_expired_post = $_POST;
413 $session_expired_location = $PHP_SELF;
414 if (!sqsession_is_registered('session_expired_post')) {
415 sqsession_register($session_expired_post,'session_expired_post');
416 }
417 if (!sqsession_is_registered('session_expired_location')) {
418 sqsession_register($session_expired_location,'session_expired_location');
419 }
420 // signout page will deal with users who aren't logged
421 // in on its own; don't show error here
422 //
423 if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
424 return;
425 }
426
427 /**
428 * Initialize the template object (logout_error uses it)
429 */
430 /*
431 * $sTemplateID is not initialized when a user is not logged in, so we
432 * will use the config file defaults here. If the neccesary variables
433 * are net set, force a default value.
434 */
435 $sTemplateID = Template::get_default_template_set();
436 $oTemplate = Template::construct_template($sTemplateID);
437
438 set_up_language($squirrelmail_language, true);
439 logout_error( _("You must be logged in to access this page.") );
440 exit;
441 }
442
443 //FIXME: remove next line if the placement of the copy of this line above does not prove to be problematic
444 sqgetGlobalVar('username',$username,SQ_SESSION);
445 sqgetGlobalVar('authz',$authz,SQ_SESSION);
446
447 /**
448 * Setting the prefs backend
449 */
450 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
451 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
452
453 if ( !sqsession_is_registered('prefs_are_cached') ||
454 !isset( $prefs_cache) ||
455 !is_array( $prefs_cache)) {
456 $prefs_are_cached = false;
457 $prefs_cache = false; //array();
458 }
459
460 /* see 'redirect' case */
461 require(SM_PATH . 'functions/prefs.php');
462
463 $prefs_backend = do_hook('prefs_backend', $null);
464 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
465 require(SM_PATH . $prefs_backend);
466 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
467 require(SM_PATH . 'functions/db_prefs.php');
468 } else {
469 require(SM_PATH . 'functions/file_prefs.php');
470 }
471
472 /**
473 * initializing user settings
474 */
475 require(SM_PATH . 'include/load_prefs.php');
476
477 // i do not understand the frames language cookie story
478 /**
479 * We'll need this to later have a noframes version
480 *
481 * Check if the user has a language preference, but no cookie.
482 * Send him a cookie with his language preference, if there is
483 * such discrepancy.
484 */
485 $my_language = getPref($data_dir, $username, 'language');
486 if ($my_language != $squirrelmail_language) {
487 sqsetcookie('squirrelmail_language', $my_language, time()+2592000, $base_uri);
488 }
489 // /dont understand
490
491 /**
492 * Set up the language.
493 */
494 $err=set_up_language(getPref($data_dir, $username, 'language'));
495
496 // Japanese translation used without mbstring support
497 if ($err==2) {
498 $sError =
499 "<p>You need to have PHP installed with the multibyte string function \n".
500 "enabled (using configure option --enable-mbstring).</p>\n".
501 "<p>System assumed that you accidently switched to Japanese translation \n".
502 "and reverted your language preference to English.</p>\n".
503 "<p>Please refresh this page in order to use webmail.</p>\n";
504 error_box($sError);
505 }
506
507 $timeZone = getPref($data_dir, $username, 'timezone');
508
509 /* Check to see if we are allowed to set the TZ environment variable.
510 * We are able to do this if ...
511 * safe_mode is disabled OR
512 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
513 * safe_mode_allowed_env_vars contains TZ
514 */
515 $tzChangeAllowed = (!ini_get('safe_mode')) ||
516 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
517 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
518
519 if ( $timeZone != SMPREF_NONE && ($timeZone != "")
520 && $tzChangeAllowed ) {
521
522 // get time zone key, if strict or custom strict timezones are used
523 if (isset($time_zone_type) &&
524 ($time_zone_type == 1 || $time_zone_type == 3)) {
525 /* load time zone functions */
526 require(SM_PATH . 'include/timezones.php');
527 $realTimeZone = sq_get_tz_key($timeZone);
528 } else {
529 $realTimeZone = $timeZone;
530 }
531
532 // set time zone
533 if ($realTimeZone) {
534 putenv("TZ=".$realTimeZone);
535 }
536 }
537
538 /**
539 * php 5.1.0 added time zone functions. Set time zone with them in order
540 * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
541 */
542 if (function_exists('date_default_timezone_set')) {
543 if ($timeZone != SMPREF_NONE && $timeZone != "") {
544 date_default_timezone_set($timeZone);
545 } else {
546 // interface runs on server's time zone. Remove php E_STRICT complains
547 $default_timezone = @date_default_timezone_get();
548 date_default_timezone_set($default_timezone);
549 }
550 }
551 break;
552 }
553
554 /*
555 * $sTemplateID is not initialized when a user is not logged in, so we
556 * will use the config file defaults here. If the neccesary variables
557 * are not set, force a default value.
558 *
559 * If the user is logged in, $sTemplateID will be set in load_prefs.php,
560 * so we shouldn't change it here.
561 */
562 if (!isset($sTemplateID)) {
563 $sTemplateID = Template::get_default_template_set();
564 $icon_theme_path = !$use_icons ? NULL : Template::calculate_template_images_directory($sTemplateID);
565 }
566
567 // template object may have already been constructed in load_prefs.php
568 //
569 if (empty($oTemplate)) {
570 $oTemplate = Template::construct_template($sTemplateID);
571 }
572
573 // We want some variables to always be available to the template
574 $oTemplate->assign('javascript_on', checkForJavascript());
575 $oTemplate->assign('base_uri', sqm_baseuri());
576 $always_include = array('sTemplateID', 'icon_theme_path');
577 foreach ($always_include as $var) {
578 $oTemplate->assign($var, (isset($$var) ? $$var : NULL));
579 }
580
581 /**
582 * Initialize our custom error handler object
583 */
584 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
585
586 /**
587 * Activate custom error handling
588 */
589 if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
590 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
591 } else {
592 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
593 }
594
595 /**
596 * Javascript support detection function
597 * @param boolean $reset recheck javascript support if set to true.
598 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
599 * @since 1.5.1
600 */
601 function checkForJavascript($reset = FALSE) {
602 global $data_dir, $username, $javascript_on, $javascript_setting;
603
604 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
605 return $javascript_on;
606
607 if ( ( $reset || !isset($javascript_setting) )
608 // getPref() not defined (nor is it meaningful) when user not
609 // logged in, but that begs the question if $javascript_on is
610 // not in the session in that case, where do we get it from?
611 && ( sqGetGlobalVar('user_is_logged_in', $user_is_logged_in, SQ_SESSION)
612 && $user_is_logged_in) )
613 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
614
615 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
616 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
617 $js_autodetect_results = SMPREF_JS_OFF;
618
619 if ( $javascript_setting == SMPREF_JS_AUTODETECT )
620 $javascript_on = $js_autodetect_results;
621 else
622 $javascript_on = $javascript_setting;
623
624 sqsession_register($javascript_on, 'javascript_on');
625 return $javascript_on;
626 }
627
628 function sqm_baseuri() {
629 global $base_uri;
630 return $base_uri;
631 }