Source for file configreader.php

Documentation is available at configreader.php

  1. <?php
  2. /**
  3. * Configuration reading object
  4. *
  5. * Parses the {@link bumblebee.ini } file
  6. *
  7. * @author    Stuart Prescott
  8. * @copyright  Copyright Stuart Prescott
  9. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  10. * @version    $Id: configreader.php,v 1.8 2007/02/16 23:10:22 themill Exp $
  11. * @package    Bumblebee
  12. * @subpackage Misc
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. /** include parent */
  20. require_once 'inc/bb/basicconfigreader.php';
  21. /** include parent */
  22. require_once 'inc/systemstatus.php';
  23.  
  24. class ConfigReader extends BasicConfigReader {
  25.  
  26.   /** @var string  used for generating links to the administrator for more information, help etc */
  27.   var $AdminEmail;
  28.  
  29.   var $BasePath;
  30.   /** @var string  prepended to all URLs generated by the system so that the links work */
  31.   var $BaseURL;
  32.   /** @var string  Location of the session array (make sure the session variables don't clash with others systems that are setting session vars) */
  33.   var $SessionIndex;
  34.  
  35.   /** @var boolean  Echo all SQL statements to the browser for debugging purposes */
  36.   var $VerboseSQL = false;
  37.   /** @var boolean  user supplied data will be dumped to the browser for debugging purposes */
  38.   var $VerboseData = false;
  39.  
  40.   /** @var SystemStatus    maintain tabs on the system status */
  41.   var $status = null;
  42.  
  43.   function ConfigReader() {
  44.     parent::BasicConfigReader();
  45.     $this->status = new SystemStatus();
  46.   }
  47.  
  48.   function ParseConfig($fatalErrors=true) {
  49.     if ($this->status === null) $this->status = new SystemStatus();
  50.  
  51.  
  52.     $this->AdminEmail = $this->value('main', 'AdminEmail', '');  ///FIXME: work out a default?
  53.  
  54.     $script_source = preg_replace('@//+@', '/', $_SERVER['SCRIPT_NAME']);
  55.  
  56.     $this->BasePath   = $this->value('main', 'BasePath');
  57.     if ($this->BasePath === null || substr($this->BasePath, 0, 1) != '/') {
  58.       if (preg_match('@install/\w+.php@', $script_source)) {
  59.         $this->BasePath = preg_replace('@install/\w+.php@', '', $script_source);
  60.       } else {
  61.         $this->BasePath = preg_replace('@/index.php@', '', $script_source);
  62.       }
  63.       if (strlen($this->BasePath) == 0) $this->BasePath = '/';
  64.     }
  65.  
  66. //     if (substr($this->BasePath, 0, 1) != '/' && ! $this->configError) {
  67. //       // the first character of the path must be a slash
  68. //       // the user is never going to be able to log on when it's like this, so let's kill it off.
  69. //       trigger_error('Bumblebee misconfiguration: please make sure that the BasePath parameter in bumblebee.ini is only the path portion of the URL and does not include the server name. (Hint: should start with a "/" and be something like "/bumblebee" or "/departments/chemistry/equipment")', $fatalErrors ? E_USER_ERROR : E_USER_NOTICE);
  70. //     }
  71.  
  72.     $this->BaseURL    = $this->value('main', 'BaseURL');    //FIXME: work out a default?
  73.     if ($this->BaseURL === null || (substr($this->BaseURL, 0, 1) != '/' && substr($this->BaseURL, 0, 4) != 'http')) {
  74.       if (preg_match('@install/\w+.php@', $script_source)) {
  75.         $this->BaseURL = preg_replace('@install/\w+.php@', 'index.php', $script_source);
  76.       } else {
  77.         $this->BaseURL = $script_source;
  78.       }
  79.     }
  80.  
  81.     if ($fatalErrors) {
  82.       if (! defined('LOAD_ALL_PHP_FILES')) {
  83.         if ($this->data['error_handling']['AllWarnings']) {
  84.           //this is nice for development but probably turn it off for production
  85.           error_reporting(E_ALL | E_STRICT); #force all warnings to be echoed
  86.           #error_reporting(E_ALL); #force all warnings to be echoed
  87.           /** load all php files */
  88.           define('LOAD_ALL_PHP_FILES', 1);
  89.         } else {
  90.           error_reporting(E_ERROR); #only errors should be echoed
  91.           /** load only the php files required to fullfill this request) */
  92.           define('LOAD_ALL_PHP_FILES', 0);
  93.         }
  94.       }
  95.     }
  96.  
  97.     $this->VerboseSQL  = $this->value('error_handling', 'VerboseSQL', false);
  98.     $this->VerboseData = $this->value('error_handling', 'VerboseData', false);
  99.  
  100. //     echo "'$script_source'";
  101.     $this->SessionIndex = md5($script_source);
  102.   }
  103.  
  104. }
  105.  
  106. ?>

Documentation generated on Tue, 06 Mar 2007 10:01:06 +0000 by phpDocumentor 1.3.0