Allow plugins to hook in under other name
[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');
918fcc1d 137require(SM_PATH . 'functions/arrays.php');
5e68a08e 138
139/* load default configuration */
140require(SM_PATH . 'config/config_default.php');
141/* reset arrays in default configuration */
142$ldap_server = array();
143$plugins = array();
144$fontsets = array();
5e68a08e 145$aTemplateSet = array();
28294310 146$aTemplateSet[0]['ID'] = 'default';
147$aTemplateSet[0]['NAME'] = 'Default';
01fd1d1a 148
5e68a08e 149/* load site configuration */
202bcbcc 150require(SM_PATH . 'config/config.php');
5e68a08e 151/* load local configuration overrides */
152if (file_exists(SM_PATH . 'config/config_local.php')) {
153 require(SM_PATH . 'config/config_local.php');
154}
155
202bcbcc 156require(SM_PATH . 'functions/plugin.php');
157require(SM_PATH . 'include/constants.php');
158require(SM_PATH . 'include/languages.php');
42b5e8aa 159require(SM_PATH . 'class/template/Template.class.php');
202bcbcc 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
8b56e282 271/**
272 * On init, we no longer need to load all plugin setup files.
273 * Now, we load the statically generated hook registrations here
274 * and let the hook calls include only the plugins needed.
275 */
276if (file_exists(SM_PATH . 'config/plugin_hooks.php')) {
8e530924 277 require(SM_PATH . 'config/plugin_hooks.php');
202bcbcc 278}
279
2c6792a0 280/**
281 * Before 1.5.2 version hook was part of functions/constants.php.
282 * After init layout changes, hook had to be moved because include/constants.php is
283 * loaded before plugins are initialized.
284 * @since 1.2.0
285 */
286do_hook('loading_constants');
202bcbcc 287
288switch ($sInitLocation) {
c4e5f61f 289 case 'style':
c4e5f61f 290
2b26084f 291 // need to get the right template set up
28294310 292 //
293 sqGetGlobalVar('templateid', $templateid, SQ_GET);
c4e5f61f 294
2b26084f 295 // sanitize just in case...
28294310 296 //
297 $templateid = preg_replace('/(\.\.\/){1,}/', '', $templateid);
298
299 // make sure given template actually is available
300 //
28294310 301 $found_templateset = false;
302 for ($i = 0; $i < count($aTemplateSet); ++$i) {
303 if ($aTemplateSet[$i]['ID'] == $templateid) {
304 $found_templateset = true;
305 break;
306 }
307 }
c4e5f61f 308
be155e14 309// FIXME: do we need/want to check here for actual (physical) presence of template sets?
28294310 310 // selected template not available, fall back to default template
311 //
312 if (!$found_templateset) {
42b5e8aa 313 $sTemplateID = Template::get_default_template_set();
28294310 314 } else {
315 $sTemplateID = $templateid;
c4e5f61f 316 }
317
2b26084f 318 session_write_close();
319 sqsetcookieflush();
c4e5f61f 320 break;
321
202bcbcc 322 case 'redirect':
4d2f7565 323 /**
826ddd72 324 * directory hashing functions are needed for all setups in case
4d2f7565 325 * plugins use own pref files.
326 */
327 require(SM_PATH . 'functions/prefs.php');
2e616fa4 328 require(SM_PATH . 'functions/auth.php');
4d2f7565 329 /* hook loads custom prefs backend plugins */
202bcbcc 330 $prefs_backend = do_hook_function('prefs_backend');
331 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
332 require(SM_PATH . $prefs_backend);
333 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
334 require(SM_PATH . 'functions/db_prefs.php');
335 } else {
202bcbcc 336 require(SM_PATH . 'functions/file_prefs.php');
337 }
338 //nobreak;
339 case 'login':
340 require(SM_PATH . 'functions/display_messages.php' );
341 require(SM_PATH . 'functions/page_header.php');
342 require(SM_PATH . 'functions/html.php');
42b5e8aa 343
344 // reset template file cache
345 //
346 $sTemplateID = Template::get_default_template_set();
347 Template::cache_template_file_hierarchy(TRUE);
348
1d537493 349 /**
01fd1d1a 350 * Make sure icon variables are setup for the login page.
351 */
352 $icon_theme = $icon_themes[$icon_theme_def]['PATH'];
353 /*
354 * NOTE: The $icon_theme_path var should contain the path to the icon
355 * theme to use. If the admin has disabled icons, or the user has
356 * set the icon theme to "None," no icons will be used.
357 */
358 $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
359
360 /**
1d537493 361 * cleanup old cookies with a cookie path the same as the standard php.ini
362 * cookie path. All previous SquirrelMail version used the standard php.ini
363 * cookie path for storing the session name. That behaviour changed.
364 */
365 if ($sCookiePath !== SM_BASE_URI) {
366 /**
367 * do not delete the standard sessions with session.name is i.e. PHPSESSID
368 * because they probably belong to other php apps
369 */
370 if (ini_get('session.name') !== $sSessionAutostartName) {
371 sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
372 }
373 }
202bcbcc 374 break;
375 default:
376 require(SM_PATH . 'functions/display_messages.php' );
377 require(SM_PATH . 'functions/page_header.php');
378 require(SM_PATH . 'functions/html.php');
379 require(SM_PATH . 'functions/strings.php');
380
381
382 /**
383 * Check if we are logged in
384 */
385 require(SM_PATH . 'functions/auth.php');
386
387 if ( !sqsession_is_registered('user_is_logged_in') ) {
388 // First we store some information in the new session to prevent
389 // information-loss.
390 //
391 $session_expired_post = $_POST;
392 $session_expired_location = $PHP_SELF;
393 if (!sqsession_is_registered('session_expired_post')) {
394 sqsession_register($session_expired_post,'session_expired_post');
395 }
396 if (!sqsession_is_registered('session_expired_location')) {
397 sqsession_register($session_expired_location,'session_expired_location');
398 }
399 // signout page will deal with users who aren't logged
400 // in on its own; don't show error here
401 //
402 if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
403 return;
404 }
405
8efadc6b 406 /**
407 * Initialize the template object (logout_error uses it)
408 */
8efadc6b 409 /*
28294310 410 * $sTemplateID is not initialized when a user is not logged in, so we
411 * will use the config file defaults here. If the neccesary variables
412 * are net set, force a default value.
8efadc6b 413 */
42b5e8aa 414 $sTemplateID = Template::get_default_template_set();
28294310 415 $oTemplate = Template::construct_template($sTemplateID);
8efadc6b 416
202bcbcc 417 set_up_language($squirrelmail_language, true);
418 logout_error( _("You must be logged in to access this page.") );
419 exit;
420 }
421
422 sqgetGlobalVar('username',$username,SQ_SESSION);
79524620 423 sqgetGlobalVar('authz',$authz,SQ_SESSION);
202bcbcc 424
425 /**
426 * Setting the prefs backend
427 */
428 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
429 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
430
431 if ( !sqsession_is_registered('prefs_are_cached') ||
432 !isset( $prefs_cache) ||
433 !is_array( $prefs_cache)) {
434 $prefs_are_cached = false;
435 $prefs_cache = false; //array();
436 }
437
c4e5f61f 438 /* see 'redirect' case */
4d2f7565 439 require(SM_PATH . 'functions/prefs.php');
440
202bcbcc 441 $prefs_backend = do_hook_function('prefs_backend');
442 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
443 require(SM_PATH . $prefs_backend);
444 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
445 require(SM_PATH . 'functions/db_prefs.php');
446 } else {
202bcbcc 447 require(SM_PATH . 'functions/file_prefs.php');
448 }
449
450 /**
451 * initializing user settings
452 */
453 require(SM_PATH . 'include/load_prefs.php');
454
202bcbcc 455// i do not understand the frames language cookie story
456 /**
457 * We'll need this to later have a noframes version
458 *
459 * Check if the user has a language preference, but no cookie.
460 * Send him a cookie with his language preference, if there is
461 * such discrepancy.
462 */
463 $my_language = getPref($data_dir, $username, 'language');
464 if ($my_language != $squirrelmail_language) {
465 sqsetcookie('squirrelmail_language', $my_language, time()+2592000, $base_uri);
466 }
467// /dont understand
468
469 /**
470 * Set up the language.
471 */
472 $err=set_up_language(getPref($data_dir, $username, 'language'));
473 /* this is the last cookie we set so flush it. */
474 sqsetcookieflush();
475
476 // Japanese translation used without mbstring support
477 if ($err==2) {
478 $sError =
479 "<p>You need to have PHP installed with the multibyte string function \n".
480 "enabled (using configure option --enable-mbstring).</p>\n".
481 "<p>System assumed that you accidently switched to Japanese translation \n".
482 "and reverted your language preference to English.</p>\n".
483 "<p>Please refresh this page in order to use webmail.</p>\n";
484 error_box($sError);
485 }
486
487 $timeZone = getPref($data_dir, $username, 'timezone');
488
489 /* Check to see if we are allowed to set the TZ environment variable.
490 * We are able to do this if ...
491 * safe_mode is disabled OR
492 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
493 * safe_mode_allowed_env_vars contains TZ
494 */
495 $tzChangeAllowed = (!ini_get('safe_mode')) ||
496 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
497 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
498
499 if ( $timeZone != SMPREF_NONE && ($timeZone != "")
500 && $tzChangeAllowed ) {
501
502 // get time zone key, if strict or custom strict timezones are used
503 if (isset($time_zone_type) &&
504 ($time_zone_type == 1 || $time_zone_type == 3)) {
505 /* load time zone functions */
506 require(SM_PATH . 'include/timezones.php');
507 $realTimeZone = sq_get_tz_key($timeZone);
508 } else {
509 $realTimeZone = $timeZone;
510 }
511
512 // set time zone
513 if ($realTimeZone) {
514 putenv("TZ=".$realTimeZone);
515 }
516 }
867fed37 517
518 /**
519 * php 5.1.0 added time zone functions. Set time zone with them in order
520 * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
521 */
522 if (function_exists('date_default_timezone_set')) {
523 if ($timeZone != SMPREF_NONE && $timeZone != "") {
524 date_default_timezone_set($timeZone);
525 } else {
526 // interface runs on server's time zone. Remove php E_STRICT complains
527 $default_timezone = @date_default_timezone_get();
528 date_default_timezone_set($default_timezone);
529 }
530 }
202bcbcc 531 break;
532}
533
202bcbcc 534/*
28294310 535 * $sTemplateID is not initialized when a user is not logged in, so we
536 * will use the config file defaults here. If the neccesary variables
537 * are not set, force a default value.
3aa46abc 538 *
28294310 539 * If the user is logged in, $sTemplateID will be set in load_prefs.php,
540 * so we shouldn't change it here.
202bcbcc 541 */
28294310 542if (!isset($sTemplateID)) {
42b5e8aa 543 $sTemplateID = Template::get_default_template_set();
28294310 544 $icon_theme_path = !$use_icons ? NULL : Template::calculate_template_images_directory($sTemplateID);
3aa46abc 545}
be155e14 546
547// template object may have already been constructed in load_prefs.php
548//
549if (empty($oTemplate)) {
550 $oTemplate = Template::construct_template($sTemplateID);
551}
202bcbcc 552
7aae649d 553// We want some variables to always be available to the template
4b145052 554$always_include = array('sTemplateID', 'icon_theme_path', 'javascript_on');
7aae649d 555foreach ($always_include as $var) {
556 $oTemplate->assign($var, (isset($$var) ? $$var : NULL));
557}
558
202bcbcc 559/**
560 * Initialize our custom error handler object
561 */
562require(SM_PATH . 'class/error.class.php');
563$oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
564
565/**
566 * Activate custom error handling
567 */
568if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
569 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
570} else {
571 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
572}
573
574/**
575 * Javascript support detection function
576 * @param boolean $reset recheck javascript support if set to true.
867fed37 577 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
202bcbcc 578 * @since 1.5.1
579 */
202bcbcc 580function checkForJavascript($reset = FALSE) {
581 global $data_dir, $username, $javascript_on, $javascript_setting;
582
583 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
584 return $javascript_on;
585
586 if ( $reset || !isset($javascript_setting) )
587 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
588
589 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
590 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
591 $js_autodetect_results = SMPREF_JS_OFF;
592
593 if ( $javascript_setting == SMPREF_JS_AUTODETECT )
594 $javascript_on = $js_autodetect_results;
595 else
596 $javascript_on = $javascript_setting;
597
598 sqsession_register($javascript_on, 'javascript_on');
599 return $javascript_on;
600}
601
602function sqm_baseuri() {
603 global $base_uri;
604 return $base_uri;
8e1e2794 605}