Source for file init.php

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

Documentation generated on Sat, 07 Oct 2006 16:11:53 +0300 by phpDocumentor 1.3.0RC6