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