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         default:
  53             unset($GLOBALS[$key]);
  54         }
  55     }
  56     // Unset variables used in foreach
  57     unset($GLOBALS['key']);
  58     unset($GLOBALS['value']);
  59 }
  60
  61 /**
  62  * Used as a dummy value, e.g., for passing as an empty
  63  * hook argument (where the value is passed by reference,
  64  * and therefore NULL itself is not acceptable).
  65  */
  66 global $null;
  67 $null = NULL;
  68
  69 /**
  70  * [#1518885] session.use_cookies = off breaks SquirrelMail
  71  *
  72  * When session cookies are not used, all http redirects, meta refreshes,
  73  * src/download.php and javascript URLs are broken. Setting must be set
  74  * before session is started.
  75  */
  76 if (!(bool)ini_get('session.use_cookies') ||
  77     ini_get('session.use_cookies') == 'off') {
  78     ini_set('session.use_cookies','1');
  79 }
  80
  81 /**
  82  * calculate SM_PATH and calculate the base_uri
  83  * assumptions made: init.php is only called from plugins or from the src dir.
  84  * files in the plugin directory may not be part of a subdirectory called "src"
  85  *
  86  */
  87 if (isset($_SERVER['SCRIPT_NAME'])) {
  88     $a = explode('/',$_SERVER['SCRIPT_NAME']);
  89 } elseif (isset($HTTP_SERVER_VARS['SCRIPT_NAME'])) {
  90     $a = explode('/',$HTTP_SERVER_VARS['SCRIPT_NAME']);
  91 } else {
  92     $error = 'Unable to detect script environment. '
  93         .'Please test your PHP settings and send PHP core config, $_SERVER '
  94         .'and $HTTP_SERVER_VARS to SquirrelMail developers.';
  95     die($error);
  96 }
  97 $sSM_PATH = '';
  98 for($i = count($a) -2;$i > -1; --$i) {
  99     $sSM_PATH .= '../';
 100     if ($a[$i] === 'src' || $a[$i] === 'plugins') {
 101         break;
 102     }
 103 }
 104
 105 $base_uri = implode('/',array_slice($a,0,$i)). '/';
 106
 107 define('SM_PATH',$sSM_PATH);
 108 define('SM_BASE_URI', $base_uri);
 109 /**
 110  * global var $bInit is used to check if initialisation took place.
 111  * At this moment it's a workarounf for the include of addrbook_search_html
 112  * inside compose.php. If we found a better way then remove this. Do only use
 113  * this var if you know for sure a page can be called stand alone and be included
 114  * in another file.
 115  */
 116 $bInit = true;
 117
 118 /**
 119  * This theme as a failsafe if no themes were found, or if we error
 120  * out before anything could be initialised.
 121  */
 122 $color = array();
 123 $color[0]  = '#DCDCDC';  /* light gray    TitleBar               */
 124 $color[1]  = '#800000';  /* red                                  */
 125 $color[2]  = '#CC0000';  /* light red     Warning/Error Messages */
 126 $color[3]  = '#A0B8C8';  /* green-blue    Left Bar Background    */
 127 $color[4]  = '#FFFFFF';  /* white         Normal Background      */
 128 $color[5]  = '#FFFFCC';  /* light yellow  Table Headers          */
 129 $color[6]  = '#000000';  /* black         Text on left bar       */
 130 $color[7]  = '#0000CC';  /* blue          Links                  */
 131 $color[8]  = '#000000';  /* black         Normal text            */
 132 $color[9]  = '#ABABAB';  /* mid-gray      Darker version of #0   */
 133 $color[10] = '#666666';  /* dark gray     Darker version of #9   */
 134 $color[11] = '#770000';  /* dark red      Special Folders color  */
 135 $color[12] = '#EDEDED';
 136 $color[13] = '#800000';  /* (dark red)    Color for quoted text -- > 1 quote */
 137 $color[14] = '#ff0000';  /* (red)         Color for quoted text -- >> 2 or more */
 138 $color[15] = '#002266';  /* (dark blue)   Unselectable folders */
 139 $color[16] = '#ff9933';  /* (orange)      Highlight color */
 140
 141 require(SM_PATH . 'functions/global.php');
 142 require(SM_PATH . 'functions/arrays.php');
 143
 144 /* load default configuration */
 145 require(SM_PATH . 'config/config_default.php');
 146 /* reset arrays in default configuration */
 147 $ldap_server = array();
 148 $plugins = array();
 149 $fontsets = array();
 150 $aTemplateSet = array();
 151 $aTemplateSet[0]['ID'] = 'default';
 152 $aTemplateSet[0]['NAME'] = 'Default';
 153
 154 /* load site configuration */
 155 require(SM_PATH . 'config/config.php');
 156 /* load local configuration overrides */
 157 if (file_exists(SM_PATH . 'config/config_local.php')) {
 158     require(SM_PATH . 'config/config_local.php');
 159 }
 160
 161 require(SM_PATH . 'functions/plugin.php');
 162 require(SM_PATH . 'include/constants.php');
 163 require(SM_PATH . 'include/languages.php');
 164 require(SM_PATH . 'class/template/Template.class.php');
 165 require(SM_PATH . 'class/error.class.php');
 166
 167 /**
 168  * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
 169  * Force magic_quotes_runtime off.
 170  * tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
 171  * If there's a better place, please let me know.
 172  */
 173 ini_set('magic_quotes_runtime','0');
 174
 175
 176 /* if running with magic_quotes_gpc then strip the slashes
 177    from POST and GET global arrays */
 178 if (get_magic_quotes_gpc()) {
 179     sqstripslashes($_GET);
 180     sqstripslashes($_POST);
 181 }
 182
 183
 184 /* strip any tags added to the url from PHP_SELF.
 185 This fixes hand crafted url XXS expoits for any
 186    page that uses PHP_SELF as the FORM action */
 187 $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
 188
 189 $PHP_SELF = php_self();
 190
 191 /**
 192  * Initialize the session
 193  */
 194
 195 /** set the name of the session cookie */
 196 if (!isset($session_name) || !$session_name) {
 197     $session_name = 'SQMSESSID';
 198 }
 199
 200 /**
 201  * if session.auto_start is On then close the session
 202  */
 203 $sSessionAutostartName = session_name();
 204 $sCookiePath = null;
 205 if ((isset($sSessionAutostartName) || $sSessionAutostartName == '') &&
 206      $sSessionAutostartName !== $session_name) {
 207     $sCookiePath = ini_get('session.cookie_path');
 208     $sCookieDomain = ini_get('session.cookie_domain');
 209     // reset the cookie
 210     setcookie($sSessionAutostartName,'',time() - 604800,$sCookiePath,$sCookieDomain);
 211     @session_destroy();
 212     session_write_close();
 213 }
 214
 215 /**
 216  * includes from classes stored in the session
 217  */
 218 require(SM_PATH . 'class/mime.class.php');
 219
 220 ini_set('session.name' , $session_name);
 221 session_set_cookie_params (0, $base_uri);
 222 sqsession_is_active();
 223
 224 /**
 225  * SquirrelMail internal version number -- DO NOT CHANGE
 226  * $sm_internal_version = array (release, major, minor)
 227  */
 228 $SQM_INTERNAL_VERSION = explode('.', SM_VERSION, 3);
 229 $SQM_INTERNAL_VERSION[2] = intval($SQM_INTERNAL_VERSION[2]);
 230
 231
 232 /* load prefs system; even when user not logged in, should be OK to do this here */
 233 require(SM_PATH . 'functions/prefs.php');
 234
 235 $prefs_backend = do_hook('prefs_backend', $null);
 236 if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
 237     require(SM_PATH . $prefs_backend);
 238 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
 239     require(SM_PATH . 'functions/db_prefs.php');
 240 } else {
 241     require(SM_PATH . 'functions/file_prefs.php');
 242 }
 243
 244
 245 /* if plugins are disabled only for one user and
 246  * the current user is NOT that user, turn them
 247  * back on
 248  */
 249 sqgetGlobalVar('username',$username,SQ_SESSION);
 250 if ($disable_plugins && !empty($disable_plugins_user)
 251  && $username != $disable_plugins_user) {
 252     $disable_plugins = false;
 253 }
 254
 255 /* remove all plugins if they are disabled */
 256 if ($disable_plugins) {
 257    $plugins = array();
 258 }
 259
 260
 261 /**
 262  * Include Compatibility plugin if available.
 263  */
 264 if (!$disable_plugins && file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
 265     include_once(SM_PATH . 'plugins/compatibility/functions.php');
 266
 267 /**
 268  * MAIN PLUGIN LOADING CODE HERE
 269  * On init, we no longer need to load all plugin setup files.
 270  * Now, we load the statically generated hook registrations here
 271  * and let the hook calls include only the plugins needed.
 272  */
 273 $squirrelmail_plugin_hooks = array();
 274 if (!$disable_plugins && file_exists(SM_PATH . 'config/plugin_hooks.php')) {
 275     require(SM_PATH . 'config/plugin_hooks.php');
 276 }
 277
 278 /**
 279  * allow plugins to override main configuration; hook is placed
 280  * here to allow plugins to use session information to do their work
 281  */
 282 do_hook('config_override', $null);
 283
 284 /**
 285  * DISABLED.
 286  * Remove globalized session data in rg=on setups
 287  *
 288  * Code can be utilized when session is started, but data is not loaded.
 289  * We have already loaded configuration and other important vars. Can't
 290  * clean session globals here.
 291 if ((bool) @ini_get('register_globals') &&
 292     strtolower(ini_get('register_globals'))!='off') {
 293     foreach ($_SESSION as $key => $value) {
 294         unset($GLOBALS[$key]);
 295     }
 296 }
 297 */
 298
 299 sqsession_register(SM_BASE_URI,'base_uri');
 300
 301 /**
 302  * Retrieve the language cookie
 303  */
 304 if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
 305     $squirrelmail_language = '';
 306 }
 307
 308
 309 /**
 310  * Do something special for some pages. This is based on the PAGE_NAME constand
 311  * set at the top of every page.
 312  */
 313 if ( !defined('PAGE_NAME') ) define('PAGE_NAME', NULL);
 314 switch (PAGE_NAME) {
 315     case 'style':
 316
 317         // need to get the right template set up
 318         //
 319         sqGetGlobalVar('templateid', $templateid, SQ_GET);
 320
 321         // sanitize just in case...
 322         //
 323         $templateid = preg_replace('/(\.\.\/){1,}/', '', $templateid);
 324
 325         // make sure given template actually is available
 326         //
 327         $found_templateset = false;
 328         for ($i = 0; $i < count($aTemplateSet); ++$i) {
 329             if ($aTemplateSet[$i]['ID'] == $templateid) {
 330                 $found_templateset = true;
 331                 break;
 332             }
 333         }
 334
 335 // FIXME: do we need/want to check here for actual (physical) presence of template sets?
 336         // selected template not available, fall back to default template
 337         //
 338         if (!$found_templateset) {
 339             $sTemplateID = Template::get_default_template_set();
 340         } else {
 341             $sTemplateID = $templateid;
 342         }
 343
 344         session_write_close();
 345         break;
 346
 347     case 'redirect':
 348         require(SM_PATH . 'functions/auth.php');
 349         //nobreak;
 350
 351     case 'login':
 352         require(SM_PATH . 'functions/display_messages.php' );
 353         require(SM_PATH . 'functions/page_header.php');
 354         require(SM_PATH . 'functions/html.php');
 355
 356         // reset template file cache
 357         //
 358         $sTemplateID = Template::get_default_template_set();
 359         Template::cache_template_file_hierarchy(TRUE);
 360
 361         /**
 362          * Make sure icon variables are setup for the login page.
 363          */
 364         $icon_theme = $icon_themes[$icon_theme_def]['PATH'];
 365         /*
 366          * NOTE: The $icon_theme_path var should contain the path to the icon
 367          *       theme to use.  If the admin has disabled icons, or the user has
 368          *       set the icon theme to "None," no icons will be used.
 369          */
 370         $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
 371
 372         /**
 373          * cleanup old cookies with a cookie path the same as the standard php.ini
 374          * cookie path. All previous SquirrelMail version used the standard php.ini
 375          * cookie path for storing the session name. That behaviour changed.
 376          */
 377         if ($sCookiePath !== SM_BASE_URI) {
 378             /**
 379              * do not delete the standard sessions with session.name is i.e. PHPSESSID
 380              * because they probably belong to other php apps
 381              */
 382             if (ini_get('session.name') !== $sSessionAutostartName) {
 383                 //  This does not work. Sometimes the cookie with SQSESSID=deleted and path /
 384                 // is picked up in webmail.php => login will fail
 385                 //sqsetcookie(ini_get('session.name'),'',0,$sCookiePath);
 386             }
 387         }
 388         break;
 389     default:
 390         require(SM_PATH . 'functions/display_messages.php' );
 391         require(SM_PATH . 'functions/page_header.php');
 392         require(SM_PATH . 'functions/html.php');
 393         require(SM_PATH . 'functions/strings.php');
 394
 395
 396         /**
 397          * Check if we are logged in
 398          */
 399         require(SM_PATH . 'functions/auth.php');
 400
 401         if ( !sqsession_is_registered('user_is_logged_in') ) {
 402             //  First we store some information in the new session to prevent
 403             //  information-loss.
 404             //
 405             $session_expired_post = $_POST;
 406             $session_expired_location = $PHP_SELF;
 407             if (!sqsession_is_registered('session_expired_post')) {
 408                 sqsession_register($session_expired_post,'session_expired_post');
 409             }
 410             if (!sqsession_is_registered('session_expired_location')) {
 411                 sqsession_register($session_expired_location,'session_expired_location');
 412             }
 413             // signout page will deal with users who aren't logged
 414             // in on its own; don't show error here
 415             //
 416             if ( PAGE_NAME == 'signout' ) {
 417                 return;
 418             }
 419
 420             /**
 421              * Initialize the template object (logout_error uses it)
 422              */
 423             /*
 424              * $sTemplateID is not initialized when a user is not logged in, so we
 425              * will use the config file defaults here.  If the neccesary variables
 426              * are net set, force a default value.
 427              */
 428             $sTemplateID = Template::get_default_template_set();
 429             $oTemplate = Template::construct_template($sTemplateID);
 430
 431             set_up_language($squirrelmail_language, true);
 432             logout_error( _("You must be logged in to access this page.") );
 433             exit;
 434         }
 435
 436 //FIXME: remove next line if the placement of the copy of this line above does not prove to be problematic
 437         sqgetGlobalVar('username',$username,SQ_SESSION);
 438         sqgetGlobalVar('authz',$authz,SQ_SESSION);
 439
 440         /**
 441          * Setting the prefs backend
 442          */
 443         sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
 444         sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
 445
 446         if ( !sqsession_is_registered('prefs_are_cached') ||
 447             !isset( $prefs_cache) ||
 448             !is_array( $prefs_cache)) {
 449             $prefs_are_cached = false;
 450             $prefs_cache = false; //array();
 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
 477         // Japanese translation used without mbstring support
 478         if ($err==2) {
 479             $sError =
 480                 "<p>You need to have PHP installed with the multibyte string function \n".
 481                 "enabled (using configure option --enable-mbstring).</p>\n".
 482                 "<p>System assumed that you accidently switched to Japanese translation \n".
 483                 "and reverted your language preference to English.</p>\n".
 484                 "<p>Please refresh this page in order to use webmail.</p>\n";
 485             error_box($sError);
 486         }
 487
 488         $timeZone = getPref($data_dir, $username, 'timezone');
 489
 490         /* Check to see if we are allowed to set the TZ environment variable.
 491          * We are able to do this if ...
 492          *   safe_mode is disabled OR
 493          *   safe_mode_allowed_env_vars is empty (you are allowed to set any) OR
 494          *   safe_mode_allowed_env_vars contains TZ
 495          */
 496         $tzChangeAllowed = (!ini_get('safe_mode')) ||
 497                             !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
 498                             preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars'));
 499
 500         if ( $timeZone != SMPREF_NONE && ($timeZone != "")
 501             && $tzChangeAllowed ) {
 502
 503             // get time zone key, if strict or custom strict timezones are used
 504             if (isset($time_zone_type) &&
 505                 ($time_zone_type == 1 || $time_zone_type == 3)) {
 506                 /* load time zone functions */
 507                 require(SM_PATH . 'include/timezones.php');
 508                 $realTimeZone = sq_get_tz_key($timeZone);
 509             } else {
 510                 $realTimeZone = $timeZone;
 511             }
 512
 513             // set time zone
 514             if ($realTimeZone) {
 515                 putenv("TZ=".$realTimeZone);
 516             }
 517         }
 518
 519         /**
 520          * php 5.1.0 added time zone functions. Set time zone with them in order
 521          * to prevent E_STRICT notices and allow time zone modifications in safe_mode.
 522          */
 523         if (function_exists('date_default_timezone_set')) {
 524             if ($timeZone != SMPREF_NONE && $timeZone != "") {
 525                 date_default_timezone_set($timeZone);
 526             } else {
 527                 // interface runs on server's time zone. Remove php E_STRICT complains
 528                 $default_timezone = @date_default_timezone_get();
 529                 date_default_timezone_set($default_timezone);
 530             }
 531         }
 532         break;
 533 }
 534
 535 /*
 536  * $sTemplateID is not initialized when a user is not logged in, so we
 537  * will use the config file defaults here.  If the neccesary variables
 538  * are not set, force a default value.
 539  *
 540  * If the user is logged in, $sTemplateID will be set in load_prefs.php,
 541  * so we shouldn't change it here.
 542  */
 543 if (!isset($sTemplateID)) {
 544     $sTemplateID = Template::get_default_template_set();
 545     $icon_theme_path = !$use_icons ? NULL : Template::calculate_template_images_directory($sTemplateID);
 546 }
 547
 548 // template object may have already been constructed in load_prefs.php
 549 //
 550 if (empty($oTemplate)) {
 551     $oTemplate = Template::construct_template($sTemplateID);
 552 }
 553
 554 // We want some variables to always be available to the template
 555 $oTemplate->assign('javascript_on',
 556     (sqGetGlobalVar('user_is_logged_in', $user_is_logged_in, SQ_SESSION)
 557      ?  checkForJavascript() : 0));
 558 $oTemplate->assign('base_uri', sqm_baseuri());
 559 $always_include = array('sTemplateID', 'icon_theme_path');
 560 foreach ($always_include as $var) {
 561     $oTemplate->assign($var, (isset($$var) ? $$var : NULL));
 562 }
 563
 564 /**
 565  * Initialize our custom error handler object
 566  */
 567 $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
 568
 569 /**
 570  * Activate custom error handling
 571  */
 572 if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
 573     $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
 574 } else {
 575     $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
 576 }
 577
 578 /**
 579  * Javascript support detection function
 580  * @param boolean $reset recheck javascript support if set to true.
 581  * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see include/constants.php})
 582  * @since 1.5.1
 583  */
 584 function checkForJavascript($reset = FALSE) {
 585   global $data_dir, $username, $javascript_on, $javascript_setting;
 586
 587   if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
 588     return $javascript_on;
 589
 590   $user_is_logged_in = FALSE;
 591   if ( $reset || !isset($javascript_setting) )
 592     $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
 593
 594   if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
 595        !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
 596     $js_autodetect_results = SMPREF_JS_OFF;
 597
 598   if ( $javascript_setting == SMPREF_JS_AUTODETECT )
 599     $javascript_on = $js_autodetect_results;
 600   else
 601     $javascript_on = $javascript_setting;
 602
 603   sqsession_register($javascript_on, 'javascript_on');
 604   return $javascript_on;
 605 }
 606
 607 function sqm_baseuri() {
 608     global $base_uri;
 609     return $base_uri;
 610 }