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 * Code requires PHP 4.1.0 or newer.
24 * Second test covers boolean set as string (php_value register_globals off).
26 if ((bool) @ini_get
('register_globals') &&
27 strtolower(ini_get('register_globals'))!='off') {
29 * Remove all globals from $_GET, $_POST, and $_COOKIE.
31 foreach ($_REQUEST as $key => $value) {
32 unset($GLOBALS[$key]);
35 * Remove globalized $_FILES variables
36 * Before 4.3.0 $_FILES are included in $_REQUEST.
37 * Unglobalize them in separate call in order to remove dependency
40 foreach ($_FILES as $key => $value) {
41 unset($GLOBALS[$key]);
42 // there are three undocumented $_FILES globals.
43 unset($GLOBALS[$key.'_type']);
44 unset($GLOBALS[$key.'_name']);
45 unset($GLOBALS[$key.'_size']);
48 * Remove globalized environment variables.
50 foreach ($_ENV as $key => $value) {
51 unset($GLOBALS[$key]);
54 * Remove globalized server variables.
56 foreach ($_SERVER as $key => $value) {
57 unset($GLOBALS[$key]);
63 * calculate SM_PATH and calculate the base_uri
64 * assumptions made: init.php is only called from plugins or from the src dir.
65 * files in the plugin directory may not be part of a subdirectory called "src"
68 if (isset($_SERVER['SCRIPT_NAME'])) {
69 $a = explode('/',$_SERVER['SCRIPT_NAME']);
70 } elseif (isset($HTTP_SERVER_VARS['SCRIPT_NAME'])) {
71 $a = explode('/',$_SERVER['SCRIPT_NAME']);
74 for($i = count($a) -2;$i > -1; --$i) {
76 if ($a[$i] === 'src' ||
$a[$i] === 'plugins') {
81 $base_uri = implode('/',array_slice($a,0,$i)). '/';
83 define('SM_PATH',$sSM_PATH);
84 define('SM_BASE_URI', $base_uri);
86 * global var $bInit is used to check if initialisation took place.
87 * At this moment it's a workarounf for the include of addrbook_search_html
88 * inside compose.php. If we found a better way then remove this. Do only use
89 * this var if you know for sure a page can be called stand alone and be included
94 require(SM_PATH
. 'functions/global.php');
95 require(SM_PATH
. 'config/config.php');
96 require(SM_PATH
. 'functions/plugin.php');
97 require(SM_PATH
. 'include/constants.php');
98 require(SM_PATH
. 'include/languages.php');
101 * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
102 * Force magic_quotes_runtime off.
103 * tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
104 * If there's a better place, please let me know.
106 ini_set('magic_quotes_runtime','0');
109 /* if running with magic_quotes_gpc then strip the slashes
110 from POST and GET global arrays */
111 if (get_magic_quotes_gpc()) {
112 sqstripslashes($_GET);
113 sqstripslashes($_POST);
117 /* strip any tags added to the url from PHP_SELF.
118 This fixes hand crafted url XXS expoits for any
119 page that uses PHP_SELF as the FORM action */
120 $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
122 $PHP_SELF = php_self();
125 * Initialize the session
128 /** set the name of the session cookie */
129 if (!isset($session_name) ||
!$session_name) {
130 $session_name = 'SQMSESSID';
134 * if session.auto_start is On then close the session
136 $sSessionAutostartName = session_name();
137 if ((isset($sSessionAutostartName) ||
$sSessionAutostartName == '') &&
138 $sSessionAutostartName !== $session_name) {
139 $sCookiePath = ini_get('session.cookie_path');
140 $sCookieDomain = ini_get('session.cookie_domain');
142 setcookie($sSessionAutostartName,'',time() - 604800,$sCookiePath,$sCookieDomain);
144 session_write_close();
148 * includes from classes stored in the session
150 require(SM_PATH
. 'class/mime.class.php');
152 ini_set('session.name' , $session_name);
153 session_set_cookie_params (0, $base_uri);
154 sqsession_is_active();
158 * Remove globalized session data in rg=on setups
160 * Code can be utilized when session is started, but data is not loaded.
161 * We have already loaded configuration and other important vars. Can't
162 * clean session globals here.
163 if ((bool) @ini_get('register_globals') &&
164 strtolower(ini_get('register_globals'))!='off') {
165 foreach ($_SESSION as $key => $value) {
166 unset($GLOBALS[$key]);
171 sqsession_register(SM_BASE_URI
,'base_uri');
174 * SquirrelMail version number -- DO NOT CHANGE
176 $version = '1.5.2 [CVS]';
179 * SquirrelMail internal version number -- DO NOT CHANGE
180 * $sm_internal_version = array (release, major, minor)
182 $SQM_INTERNAL_VERSION = array(1,5,2);
185 * Retrieve the language cookie
187 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE
)) {
188 $squirrelmail_language = '';
193 * @var $sInitlocation From where do we include.
195 if (!isset($sInitLocation)) {
200 * MAIN PLUGIN LOADING CODE HERE
204 * Include Compatibility plugin if available.
206 if (file_exists(SM_PATH
. 'plugins/compatibility/functions.php'))
207 include_once(SM_PATH
. 'plugins/compatibility/functions.php');
208 $squirrelmail_plugin_hooks = array();
210 /* On init, register all plugins configured for use. */
211 if (isset($plugins) && is_array($plugins)) {
212 // turn on output buffering in order to prevent output of new lines
214 foreach ($plugins as $name) {
217 // get output and remove whitespace
218 $output = trim(ob_get_contents());
220 // if plugins output more than newlines and spacing, stop script execution.
221 if (!empty($output)) {
227 switch ($sInitLocation) {
228 case 'style': session_write_close(); sqsetcookieflush(); break;
231 * directory hashing functions are needed for all setups in case
232 * plugins use own pref files.
234 require(SM_PATH
. 'functions/prefs.php');
235 /* hook loads custom prefs backend plugins */
236 $prefs_backend = do_hook_function('prefs_backend');
237 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH
. $prefs_backend)) {
238 require(SM_PATH
. $prefs_backend);
239 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
240 require(SM_PATH
. 'functions/db_prefs.php');
242 require(SM_PATH
. 'functions/file_prefs.php');
246 require(SM_PATH
. 'functions/display_messages.php' );
247 require(SM_PATH
. 'functions/page_header.php');
248 require(SM_PATH
. 'functions/html.php');
250 * cleanup old cookies with a cookie path the same as the standard php.ini
251 * cookie path. All previous SquirrelMail version used the standard php.ini
252 * cookie path for storing the session name. That behaviour changed.
254 if ($sCookiePath !== SM_BASE_URI
) {
256 * do not delete the standard sessions with session.name is i.e. PHPSESSID
257 * because they probably belong to other php apps
259 if (ini_get('session.name') !== $sSessionAutostartName) {
260 sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
265 require(SM_PATH
. 'functions/display_messages.php' );
266 require(SM_PATH
. 'functions/page_header.php');
267 require(SM_PATH
. 'functions/html.php');
268 require(SM_PATH
. 'functions/strings.php');
272 * Check if we are logged in
274 require(SM_PATH
. 'functions/auth.php');
276 if ( !sqsession_is_registered('user_is_logged_in') ) {
277 // First we store some information in the new session to prevent
280 $session_expired_post = $_POST;
281 $session_expired_location = $PHP_SELF;
282 if (!sqsession_is_registered('session_expired_post')) {
283 sqsession_register($session_expired_post,'session_expired_post');
285 if (!sqsession_is_registered('session_expired_location')) {
286 sqsession_register($session_expired_location,'session_expired_location');
288 // signout page will deal with users who aren't logged
289 // in on its own; don't show error here
291 if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
295 set_up_language($squirrelmail_language, true);
296 logout_error( _("You must be logged in to access this page.") );
300 sqgetGlobalVar('username',$username,SQ_SESSION
);
303 * Setting the prefs backend
305 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION
);
306 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION
);
308 if ( !sqsession_is_registered('prefs_are_cached') ||
309 !isset( $prefs_cache) ||
310 !is_array( $prefs_cache)) {
311 $prefs_are_cached = false;
312 $prefs_cache = false; //array();
315 /* see 'redirect' switch */
316 require(SM_PATH
. 'functions/prefs.php');
318 $prefs_backend = do_hook_function('prefs_backend');
319 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH
. $prefs_backend)) {
320 require(SM_PATH
. $prefs_backend);
321 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
322 require(SM_PATH
. 'functions/db_prefs.php');
324 require(SM_PATH
. 'functions/file_prefs.php');
328 * initializing user settings
330 require(SM_PATH
. 'include/load_prefs.php');
333 // i do not understand the frames language cookie story
335 * We'll need this to later have a noframes version
337 * Check if the user has a language preference, but no cookie.
338 * Send him a cookie with his language preference, if there is
341 $my_language = getPref($data_dir, $username, 'language');
342 if ($my_language != $squirrelmail_language) {
343 sqsetcookie('squirrelmail_language', $my_language, time()+
2592000, $base_uri);
348 * Set up the language.
350 $err=set_up_language(getPref($data_dir, $username, 'language'));
351 /* this is the last cookie we set so flush it. */
354 // Japanese translation used without mbstring support
357 "<p>You need to have PHP installed with the multibyte string function \n".
358 "enabled (using configure option --enable-mbstring).</p>\n".
359 "<p>System assumed that you accidently switched to Japanese translation \n".
360 "and reverted your language preference to English.</p>\n".
361 "<p>Please refresh this page in order to use webmail.</p>\n";
365 $timeZone = getPref($data_dir, $username, 'timezone');
367 /* Check to see if we are allowed to set the TZ environment variable.
368 * We are able to do this if ...
369 * safe_mode is disabled OR
370 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
371 * safe_mode_allowed_env_vars contains TZ
373 $tzChangeAllowed = (!ini_get('safe_mode')) ||
374 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
375 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
377 if ( $timeZone != SMPREF_NONE
&& ($timeZone != "")
378 && $tzChangeAllowed ) {
380 // get time zone key, if strict or custom strict timezones are used
381 if (isset($time_zone_type) &&
382 ($time_zone_type == 1 ||
$time_zone_type == 3)) {
383 /* load time zone functions */
384 require(SM_PATH
. 'include/timezones.php');
385 $realTimeZone = sq_get_tz_key($timeZone);
387 $realTimeZone = $timeZone;
392 putenv("TZ=".$realTimeZone);
397 * php 5.1.0 added time zone functions. Set time zone with them in order
398 * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
400 if (function_exists('date_default_timezone_set')) {
401 if ($timeZone != SMPREF_NONE
&& $timeZone != "") {
402 date_default_timezone_set($timeZone);
404 // interface runs on server's time zone. Remove php E_STRICT complains
405 $default_timezone = @date_default_timezone_get
();
406 date_default_timezone_set($default_timezone);
413 * Initialize the template object
415 require(SM_PATH
. 'class/template/template.class.php');
417 * $sTplDir is not initialized when a user is not logged in, so we will use
418 * the config file defaults here. If the neccesary variables are net set,
419 * force a default value.
421 $aTemplateSet = ( !isset($aTemplateSet) ?
array() : $aTemplateSet );
422 $templateset_default = ( !isset($templateset_default) ?
0 : $templateset_default );
424 $sTplDir = ( !isset($aTemplateSet[$templateset_default]['PATH']) ?
425 SM_PATH
. 'templates/default/' :
426 $aTemplateSet[$templateset_default]['PATH'] );
427 $oTemplate = new Template($sTplDir);
430 * Initialize our custom error handler object
432 require(SM_PATH
. 'class/error.class.php');
433 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
436 * Activate custom error handling
438 if (version_compare(PHP_VERSION
, "4.3.0", ">=")) {
439 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
441 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
445 * Javascript support detection function
446 * @param boolean $reset recheck javascript support if set to true.
447 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
450 function checkForJavascript($reset = FALSE) {
451 global $data_dir, $username, $javascript_on, $javascript_setting;
453 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION
) )
454 return $javascript_on;
456 if ( $reset ||
!isset($javascript_setting) )
457 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT
);
459 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
460 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
461 $js_autodetect_results = SMPREF_JS_OFF
;
463 if ( $javascript_setting == SMPREF_JS_AUTODETECT
)
464 $javascript_on = $js_autodetect_results;
466 $javascript_on = $javascript_setting;
468 sqsession_register($javascript_on, 'javascript_on');
469 return $javascript_on;
472 function sqm_baseuri() {