E_ALL is a moving target
[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 2006-2012 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 FIXME: disabling this for now, because we now have $sm_debug_mode, but the problem with that is that we don't know what it will be until we have loaded the config file, a good 175 lines below after several important files have been included, etc. For now, we'll trust that developers have turned on E_ALL in php.ini anyway, but this can be uncommented if not.
18 */
19 //error_reporting(E_ALL);
20
21
22 /**
23 * Make sure we have a page name
24 *
25 */
26 if ( !defined('PAGE_NAME') ) define('PAGE_NAME', NULL);
27
28
29 /**
30 * If register_globals are on, unregister globals.
31 * Second test covers boolean set as string (php_value register_globals off).
32 */
33 if ((bool) ini_get('register_globals') &&
34 strtolower(ini_get('register_globals'))!='off') {
35 /**
36 * Remove all globals that are not reserved by PHP
37 * 'value' and 'key' are used by foreach. Don't unset them inside foreach.
38 */
39 foreach ($GLOBALS as $key => $value) {
40 switch($key) {
41 case 'HTTP_POST_VARS':
42 case '_POST':
43 case 'HTTP_GET_VARS':
44 case '_GET':
45 case 'HTTP_COOKIE_VARS':
46 case '_COOKIE':
47 case 'HTTP_SERVER_VARS':
48 case '_SERVER':
49 case 'HTTP_ENV_VARS':
50 case '_ENV':
51 case 'HTTP_POST_FILES':
52 case '_FILES':
53 case '_REQUEST':
54 case 'HTTP_SESSION_VARS':
55 case '_SESSION':
56 case 'GLOBALS':
57 case 'key':
58 case 'value':
59 break;
60 default:
61 unset($GLOBALS[$key]);
62 }
63 }
64 // Unset variables used in foreach
65 unset($GLOBALS['key']);
66 unset($GLOBALS['value']);
67 }
68
69 /**
70 * Used as a dummy value, e.g., for passing as an empty
71 * hook argument (where the value is passed by reference,
72 * and therefore NULL itself is not acceptable).
73 */
74 global $null;
75 $null = NULL;
76
77 /**
78 * The global $server_os variable will be "windows" if
79 * we are working in a Windows environment or "*nix"
80 * otherwise.
81 */
82 global $server_os;
83 if (DIRECTORY_SEPARATOR == '\\') $server_os = 'windows'; else $server_os = '*nix';
84
85 /**
86 * [#1518885] session.use_cookies = off breaks SquirrelMail
87 *
88 * When session cookies are not used, all http redirects, meta refreshes,
89 * src/download.php and javascript URLs are broken. Setting must be set
90 * before session is started.
91 */
92 if (!(bool)ini_get('session.use_cookies') ||
93 ini_get('session.use_cookies') == 'off') {
94 ini_set('session.use_cookies','1');
95 }
96
97 /**
98 * Initialize seed of random number generator.
99 * We use a number of things to randomize input: current time in ms,
100 * info about the remote client, info about the current process, the
101 * randomness of uniqid and stat of the current file.
102 *
103 * We seed this here only once per init, not only to save cycles
104 * but also to make the result of mt_rand more random (it now also
105 * depends on the number of times mt_rand was called before in this
106 * execution.
107 */
108 $seed = microtime() . $_SERVER['REMOTE_PORT'] . $_SERVER['REMOTE_ADDR'] . getmypid();
109
110 if (function_exists('getrusage')) {
111 /* Avoid warnings with Win32 */
112 $dat = @getrusage();
113 if (isset($dat) && is_array($dat)) { $seed .= implode('', $dat); }
114 }
115
116 if(!empty($_SERVER['UNIQUE_ID'])) {
117 $seed .= $_SERVER['UNIQUE_ID'];
118 }
119
120 $seed .= uniqid(mt_rand(),TRUE);
121 $seed .= implode('', stat( __FILE__));
122
123 // mt_srand() uses an integer to seed, so we need to distill our
124 // very large seed to something useful (without taking a sub-string,
125 // the integer conversion of such a large number is always 0 on
126 // many systems, but strangely, 9 hex numbers - even if larger
127 // than a signed 32 bit integer - seem to be an acceptable "integer"
128 // seed (perhaps it is used as unsigned?)...
129 // we may want to revisit this and always force it to be less than
130 // 2,147,483,647
131 //
132 $seed = hexdec(substr(md5($seed), 0, 9));
133
134 // PHP 4.2 and up don't require seeding, but their used seed algorithm
135 // is of questionable quality, so we keep doing it ourselves. */
136 mt_srand($seed);
137
138 /**
139 * calculate SM_PATH and calculate the base_uri
140 * assumptions made: init.php is only called from plugins or from the src dir.
141 * files in the plugin directory may not be part of a subdirectory called "src"
142 *
143 */
144 if (isset($_SERVER['SCRIPT_NAME'])) {
145 $a = explode('/', $_SERVER['SCRIPT_NAME']);
146 } elseif (isset($HTTP_SERVER_VARS['SCRIPT_NAME'])) {
147 $a = explode('/', $HTTP_SERVER_VARS['SCRIPT_NAME']);
148 } else {
149 $error = 'Unable to detect script environment. Please test your PHP '
150 . 'settings and send your PHP core configuration, $_SERVER and '
151 . '$HTTP_SERVER_VARS contents to the SquirrelMail developers.';
152 die($error);
153 }
154 $sSM_PATH = '';
155 for($i = count($a) -2; $i > -1; --$i) {
156 $sSM_PATH .= '../';
157 if ($a[$i] === 'src' || $a[$i] === 'plugins') {
158 break;
159 }
160 }
161
162 $base_uri = implode('/', array_slice($a, 0, $i)). '/';
163
164 define('SM_PATH',$sSM_PATH);
165 define('SM_BASE_URI', $base_uri);
166
167
168 /**
169 * global var $bInit is used to check if initialisation took place.
170 * At this moment it's a workarounf for the include of addrbook_search_html
171 * inside compose.php. If we found a better way then remove this. Do only use
172 * this var if you know for sure a page can be called stand alone and be included
173 * in another file.
174 */
175 $bInit = true;
176
177 /**
178 * This theme as a failsafe if no themes were found, or if we error
179 * out before anything could be initialised.
180 */
181 $color = array();
182 $color[0] = '#DCDCDC'; /* light gray TitleBar */
183 $color[1] = '#800000'; /* red */
184 $color[2] = '#CC0000'; /* light red Warning/Error Messages */
185 $color[3] = '#A0B8C8'; /* green-blue Left Bar Background */
186 $color[4] = '#FFFFFF'; /* white Normal Background */
187 $color[5] = '#FFFFCC'; /* light yellow Table Headers */
188 $color[6] = '#000000'; /* black Text on left bar */
189 $color[7] = '#0000CC'; /* blue Links */
190 $color[8] = '#000000'; /* black Normal text */
191 $color[9] = '#ABABAB'; /* mid-gray Darker version of #0 */
192 $color[10] = '#666666'; /* dark gray Darker version of #9 */
193 $color[11] = '#770000'; /* dark red Special Folders color */
194 $color[12] = '#EDEDED';
195 $color[13] = '#800000'; /* (dark red) Color for quoted text -- > 1 quote */
196 $color[14] = '#ff0000'; /* (red) Color for quoted text -- >> 2 or more */
197 $color[15] = '#002266'; /* (dark blue) Unselectable folders */
198 $color[16] = '#ff9933'; /* (orange) Highlight color */
199
200 require(SM_PATH . 'include/constants.php');
201 require(SM_PATH . 'functions/global.php');
202 require(SM_PATH . 'functions/strings.php');
203 require(SM_PATH . 'functions/arrays.php');
204 require(SM_PATH . 'functions/files.php');
205
206 /* load default configuration */
207 require(SM_PATH . 'config/config_default.php');
208 /* reset arrays in default configuration */
209 $ldap_server = array();
210 $plugins = array();
211 $fontsets = array();
212 $aTemplateSet = array();
213 $aTemplateSet[0]['ID'] = 'default';
214 $aTemplateSet[0]['NAME'] = 'Default';
215
216 /* load site configuration */
217 require(SM_PATH . 'config/config.php');
218 /* load local configuration overrides */
219 if (file_exists(SM_PATH . 'config/config_local.php')) {
220 require(SM_PATH . 'config/config_local.php');
221 }
222
223
224 /**
225 * Set PHP error reporting level based on the SquirrelMail debug mode
226 */
227 $error_level = 0;
228 if ($sm_debug_mode & SM_DEBUG_MODE_SIMPLE)
229 $error_level |= E_ERROR;
230 if ($sm_debug_mode & SM_DEBUG_MODE_MODERATE
231 || $sm_debug_mode & SM_DEBUG_MODE_ADVANCED)
232 $error_level |= E_ALL;
233 if ($sm_debug_mode & SM_DEBUG_MODE_STRICT)
234 $error_level |= E_STRICT;
235 error_reporting($error_level);
236
237
238 /**
239 * Detect SSL connections
240 */
241 $is_secure_connection = is_ssl_secured_connection();
242
243
244 require(SM_PATH . 'functions/plugin.php');
245 require(SM_PATH . 'include/languages.php');
246 require(SM_PATH . 'class/template/Template.class.php');
247 require(SM_PATH . 'class/error.class.php');
248
249 /**
250 * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
251 * Force magic_quotes_runtime off.
252 * tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
253 * If there's a better place, please let me know.
254 */
255 ini_set('magic_quotes_runtime','0');
256
257
258 /* if running with magic_quotes_gpc then strip the slashes
259 from POST and GET global arrays */
260 if (function_exists('get_magic_quotes_gpc') && @get_magic_quotes_gpc()) {
261 sqstripslashes($_GET);
262 sqstripslashes($_POST);
263 }
264
265
266 /**
267 * Strip any tags added to the url from PHP_SELF.
268 * This fixes hand crafted url XXS expoits for any
269 * page that uses PHP_SELF as the FORM action
270 * Update: strip_tags() won't catch something like
271 * src/right_main.php?sort=0&startMessage=1&mailbox=INBOX&xxx="><script>window.open("http://example.com")</script>
272 * or
273 * contrib/decrypt_headers.php/%22%20onmouseover=%22alert(%27hello%20world%27)%22%3E
274 * because it doesn't bother with broken tags.
275 * htmlspecialchars() is the preferred method.
276 * QUERY_STRING also needs the same treatment since it is
277 * used in php_self().
278 * Update again: the encoding of ampersands that occurs
279 * using htmlspecialchars() corrupts the query strings
280 * in normal URIs, so we have to let those through.
281 FIXME: will the de-sanitizing of ampersands create any security/XSS problems?
282 */
283 if (isset($_SERVER['REQUEST_URI']))
284 $_SERVER['REQUEST_URI'] = str_replace('&amp;', '&', htmlspecialchars($_SERVER['REQUEST_URI']));
285 if (isset($_SERVER['PHP_SELF']))
286 $_SERVER['PHP_SELF'] = str_replace('&amp;', '&', htmlspecialchars($_SERVER['PHP_SELF']));
287 if (isset($_SERVER['QUERY_STRING']))
288 $_SERVER['QUERY_STRING'] = str_replace('&amp;', '&', htmlspecialchars($_SERVER['QUERY_STRING']));
289
290 $PHP_SELF = php_self();
291
292 /**
293 * Initialize the session
294 */
295
296 /** set the name of the session cookie */
297 if (!isset($session_name) || !$session_name) {
298 $session_name = 'SQMSESSID';
299 }
300
301 /**
302 * When session.auto_start is On we want to destroy/close the session
303 */
304 $sSessionAutostartName = session_name();
305 $sSessionAutostartID = session_id();
306 if (!empty($sSessionAutostartID) && $sSessionAutostartName !== $session_name) {
307 $sCookiePath = ini_get('session.cookie_path');
308 $sCookieDomain = ini_get('session.cookie_domain');
309 // reset the cookie
310 sqsetcookie($sSessionAutostartName,'',1,$sCookiePath,$sCookieDomain);
311 @session_destroy();
312 session_write_close();
313 }
314
315 /**
316 * includes from classes stored in the session
317 */
318 require(SM_PATH . 'class/mime.class.php');
319
320 ini_set('session.name' , $session_name);
321 session_set_cookie_params (0, $base_uri);
322 sqsession_is_active();
323
324 /**
325 * When on login page, have to reset the user session, making
326 * sure to save session restore data first
327 */
328 if (PAGE_NAME == 'login') {
329 if (!sqGetGlobalVar('session_expired_post', $sep, SQ_SESSION))
330 $sep = '';
331 if (!sqGetGlobalVar('session_expired_location', $sel, SQ_SESSION))
332 $sel = '';
333 sqsession_destroy();
334 session_write_close();
335
336 /**
337 * in some rare instances, the session seems to stick
338 * around even after destroying it (!!), so if it does,
339 * we'll manually flatten the $_SESSION data
340 */
341 if (!empty($_SESSION))
342 $_SESSION = array();
343
344 /**
345 * Allow administrators to define custom session handlers
346 * for SquirrelMail without needing to change anything in
347 * php.ini (application-level).
348 *
349 * In config_local.php, admin needs to put:
350 *
351 * $custom_session_handlers = array(
352 * 'my_open_handler',
353 * 'my_close_handler',
354 * 'my_read_handler',
355 * 'my_write_handler',
356 * 'my_destroy_handler',
357 * 'my_gc_handler',
358 * );
359 * session_module_name('user');
360 * session_set_save_handler(
361 * $custom_session_handlers[0],
362 * $custom_session_handlers[1],
363 * $custom_session_handlers[2],
364 * $custom_session_handlers[3],
365 * $custom_session_handlers[4],
366 * $custom_session_handlers[5]
367 * );
368 *
369 * We need to replicate that code once here because PHP has
370 * long had a bug that resets the session handler mechanism
371 * when the session data is also destroyed. Because of this
372 * bug, even administrators who define custom session handlers
373 * via a PHP pre-load defined in php.ini (auto_prepend_file)
374 * will still need to define the $custom_session_handlers array
375 * in config_local.php.
376 */
377 global $custom_session_handlers;
378 if (!empty($custom_session_handlers)) {
379 $open = $custom_session_handlers[0];
380 $close = $custom_session_handlers[1];
381 $read = $custom_session_handlers[2];
382 $write = $custom_session_handlers[3];
383 $destroy = $custom_session_handlers[4];
384 $gc = $custom_session_handlers[5];
385 session_module_name('user');
386 session_set_save_handler($open, $close, $read, $write, $destroy, $gc);
387 }
388
389 sqsession_is_active();
390 session_regenerate_id();
391
392 // put session restore data back into session if necessary
393 if (!empty($sel)) {
394 sqsession_register($sel, 'session_expired_location');
395 if (!empty($sep))
396 sqsession_register($sep, 'session_expired_post');
397 }
398 }
399
400 /**
401 * SquirrelMail internal version number -- DO NOT CHANGE
402 * $sm_internal_version = array (release, major, minor)
403 */
404 $SQM_INTERNAL_VERSION = explode('.', SM_VERSION, 3);
405 $SQM_INTERNAL_VERSION[2] = intval($SQM_INTERNAL_VERSION[2]);
406
407
408 /* load prefs system; even when user not logged in, should be OK to do this here */
409 require(SM_PATH . 'functions/prefs.php');
410
411
412 /* if plugins are disabled only for one user and
413 * the current user is NOT that user, turn them
414 * back on
415 */
416 sqgetGlobalVar('username', $username, SQ_SESSION);
417 if ($disable_plugins && !empty($disable_plugins_user)
418 && $username != $disable_plugins_user) {
419 $disable_plugins = false;
420 }
421
422
423 /* remove all plugins if they are disabled */
424 if ($disable_plugins) {
425 $plugins = array();
426 }
427
428
429 /**
430 * Include Compatibility plugin if available.
431 */
432 if (!$disable_plugins && file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
433 include_once(SM_PATH . 'plugins/compatibility/functions.php');
434
435
436 /**
437 * MAIN PLUGIN LOADING CODE HERE
438 * On init, we no longer need to load all plugin setup files.
439 * Now, we load the statically generated hook registrations here
440 * and let the hook calls include only the plugins needed.
441 */
442 $squirrelmail_plugin_hooks = array();
443 if (!$disable_plugins && file_exists(SM_PATH . 'config/plugin_hooks.php')) {
444 //FIXME: if we keep the plugin hooks array static like this, it seems like we should also keep the template files list in a static file too (when a new user session is started or the template set is changed, the code will dynamically iterate through the directory heirarchy of the template directory and catalog all the template files therein (and store the "catalog" in PHP session) -- instead, we could do that once at config-time and keep that static so SM can just include the file just like the line below)
445 require(SM_PATH . 'config/plugin_hooks.php');
446 }
447
448
449 /**
450 * Plugin authors note that the "config_override" hook used to be
451 * executed here, but please adapt your plugin to use this "prefs_backend"
452 * hook instead, making sure that it does NOT return anything, since
453 * doing so will interfere with proper prefs system functionality.
454 * Of course, otherwise, this hook may be used to do any configuration
455 * overrides as needed, as well as set up a custom preferences backend.
456 */
457 $prefs_backend = do_hook('prefs_backend', $null);
458 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
459 require(SM_PATH . $prefs_backend);
460 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
461 require(SM_PATH . 'functions/db_prefs.php');
462 } else {
463 require(SM_PATH . 'functions/file_prefs.php');
464 }
465
466
467
468 /**
469 * DISABLED.
470 * Remove globalized session data in rg=on setups
471 *
472 * Code can be utilized when session is started, but data is not loaded.
473 * We have already loaded configuration and other important vars. Can't
474 * clean session globals here, beside, the cleanout of globals at the
475 * top of this file will have removed anything this code would find anyway.
476 if ((bool) @ini_get('register_globals') &&
477 strtolower(ini_get('register_globals'))!='off') {
478 foreach ($_SESSION as $key => $value) {
479 unset($GLOBALS[$key]);
480 }
481 }
482 */
483
484 sqsession_register(SM_BASE_URI,'base_uri');
485
486 /**
487 * Retrieve the language cookie
488 */
489 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
490 $squirrelmail_language = '';
491 }
492
493
494 /**
495 * In some cases, buffering all output allows more complex functionality,
496 * especially for plugins that want to add headers on hooks that are beyond
497 * the point of output having been sent to the browser otherwise.
498 *
499 * Note that we don't turn this on any earlier since we want to allow plugins
500 * to turn it on themselves via a configuration override on the prefs_backend
501 * hook.
502 *
503 */
504 if ($buffer_output) ob_start(!empty($buffered_output_handler) ? $buffered_output_handler : NULL);
505
506
507 /**
508 * Do something special for some pages. This is based on the PAGE_NAME constant
509 * set at the top of every page.
510 */
511 $set_up_langage_after_template_setup = FALSE;
512 switch (PAGE_NAME) {
513 case 'style':
514
515 // need to get the right template set up
516 //
517 sqGetGlobalVar('templateid', $templateid, SQ_GET);
518
519 // sanitize just in case...
520 //
521 $templateid = preg_replace('/(\.\.\/){1,}/', '', $templateid);
522
523 // make sure given template actually is available
524 //
525 $found_templateset = false;
526 for ($i = 0; $i < count($aTemplateSet); ++$i) {
527 if ($aTemplateSet[$i]['ID'] == $templateid) {
528 $found_templateset = true;
529 break;
530 }
531 }
532
533 // FIXME: do we need/want to check here for actual (physical) presence of template sets?
534 // selected template not available, fall back to default template
535 //
536 if (!$found_templateset) {
537 $sTemplateID = Template::get_default_template_set();
538 } else {
539 $sTemplateID = $templateid;
540 }
541
542 session_write_close();
543 break;
544
545 case 'mailto':
546 // nothing to do
547 break;
548
549 case 'redirect':
550 require(SM_PATH . 'functions/auth.php');
551 //nobreak;
552
553 case 'login':
554 require(SM_PATH . 'functions/display_messages.php' );
555 require(SM_PATH . 'functions/page_header.php');
556 require(SM_PATH . 'functions/html.php');
557
558 // reset template file cache
559 //
560 $sTemplateID = Template::get_default_template_set();
561 Template::cache_template_file_hierarchy($sTemplateID, TRUE);
562
563 /**
564 * Make sure icon variables are setup for the login page.
565 */
566 $icon_theme = $icon_themes[$icon_theme_def]['PATH'];
567 /*
568 * NOTE: The $icon_theme_path var should contain the path to the icon
569 * theme to use. If the admin has disabled icons, or the user has
570 * set the icon theme to "None," no icons will be used.
571 */
572 $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
573
574 break;
575 default:
576 require(SM_PATH . 'functions/display_messages.php' );
577 require(SM_PATH . 'functions/page_header.php');
578 require(SM_PATH . 'functions/html.php');
579
580
581 /**
582 * Check if we are logged in and does optional referrer check
583 */
584 require(SM_PATH . 'functions/auth.php');
585
586 global $check_referrer, $domain;
587 if (!sqgetGlobalVar('HTTP_REFERER', $referrer, SQ_SERVER)) $referrer = '';
588 if ($check_referrer == '###DOMAIN###') $check_referrer = $domain;
589 if (!empty($check_referrer)) {
590 $ssl_check_referrer = 'https://' . $check_referrer;
591 $check_referrer = 'http://' . $check_referrer;
592 }
593 if (!sqsession_is_registered('user_is_logged_in')
594 || ($check_referrer && !empty($referrer)
595 && strpos(strtolower($referrer), strtolower($check_referrer)) !== 0
596 && strpos(strtolower($referrer), strtolower($ssl_check_referrer)) !== 0)) {
597
598 // use $message to indicate what logout text the user
599 // will see... if 0, typical "You must be logged in"
600 // if 1, information that the user session was saved
601 // and will be resumed after (re)login, if 2, there
602 // seems to have been a XSS or phishing attack (bad
603 // referrer)
604 //
605 $message = 0;
606
607 // First we store some information in the new session to prevent
608 // information-loss.
609 //
610 $session_expired_post = $_POST;
611 $session_expired_location = PAGE_NAME;
612 if (!sqsession_is_registered('session_expired_post')) {
613 sqsession_register($session_expired_post,'session_expired_post');
614 }
615 if (!sqsession_is_registered('session_expired_location')) {
616 sqsession_register($session_expired_location,'session_expired_location');
617 if ($session_expired_location == 'compose')
618 $message = 1;
619 }
620
621 // was bad referrer the reason we were rejected?
622 //
623 if (sqsession_is_registered('user_is_logged_in')
624 && $check_referrer && !empty($referrer))
625 $message = 2;
626
627 // signout page will deal with users who aren't logged
628 // in on its own; don't show error here
629 //
630 if ( PAGE_NAME == 'signout' ) {
631 return;
632 }
633
634 /**
635 * Initialize the template object (logout_error uses it)
636 */
637 /*
638 * $sTemplateID is not initialized when a user is not logged in, so we
639 * will use the config file defaults here. If the neccesary variables
640 * are not set, force a default value.
641 */
642 if (PAGE_NAME == 'squirrelmail_rpc') {
643 $sTemplateID = Template::get_rpc_template_set();
644 } else {
645 $sTemplateID = Template::get_default_template_set();
646 }
647 $oTemplate = Template::construct_template($sTemplateID);
648
649 set_up_language($squirrelmail_language, true);
650 if (!$message)
651 logout_error( _("You must be logged in to access this page.") );
652 else if ($message == 1)
653 logout_error( _("Your session has expired, but will be resumed after logging in again.") );
654 else if ($message == 2)
655 logout_error( _("The current page request appears to have originated from an unrecognized source.") );
656 exit;
657 }
658
659 sqgetGlobalVar('authz',$authz,SQ_SESSION);
660
661 /**
662 * Setting the prefs backend
663 */
664 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
665 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
666
667 if ( !sqsession_is_registered('prefs_are_cached') ||
668 !isset( $prefs_cache) ||
669 !is_array( $prefs_cache)) {
670 $prefs_are_cached = false;
671 $prefs_cache = false; //array();
672 }
673
674 /**
675 * initializing user settings
676 */
677 require(SM_PATH . 'include/load_prefs.php');
678
679 /**
680 * We'll need this to later have a noframes version
681 *
682 * Check if the user has a language preference, but no cookie.
683 * Send him a cookie with his language preference, if there is
684 * such discrepancy.
685 */
686 $my_language = getPref($data_dir, $username, 'language');
687 if ($my_language != $squirrelmail_language) {
688 sqsetcookie('squirrelmail_language', $my_language, time()+2592000, $base_uri);
689 }
690
691 $set_up_langage_after_template_setup = TRUE;
692
693 $timeZone = getPref($data_dir, $username, 'timezone');
694
695 /* Check to see if we are allowed to set the TZ environment variable.
696 * We are able to do this if ...
697 * safe_mode is disabled OR
698 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
699 * safe_mode_allowed_env_vars contains TZ
700 */
701 $tzChangeAllowed = (!ini_get('safe_mode')) ||
702 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
703 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
704
705 if ( $timeZone != SMPREF_NONE && ($timeZone != "")
706 && $tzChangeAllowed ) {
707
708 // get time zone key, if strict or custom strict timezones are used
709 if (isset($time_zone_type) &&
710 ($time_zone_type == 1 || $time_zone_type == 3)) {
711 /* load time zone functions */
712 require(SM_PATH . 'include/timezones.php');
713 $realTimeZone = sq_get_tz_key($timeZone);
714 } else {
715 $realTimeZone = $timeZone;
716 }
717
718 // set time zone
719 if ($realTimeZone) {
720 putenv("TZ=".$realTimeZone);
721 }
722 }
723
724 /**
725 * php 5.1.0 added time zone functions. Set time zone with them in order
726 * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
727 */
728 if (function_exists('date_default_timezone_set')) {
729 if ($timeZone != SMPREF_NONE && $timeZone != "") {
730 date_default_timezone_set($timeZone);
731 } else {
732 // interface runs on server's time zone. Remove php E_STRICT complains
733 $default_timezone = @date_default_timezone_get();
734 date_default_timezone_set($default_timezone);
735 }
736 }
737 break;
738 }
739
740 /*
741 * $sTemplateID is not initialized when a user is not logged in, so we
742 * will use the config file defaults here. If the neccesary variables
743 * are not set, force a default value.
744 *
745 * If the user is logged in, $sTemplateID will be set in load_prefs.php,
746 * so we shouldn't change it here.
747 */
748 if (!isset($sTemplateID)) {
749 if (PAGE_NAME == 'squirrelmail_rpc') {
750 $sTemplateID = Template::get_rpc_template_set();
751 } else {
752 $sTemplateID = Template::get_default_template_set();
753 }
754 $icon_theme_path = !$use_icons ? NULL : Template::calculate_template_images_directory($sTemplateID);
755 }
756
757 // template object may have already been constructed in load_prefs.php
758 //
759 if (empty($oTemplate)) {
760 $oTemplate = Template::construct_template($sTemplateID);
761 }
762
763 // We want some variables to always be available to the template
764 //
765 $oTemplate->assign('javascript_on',
766 (sqGetGlobalVar('user_is_logged_in', $user_is_logged_in, SQ_SESSION)
767 ? checkForJavascript() : 0));
768 $oTemplate->assign('base_uri', sqm_baseuri());
769 $always_include = array('sTemplateID', 'icon_theme_path');
770 foreach ($always_include as $var) {
771 $oTemplate->assign($var, (isset($$var) ? $$var : NULL));
772 }
773
774 // A few output elements are used often, so just get them once here
775 //
776 $nbsp = $oTemplate->fetch('non_breaking_space.tpl');
777 $br = $oTemplate->fetch('line_break.tpl');
778
779
780 /**
781 * Set up the language.
782 *
783 * This code block corresponds to the *default* block of the switch
784 * statement above, but the language cannot be set up until after the
785 * template is instantiated, so we set $set_up_langage_after_template_setup
786 * above and do the linguistic stuff now.
787 */
788 if ($set_up_langage_after_template_setup) {
789 $err=set_up_language(getPref($data_dir, $username, 'language'));
790
791 // Japanese translation used without mbstring support
792 if ($err==2) {
793 $sError = "<p>Your administrator needs to have PHP installed with the multibyte string extension enabled (using configure option --enable-mbstring).</p>\n"
794 . "<p>This system has assumed that you accidently switched to Japanese and has reverted your language preference to English.</p>\n"
795 . "<p>Please refresh this page in order to continue using your webmail.</p>\n";
796 error_box($sError);
797 }
798 }
799
800
801 /**
802 * Initialize our custom error handler object
803 */
804 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
805
806
807 /**
808 * Activate custom error handling
809 */
810 if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
811 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
812 } else {
813 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
814 }
815
816
817 // ============================================================================
818 // ================= End of Live Code, Beginning of Functions =================
819 // ============================================================================
820
821
822 /**
823 * Javascript support detection function
824 * @param boolean $reset recheck javascript support if set to true.
825 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
826 * @since 1.5.1
827 */
828 function checkForJavascript($reset = FALSE) {
829 global $data_dir, $username, $javascript_on, $javascript_setting;
830
831 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
832 return $javascript_on;
833
834 //FIXME: this isn't used anywhere else in this function; can we remove it? why is it here?
835 $user_is_logged_in = FALSE;
836 if ( $reset || !isset($javascript_setting) )
837 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
838
839 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
840 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
841 $js_autodetect_results = SMPREF_JS_OFF;
842
843 if ( $javascript_setting == SMPREF_JS_AUTODETECT )
844 $javascript_on = $js_autodetect_results;
845 else
846 $javascript_on = $javascript_setting;
847
848 sqsession_register($javascript_on, 'javascript_on');
849 return $javascript_on;
850 }
851
852 function sqm_baseuri() {
853 global $base_uri;
854 return $base_uri;
855 }