4 * init.php -- initialisation file
6 * File should be loaded in every file in src/ or plugins that occupate an entire frame
8 * @copyright © 2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
15 * This is a development version so in order to track programmer mistakes we
16 * set the error reporting to E_ALL
18 error_reporting(E_ALL
);
22 * If register_globals are on, unregister globals.
23 * Second test covers boolean set as string (php_value register_globals off).
25 if ((bool) ini_get('register_globals') &&
26 strtolower(ini_get('register_globals'))!='off') {
28 * Remove all globals that are not reserved by PHP
29 * 'value' and 'key' are used by foreach. Don't unset them inside foreach.
31 foreach ($GLOBALS as $key => $value) {
33 case 'HTTP_POST_VARS':
37 case 'HTTP_COOKIE_VARS':
39 case 'HTTP_SERVER_VARS':
43 case 'HTTP_POST_FILES':
46 case 'HTTP_SESSION_VARS':
53 // FIXME: variable must be set only in src/login.php
56 unset($GLOBALS[$key]);
59 // Unset variables used in foreach
60 unset($GLOBALS['key']);
61 unset($GLOBALS['value']);
65 * [#1518885] session.use_cookies = off breaks SquirrelMail
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.
71 if (!(bool)ini_get('session.use_cookies') ||
72 ini_get('session.use_cookies') == 'off') {
73 ini_set('session.use_cookies','1');
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"
82 if (isset($_SERVER['SCRIPT_NAME'])) {
83 $a = explode('/',$_SERVER['SCRIPT_NAME']);
84 } elseif (isset($HTTP_SERVER_VARS['SCRIPT_NAME'])) {
85 $a = explode('/',$HTTP_SERVER_VARS['SCRIPT_NAME']);
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.';
93 for($i = count($a) -2;$i > -1; --$i) {
95 if ($a[$i] === 'src' ||
$a[$i] === 'plugins') {
100 $base_uri = implode('/',array_slice($a,0,$i)). '/';
102 define('SM_PATH',$sSM_PATH);
103 define('SM_BASE_URI', $base_uri);
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
114 * This theme as a failsafe if no themes were found, or if we error
115 * out before anything could be initialised.
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 */
136 require(SM_PATH
. 'functions/global.php');
137 require(SM_PATH
. 'functions/arrays.php');
139 /* load default configuration */
140 require(SM_PATH
. 'config/config_default.php');
141 /* reset arrays in default configuration */
142 $ldap_server = array();
146 $theme[0]['PATH'] = SM_PATH
. 'themes/default_theme.php';
147 $theme[0]['NAME'] = 'Default';
148 $aTemplateSet = array();
149 $aTemplateSet[0]['ID'] = 'default';
150 $aTemplateSet[0]['NAME'] = 'Default';
151 /* load site configuration */
152 require(SM_PATH
. 'config/config.php');
153 /* load local configuration overrides */
154 if (file_exists(SM_PATH
. 'config/config_local.php')) {
155 require(SM_PATH
. 'config/config_local.php');
158 require(SM_PATH
. 'functions/plugin.php');
159 require(SM_PATH
. 'include/constants.php');
160 require(SM_PATH
. 'include/languages.php');
161 require(SM_PATH
. 'class/template/Template.class.php');
164 * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
165 * Force magic_quotes_runtime off.
166 * tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
167 * If there's a better place, please let me know.
169 ini_set('magic_quotes_runtime','0');
172 /* if running with magic_quotes_gpc then strip the slashes
173 from POST and GET global arrays */
174 if (get_magic_quotes_gpc()) {
175 sqstripslashes($_GET);
176 sqstripslashes($_POST);
180 /* strip any tags added to the url from PHP_SELF.
181 This fixes hand crafted url XXS expoits for any
182 page that uses PHP_SELF as the FORM action */
183 $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
185 $PHP_SELF = php_self();
188 * Initialize the session
191 /** set the name of the session cookie */
192 if (!isset($session_name) ||
!$session_name) {
193 $session_name = 'SQMSESSID';
197 * if session.auto_start is On then close the session
199 $sSessionAutostartName = session_name();
200 if ((isset($sSessionAutostartName) ||
$sSessionAutostartName == '') &&
201 $sSessionAutostartName !== $session_name) {
202 $sCookiePath = ini_get('session.cookie_path');
203 $sCookieDomain = ini_get('session.cookie_domain');
205 setcookie($sSessionAutostartName,'',time() - 604800,$sCookiePath,$sCookieDomain);
207 session_write_close();
211 * includes from classes stored in the session
213 require(SM_PATH
. 'class/mime.class.php');
215 ini_set('session.name' , $session_name);
216 session_set_cookie_params (0, $base_uri);
217 sqsession_is_active();
221 * Remove globalized session data in rg=on setups
223 * Code can be utilized when session is started, but data is not loaded.
224 * We have already loaded configuration and other important vars. Can't
225 * clean session globals here.
226 if ((bool) @ini_get('register_globals') &&
227 strtolower(ini_get('register_globals'))!='off') {
228 foreach ($_SESSION as $key => $value) {
229 unset($GLOBALS[$key]);
234 sqsession_register(SM_BASE_URI
,'base_uri');
237 * SquirrelMail version number -- DO NOT CHANGE
239 $version = '1.5.2 [CVS]';
242 * SquirrelMail internal version number -- DO NOT CHANGE
243 * $sm_internal_version = array (release, major, minor)
245 $SQM_INTERNAL_VERSION = array(1,5,2);
248 * Retrieve the language cookie
250 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE
)) {
251 $squirrelmail_language = '';
256 * @var $sInitlocation From where do we include.
258 if (!isset($sInitLocation)) {
263 * MAIN PLUGIN LOADING CODE HERE
267 * Include Compatibility plugin if available.
269 if (file_exists(SM_PATH
. 'plugins/compatibility/functions.php'))
270 include_once(SM_PATH
. 'plugins/compatibility/functions.php');
271 $squirrelmail_plugin_hooks = array();
273 /* On init, register all plugins configured for use. */
274 if (isset($plugins) && is_array($plugins)) {
275 // turn on output buffering in order to prevent output of new lines
277 foreach ($plugins as $name) {
280 // get output and remove whitespace
281 $output = trim(ob_get_contents());
283 // if plugins output more than newlines and spacing, stop script execution.
284 if (!empty($output)) {
290 * Before 1.5.2 version hook was part of functions/constants.php.
291 * After init layout changes, hook had to be moved because include/constants.php is
292 * loaded before plugins are initialized.
295 do_hook('loading_constants');
297 switch ($sInitLocation) {
300 // need to get the right template set up
302 sqGetGlobalVar('templateid', $templateid, SQ_GET
);
304 // sanitize just in case...
306 $templateid = preg_replace('/(\.\.\/){1,}/', '', $templateid);
308 // make sure given template actually is available
310 $found_templateset = false;
311 for ($i = 0; $i < count($aTemplateSet); ++
$i) {
312 if ($aTemplateSet[$i]['ID'] == $templateid) {
313 $found_templateset = true;
318 // FIXME: do we need/want to check here for actual presence of template sets?
319 // selected template not available, fall back to default template
321 if (!$found_templateset) {
322 $sTemplateID = Template
::get_default_template_set();
324 $sTemplateID = $templateid;
327 session_write_close();
333 * directory hashing functions are needed for all setups in case
334 * plugins use own pref files.
336 require(SM_PATH
. 'functions/prefs.php');
337 /* hook loads custom prefs backend plugins */
338 $prefs_backend = do_hook_function('prefs_backend');
339 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH
. $prefs_backend)) {
340 require(SM_PATH
. $prefs_backend);
341 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
342 require(SM_PATH
. 'functions/db_prefs.php');
344 require(SM_PATH
. 'functions/file_prefs.php');
348 require(SM_PATH
. 'functions/display_messages.php' );
349 require(SM_PATH
. 'functions/page_header.php');
350 require(SM_PATH
. 'functions/html.php');
352 // reset template file cache
354 $sTemplateID = Template
::get_default_template_set();
355 Template
::cache_template_file_hierarchy(TRUE);
358 * cleanup old cookies with a cookie path the same as the standard php.ini
359 * cookie path. All previous SquirrelMail version used the standard php.ini
360 * cookie path for storing the session name. That behaviour changed.
362 if ($sCookiePath !== SM_BASE_URI
) {
364 * do not delete the standard sessions with session.name is i.e. PHPSESSID
365 * because they probably belong to other php apps
367 if (ini_get('session.name') !== $sSessionAutostartName) {
368 sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
373 require(SM_PATH
. 'functions/display_messages.php' );
374 require(SM_PATH
. 'functions/page_header.php');
375 require(SM_PATH
. 'functions/html.php');
376 require(SM_PATH
. 'functions/strings.php');
380 * Check if we are logged in
382 require(SM_PATH
. 'functions/auth.php');
384 if ( !sqsession_is_registered('user_is_logged_in') ) {
385 // First we store some information in the new session to prevent
388 $session_expired_post = $_POST;
389 $session_expired_location = $PHP_SELF;
390 if (!sqsession_is_registered('session_expired_post')) {
391 sqsession_register($session_expired_post,'session_expired_post');
393 if (!sqsession_is_registered('session_expired_location')) {
394 sqsession_register($session_expired_location,'session_expired_location');
396 // signout page will deal with users who aren't logged
397 // in on its own; don't show error here
399 if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
404 * Initialize the template object (logout_error uses it)
407 * $sTemplateID is not initialized when a user is not logged in, so we
408 * will use the config file defaults here. If the neccesary variables
409 * are net set, force a default value.
411 $sTemplateID = Template
::get_default_template_set();
412 $oTemplate = Template
::construct_template($sTemplateID);
414 set_up_language($squirrelmail_language, true);
415 logout_error( _("You must be logged in to access this page.") );
419 sqgetGlobalVar('username',$username,SQ_SESSION
);
422 * Setting the prefs backend
424 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION
);
425 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION
);
427 if ( !sqsession_is_registered('prefs_are_cached') ||
428 !isset( $prefs_cache) ||
429 !is_array( $prefs_cache)) {
430 $prefs_are_cached = false;
431 $prefs_cache = false; //array();
434 /* see 'redirect' case */
435 require(SM_PATH
. 'functions/prefs.php');
437 $prefs_backend = do_hook_function('prefs_backend');
438 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH
. $prefs_backend)) {
439 require(SM_PATH
. $prefs_backend);
440 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
441 require(SM_PATH
. 'functions/db_prefs.php');
443 require(SM_PATH
. 'functions/file_prefs.php');
447 * initializing user settings
449 require(SM_PATH
. 'include/load_prefs.php');
451 // i do not understand the frames language cookie story
453 * We'll need this to later have a noframes version
455 * Check if the user has a language preference, but no cookie.
456 * Send him a cookie with his language preference, if there is
459 $my_language = getPref($data_dir, $username, 'language');
460 if ($my_language != $squirrelmail_language) {
461 sqsetcookie('squirrelmail_language', $my_language, time()+
2592000, $base_uri);
466 * Set up the language.
468 $err=set_up_language(getPref($data_dir, $username, 'language'));
469 /* this is the last cookie we set so flush it. */
472 // Japanese translation used without mbstring support
475 "<p>You need to have PHP installed with the multibyte string function \n".
476 "enabled (using configure option --enable-mbstring).</p>\n".
477 "<p>System assumed that you accidently switched to Japanese translation \n".
478 "and reverted your language preference to English.</p>\n".
479 "<p>Please refresh this page in order to use webmail.</p>\n";
483 $timeZone = getPref($data_dir, $username, 'timezone');
485 /* Check to see if we are allowed to set the TZ environment variable.
486 * We are able to do this if ...
487 * safe_mode is disabled OR
488 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
489 * safe_mode_allowed_env_vars contains TZ
491 $tzChangeAllowed = (!ini_get('safe_mode')) ||
492 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
493 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
495 if ( $timeZone != SMPREF_NONE
&& ($timeZone != "")
496 && $tzChangeAllowed ) {
498 // get time zone key, if strict or custom strict timezones are used
499 if (isset($time_zone_type) &&
500 ($time_zone_type == 1 ||
$time_zone_type == 3)) {
501 /* load time zone functions */
502 require(SM_PATH
. 'include/timezones.php');
503 $realTimeZone = sq_get_tz_key($timeZone);
505 $realTimeZone = $timeZone;
510 putenv("TZ=".$realTimeZone);
515 * php 5.1.0 added time zone functions. Set time zone with them in order
516 * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
518 if (function_exists('date_default_timezone_set')) {
519 if ($timeZone != SMPREF_NONE
&& $timeZone != "") {
520 date_default_timezone_set($timeZone);
522 // interface runs on server's time zone. Remove php E_STRICT complains
523 $default_timezone = @date_default_timezone_get
();
524 date_default_timezone_set($default_timezone);
531 * $sTemplateID is not initialized when a user is not logged in, so we
532 * will use the config file defaults here. If the neccesary variables
533 * are not set, force a default value.
535 * If the user is logged in, $sTemplateID will be set in load_prefs.php,
536 * so we shouldn't change it here.
538 if (!isset($sTemplateID)) {
539 $sTemplateID = Template
::get_default_template_set();
540 $icon_theme_path = !$use_icons ?
NULL : Template
::calculate_template_images_directory($sTemplateID);
542 $oTemplate = Template
::construct_template($sTemplateID);
544 // We want some variables to always be available to the template
545 $always_include = array('sTemplateID', 'icon_theme_path');
546 foreach ($always_include as $var) {
547 $oTemplate->assign($var, (isset($
$var) ? $
$var : NULL));
551 * Initialize our custom error handler object
553 require(SM_PATH
. 'class/error.class.php');
554 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
557 * Activate custom error handling
559 if (version_compare(PHP_VERSION
, "4.3.0", ">=")) {
560 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
562 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
566 * Javascript support detection function
567 * @param boolean $reset recheck javascript support if set to true.
568 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
571 function checkForJavascript($reset = FALSE) {
572 global $data_dir, $username, $javascript_on, $javascript_setting;
574 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION
) )
575 return $javascript_on;
577 if ( $reset ||
!isset($javascript_setting) )
578 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT
);
580 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
581 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
582 $js_autodetect_results = SMPREF_JS_OFF
;
584 if ( $javascript_setting == SMPREF_JS_AUTODETECT
)
585 $javascript_on = $js_autodetect_results;
587 $javascript_on = $javascript_setting;
589 sqsession_register($javascript_on, 'javascript_on');
590 return $javascript_on;
593 function sqm_baseuri() {