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