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