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