upgrade to codeigniter 1.7.2 for f12
[www-register-wizard.git] / codeigniter / Common.php
index 9212f07..eb9dce6 100644 (file)
-<?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');\r
-/**\r
- * CodeIgniter\r
- *\r
- * An open source application development framework for PHP 4.3.2 or newer\r
- *\r
- * @package            CodeIgniter\r
- * @author             ExpressionEngine Dev Team\r
- * @copyright  Copyright (c) 2008, EllisLab, Inc.\r
- * @license            http://codeigniter.com/user_guide/license.html\r
- * @link               http://codeigniter.com\r
- * @since              Version 1.0\r
- * @filesource\r
- */\r
-\r
-// ------------------------------------------------------------------------\r
-\r
-/**\r
- * Common Functions\r
- *\r
- * Loads the base classes and executes the request.\r
- *\r
- * @package            CodeIgniter\r
- * @subpackage codeigniter\r
- * @category   Common Functions\r
- * @author             ExpressionEngine Dev Team\r
- * @link               http://codeigniter.com/user_guide/\r
- */\r
-\r
-// ------------------------------------------------------------------------\r
-\r
-/**\r
- * Tests for file writability\r
- *\r
- * is_writable() returns TRUE on Windows servers when you really can't write to \r
- * the file, based on the read-only attribute.  is_writable() is also unreliable\r
- * on Unix servers if safe_mode is on. \r
- *\r
- * @access     private\r
- * @return     void\r
- */\r
-function is_really_writable($file)\r
-{      \r
-       // If we're on a Unix server with safe_mode off we call is_writable\r
-       if (DIRECTORY_SEPARATOR == '/' AND @ini_get("safe_mode") == FALSE)\r
-       {\r
-               return is_writable($file);\r
-       }\r
-\r
-       // For windows servers and safe_mode "on" installations we'll actually\r
-       // write a file then read it.  Bah...\r
-       if (is_dir($file))\r
-       {\r
-               $file = rtrim($file, '/').'/'.md5(rand(1,100));\r
-\r
-               if (($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)\r
-               {\r
-                       return FALSE;\r
-               }\r
-\r
-               fclose($fp);\r
-               @chmod($file, DIR_WRITE_MODE);\r
-               @unlink($file);\r
-               return TRUE;\r
-       }\r
-       elseif (($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)\r
-       {\r
-               return FALSE;\r
-       }\r
-\r
-       fclose($fp);\r
-       return TRUE;\r
-}\r
-\r
-// ------------------------------------------------------------------------\r
-\r
-/**\r
-* Class registry\r
-*\r
-* This function acts as a singleton.  If the requested class does not\r
-* exist it is instantiated and set to a static variable.  If it has\r
-* previously been instantiated the variable is returned.\r
-*\r
-* @access      public\r
-* @param       string  the class name being requested\r
-* @param       bool    optional flag that lets classes get loaded but not instantiated\r
-* @return      object\r
-*/\r
-function &load_class($class, $instantiate = TRUE)\r
-{\r
-       static $objects = array();\r
-\r
-       // Does the class exist?  If so, we're done...\r
-       if (isset($objects[$class]))\r
-       {\r
-               return $objects[$class];\r
-       }\r
-\r
-       // If the requested class does not exist in the application/libraries\r
-       // folder we'll load the native class from the system/libraries folder. \r
-       if (file_exists(APPPATH.'libraries/'.config_item('subclass_prefix').$class.EXT))\r
-       {\r
-               require(BASEPATH.'libraries/'.$class.EXT);\r
-               require(APPPATH.'libraries/'.config_item('subclass_prefix').$class.EXT);\r
-               $is_subclass = TRUE;\r
-       }\r
-       else\r
-       {\r
-               if (file_exists(APPPATH.'libraries/'.$class.EXT))\r
-               {\r
-                       require(APPPATH.'libraries/'.$class.EXT);\r
-                       $is_subclass = FALSE;\r
-               }\r
-               else\r
-               {\r
-                       require(BASEPATH.'libraries/'.$class.EXT);\r
-                       $is_subclass = FALSE;\r
-               }\r
-       }\r
-\r
-       if ($instantiate == FALSE)\r
-       {\r
-               $objects[$class] = TRUE;\r
-               return $objects[$class];\r
-       }\r
-\r
-       if ($is_subclass == TRUE)\r
-       {\r
-               $name = config_item('subclass_prefix').$class;\r
-               $objects[$class] =& new $name();\r
-               return $objects[$class];\r
-       }\r
-\r
-       $name = ($class != 'Controller') ? 'CI_'.$class : $class;\r
-       \r
-       $objects[$class] =& new $name();\r
-       return $objects[$class];\r
-}\r
-\r
-/**\r
-* Loads the main config.php file\r
-*\r
-* @access      private\r
-* @return      array\r
-*/\r
-function &get_config()\r
-{\r
-       static $main_conf;\r
-\r
-       if ( ! isset($main_conf))\r
-       {\r
-               if ( ! file_exists(APPPATH.'config/config'.EXT))\r
-               {\r
-                       exit('The configuration file config'.EXT.' does not exist.');\r
-               }\r
-\r
-               require(APPPATH.'config/config'.EXT);\r
-\r
-               if ( ! isset($config) OR ! is_array($config))\r
-               {\r
-                       exit('Your config file does not appear to be formatted correctly.');\r
-               }\r
-\r
-               $main_conf[0] =& $config;\r
-       }\r
-       return $main_conf[0];\r
-}\r
-\r
-/**\r
-* Gets a config item\r
-*\r
-* @access      public\r
-* @return      mixed\r
-*/\r
-function config_item($item)\r
-{\r
-       static $config_item = array();\r
-\r
-       if ( ! isset($config_item[$item]))\r
-       {\r
-               $config =& get_config();\r
-\r
-               if ( ! isset($config[$item]))\r
-               {\r
-                       return FALSE;\r
-               }\r
-               $config_item[$item] = $config[$item];\r
-       }\r
-\r
-       return $config_item[$item];\r
-}\r
-\r
-\r
-/**\r
-* Error Handler\r
-*\r
-* This function lets us invoke the exception class and\r
-* display errors using the standard error template located\r
-* in application/errors/errors.php\r
-* This function will send the error page directly to the\r
-* browser and exit.\r
-*\r
-* @access      public\r
-* @return      void\r
-*/\r
-function show_error($message)\r
-{\r
-       $error =& load_class('Exceptions');\r
-       echo $error->show_error('An Error Was Encountered', $message);\r
-       exit;\r
-}\r
-\r
-\r
-/**\r
-* 404 Page Handler\r
-*\r
-* This function is similar to the show_error() function above\r
-* However, instead of the standard error template it displays\r
-* 404 errors.\r
-*\r
-* @access      public\r
-* @return      void\r
-*/\r
-function show_404($page = '')\r
-{\r
-       $error =& load_class('Exceptions');\r
-       $error->show_404($page);\r
-       exit;\r
-}\r
-\r
-\r
-/**\r
-* Error Logging Interface\r
-*\r
-* We use this as a simple mechanism to access the logging\r
-* class and send messages to be logged.\r
-*\r
-* @access      public\r
-* @return      void\r
-*/\r
-function log_message($level = 'error', $message, $php_error = FALSE)\r
-{\r
-       static $LOG;\r
-       \r
-       $config =& get_config();\r
-       if ($config['log_threshold'] == 0)\r
-       {\r
-               return;\r
-       }\r
-\r
-       $LOG =& load_class('Log');\r
-       $LOG->write_log($level, $message, $php_error);\r
-}\r
-\r
-/**\r
-* Exception Handler\r
-*\r
-* This is the custom exception handler that is declaired at the top\r
-* of Codeigniter.php.  The main reason we use this is permit\r
-* PHP errors to be logged in our own log files since we may\r
-* not have access to server logs. Since this function\r
-* effectively intercepts PHP errors, however, we also need\r
-* to display errors based on the current error_reporting level.\r
-* We do that with the use of a PHP error template.\r
-*\r
-* @access      private\r
-* @return      void\r
-*/\r
-function _exception_handler($severity, $message, $filepath, $line)\r
-{      \r
-        // We don't bother with "strict" notices since they will fill up\r
-        // the log file with information that isn't normally very\r
-        // helpful.  For example, if you are running PHP 5 and you\r
-        // use version 4 style class functions (without prefixes\r
-        // like "public", "private", etc.) you'll get notices telling\r
-        // you that these have been deprecated.\r
-       \r
-       if ($severity == E_STRICT)\r
-       {\r
-               return;\r
-       }\r
-\r
-       $error =& load_class('Exceptions');\r
-\r
-       // Should we display the error?\r
-       // We'll get the current error_reporting level and add its bits\r
-       // with the severity bits to find out.\r
-       \r
-       if (($severity & error_reporting()) == $severity)\r
-       {\r
-               $error->show_php_error($severity, $message, $filepath, $line);\r
-       }\r
-       \r
-       // Should we log the error?  No?  We're done...\r
-       $config =& get_config();\r
-       if ($config['log_threshold'] == 0)\r
-       {\r
-               return;\r
-       }\r
-\r
-       $error->log_exception($severity, $message, $filepath, $line);\r
-}\r
-\r
-\r
-\r
-/* End of file Common.php */\r
+<?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+/**
+ * CodeIgniter
+ *
+ * An open source application development framework for PHP 4.3.2 or newer
+ *
+ * @package            CodeIgniter
+ * @author             ExpressionEngine Dev Team
+ * @copyright  Copyright (c) 2008 - 2009, EllisLab, Inc.
+ * @license            http://codeigniter.com/user_guide/license.html
+ * @link               http://codeigniter.com
+ * @since              Version 1.0
+ * @filesource
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+* Determines if the current version of PHP is greater then the supplied value
+*
+* Since there are a few places where we conditionally test for PHP > 5
+* we'll set a static variable.
+*
+* @access      public
+* @param       string
+* @return      bool
+*/
+function is_php($version = '5.0.0')
+{
+       static $_is_php;
+       $version = (string)$version;
+       
+       if ( ! isset($_is_php[$version]))
+       {
+               $_is_php[$version] = (version_compare(PHP_VERSION, $version) < 0) ? FALSE : TRUE;
+       }
+
+       return $_is_php[$version];
+}
+
+// ------------------------------------------------------------------------
+
+/**
+ * Tests for file writability
+ *
+ * is_writable() returns TRUE on Windows servers when you really can't write to 
+ * the file, based on the read-only attribute.  is_writable() is also unreliable
+ * on Unix servers if safe_mode is on. 
+ *
+ * @access     private
+ * @return     void
+ */
+function is_really_writable($file)
+{      
+       // If we're on a Unix server with safe_mode off we call is_writable
+       if (DIRECTORY_SEPARATOR == '/' AND @ini_get("safe_mode") == FALSE)
+       {
+               return is_writable($file);
+       }
+
+       // For windows servers and safe_mode "on" installations we'll actually
+       // write a file then read it.  Bah...
+       if (is_dir($file))
+       {
+               $file = rtrim($file, '/').'/'.md5(rand(1,100));
+
+               if (($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)
+               {
+                       return FALSE;
+               }
+
+               fclose($fp);
+               @chmod($file, DIR_WRITE_MODE);
+               @unlink($file);
+               return TRUE;
+       }
+       elseif (($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)
+       {
+               return FALSE;
+       }
+
+       fclose($fp);
+       return TRUE;
+}
+
+// ------------------------------------------------------------------------
+
+/**
+* Class registry
+*
+* This function acts as a singleton.  If the requested class does not
+* exist it is instantiated and set to a static variable.  If it has
+* previously been instantiated the variable is returned.
+*
+* @access      public
+* @param       string  the class name being requested
+* @param       bool    optional flag that lets classes get loaded but not instantiated
+* @return      object
+*/
+function &load_class($class, $instantiate = TRUE)
+{
+       static $objects = array();
+
+       // Does the class exist?  If so, we're done...
+       if (isset($objects[$class]))
+       {
+               return $objects[$class];
+       }
+
+       // If the requested class does not exist in the application/libraries
+       // folder we'll load the native class from the system/libraries folder. 
+       if (file_exists(APPPATH.'libraries/'.config_item('subclass_prefix').$class.EXT))
+       {
+               require(BASEPATH.'libraries/'.$class.EXT);
+               require(APPPATH.'libraries/'.config_item('subclass_prefix').$class.EXT);
+               $is_subclass = TRUE;
+       }
+       else
+       {
+               if (file_exists(APPPATH.'libraries/'.$class.EXT))
+               {
+                       require(APPPATH.'libraries/'.$class.EXT);
+                       $is_subclass = FALSE;
+               }
+               else
+               {
+                       require(BASEPATH.'libraries/'.$class.EXT);
+                       $is_subclass = FALSE;
+               }
+       }
+
+       if ($instantiate == FALSE)
+       {
+               $objects[$class] = TRUE;
+               return $objects[$class];
+       }
+
+       if ($is_subclass == TRUE)
+       {
+               $name = config_item('subclass_prefix').$class;
+
+               $objects[$class] =& instantiate_class(new $name());
+               return $objects[$class];
+       }
+
+       $name = ($class != 'Controller') ? 'CI_'.$class : $class;
+
+       $objects[$class] =& instantiate_class(new $name());
+       return $objects[$class];
+}
+
+/**
+ * Instantiate Class
+ *
+ * Returns a new class object by reference, used by load_class() and the DB class.
+ * Required to retain PHP 4 compatibility and also not make PHP 5.3 cry.
+ *
+ * Use: $obj =& instantiate_class(new Foo());
+ * 
+ * @access     public
+ * @param      object
+ * @return     object
+ */
+function &instantiate_class(&$class_object)
+{
+       return $class_object;
+}
+
+/**
+* Loads the main config.php file
+*
+* @access      private
+* @return      array
+*/
+function &get_config()
+{
+       static $main_conf;
+
+       if ( ! isset($main_conf))
+       {
+               if ( ! file_exists(APPPATH.'config/config'.EXT))
+               {
+                       exit('The configuration file config'.EXT.' does not exist.');
+               }
+
+               require(APPPATH.'config/config'.EXT);
+
+               if ( ! isset($config) OR ! is_array($config))
+               {
+                       exit('Your config file does not appear to be formatted correctly.');
+               }
+
+               $main_conf[0] =& $config;
+       }
+       return $main_conf[0];
+}
+
+/**
+* Gets a config item
+*
+* @access      public
+* @return      mixed
+*/
+function config_item($item)
+{
+       static $config_item = array();
+
+       if ( ! isset($config_item[$item]))
+       {
+               $config =& get_config();
+
+               if ( ! isset($config[$item]))
+               {
+                       return FALSE;
+               }
+               $config_item[$item] = $config[$item];
+       }
+
+       return $config_item[$item];
+}
+
+
+/**
+* Error Handler
+*
+* This function lets us invoke the exception class and
+* display errors using the standard error template located
+* in application/errors/errors.php
+* This function will send the error page directly to the
+* browser and exit.
+*
+* @access      public
+* @return      void
+*/
+function show_error($message, $status_code = 500)
+{
+       $error =& load_class('Exceptions');
+       echo $error->show_error('An Error Was Encountered', $message, 'error_general', $status_code);
+       exit;
+}
+
+
+/**
+* 404 Page Handler
+*
+* This function is similar to the show_error() function above
+* However, instead of the standard error template it displays
+* 404 errors.
+*
+* @access      public
+* @return      void
+*/
+function show_404($page = '')
+{
+       $error =& load_class('Exceptions');
+       $error->show_404($page);
+       exit;
+}
+
+
+/**
+* Error Logging Interface
+*
+* We use this as a simple mechanism to access the logging
+* class and send messages to be logged.
+*
+* @access      public
+* @return      void
+*/
+function log_message($level = 'error', $message, $php_error = FALSE)
+{
+       static $LOG;
+       
+       $config =& get_config();
+       if ($config['log_threshold'] == 0)
+       {
+               return;
+       }
+
+       $LOG =& load_class('Log');
+       $LOG->write_log($level, $message, $php_error);
+}
+
+
+/**
+ * Set HTTP Status Header
+ *
+ * @access     public
+ * @param      int     the status code
+ * @param      string  
+ * @return     void
+ */
+function set_status_header($code = 200, $text = '')
+{
+       $stati = array(
+                                               200     => 'OK',
+                                               201     => 'Created',
+                                               202     => 'Accepted',
+                                               203     => 'Non-Authoritative Information',
+                                               204     => 'No Content',
+                                               205     => 'Reset Content',
+                                               206     => 'Partial Content',
+
+                                               300     => 'Multiple Choices',
+                                               301     => 'Moved Permanently',
+                                               302     => 'Found',
+                                               304     => 'Not Modified',
+                                               305     => 'Use Proxy',
+                                               307     => 'Temporary Redirect',
+
+                                               400     => 'Bad Request',
+                                               401     => 'Unauthorized',
+                                               403     => 'Forbidden',
+                                               404     => 'Not Found',
+                                               405     => 'Method Not Allowed',
+                                               406     => 'Not Acceptable',
+                                               407     => 'Proxy Authentication Required',
+                                               408     => 'Request Timeout',
+                                               409     => 'Conflict',
+                                               410     => 'Gone',
+                                               411     => 'Length Required',
+                                               412     => 'Precondition Failed',
+                                               413     => 'Request Entity Too Large',
+                                               414     => 'Request-URI Too Long',
+                                               415     => 'Unsupported Media Type',
+                                               416     => 'Requested Range Not Satisfiable',
+                                               417     => 'Expectation Failed',
+
+                                               500     => 'Internal Server Error',
+                                               501     => 'Not Implemented',
+                                               502     => 'Bad Gateway',
+                                               503     => 'Service Unavailable',
+                                               504     => 'Gateway Timeout',
+                                               505     => 'HTTP Version Not Supported'
+                                       );
+
+       if ($code == '' OR ! is_numeric($code))
+       {
+               show_error('Status codes must be numeric', 500);
+       }
+
+       if (isset($stati[$code]) AND $text == '')
+       {                               
+               $text = $stati[$code];
+       }
+       
+       if ($text == '')
+       {
+               show_error('No status text available.  Please check your status code number or supply your own message text.', 500);
+       }
+       
+       $server_protocol = (isset($_SERVER['SERVER_PROTOCOL'])) ? $_SERVER['SERVER_PROTOCOL'] : FALSE;
+
+       if (substr(php_sapi_name(), 0, 3) == 'cgi')
+       {
+               header("Status: {$code} {$text}", TRUE);
+       }
+       elseif ($server_protocol == 'HTTP/1.1' OR $server_protocol == 'HTTP/1.0')
+       {
+               header($server_protocol." {$code} {$text}", TRUE, $code);
+       }
+       else
+       {
+               header("HTTP/1.1 {$code} {$text}", TRUE, $code);
+       }
+}
+
+
+/**
+* Exception Handler
+*
+* This is the custom exception handler that is declaired at the top
+* of Codeigniter.php.  The main reason we use this is permit
+* PHP errors to be logged in our own log files since we may
+* not have access to server logs. Since this function
+* effectively intercepts PHP errors, however, we also need
+* to display errors based on the current error_reporting level.
+* We do that with the use of a PHP error template.
+*
+* @access      private
+* @return      void
+*/
+function _exception_handler($severity, $message, $filepath, $line)
+{      
+        // We don't bother with "strict" notices since they will fill up
+        // the log file with information that isn't normally very
+        // helpful.  For example, if you are running PHP 5 and you
+        // use version 4 style class functions (without prefixes
+        // like "public", "private", etc.) you'll get notices telling
+        // you that these have been deprecated.
+       
+       if ($severity == E_STRICT)
+       {
+               return;
+       }
+
+       $error =& load_class('Exceptions');
+
+       // Should we display the error?
+       // We'll get the current error_reporting level and add its bits
+       // with the severity bits to find out.
+       
+       if (($severity & error_reporting()) == $severity)
+       {
+               $error->show_php_error($severity, $message, $filepath, $line);
+       }
+       
+       // Should we log the error?  No?  We're done...
+       $config =& get_config();
+       if ($config['log_threshold'] == 0)
+       {
+               return;
+       }
+
+       $error->log_exception($severity, $message, $filepath, $line);
+}
+
+
+
+/* End of file Common.php */
 /* Location: ./system/codeigniter/Common.php */
\ No newline at end of file