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