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