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