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