ldap connection test script. don't want to recreate same script one more
[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.
23 * Code requires PHP 4.1.0 or newer.
a3b99374 24 * Second test covers boolean set as string (php_value register_globals off).
6a2a6e44 25 */
a3b99374 26if ((bool) @ini_get('register_globals') &&
27 strtolower(ini_get('register_globals'))!='off') {
6a2a6e44 28 /**
29 * Remove all globals from $_GET, $_POST, and $_COOKIE.
30 */
31 foreach ($_REQUEST as $key => $value) {
32 unset($GLOBALS[$key]);
33 }
34 /**
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
38 * on PHP version.
39 */
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']);
46 }
47 /**
48 * Remove globalized environment variables.
49 */
50 foreach ($_ENV as $key => $value) {
51 unset($GLOBALS[$key]);
52 }
53 /**
54 * Remove globalized server variables.
55 */
56 foreach ($_SERVER as $key => $value) {
57 unset($GLOBALS[$key]);
58 }
59}
60
61
62/**
202bcbcc 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"
66 *
67 */
68if (isset($_SERVER['SCRIPT_NAME'])) {
69 $a = explode('/',$_SERVER['SCRIPT_NAME']);
70} elseif (isset($HTTP_SERVER_VARS['SCRIPT_NAME'])) {
71 $a = explode('/',$_SERVER['SCRIPT_NAME']);
72}
73$sSM_PATH = '';
74for($i = count($a) -2;$i > -1; --$i) {
75 $sSM_PATH .= '../';
76 if ($a[$i] === 'src' || $a[$i] === 'plugins') {
77 break;
78 }
79}
80
81$base_uri = implode('/',array_slice($a,0,$i)). '/';
82
202bcbcc 83define('SM_PATH',$sSM_PATH);
6a2a6e44 84define('SM_BASE_URI', $base_uri);
202bcbcc 85/**
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
90 * in another file.
91 */
92$bInit = true;
93
94require(SM_PATH . 'functions/global.php');
95require(SM_PATH . 'config/config.php');
96require(SM_PATH . 'functions/plugin.php');
97require(SM_PATH . 'include/constants.php');
98require(SM_PATH . 'include/languages.php');
99
100/**
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.
105 */
106ini_set('magic_quotes_runtime','0');
107
108
109/* if running with magic_quotes_gpc then strip the slashes
110 from POST and GET global arrays */
111if (get_magic_quotes_gpc()) {
112 sqstripslashes($_GET);
113 sqstripslashes($_POST);
114}
115
202bcbcc 116
117/* strip any tags added to the url from PHP_SELF.
118This 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']);
121
122$PHP_SELF = php_self();
123
124/**
125 * Initialize the session
126 */
127
e8c4e350 128/** set the name of the session cookie */
129if (!isset($session_name) || !$session_name) {
130 $session_name = 'SQMSESSID';
131}
132
133/**
134 * if session.auto_start is On then close the session
1d537493 135 */
136$sSessionAutostartName = session_name();
137if ((isset($sSessionAutostartName) || $sSessionAutostartName == '') &&
138 $sSessionAutostartName !== $session_name) {
139 $sCookiePath = ini_get('session.cookie_path');
140 $sCookieDomain = ini_get('session.cookie_domain');
e8c4e350 141 // reset the cookie
1d537493 142 setcookie($sSessionAutostartName,'',time() - 604800,$sCookiePath,$sCookieDomain);
e8c4e350 143 @session_destroy();
144 session_write_close();
1d537493 145}
e8c4e350 146
202bcbcc 147/**
148 * includes from classes stored in the session
149 */
150require(SM_PATH . 'class/mime.class.php');
151
202bcbcc 152ini_set('session.name' , $session_name);
153session_set_cookie_params (0, $base_uri);
154sqsession_is_active();
155
202bcbcc 156/**
157 * Remove globalized session data in rg=on setups
158 */
159if ((bool) @ini_get('register_globals')) {
160 foreach ($_SESSION as $key => $value) {
161 unset($GLOBALS[$key]);
162 }
163}
6a2a6e44 164
165sqsession_register($base_uri, SM_BASE_URI);
166
202bcbcc 167/**
e8c4e350 168 * SquirrelMail version number -- DO NOT CHANGE
169 */
170$version = '1.5.2 [CVS]';
171
172/**
1d537493 173 * SquirrelMail internal version number -- DO NOT CHANGE
174 * $sm_internal_version = array (release, major, minor)
175 */
176$SQM_INTERNAL_VERSION = array(1,5,2);
177
178/**
202bcbcc 179 * Retrieve the language cookie
180 */
181if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
182 $squirrelmail_language = '';
183}
184
185
186/**
187 * @var $sInitlocation From where do we include.
188 */
189if (!isset($sInitLocation)) {
190 $sInitLocation=NULL;
191}
192
193/**
194 * MAIN PLUGIN LOADING CODE HERE
195 */
196
197/**
198 * Include Compatibility plugin if available.
199 */
200if (file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
201 include_once(SM_PATH . 'plugins/compatibility/functions.php');
202$squirrelmail_plugin_hooks = array();
203
204/* On init, register all plugins configured for use. */
205if (isset($plugins) && is_array($plugins)) {
206 // turn on output buffering in order to prevent output of new lines
207 ob_start();
208 foreach ($plugins as $name) {
209 use_plugin($name);
210 }
211 // get output and remove whitespace
212 $output = trim(ob_get_contents());
213 ob_end_clean();
214 // if plugins output more than newlines and spacing, stop script execution.
215 if (!empty($output)) {
216 die($output);
217 }
218}
219
220
221switch ($sInitLocation) {
222 case 'style': session_write_close(); sqsetcookieflush(); break;
223 case 'redirect':
224 $prefs_backend = do_hook_function('prefs_backend');
225 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
226 require(SM_PATH . $prefs_backend);
227 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
228 require(SM_PATH . 'functions/db_prefs.php');
229 } else {
230 require(SM_PATH . 'functions/prefs.php');
231 require(SM_PATH . 'functions/file_prefs.php');
232 }
233 //nobreak;
234 case 'login':
235 require(SM_PATH . 'functions/display_messages.php' );
236 require(SM_PATH . 'functions/page_header.php');
237 require(SM_PATH . 'functions/html.php');
1d537493 238 /**
239 * cleanup old cookies with a cookie path the same as the standard php.ini
240 * cookie path. All previous SquirrelMail version used the standard php.ini
241 * cookie path for storing the session name. That behaviour changed.
242 */
243 if ($sCookiePath !== SM_BASE_URI) {
244 /**
245 * do not delete the standard sessions with session.name is i.e. PHPSESSID
246 * because they probably belong to other php apps
247 */
248 if (ini_get('session.name') !== $sSessionAutostartName) {
249 sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
250 }
251 }
202bcbcc 252 break;
253 default:
254 require(SM_PATH . 'functions/display_messages.php' );
255 require(SM_PATH . 'functions/page_header.php');
256 require(SM_PATH . 'functions/html.php');
257 require(SM_PATH . 'functions/strings.php');
258
259
260 /**
261 * Check if we are logged in
262 */
263 require(SM_PATH . 'functions/auth.php');
264
265 if ( !sqsession_is_registered('user_is_logged_in') ) {
266 // First we store some information in the new session to prevent
267 // information-loss.
268 //
269 $session_expired_post = $_POST;
270 $session_expired_location = $PHP_SELF;
271 if (!sqsession_is_registered('session_expired_post')) {
272 sqsession_register($session_expired_post,'session_expired_post');
273 }
274 if (!sqsession_is_registered('session_expired_location')) {
275 sqsession_register($session_expired_location,'session_expired_location');
276 }
277 // signout page will deal with users who aren't logged
278 // in on its own; don't show error here
279 //
280 if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
281 return;
282 }
283
284 set_up_language($squirrelmail_language, true);
285 logout_error( _("You must be logged in to access this page.") );
286 exit;
287 }
288
289 sqgetGlobalVar('username',$username,SQ_SESSION);
290
291 /**
292 * Setting the prefs backend
293 */
294 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
295 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
296
297 if ( !sqsession_is_registered('prefs_are_cached') ||
298 !isset( $prefs_cache) ||
299 !is_array( $prefs_cache)) {
300 $prefs_are_cached = false;
301 $prefs_cache = false; //array();
302 }
303
304 $prefs_backend = do_hook_function('prefs_backend');
305 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
306 require(SM_PATH . $prefs_backend);
307 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
308 require(SM_PATH . 'functions/db_prefs.php');
309 } else {
310 require(SM_PATH . 'functions/prefs.php');
311 require(SM_PATH . 'functions/file_prefs.php');
312 }
313
314 /**
315 * initializing user settings
316 */
317 require(SM_PATH . 'include/load_prefs.php');
318
319
320// i do not understand the frames language cookie story
321 /**
322 * We'll need this to later have a noframes version
323 *
324 * Check if the user has a language preference, but no cookie.
325 * Send him a cookie with his language preference, if there is
326 * such discrepancy.
327 */
328 $my_language = getPref($data_dir, $username, 'language');
329 if ($my_language != $squirrelmail_language) {
330 sqsetcookie('squirrelmail_language', $my_language, time()+2592000, $base_uri);
331 }
332// /dont understand
333
334 /**
335 * Set up the language.
336 */
337 $err=set_up_language(getPref($data_dir, $username, 'language'));
338 /* this is the last cookie we set so flush it. */
339 sqsetcookieflush();
340
341 // Japanese translation used without mbstring support
342 if ($err==2) {
343 $sError =
344 "<p>You need to have PHP installed with the multibyte string function \n".
345 "enabled (using configure option --enable-mbstring).</p>\n".
346 "<p>System assumed that you accidently switched to Japanese translation \n".
347 "and reverted your language preference to English.</p>\n".
348 "<p>Please refresh this page in order to use webmail.</p>\n";
349 error_box($sError);
350 }
351
352 $timeZone = getPref($data_dir, $username, 'timezone');
353
354 /* Check to see if we are allowed to set the TZ environment variable.
355 * We are able to do this if ...
356 * safe_mode is disabled OR
357 * safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
358 * safe_mode_allowed_env_vars contains TZ
359 */
360 $tzChangeAllowed = (!ini_get('safe_mode')) ||
361 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
362 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
363
364 if ( $timeZone != SMPREF_NONE && ($timeZone != "")
365 && $tzChangeAllowed ) {
366
367 // get time zone key, if strict or custom strict timezones are used
368 if (isset($time_zone_type) &&
369 ($time_zone_type == 1 || $time_zone_type == 3)) {
370 /* load time zone functions */
371 require(SM_PATH . 'include/timezones.php');
372 $realTimeZone = sq_get_tz_key($timeZone);
373 } else {
374 $realTimeZone = $timeZone;
375 }
376
377 // set time zone
378 if ($realTimeZone) {
379 putenv("TZ=".$realTimeZone);
380 }
381 }
382 break;
383}
384
385/**
386 * Initialize the template object
387 */
388require(SM_PATH . 'class/template/template.class.php');
389/*
390 * $sTplDir is not initialized when a user is not logged in, so we will use
391 * the config file defaults here. If the neccesary variables are net set,
392 * force a default value.
393 */
394$aTemplateSet = ( !isset($aTemplateSet) ? array() : $aTemplateSet );
395$templateset_default = ( !isset($templateset_default) ? 0 : $templateset_default );
396
397$sTplDir = ( !isset($aTemplateSet[$templateset_default]['PATH']) ?
398 SM_PATH . 'templates/default/' :
399 $aTemplateSet[$templateset_default]['PATH'] );
400$oTemplate = new Template($sTplDir);
401
402/**
403 * Initialize our custom error handler object
404 */
405require(SM_PATH . 'class/error.class.php');
406$oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
407
408/**
409 * Activate custom error handling
410 */
411if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
412 $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
413} else {
414 $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
415}
416
417/**
418 * Javascript support detection function
419 * @param boolean $reset recheck javascript support if set to true.
420 * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see functions/constants.php})
421 * @since 1.5.1
422 */
202bcbcc 423function checkForJavascript($reset = FALSE) {
424 global $data_dir, $username, $javascript_on, $javascript_setting;
425
426 if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
427 return $javascript_on;
428
429 if ( $reset || !isset($javascript_setting) )
430 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
431
432 if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
433 !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
434 $js_autodetect_results = SMPREF_JS_OFF;
435
436 if ( $javascript_setting == SMPREF_JS_AUTODETECT )
437 $javascript_on = $js_autodetect_results;
438 else
439 $javascript_on = $javascript_setting;
440
441 sqsession_register($javascript_on, 'javascript_on');
442 return $javascript_on;
443}
444
445function sqm_baseuri() {
446 global $base_uri;
447 return $base_uri;
448}