d41abd28c943538fae5a226fd5baa6b8781ffa93
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
19 * SquirrelMail internal version number -- DO NOT CHANGE
20 * $sm_internal_version = array (release, major, minor)
23 $SQM_INTERNAL_VERSION = array(1,5,2);
26 * This is a development version so in order to track programmer mistakes we
27 * set the error reporting to E_ALL
30 error_reporting(E_ALL
);
34 * If register_globals are on, unregister globals.
35 * Code requires PHP 4.1.0 or newer.
38 if ((bool) @ini_get
('register_globals')) {
40 * Remove all globals from $_GET, $_POST, and $_COOKIE.
42 foreach ($_REQUEST as $key => $value) {
43 unset($GLOBALS[$key]);
46 * Remove globalized $_FILES variables
47 * Before 4.3.0 $_FILES are included in $_REQUEST.
48 * Unglobalize them in separate call in order to remove dependency
51 foreach ($_FILES as $key => $value) {
52 unset($GLOBALS[$key]);
53 // there are three undocumented $_FILES globals.
54 unset($GLOBALS[$key.'_type']);
55 unset($GLOBALS[$key.'_name']);
56 unset($GLOBALS[$key.'_size']);
59 * Remove globalized environment variables.
61 foreach ($_ENV as $key => $value) {
62 unset($GLOBALS[$key]);
65 * Remove globalized server variables.
67 foreach ($_SERVER as $key => $value) {
68 unset($GLOBALS[$key]);
74 * calculate SM_PATH and calculate the base_uri
75 * assumptions made: init.php is only called from plugins or from the src dir.
76 * files in the plugin directory may not be part of a subdirectory called "src"
79 if (isset($_SERVER['SCRIPT_NAME'])) {
80 $a = explode('/',$_SERVER['SCRIPT_NAME']);
81 } elseif (isset($HTTP_SERVER_VARS['SCRIPT_NAME'])) {
82 $a = explode('/',$_SERVER['SCRIPT_NAME']);
85 for($i = count($a) -2;$i > -1; --$i) {
87 if ($a[$i] === 'src' ||
$a[$i] === 'plugins') {
92 $base_uri = implode('/',array_slice($a,0,$i)). '/';
94 define('SM_PATH',$sSM_PATH);
95 define('SM_BASE_URI', $base_uri);
97 * global var $bInit is used to check if initialisation took place.
98 * At this moment it's a workarounf for the include of addrbook_search_html
99 * inside compose.php. If we found a better way then remove this. Do only use
100 * this var if you know for sure a page can be called stand alone and be included
105 require(SM_PATH
. 'functions/global.php');
106 require(SM_PATH
. 'config/config.php');
107 require(SM_PATH
. 'functions/plugin.php');
108 require(SM_PATH
. 'include/constants.php');
109 require(SM_PATH
. 'include/languages.php');
112 * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
113 * Force magic_quotes_runtime off.
114 * tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
115 * If there's a better place, please let me know.
117 ini_set('magic_quotes_runtime','0');
120 /* if running with magic_quotes_gpc then strip the slashes
121 from POST and GET global arrays */
122 if (get_magic_quotes_gpc()) {
123 sqstripslashes($_GET);
124 sqstripslashes($_POST);
128 /* strip any tags added to the url from PHP_SELF.
129 This fixes hand crafted url XXS expoits for any
130 page that uses PHP_SELF as the FORM action */
131 $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
133 $PHP_SELF = php_self();
136 * Initialize the session
139 /** set the name of the session cookie */
140 if (!isset($session_name) ||
!$session_name) {
141 $session_name = 'SQMSESSID';
145 * if session.auto_start is On then close the session
147 $session_autostart_name = session_name();
148 if ((isset($session_autostart_name) ||
$session_autostart_name == '') &&
149 $session_autostart_name !== $session_name) {
150 $cookiepath = ini_get('session.cookie_path');
151 $cookiedomain = ini_get('session.cookie_domain');
153 setcookie($session_autostart_name,'',time() - 604800,$cookiepath,$cookiedomain);
155 session_write_close();
159 * includes from classes stored in the session
161 require(SM_PATH
. 'class/mime.class.php');
163 ini_set('session.name' , $session_name);
164 session_set_cookie_params (0, $base_uri);
165 sqsession_is_active();
168 * Remove globalized session data in rg=on setups
170 if ((bool) @ini_get
('register_globals')) {
171 foreach ($_SESSION as $key => $value) {
172 unset($GLOBALS[$key]);
176 sqsession_register($base_uri, SM_BASE_URI
);
179 * SquirrelMail version number -- DO NOT CHANGE
181 $version = '1.5.2 [CVS]';
184 * Retrieve the language cookie
186 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE
)) {
187 $squirrelmail_language = '';
192 * @var $sInitlocation From where do we include.
194 if (!isset($sInitLocation)) {
199 * MAIN PLUGIN LOADING CODE HERE
203 * Include Compatibility plugin if available.
205 if (file_exists(SM_PATH
. 'plugins/compatibility/functions.php'))
206 include_once(SM_PATH
. 'plugins/compatibility/functions.php');
207 $squirrelmail_plugin_hooks = array();
209 /* On init, register all plugins configured for use. */
210 if (isset($plugins) && is_array($plugins)) {
211 // turn on output buffering in order to prevent output of new lines
213 foreach ($plugins as $name) {
216 // get output and remove whitespace
217 $output = trim(ob_get_contents());
219 // if plugins output more than newlines and spacing, stop script execution.
220 if (!empty($output)) {
226 switch ($sInitLocation) {
227 case 'style': session_write_close(); sqsetcookieflush(); break;
229 $prefs_backend = do_hook_function('prefs_backend');
230 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH
. $prefs_backend)) {
231 require(SM_PATH
. $prefs_backend);
232 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
233 require(SM_PATH
. 'functions/db_prefs.php');
235 require(SM_PATH
. 'functions/prefs.php');
236 require(SM_PATH
. 'functions/file_prefs.php');
240 require(SM_PATH
. 'functions/display_messages.php' );
241 require(SM_PATH
. 'functions/page_header.php');
242 require(SM_PATH
. 'functions/html.php');
245 require(SM_PATH
. 'functions/display_messages.php' );
246 require(SM_PATH
. 'functions/page_header.php');
247 require(SM_PATH
. 'functions/html.php');
248 require(SM_PATH
. 'functions/strings.php');
252 * Check if we are logged in
254 require(SM_PATH
. 'functions/auth.php');
256 if ( !sqsession_is_registered('user_is_logged_in') ) {
257 // First we store some information in the new session to prevent
260 $session_expired_post = $_POST;
261 $session_expired_location = $PHP_SELF;
262 if (!sqsession_is_registered('session_expired_post')) {
263 sqsession_register($session_expired_post,'session_expired_post');
265 if (!sqsession_is_registered('session_expired_location')) {
266 sqsession_register($session_expired_location,'session_expired_location');
268 // signout page will deal with users who aren't logged
269 // in on its own; don't show error here
271 if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
275 set_up_language($squirrelmail_language, true);
276 logout_error( _("You must be logged in to access this page.") );
280 sqgetGlobalVar('username',$username,SQ_SESSION
);
283 * Setting the prefs backend
285 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION
);
286 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION
);
288 if ( !sqsession_is_registered('prefs_are_cached') ||
289 !isset( $prefs_cache) ||
290 !is_array( $prefs_cache)) {
291 $prefs_are_cached = false;
292 $prefs_cache = false; //array();
295 $prefs_backend = do_hook_function('prefs_backend');
296 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH
. $prefs_backend)) {
297 require(SM_PATH
. $prefs_backend);
298 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
299 require(SM_PATH
. 'functions/db_prefs.php');
301 require(SM_PATH
. 'functions/prefs.php');
302 require(SM_PATH
. 'functions/file_prefs.php');
306 * initializing user settings
308 require(SM_PATH
. 'include/load_prefs.php');
311 // i do not understand the frames language cookie story
313 * We'll need this to later have a noframes version
315 * Check if the user has a language preference, but no cookie.
316 * Send him a cookie with his language preference, if there is
319 $my_language = getPref($data_dir, $username, 'language');
320 if ($my_language != $squirrelmail_language) {
321 sqsetcookie('squirrelmail_language', $my_language, time()+
2592000, $base_uri);
326 * Set up the language.
328 $err=set_up_language(getPref($data_dir, $username, 'language'));
329 /* this is the last cookie we set so flush it. */
332 // Japanese translation used without mbstring support
335 "<p>You need to have PHP installed with the multibyte string function \n".
336 "enabled (using configure option --enable-mbstring).</p>\n".
337 "<p>System assumed that you accidently switched to Japanese translation \n".
338 "and reverted your language preference to English.</p>\n".
339 "<p>Please refresh this page in order to use webmail.</p>\n";
343 $timeZone = getPref($data_dir, $username, 'timezone');
345 /* Check to see if we are allowed to set the TZ environment variable.
346 * We are able to do this if ...
347 * safe_mode is disabled OR
348 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
349 * safe_mode_allowed_env_vars contains TZ
351 $tzChangeAllowed = (!ini_get('safe_mode')) ||
352 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
353 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
355 if ( $timeZone != SMPREF_NONE
&& ($timeZone != "")
356 && $tzChangeAllowed ) {
358 // get time zone key, if strict or custom strict timezones are used
359 if (isset($time_zone_type) &&
360 ($time_zone_type == 1 ||
$time_zone_type == 3)) {
361 /* load time zone functions */
362 require(SM_PATH
. 'include/timezones.php');
363 $realTimeZone = sq_get_tz_key($timeZone);
365 $realTimeZone = $timeZone;
370 putenv("TZ=".$realTimeZone);
377 * Initialize the template object
379 require(SM_PATH
. 'class/template/template.class.php');
381 * $sTplDir is not initialized when a user is not logged in, so we will use
382 * the config file defaults here. If the neccesary variables are net set,
383 * force a default value.
385 $aTemplateSet = ( !isset($aTemplateSet) ?
array() : $aTemplateSet );
386 $templateset_default = ( !isset($templateset_default) ?
0 : $templateset_default );
388 $sTplDir = ( !isset($aTemplateSet[$templateset_default]['PATH']) ?
389 SM_PATH
. 'templates/default/' :
390 $aTemplateSet[$templateset_default]['PATH'] );
391 $oTemplate = new Template($sTplDir);
394 * Initialize our custom error handler object
396 require(SM_PATH
. 'class/error.class.php');
397 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
400 * Activate custom error handling
402 if (version_compare(PHP_VERSION
, "4.3.0", ">=")) {
403 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
405 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
409 * Javascript support detection function
410 * @param boolean $reset recheck javascript support if set to true.
411 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see functions/constants.php})
415 function checkForJavascript($reset = FALSE) {
416 global $data_dir, $username, $javascript_on, $javascript_setting;
418 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION
) )
419 return $javascript_on;
421 if ( $reset ||
!isset($javascript_setting) )
422 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT
);
424 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
425 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
426 $js_autodetect_results = SMPREF_JS_OFF
;
428 if ( $javascript_setting == SMPREF_JS_AUTODETECT
)
429 $javascript_on = $js_autodetect_results;
431 $javascript_on = $javascript_setting;
433 sqsession_register($javascript_on, 'javascript_on');
434 return $javascript_on;
437 function sqm_baseuri() {