include/init.php

   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
  14 /**
  15  * This is a development version so in order to track programmer mistakes we
  16  * set the error reporting to E_ALL
  17  */
  18 error_reporting(E_ALL);
  19
  20
  21 /**
  22  * If register_globals are on, unregister globals.
  23  * Second test covers boolean set as string (php_value register_globals off).
  24  */
  25 if ((bool) ini_get('register_globals') &&
  26     strtolower(ini_get('register_globals'))!='off') {
  27     /**
  28      * Remove all globals that are not reserved by PHP
  29      * 'value' and 'key' are used by foreach. Don't unset them inside foreach.
  30      */
  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         }
  58     }
  59     // Unset variables used in foreach
  60     unset($GLOBALS['key']);
  61     unset($GLOBALS['value']);
  62 }
  63
  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  */
  71 if (!(bool)ini_get('session.use_cookies') ||
  72     ini_get('session.use_cookies') == 'off') {
  73     ini_set('session.use_cookies','1');
  74 }
  75
  76 /**
  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  */
  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']);
  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);
  91 }
  92 $sSM_PATH = '';
  93 for($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
 102 define('SM_PATH',$sSM_PATH);
 103 define('SM_BASE_URI', $base_uri);
 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
 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
 136 require(SM_PATH . 'functions/global.php');
 137 require(SM_PATH . 'functions/arrays.php');
 138
 139 /* load default configuration */
 140 require(SM_PATH . 'config/config_default.php');
 141 /* reset arrays in default configuration */
 142 $ldap_server = array();
 143 $plugins = array();
 144 $fontsets = array();
 145 $aTemplateSet = array();
 146 $aTemplateSet[0]['ID'] = 'default';
 147 $aTemplateSet[0]['NAME'] = 'Default';
 148
 149 /* load site configuration */
 150 require(SM_PATH . 'config/config.php');
 151 /* load local configuration overrides */
 152 if (file_exists(SM_PATH . 'config/config_local.php')) {
 153     require(SM_PATH . 'config/config_local.php');
 154 }
 155
 156 require(SM_PATH . 'functions/plugin.php');
 157 require(SM_PATH . 'include/constants.php');
 158 require(SM_PATH . 'include/languages.php');
 159 require(SM_PATH . 'class/template/Template.class.php');
 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  */
 167 ini_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 */
 172 if (get_magic_quotes_gpc()) {
 173     sqstripslashes($_GET);
 174     sqstripslashes($_POST);
 175 }
 176
 177
 178 /* strip any tags added to the url from PHP_SELF.
 179 This 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
 189 /** set the name of the session cookie */
 190 if (!isset($session_name) || !$session_name) {
 191     $session_name = 'SQMSESSID';
 192 }
 193
 194 /**
 195  * if session.auto_start is On then close the session
 196  */
 197 $sSessionAutostartName = session_name();
 198 if ((isset($sSessionAutostartName) || $sSessionAutostartName == '') &&
 199      $sSessionAutostartName !== $session_name) {
 200     $sCookiePath = ini_get('session.cookie_path');
 201     $sCookieDomain = ini_get('session.cookie_domain');
 202     // reset the cookie
 203     setcookie($sSessionAutostartName,'',time() - 604800,$sCookiePath,$sCookieDomain);
 204     @session_destroy();
 205     session_write_close();
 206 }
 207
 208 /**
 209  * includes from classes stored in the session
 210  */
 211 require(SM_PATH . 'class/mime.class.php');
 212
 213 ini_set('session.name' , $session_name);
 214 session_set_cookie_params (0, $base_uri);
 215 sqsession_is_active();
 216
 217 /**
 218  * SquirrelMail version number -- DO NOT CHANGE
 219  */
 220 $version = '1.5.2 [CVS]';
 221
 222 /**
 223  * SquirrelMail internal version number -- DO NOT CHANGE
 224  * $sm_internal_version = array (release, major, minor)
 225  */
 226 $SQM_INTERNAL_VERSION = array(1,5,2);
 227
 228 /**
 229  * Include Compatibility plugin if available.
 230  */
 231 if (file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
 232     include_once(SM_PATH . 'plugins/compatibility/functions.php');
 233
 234 /**
 235  * MAIN PLUGIN LOADING CODE HERE
 236  * On init, we no longer need to load all plugin setup files.
 237  * Now, we load the statically generated hook registrations here
 238  * and let the hook calls include only the plugins needed.
 239  */
 240 $squirrelmail_plugin_hooks = array();
 241 if (file_exists(SM_PATH . 'config/plugin_hooks.php')) {
 242     require(SM_PATH . 'config/plugin_hooks.php');
 243 }
 244
 245 /**
 246  * allow plugins to override main configuration; hook is placed
 247  * here to allow plugins to use session information to do their work
 248  */
 249 do_hook('config_override');
 250
 251 /**
 252  * DISABLED.
 253  * Remove globalized session data in rg=on setups
 254  *
 255  * Code can be utilized when session is started, but data is not loaded.
 256  * We have already loaded configuration and other important vars. Can't
 257  * clean session globals here.
 258 if ((bool) @ini_get('register_globals') &&
 259     strtolower(ini_get('register_globals'))!='off') {
 260     foreach ($_SESSION as $key => $value) {
 261         unset($GLOBALS[$key]);
 262     }
 263 }
 264 */
 265
 266 sqsession_register(SM_BASE_URI,'base_uri');
 267
 268 /**
 269  * Retrieve the language cookie
 270  */
 271 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
 272     $squirrelmail_language = '';
 273 }
 274
 275
 276 /**
 277  * @var $sInitlocation From where do we include.
 278  */
 279 if (!isset($sInitLocation)) {
 280     $sInitLocation=NULL;
 281 }
 282
 283 /**
 284  * Before 1.5.2 version hook was part of functions/constants.php.
 285  * After init layout changes, hook had to be moved because include/constants.php is
 286  * loaded before plugins are initialized.
 287  * @since 1.2.0
 288  */
 289 do_hook('loading_constants');
 290
 291 switch ($sInitLocation) {
 292     case 'style':
 293
 294         // need to get the right template set up
 295         //
 296         sqGetGlobalVar('templateid', $templateid, SQ_GET);
 297
 298         // sanitize just in case...
 299         //
 300         $templateid = preg_replace('/(\.\.\/){1,}/', '', $templateid);
 301
 302         // make sure given template actually is available
 303         //
 304         $found_templateset = false;
 305         for ($i = 0; $i < count($aTemplateSet); ++$i) {
 306             if ($aTemplateSet[$i]['ID'] == $templateid) {
 307                 $found_templateset = true;
 308                 break;
 309             }
 310         }
 311
 312 // FIXME: do we need/want to check here for actual (physical) presence of template sets?
 313         // selected template not available, fall back to default template
 314         //
 315         if (!$found_templateset) {
 316             $sTemplateID = Template::get_default_template_set();
 317         } else {
 318             $sTemplateID = $templateid;
 319         }
 320
 321         session_write_close();
 322         sqsetcookieflush();
 323         break;
 324
 325     case 'redirect':
 326         /**
 327          * directory hashing functions are needed for all setups in case
 328          * plugins use own pref files.
 329          */
 330         require(SM_PATH . 'functions/prefs.php');
 331         require(SM_PATH . 'functions/auth.php');
 332         /* hook loads custom prefs backend plugins */
 333         $prefs_backend = do_hook_function('prefs_backend');
 334         if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
 335             require(SM_PATH . $prefs_backend);
 336         } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
 337             require(SM_PATH . 'functions/db_prefs.php');
 338         } else {
 339             require(SM_PATH . 'functions/file_prefs.php');
 340         }
 341         //nobreak;
 342     case 'login':
 343         require(SM_PATH . 'functions/display_messages.php' );
 344         require(SM_PATH . 'functions/page_header.php');
 345         require(SM_PATH . 'functions/html.php');
 346
 347         // reset template file cache
 348         //
 349         $sTemplateID = Template::get_default_template_set();
 350         Template::cache_template_file_hierarchy(TRUE);
 351
 352         /**
 353          * Make sure icon variables are setup for the login page.
 354          */
 355         $icon_theme = $icon_themes[$icon_theme_def]['PATH'];
 356         /*
 357          * NOTE: The $icon_theme_path var should contain the path to the icon
 358          *       theme to use.  If the admin has disabled icons, or the user has
 359          *       set the icon theme to "None," no icons will be used.
 360          */
 361         $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
 362
 363         /**
 364          * cleanup old cookies with a cookie path the same as the standard php.ini
 365          * cookie path. All previous SquirrelMail version used the standard php.ini
 366          * cookie path for storing the session name. That behaviour changed.
 367          */
 368         if ($sCookiePath !== SM_BASE_URI) {
 369             /**
 370              * do not delete the standard sessions with session.name is i.e. PHPSESSID
 371              * because they probably belong to other php apps
 372              */
 373             if (ini_get('session.name') !== $sSessionAutostartName) {
 374                 sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
 375             }
 376         }
 377         break;
 378     default:
 379         require(SM_PATH . 'functions/display_messages.php' );
 380         require(SM_PATH . 'functions/page_header.php');
 381         require(SM_PATH . 'functions/html.php');
 382         require(SM_PATH . 'functions/strings.php');
 383
 384
 385         /**
 386          * Check if we are logged in
 387          */
 388         require(SM_PATH . 'functions/auth.php');
 389
 390         if ( !sqsession_is_registered('user_is_logged_in') ) {
 391             //  First we store some information in the new session to prevent
 392             //  information-loss.
 393             //
 394             $session_expired_post = $_POST;
 395             $session_expired_location = $PHP_SELF;
 396             if (!sqsession_is_registered('session_expired_post')) {
 397                 sqsession_register($session_expired_post,'session_expired_post');
 398             }
 399             if (!sqsession_is_registered('session_expired_location')) {
 400                 sqsession_register($session_expired_location,'session_expired_location');
 401             }
 402             // signout page will deal with users who aren't logged
 403             // in on its own; don't show error here
 404             //
 405             if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
 406             return;
 407             }
 408
 409             /**
 410              * Initialize the template object (logout_error uses it)
 411              */
 412             /*
 413              * $sTemplateID is not initialized when a user is not logged in, so we
 414              * will use the config file defaults here.  If the neccesary variables
 415              * are net set, force a default value.
 416              */
 417             $sTemplateID = Template::get_default_template_set();
 418             $oTemplate = Template::construct_template($sTemplateID);
 419
 420             set_up_language($squirrelmail_language, true);
 421             logout_error( _("You must be logged in to access this page.") );
 422             exit;
 423         }
 424
 425         sqgetGlobalVar('username',$username,SQ_SESSION);
 426         sqgetGlobalVar('authz',$authz,SQ_SESSION);
 427
 428         /**
 429          * Setting the prefs backend
 430          */
 431         sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
 432         sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
 433
 434         if ( !sqsession_is_registered('prefs_are_cached') ||
 435             !isset( $prefs_cache) ||
 436             !is_array( $prefs_cache)) {
 437             $prefs_are_cached = false;
 438             $prefs_cache = false; //array();
 439         }
 440
 441         /* see 'redirect' case */
 442         require(SM_PATH . 'functions/prefs.php');
 443
 444         $prefs_backend = do_hook_function('prefs_backend');
 445         if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
 446             require(SM_PATH . $prefs_backend);
 447         } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
 448             require(SM_PATH . 'functions/db_prefs.php');
 449         } else {
 450             require(SM_PATH . 'functions/file_prefs.php');
 451         }
 452
 453         /**
 454          * initializing user settings
 455          */
 456         require(SM_PATH . 'include/load_prefs.php');
 457
 458 // i do not understand the frames language cookie story
 459         /**
 460          * We'll need this to later have a noframes version
 461          *
 462          * Check if the user has a language preference, but no cookie.
 463          * Send him a cookie with his language preference, if there is
 464          * such discrepancy.
 465          */
 466          $my_language = getPref($data_dir, $username, 'language');
 467          if ($my_language != $squirrelmail_language) {
 468              sqsetcookie('squirrelmail_language', $my_language, time()+2592000, $base_uri);
 469          }
 470 // /dont understand
 471
 472         /**
 473          * Set up the language.
 474          */
 475         $err=set_up_language(getPref($data_dir, $username, 'language'));
 476         /* this is the last cookie we set so flush it. */
 477         sqsetcookieflush();
 478
 479         // Japanese translation used without mbstring support
 480         if ($err==2) {
 481             $sError =
 482                 "<p>You need to have PHP installed with the multibyte string function \n".
 483                 "enabled (using configure option --enable-mbstring).</p>\n".
 484                 "<p>System assumed that you accidently switched to Japanese translation \n".
 485                 "and reverted your language preference to English.</p>\n".
 486                 "<p>Please refresh this page in order to use webmail.</p>\n";
 487             error_box($sError);
 488         }
 489
 490         $timeZone = getPref($data_dir, $username, 'timezone');
 491
 492         /* Check to see if we are allowed to set the TZ environment variable.
 493          * We are able to do this if ...
 494          *   safe_mode is disabled OR
 495          *   safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
 496          *   safe_mode_allowed_env_vars contains TZ
 497          */
 498         $tzChangeAllowed = (!ini_get('safe_mode')) ||
 499                             !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
 500                             preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
 501
 502         if ( $timeZone != SMPREF_NONE && ($timeZone != "")
 503             && $tzChangeAllowed ) {
 504
 505             // get time zone key, if strict or custom strict timezones are used
 506             if (isset($time_zone_type) &&
 507                 ($time_zone_type == 1 || $time_zone_type == 3)) {
 508                 /* load time zone functions */
 509                 require(SM_PATH . 'include/timezones.php');
 510                 $realTimeZone = sq_get_tz_key($timeZone);
 511             } else {
 512                 $realTimeZone = $timeZone;
 513             }
 514
 515             // set time zone
 516             if ($realTimeZone) {
 517                 putenv("TZ=".$realTimeZone);
 518             }
 519         }
 520
 521         /**
 522          * php 5.1.0 added time zone functions. Set time zone with them in order
 523          * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
 524          */
 525         if (function_exists('date_default_timezone_set')) {
 526             if ($timeZone != SMPREF_NONE && $timeZone != "") {
 527                 date_default_timezone_set($timeZone);
 528             } else {
 529                 // interface runs on server's time zone. Remove php E_STRICT complains
 530                 $default_timezone = @date_default_timezone_get();
 531                 date_default_timezone_set($default_timezone);
 532             }
 533         }
 534         break;
 535 }
 536
 537 /*
 538  * $sTemplateID is not initialized when a user is not logged in, so we
 539  * will use the config file defaults here.  If the neccesary variables
 540  * are not set, force a default value.
 541  *
 542  * If the user is logged in, $sTemplateID will be set in load_prefs.php,
 543  * so we shouldn't change it here.
 544  */
 545 if (!isset($sTemplateID)) {
 546     $sTemplateID = Template::get_default_template_set();
 547     $icon_theme_path = !$use_icons ? NULL : Template::calculate_template_images_directory($sTemplateID);
 548 }
 549
 550 // template object may have already been constructed in load_prefs.php
 551 //
 552 if (empty($oTemplate)) {
 553     $oTemplate = Template::construct_template($sTemplateID);
 554 }
 555
 556 // We want some variables to always be available to the template
 557 $always_include = array('sTemplateID', 'icon_theme_path', 'javascript_on');
 558 foreach ($always_include as $var) {
 559     $oTemplate->assign($var, (isset($$var) ? $$var : NULL));
 560 }
 561
 562 /**
 563  * Initialize our custom error handler object
 564  */
 565 require(SM_PATH . 'class/error.class.php');
 566 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
 567
 568 /**
 569  * Activate custom error handling
 570  */
 571 if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
 572     $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
 573 } else {
 574     $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
 575 }
 576
 577 /**
 578  * Javascript support detection function
 579  * @param boolean $reset recheck javascript support if set to true.
 580  * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
 581  * @since 1.5.1
 582  */
 583 function checkForJavascript($reset = FALSE) {
 584   global $data_dir, $username, $javascript_on, $javascript_setting;
 585
 586   if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
 587     return $javascript_on;
 588
 589   if ( $reset || !isset($javascript_setting) )
 590     $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
 591
 592   if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
 593        !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
 594     $js_autodetect_results = SMPREF_JS_OFF;
 595
 596   if ( $javascript_setting == SMPREF_JS_AUTODETECT )
 597     $javascript_on = $js_autodetect_results;
 598   else
 599     $javascript_on = $javascript_setting;
 600
 601   sqsession_register($javascript_on, 'javascript_on');
 602   return $javascript_on;
 603 }
 604
 605 function sqm_baseuri() {
 606     global $base_uri;
 607     return $base_uri;
 608 }