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