Enabled user selection of address format when adding from address book during message...
[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 $prefs_backend = do_hook('prefs_backend', $null);
277 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
278 require(SM_PATH . $prefs_backend);
279 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
280 require(SM_PATH . 'functions/db_prefs.php');
281 } else {
282 require(SM_PATH . 'functions/file_prefs.php');
283 }
284
285
286 /* if plugins are disabled only for one user and
287 * the current user is NOT that user, turn them
288 * back on
289 */
290 sqgetGlobalVar('username',$username,SQ_SESSION);
291 if ($disable_plugins && !empty($disable_plugins_user)
292 && $username != $disable_plugins_user) {
293 $disable_plugins = false;
294 }
295
296 /* remove all plugins if they are disabled */
297 if ($disable_plugins) {
298 $plugins = array();
299 }
300
301
302 /**
303 * Include Compatibility plugin if available.
304 */
305 if (!$disable_plugins && file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
306 include_once(SM_PATH . 'plugins/compatibility/functions.php');
307
308 /**
309 * MAIN PLUGIN LOADING CODE HERE
310 * On init, we no longer need to load all plugin setup files.
311 * Now, we load the statically generated hook registrations here
312 * and let the hook calls include only the plugins needed.
313 */
314 $squirrelmail_plugin_hooks = array();
315 if (!$disable_plugins && file_exists(SM_PATH . 'config/plugin_hooks.php')) {
316 require(SM_PATH . 'config/plugin_hooks.php');
317 }
318
319 /**
320 * allow plugins to override main configuration; hook is placed
321 * here to allow plugins to use session information to do their work
322 */
323 do_hook('config_override', $null);
324
325 /**
326 * DISABLED.
327 * Remove globalized session data in rg=on setups
328 *
329 * Code can be utilized when session is started, but data is not loaded.
330 * We have already loaded configuration and other important vars. Can't
331 * clean session globals here.
332 if ((bool) @ini_get('register_globals') &&
333 strtolower(ini_get('register_globals'))!='off') {
334 foreach ($_SESSION as $key => $value) {
335 unset($GLOBALS[$key]);
336 }
337 }
338 */
339
340 sqsession_register(SM_BASE_URI,'base_uri');
341
342 /**
343 * Retrieve the language cookie
344 */
345 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
346 $squirrelmail_language = '';
347 }
348
349
350 /**
351 * Do something special for some pages. This is based on the PAGE_NAME constand
352 * set at the top of every page.
353 */
354 switch (PAGE_NAME) {
355 case 'style':
356
357 // need to get the right template set up
358 //
359 sqGetGlobalVar('templateid', $templateid, SQ_GET);
360
361 // sanitize just in case...
362 //
363 $templateid = preg_replace('/(\.\.\/){1,}/', '', $templateid);
364
365 // make sure given template actually is available
366 //
367 $found_templateset = false;
368 for ($i = 0; $i < count($aTemplateSet); ++$i) {
369 if ($aTemplateSet[$i]['ID'] == $templateid) {
370 $found_templateset = true;
371 break;
372 }
373 }
374
375 // FIXME: do we need/want to check here for actual (physical) presence of template sets?
376 // selected template not available, fall back to default template
377 //
378 if (!$found_templateset) {
379 $sTemplateID = Template::get_default_template_set();
380 } else {
381 $sTemplateID = $templateid;
382 }
383
384 session_write_close();
385 break;
386
387 case 'redirect':
388 require(SM_PATH . 'functions/auth.php');
389 //nobreak;
390
391 case 'login':
392 require(SM_PATH . 'functions/display_messages.php' );
393 require(SM_PATH . 'functions/page_header.php');
394 require(SM_PATH . 'functions/html.php');
395
396 // reset template file cache
397 //
398 $sTemplateID = Template::get_default_template_set();
399 Template::cache_template_file_hierarchy(TRUE);
400
401 /**
402 * Make sure icon variables are setup for the login page.
403 */
404 $icon_theme = $icon_themes[$icon_theme_def]['PATH'];
405 /*
406 * NOTE: The $icon_theme_path var should contain the path to the icon
407 * theme to use. If the admin has disabled icons, or the user has
408 * set the icon theme to "None," no icons will be used.
409 */
410 $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
411
412 /**
413 * cleanup old cookies with a cookie path the same as the standard php.ini
414 * cookie path. All previous SquirrelMail version used the standard php.ini
415 * cookie path for storing the session name. That behaviour changed.
416 */
417 if ($sCookiePath !== SM_BASE_URI) {
418 /**
419 * do not delete the standard sessions with session.name is i.e. PHPSESSID
420 * because they probably belong to other php apps
421 */
422 if (ini_get('session.name') !== $sSessionAutostartName) {
423 // This does not work. Sometimes the cookie with SQSESSID=deleted and path /
424 // is picked up in webmail.php => login will fail
425 //sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
426 }
427 }
428 break;
429 default:
430 require(SM_PATH . 'functions/display_messages.php' );
431 require(SM_PATH . 'functions/page_header.php');
432 require(SM_PATH . 'functions/html.php');
433
434
435 /**
436 * Check if we are logged in
437 */
438 require(SM_PATH . 'functions/auth.php');
439
440 if ( !sqsession_is_registered('user_is_logged_in') ) {
441
442 // use $message to indicate what logout text the user
443 // will see... if 0, typical "You must be logged in"
444 // if 1, information that the user session was saved
445 // and will be resumed after (re)login
446 //
447 $message = 0;
448
449 // First we store some information in the new session to prevent
450 // information-loss.
451 //
452 $session_expired_post = $_POST;
453 $session_expired_location = PAGE_NAME;
454 if (!sqsession_is_registered('session_expired_post')) {
455 sqsession_register($session_expired_post,'session_expired_post');
456 }
457 if (!sqsession_is_registered('session_expired_location')) {
458 sqsession_register($session_expired_location,'session_expired_location');
459 if ($session_expired_location == 'compose')
460 $message = 1;
461 }
462 // signout page will deal with users who aren't logged
463 // in on its own; don't show error here
464 //
465 if ( PAGE_NAME == 'signout' ) {
466 return;
467 }
468
469 /**
470 * Initialize the template object (logout_error uses it)
471 */
472 /*
473 * $sTemplateID is not initialized when a user is not logged in, so we
474 * will use the config file defaults here. If the neccesary variables
475 * are net set, force a default value.
476 */
477 $sTemplateID = Template::get_default_template_set();
478 $oTemplate = Template::construct_template($sTemplateID);
479
480 set_up_language($squirrelmail_language, true);
481 if (!$message)
482 logout_error( _("You must be logged in to access this page.") );
483 else
484 logout_error( _("Your session has expired, but will be resumed after logging in again.") );
485 exit;
486 }
487
488 //FIXME: remove next line if the placement of the copy of this line above does not prove to be problematic
489 sqgetGlobalVar('username',$username,SQ_SESSION);
490 sqgetGlobalVar('authz',$authz,SQ_SESSION);
491
492 /**
493 * Setting the prefs backend
494 */
495 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
496 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
497
498 if ( !sqsession_is_registered('prefs_are_cached') ||
499 !isset( $prefs_cache) ||
500 !is_array( $prefs_cache)) {
501 $prefs_are_cached = false;
502 $prefs_cache = false; //array();
503 }
504
505 /**
506 * initializing user settings
507 */
508 require(SM_PATH . 'include/load_prefs.php');
509
510 // i do not understand the frames language cookie story
511 /**
512 * We'll need this to later have a noframes version
513 *
514 * Check if the user has a language preference, but no cookie.
515 * Send him a cookie with his language preference, if there is
516 * such discrepancy.
517 */
518 $my_language = getPref($data_dir, $username, 'language');
519 if ($my_language != $squirrelmail_language) {
520 sqsetcookie('squirrelmail_language', $my_language, time()+2592000, $base_uri);
521 }
522 // /dont understand
523
524 /**
525 * Set up the language.
526 */
527 $err=set_up_language(getPref($data_dir, $username, 'language'));
528
529 // Japanese translation used without mbstring support
530 if ($err==2) {
531 $sError =
532 "<p>You need to have PHP installed with the multibyte string function \n".
533 "enabled (using configure option --enable-mbstring).</p>\n".
534 "<p>System assumed that you accidently switched to Japanese translation \n".
535 "and reverted your language preference to English.</p>\n".
536 "<p>Please refresh this page in order to use webmail.</p>\n";
537 error_box($sError);
538 }
539
540 $timeZone = getPref($data_dir, $username, 'timezone');
541
542 /* Check to see if we are allowed to set the TZ environment variable.
543 * We are able to do this if ...
544 * safe_mode is disabled OR
545 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
546 * safe_mode_allowed_env_vars contains TZ
547 */
548 $tzChangeAllowed = (!ini_get('safe_mode')) ||
549 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
550 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
551
552 if ( $timeZone != SMPREF_NONE && ($timeZone != "")
553 && $tzChangeAllowed ) {
554
555 // get time zone key, if strict or custom strict timezones are used
556 if (isset($time_zone_type) &&
557 ($time_zone_type == 1 || $time_zone_type == 3)) {
558 /* load time zone functions */
559 require(SM_PATH . 'include/timezones.php');
560 $realTimeZone = sq_get_tz_key($timeZone);
561 } else {
562 $realTimeZone = $timeZone;
563 }
564
565 // set time zone
566 if ($realTimeZone) {
567 putenv("TZ=".$realTimeZone);
568 }
569 }
570
571 /**
572 * php 5.1.0 added time zone functions. Set time zone with them in order
573 * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
574 */
575 if (function_exists('date_default_timezone_set')) {
576 if ($timeZone != SMPREF_NONE && $timeZone != "") {
577 date_default_timezone_set($timeZone);
578 } else {
579 // interface runs on server's time zone. Remove php E_STRICT complains
580 $default_timezone = @date_default_timezone_get();
581 date_default_timezone_set($default_timezone);
582 }
583 }
584 break;
585 }
586
587 /*
588 * $sTemplateID is not initialized when a user is not logged in, so we
589 * will use the config file defaults here. If the neccesary variables
590 * are not set, force a default value.
591 *
592 * If the user is logged in, $sTemplateID will be set in load_prefs.php,
593 * so we shouldn't change it here.
594 */
595 if (!isset($sTemplateID)) {
596 $sTemplateID = Template::get_default_template_set();
597 $icon_theme_path = !$use_icons ? NULL : Template::calculate_template_images_directory($sTemplateID);
598 }
599
600 // template object may have already been constructed in load_prefs.php
601 //
602 if (empty($oTemplate)) {
603 $oTemplate = Template::construct_template($sTemplateID);
604 }
605
606 // We want some variables to always be available to the template
607 $oTemplate->assign('javascript_on',
608 (sqGetGlobalVar('user_is_logged_in', $user_is_logged_in, SQ_SESSION)
609 ? checkForJavascript() : 0));
610 $oTemplate->assign('base_uri', sqm_baseuri());
611 $always_include = array('sTemplateID', 'icon_theme_path');
612 foreach ($always_include as $var) {
613 $oTemplate->assign($var, (isset($$var) ? $$var : NULL));
614 }
615
616 /**
617 * Initialize our custom error handler object
618 */
619 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
620
621 /**
622 * Activate custom error handling
623 */
624 if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
625 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
626 } else {
627 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
628 }
629
630 /**
631 * Javascript support detection function
632 * @param boolean $reset recheck javascript support if set to true.
633 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
634 * @since 1.5.1
635 */
636 function checkForJavascript($reset = FALSE) {
637 global $data_dir, $username, $javascript_on, $javascript_setting;
638
639 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
640 return $javascript_on;
641
642 $user_is_logged_in = FALSE;
643 if ( $reset || !isset($javascript_setting) )
644 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
645
646 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
647 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
648 $js_autodetect_results = SMPREF_JS_OFF;
649
650 if ( $javascript_setting == SMPREF_JS_AUTODETECT )
651 $javascript_on = $js_autodetect_results;
652 else
653 $javascript_on = $javascript_setting;
654
655 sqsession_register($javascript_on, 'javascript_on');
656 return $javascript_on;
657 }
658
659 function sqm_baseuri() {
660 global $base_uri;
661 return $base_uri;
662 }