* @version 2.0 */ // Message Types. define('MSG_ERR', 1); define('MSG_ERROR', MSG_ERR); define('MSG_WARNING', 2); define('MSG_NOTICE', 4); define('MSG_SUCCESS', 8); define('MSG_ALL', MSG_SUCCESS | MSG_NOTICE | MSG_WARNING | MSG_ERROR); require_once dirname(__FILE__) . '/Utilities.inc.php'; class App { // Name of this application. var $app = '_app_'; // If App::start has run successfully. var $running = false; // Instance of database object. var $db; // Array of query arguments will be carried persistently between requests. var $_carry_queries = array(); // Hash of global application parameters. var $_params = array(); // Default parameters. var $_param_defaults = array( // Public name and email address for this application. 'site_name' => null, 'site_email' => null, 'site_url' => '', // URL automatically determined by _SERVER['HTTP_HOST'] if not set here. // The location the user will go if the system doesn't knew where else to send them. 'redirect_home_url' => '/', // SSL URL used when redirecting with App::sslOn(). 'ssl_domain' => null, 'ssl_enabled' => false, // Character set for page output. Used in the Content-Type header and the HTML tag. 'character_set' => 'utf-8', // Human-readable format used to display dates. 'date_format' => 'd M Y', 'time_format' => 'h:i:s A', 'sql_date_format' => '%e %b %Y', 'sql_time_format' => '%k:%i', // Use php sessions? 'enable_session' => false, 'session_name' => 'Strangecode', 'session_use_cookies' => true, // Use database? 'enable_db' => false, // Use db-based sessions? 'enable_db_session_handler' => false, // DB passwords should be set as apache environment variables in httpd.conf, readable only by root. 'db_server' => 'localhost', 'db_name' => null, 'db_user' => null, 'db_pass' => null, // Database debugging. 'db_always_debug' => false, // TRUE = display all SQL queries. 'db_debug' => false, // TRUE = display db errors. 'db_die_on_failure' => false, // TRUE = script stops on db error. // For classes that require db tables, do we check that a table exists and create if missing? 'db_create_tables' => true, // The level of error reporting. Don't set this to 0 to suppress messages, instead use display_errors to control display. 'error_reporting' => E_ALL, // Don't display errors by default; it is preferable to log them to a file. 'display_errors' => false, // Directory in which to store log files. 'log_directory' => '', // PHP error log. 'php_error_log' => 'php_error_log', // General application log. 'log_filename' => 'app_error_log', // Logging priority can be any of the following, or false to deactivate: // LOG_EMERG system is unusable // LOG_ALERT action must be taken immediately // LOG_CRIT critical conditions // LOG_ERR error conditions // LOG_WARNING warning conditions // LOG_NOTICE normal, but significant, condition // LOG_INFO informational message // LOG_DEBUG debug-level message 'log_file_priority' => false, 'log_email_priority' => false, 'log_sms_priority' => false, 'log_screen_priority' => false, // Email address to receive log event emails. 'log_to_email_address' => null, // SMS Email address to receive log event SMS messages. 'log_to_sms_address' => null, // A key for calculating simple cryptographic signatures. Set using as an environment variables in the httpd.conf with 'SetEnv SIGNING_KEY '. 'signing_key' => 'aae6abd6209d82a691a9f96384a7634a', ); /** * This method enforces the singleton pattern for this class. Only one application is running at a time. * * @return object Reference to the global SessionCache object. * @access public * @static */ function &getInstance($app=null) { static $instance = null; if ($instance === null) { $instance = new App($app); } return $instance; } /** * Constructor. */ function App($app=null) { if (isset($app)) { $this->app .= $app; } // Initialize default parameters. $this->_params = array_merge($this->_params, $this->_param_defaults); } /** * Set (or overwrite existing) parameters by passing an array of new parameters. * * @access public * @param array $param Array of parameters (key => val pairs). */ function setParam($param=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (isset($param) && is_array($param)) { // Merge new parameters with old overriding only those passed. $this->_params = array_merge($this->_params, $param); } } /** * Return the value of a parameter. * * @access public * @param string $param The key of the parameter to return. * @return mixed Parameter value, or null if not existing. */ function &getParam($param=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if ($param === null) { return $this->_params; } else if (isset($this->_params[$param])) { return $this->_params[$param]; } else { trigger_error(sprintf('Parameter is not set: %s', $param), E_USER_NOTICE); return null; } } /** * Begin running this application. * * @access public * @author Quinn Comendant * @since 15 Jul 2005 00:32:21 */ function start() { if ($this->running) { return false; } // Error reporting. ini_set('error_reporting', $this->getParam('error_reporting')); ini_set('display_errors', $this->getParam('display_errors')); ini_set('log_errors', true); if (is_dir($this->getParam('log_directory')) && is_writable($this->getParam('log_directory'))) { ini_set('error_log', $this->getParam('log_directory') . '/' . $this->getParam('php_error_log')); } /** * 1. Start Database. */ if (true === $this->getParam('enable_db')) { // DB connection parameters taken from environment variables in the httpd.conf file, readable only by root. if (!empty($_SERVER['DB_SERVER'])) { $this->setParam(array('db_server' => $_SERVER['DB_SERVER'])); } if (!empty($_SERVER['DB_NAME'])) { $this->setParam(array('db_name' => $_SERVER['DB_NAME'])); } if (!empty($_SERVER['DB_USER'])) { $this->setParam(array('db_user' => $_SERVER['DB_USER'])); } if (!empty($_SERVER['DB_PASS'])) { $this->setParam(array('db_pass' => $_SERVER['DB_PASS'])); } // The only instance of the DB object. require_once dirname(__FILE__) . '/DB.inc.php'; $this->db =& DB::getInstance(); $this->db->setParam(array( 'db_server' => $this->getParam('db_server'), 'db_name' => $this->getParam('db_name'), 'db_user' => $this->getParam('db_user'), 'db_pass' => $this->getParam('db_pass'), 'db_always_debug' => $this->getParam('db_always_debug'), 'db_debug' => $this->getParam('db_debug'), 'db_die_on_failure' => $this->getParam('db_die_on_failure'), )); // Connect to database. $this->db->connect(); } /** * 2. Start PHP session. */ // Skip session for some user agents. if (preg_match('/Atomz|ApacheBench|Wget/i', getenv('HTTP_USER_AGENT'))) { $this->setParam(array('enable_session' => false)); } if (true === $this->getParam('enable_session')) { // Set the session ID to one provided in GET/POST. This is necessary for linking // between domains and keeping the same session. if ($ses = getFormData($this->getParam('session_name'), false)) { session_id($ses); } if (true === $this->getParam('enable_db_session_handler') && true === $this->getParam('enable_db')) { // Database session handling. require_once dirname(__FILE__) . '/DBSessionHandler.inc.php'; $db_save_handler = new DBSessionHandler($this->db, array( 'db_table' => 'session_tbl', 'create_table' => $this->getParam('db_create_tables'), )); } // Session parameters. ini_set('session.use_cookies', $this->getParam('session_use_cookies')); ini_set('session.use_trans_sid', false); ini_set('session.entropy_file', '/dev/urandom'); ini_set('session.entropy_length', '512'); session_name($this->getParam('session_name')); // Start the session. session_start(); if (!isset($_SESSION[$this->app])) { // Access session data using: $_SESSION['...']. // Initialize here _after_ session has started. $_SESSION[$this->app] = array( 'messages' => array(), 'boomerang' => array('url'), ); } } /** * 3. Misc setup. */ // Script URI will be something like http://host.name.tld (no ending slash) // and is used whenever a URL need be used to the current site. // Not available on cli scripts obviously. if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_url')) { $this->setParam(array('site_url' => sprintf('%s://%s', ('on' == getenv('HTTPS') ? 'https' : 'http'), getenv('HTTP_HOST')))); } // A key for calculating simple cryptographic signatures. if (isset($_SERVER['SIGNING_KEY'])) { $this->setParam(array('signing_key' => $_SERVER['SIGNING_KEY'])); } // Character set. This should also be printed in the html header template. header('Content-type: text/html; charset=' . $this->getParam('character_set')); $this->running = true; } /** * Stop running this application. * * @access public * @author Quinn Comendant * @since 17 Jul 2005 17:20:18 */ function stop() { session_write_close(); restore_include_path(); $this->running = false; if (true === $this->getParam('enable_db')) { $this->db->close(); } } /** * Add a message to the session, which is printed in the header. * Just a simple way to print messages to the user. * * @access public * * @param string $message The text description of the message. * @param int $type The type of message: MSG_NOTICE, * MSG_SUCCESS, MSG_WARNING, or MSG_ERR. * @param string $file __FILE__. * @param string $line __LINE__. */ function raiseMsg($message, $type=MSG_NOTICE, $file=null, $line=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } $message = trim($message); if (!$this->running || '' == $message) { $this->logMsg(sprintf('Canceled method call %s, application not running or message is an empty string.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } // Save message in session under unique key to avoid duplicate messages. $msg_id = md5($type . $message . $file . $line); $_SESSION[$this->app]['messages'][$msg_id] = array( 'type' => $type, 'message' => $message, 'file' => $file, 'line' => $line, 'count' => (isset($_SESSION[$this->app]['messages'][$msg_id]['count']) ? (1 + $_SESSION[$this->app]['messages'][$msg_id]['count']) : 1) ); if (!in_array($type, array(MSG_NOTICE, MSG_SUCCESS, MSG_WARNING, MSG_ERR))) { $this->logMsg(sprintf('Invalid MSG_* type: %s', $type), LOG_DEBUG, __FILE__, __LINE__); } } /** * Returns an array of the raised messages. * * @access public * @return array List of messags in FIFO order. * @author Quinn Comendant * @since 21 Dec 2005 13:09:20 */ function getRaisedMessages() { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } $output = array(); while (isset($_SESSION[$this->app]['messages']) && $message = array_shift($_SESSION[$this->app]['messages'])) { $output[] = $message; } return $output; } /** * Resets the message list. * * @access public * @author Quinn Comendant * @since 21 Dec 2005 13:21:54 */ function clearRaisedMessages() { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } $_SESSION[$this->app]['messages'] = array(); } /** * Prints the HTML for displaying raised messages. * * @access public * @author Quinn Comendant * @since 15 Jul 2005 01:39:14 */ function printRaisedMessages() { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } while (isset($_SESSION[$this->app]['messages']) && $message = array_shift($_SESSION[$this->app]['messages'])) { ?>
0 && $this->getParam('display_errors')) { echo "\n'; } switch ($message['type']) { case MSG_ERR: echo '
' . $message['message'] . '
'; break; case MSG_WARNING: echo '
' . $message['message'] . '
'; break; case MSG_SUCCESS: echo '
' . $message['message'] . '
'; break; case MSG_NOTICE: default: echo '
' . $message['message'] . '
'; break; } ?>
logPriorityToString($priority)) { $this->logMsg(sprintf('Log priority %s not defined. (Message: %s)', $priority, $message), LOG_EMERG, $file, $line); $priority = LOG_EMERG; } // If log file is not specified, don't log to a file. if (!$this->getParam('log_directory') || !$this->getParam('log_filename') || !is_dir($this->getParam('log_directory')) || !is_writable($this->getParam('log_directory'))) { $this->setParam(array('log_file_priority' => false)); // We must use trigger_error to report this problem rather than calling App::logMsg, which might lead to an infinite loop. trigger_error(sprintf('Codebase error: log directory (%s) not found or writable.', $this->getParam('log_directory')), E_USER_NOTICE); } // Make sure to log in the system's locale. $locale = setlocale(LC_TIME, 0); setlocale(LC_TIME, 'C'); // Strip HTML tags except any with more than 7 characters because that's probably not a HTML tag, e.g. . preg_match_all('/(<[^>\s]{7,})[^>]*>/', $message, $strip_tags_allow); $message = strip_tags(preg_replace('/\s+/', ' ', $message), (!empty($strip_tags_allow[1]) ? join('> ', $strip_tags_allow[1]) . '>' : null)); // Store this event under a unique key, counting each time it occurs so that it only gets reported a limited number of times. $msg_id = md5($message . $priority . $file . $line); if (isset($previous_events[$msg_id])) { $previous_events[$msg_id]++; if ($previous_events[$msg_id] == 2) { $this->logMsg(sprintf('%s (Event repeated %s or more times)', $message, $previous_events[$msg_id]), $priority, $file, $line); } return false; } else { $previous_events[$msg_id] = 1; } // Data to be stored for a log event. $event = array( 'date' => date('Y-m-d H:i:s'), 'remote ip' => getRemoteAddr(), 'pid' => (substr(PHP_OS, 0, 3) != 'WIN' ? posix_getpid() : ''), 'type' => $this->logPriorityToString($priority), 'file:line' => "$file : $line", 'url' => (isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : ''), 'message' => $message ); // FILE ACTION if ($this->getParam('log_file_priority') && $priority <= $this->getParam('log_file_priority')) { $event_str = '[' . join('] [', $event) . ']'; error_log($event_str . "\n", 3, $this->getParam('log_directory') . '/' . $this->getParam('log_filename')); } // EMAIL ACTION if ($this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority')) { $subject = sprintf('[%s %s] %s', getenv('HTTP_HOST'), $event['type'], $message); $email_msg = sprintf("A %s log event occured on %s\n\n", $event['type'], getenv('HTTP_HOST')); $headers = "From: codebase@strangecode.com"; foreach ($event as $k=>$v) { $email_msg .= sprintf("%-11s%s\n", $k, $v); } mail($this->getParam('log_to_email_address'), $subject, $email_msg, $headers, '-f codebase@strangecode.com'); } // SMS ACTION if ($this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority')) { $subject = sprintf('[%s %s]', getenv('HTTP_HOST'), $priority); $sms_msg = sprintf('%s [%s:%s]', $event['message'], basename($file), $line); $headers = "From: codebase@strangecode.com"; mail($this->getParam('log_to_sms_address'), $subject, $sms_msg, $headers, '-f codebase@strangecode.com'); } // SCREEN ACTION if ($this->getParam('log_screen_priority') && $priority <= $this->getParam('log_screen_priority')) { echo "[{$event['date']}] [{$event['type']}] [{$event['file:line']}] [{$event['message']}]\n"; } // Restore original locale. setlocale(LC_TIME, $locale); } /** * Returns the string representation of a LOG_* integer constant. * * @param int $priority The LOG_* integer constant. * * @return The string representation of $priority. */ function logPriorityToString ($priority) { $priorities = array( LOG_EMERG => 'emergency', LOG_ALERT => 'alert', LOG_CRIT => 'critical', LOG_ERR => 'error', LOG_WARNING => 'warning', LOG_NOTICE => 'notice', LOG_INFO => 'info', LOG_DEBUG => 'debug' ); if (isset($priorities[$priority])) { return $priorities[$priority]; } else { return false; } } /** * Sets which query arguments will be carried persistently between requests. * Values in the _carry_queries array will be copied to URLs (via App::url()) and * to hidden input values (via printHiddenSession()). * * @access public * @param string $query_key The key of the query argument to save. * @author Quinn Comendant * @since 14 Nov 2005 19:24:52 */ function carryQuery($query_key) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } // If not already set, and there is a non-empty value provided in the request... if (!isset($this->_carry_queries[$query_key]) && getFormData($query_key, false)) { // Copy the value of the specified query argument into the _carry_queries array. $this->_carry_queries[$query_key] = getFormData($query_key); } } /** * Outputs a fully qualified URL with a query of all the used (ie: not empty) * keys and values, including optional queries. This allows mindless retention * of query arguments across page requests. If cookies are not * used, the session id will be propogated in the URL. * * @param string $url The initial url * @param mixed $carry_args Additional url arguments to carry in the query, * or FALSE to prevent carrying queries. Can be any of the following formats: * array('key1', key2', key3') <-- to save these keys if in the form data. * array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data. * false <-- To not carry any queries. If URL already has queries those will be retained. * * @param mixed $always_include_sid Always add the session id, even if using_trans_sid = true. This is required when * URL starts with http, since PHP using_trans_sid doesn't do those and also for * header('Location...') redirections. * * @return string url with attached queries and, if not using cookies, the session id */ function url($url, $carry_args=null, $always_include_sid=false) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } // Get any provided query arguments to include in the final URL. // If FALSE is a provided here, DO NOT carry the queries. $do_carry_queries = true; $one_time_carry_queries = array(); if (!is_null($carry_args)) { if (is_array($carry_args) && !empty($carry_args)) { foreach ($carry_args as $key=>$arg) { // Get query from appropriate source. if (false === $arg) { $do_carry_queries = false; } else if (false !== getFormData($arg, false)) { $one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available. } else if (!is_numeric($key) && '' != $arg) { $one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data). } } } else if (false !== getFormData($carry_args, false)) { $one_time_carry_queries[$carry_args] = getFormData($carry_args); } else if (false === $carry_args) { $do_carry_queries = false; } } // Get the first delimiter that is needed in the url. $delim = strpos($url, '?') !== false ? ini_get('arg_separator.output') : '?'; $q = ''; if ($do_carry_queries) { // Join the global _carry_queries and local one_time_carry_queries. $query_args = urlEncodeArray(array_merge($this->_carry_queries, $one_time_carry_queries)); foreach ($query_args as $key=>$val) { // Check value is set and value does not already exist in the url. if (!preg_match('/[?&]' . preg_quote($key) . '=/', $url)) { $q .= $delim . $key . '=' . $val; $delim = ini_get('arg_separator.output'); } } } // Include the necessary SID if the following is true: // - no cookie in http request OR cookies disabled in App // - sessions are enabled // - the link stays on our site // - transparent SID propogation with session.use_trans_sid is not being used OR url begins with protocol (using_trans_sid has no effect here) // OR // - we must include the SID because we say so (it's used in a context where cookies will not be effective, ie. moving from http to https) // AND // - the SID is not already in the query. if ( ( ( ( !isset($_COOKIE[session_name()]) || !$this->getParam('session_use_cookies') ) && $this->getParam('enable_session') && isMyDomain($url) && ( !ini_get('session.use_trans_sid') || preg_match('!^(http|https)://!i', $url) ) ) || $always_include_sid ) && !preg_match('/[?&]' . preg_quote(session_name()) . '=/', $url) ) { $url .= $q . $delim . session_name() . '=' . session_id(); return $url; } else { $url .= $q; return $url; } } /** * Returns a HTML-friendly URL processed with App::url and & replaced with & * * @access public * @param string $url Input URL to parse. * @return string URL with App::url() and htmlentities() applied. * @author Quinn Comendant * @since 09 Dec 2005 17:58:45 */ function oHREF($url, $carry_args=null, $always_include_sid=false) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } $url = $this->url($url, $carry_args, $always_include_sid); // Replace any & not followed by an html or unicode entity with it's & equivalent. $url = preg_replace('/&(?![\w\d#]{1,10};)/', '&', $url); return $url; } /** * Prints a hidden form element with the PHPSESSID when cookies are not used, as well * as hidden form elements for GET_VARS that might be in use. * * @param mixed $carry_args Additional url arguments to carry in the query, * or FALSE to prevent carrying queries. Can be any of the following formats: * array('key1', key2', key3') <-- to save these keys if in the form data. * array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data. * false <-- To not carry any queries. If URL already has queries those will be retained. */ function printHiddenSession($carry_args=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } // Get any provided query arguments to include in the final hidden form data. // If FALSE is a provided here, DO NOT carry the queries. $do_carry_queries = true; $one_time_carry_queries = array(); if (!is_null($carry_args)) { if (is_array($carry_args) && !empty($carry_args)) { foreach ($carry_args as $key=>$arg) { // Get query from appropriate source. if (false === $arg) { $do_carry_queries = false; } else if (false !== getFormData($arg, false)) { $one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available. } else if (!is_numeric($key) && '' != $arg) { $one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data). } } } else if (false !== getFormData($carry_args, false)) { $one_time_carry_queries[$carry_args] = getFormData($carry_args); } else if (false === $carry_args) { $do_carry_queries = false; } } // For each existing POST value, we create a hidden input to carry it through a form. if ($do_carry_queries) { // Join the global _carry_queries and local one_time_carry_queries. // urlencode is not used here, not for form data! $query_args = array_merge($this->_carry_queries, $one_time_carry_queries); foreach ($query_args as $key=>$val) { echo ''; } } // Include the SID if cookies are disabled. if (!isset($_COOKIE[session_name()]) && !ini_get('session.use_trans_sid')) { echo ''; } } /** * Uses an http header to redirect the client to the given $url. If sessions are not used * and the session is not already defined in the given $url, the SID is appended as a URI query. * As with all header generating functions, make sure this is called before any other output. * * @param string $url The URL the client will be redirected to. * @param mixed $carry_args Additional url arguments to carry in the query, * or FALSE to prevent carrying queries. Can be any of the following formats: * -array('key1', key2', key3') <-- to save these keys if in the form data. * -array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data. * -false <-- To not carry any queries. If URL already has queries those will be retained. * @param bool $always_include_sid Force session id to be added to Location header. */ function dieURL($url, $carry_args=null, $always_include_sid=false) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } if ('' == $url) { // If URL is not specified, use the redirect_home_url. $url = $this->getParam('redirect_home_url'); } if (preg_match('!^/!', $url)) { // If relative URL is given, prepend correct local hostname. $scheme = 'on' == getenv('HTTPS') ? 'https' : 'http'; $host = getenv('HTTP_HOST'); $url = sprintf('%s://%s%s', $scheme, $host, $url); } $url = $this->url($url, $carry_args, $always_include_sid); header(sprintf('Location: %s', $url)); $this->logMsg(sprintf('dieURL: %s', $url), LOG_DEBUG, __FILE__, __LINE__); // End this application. // Recommended, although I'm not sure it's necessary: http://cn2.php.net/session_write_close $this->stop(); die; } /* * Redirects a user by calling App::dieURL(). It will use: * 1. the stored boomerang URL, it it exists * 2. a specified $default_url, it it exists * 3. the referring URL, it it exists. * 4. redirect_home_url configuration variable. * * @access public * @param string $id Identifier for this script. * @param mixed $carry_args Additional arguments to carry in the URL automatically (see App::oHREF()). * @param string $default_url A default URL if there is not a valid specified boomerang URL. * @return bool False if the session is not running. No return otherwise. * @author Quinn Comendant * @since 31 Mar 2006 19:17:00 */ function dieBoomerangURL($id=null, $carry_args=null, $default_url=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } // Get URL from stored boomerang. Allow non specific URL if ID not valid. if ($this->validBoomerangURL($id, true)) { if (isset($id) && isset($_SESSION[$this->app]['boomerang']['url'][$id])) { $url = $_SESSION[$this->app]['boomerang']['url'][$id]; $this->logMsg(sprintf('dieBoomerangURL(%s) found: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); } else { $url = end($_SESSION[$this->app]['boomerang']['url']); $this->logMsg(sprintf('dieBoomerangURL(%s) using: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); } // Delete stored boomerang. $this->deleteBoomerangURL($id); } else if (isset($default_url)) { $url = $default_url; } else if (!refererIsMe()) { // Ensure that the redirecting page is not also the referrer. $url = getenv('HTTP_REFERER'); $this->logMsg(sprintf('dieBoomerangURL(%s) using referrer: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); } else { // If URL is not specified, use the redirect_home_url. $url = $this->getParam('redirect_home_url'); $this->logMsg(sprintf('dieBoomerangURL(%s) not found, using redirect_home_url: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); } // A redirection will never happen immediately twice. // Set the time so ensure this doesn't happen. $_SESSION[$this->app]['boomerang']['time'] = time(); $this->dieURL($url, $carry_args); } /** * Set the URL to return to when App::dieBoomerangURL() is called. * * @param string $url A fully validated URL. * @param bool $id An identification tag for this url. * FIXME: url garbage collection? */ function setBoomerangURL($url=null, $id=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } // A redirection will never happen immediately after setting the boomerangURL. // Set the time so ensure this doesn't happen. See App::validBoomerangURL for more. if ('' != $url && is_string($url)) { // Delete any boomerang request keys in the query string. $url = preg_replace('/boomerang=[\w]+/', '', $url); if (isset($_SESSION[$this->app]['boomerang']['url']) && is_array($_SESSION[$this->app]['boomerang']['url']) && !empty($_SESSION[$this->app]['boomerang']['url'])) { // If the URL currently exists in the boomerang array, delete. while ($existing_key = array_search($url, $_SESSION[$this->app]['boomerang']['url'])) { unset($_SESSION[$this->app]['boomerang']['url'][$existing_key]); } } if (isset($id)) { $_SESSION[$this->app]['boomerang']['url'][$id] = $url; } else { $_SESSION[$this->app]['boomerang']['url'][] = $url; } $this->logMsg(sprintf('setBoomerangURL(%s): %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); return true; } else { $this->logMsg(sprintf('setBoomerangURL(%s) is empty!', $id, $url), LOG_NOTICE, __FILE__, __LINE__); return false; } } /** * Return the URL set for the specified $id. * * @param string $id An identification tag for this url. */ function getBoomerangURL($id=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } if (isset($id)) { if (isset($_SESSION[$this->app]['boomerang']['url'][$id])) { return $_SESSION[$this->app]['boomerang']['url'][$id]; } else { return ''; } } else if (is_array($_SESSION[$this->app]['boomerang']['url'])) { return end($_SESSION[$this->app]['boomerang']['url']); } else { return false; } } /** * Delete the URL set for the specified $id. * * @param string $id An identification tag for this url. */ function deleteBoomerangURL($id=null) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } $this->logMsg(sprintf('deleteBoomerangURL(%s): %s', $id, $this->getBoomerangURL($id)), LOG_DEBUG, __FILE__, __LINE__); if (isset($id) && isset($_SESSION[$this->app]['boomerang']['url'][$id])) { unset($_SESSION[$this->app]['boomerang']['url'][$id]); } else if (is_array($_SESSION[$this->app]['boomerang']['url'])) { array_pop($_SESSION[$this->app]['boomerang']['url']); } } /** * Check if a valid boomerang URL value has been set. A boomerang URL is considered * valid if: 1) it is not empty, 2) it is not the current URL, and 3) has not been accessed within n seconds. * * @return bool True if it is set and valid, false otherwise. */ function validBoomerangURL($id=null, $use_nonspecificboomerang=false) { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (!$this->running) { $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_DEBUG, __FILE__, __LINE__); return false; } if (!isset($_SESSION[$this->app]['boomerang']['url'])) { $this->logMsg(sprintf('validBoomerangURL(%s) no boomerang URL set.', $id), LOG_DEBUG, __FILE__, __LINE__); return false; } // Time is the timestamp of a boomerangURL redirection, or setting of a boomerangURL. // a boomerang redirection will always occur at least several seconds after the last boomerang redirect // or a boomerang being set. $boomerang_time = isset($_SESSION[$this->app]['boomerang']['time']) ? $_SESSION[$this->app]['boomerang']['time'] : 0; $url = ''; if (isset($id) && isset($_SESSION[$this->app]['boomerang']['url'][$id])) { $url = $_SESSION[$this->app]['boomerang']['url'][$id]; } else if (!isset($id) || $use_nonspecificboomerang) { // Use non specific boomerang if available. $url = end($_SESSION[$this->app]['boomerang']['url']); } $this->logMsg(sprintf('validBoomerangURL(%s) testing: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); if ('' == $url) { $this->logMsg(sprintf('validBoomerangURL(%s) not valid, empty!', $id), LOG_DEBUG, __FILE__, __LINE__); return false; } if ($url == absoluteMe()) { // The URL we are directing to is the current page. $this->logMsg(sprintf('validBoomerangURL(%s) not valid, same as absoluteMe: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); return false; } if ($boomerang_time >= (time() - 2)) { // Last boomerang direction was more than 2 seconds ago. $this->logMsg(sprintf('validBoomerangURL(%s) not valid, boomerang_time too short: %s', $id, time() - $boomerang_time), LOG_DEBUG, __FILE__, __LINE__); return false; } $this->logMsg(sprintf('validBoomerangURL(%s) is valid: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); return true; } /** * Force the user to connect via https (port 443) by redirecting them to * the same page but with https. */ function sslOn() { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if (function_exists('apache_get_modules')) { $modules = apache_get_modules(); } else { // It's safe to assume we have mod_ssl if we can't determine otherwise. $modules = array('mod_ssl'); } if ('' == getenv('HTTPS') && $this->getParam('ssl_enabled') && in_array('mod_ssl', $modules)) { $this->raiseMsg(sprintf(_("Secure SSL connection made to %s"), $this->getParam('ssl_domain')), MSG_NOTICE, __FILE__, __LINE__); // Always append session because some browsers do not send cookie when crossing to SSL URL. $this->dieURL('https://' . $this->getParam('ssl_domain') . getenv('REQUEST_URI'), null, true); } } /** * to enforce the user to connect via http (port 80) by redirecting them to * a http version of the current url. */ function sslOff() { if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) { $this =& App::getInstance(); } if ('' != getenv('HTTPS')) { $this->dieURL('http://' . getenv('HTTP_HOST') . getenv('REQUEST_URI'), null, true); } } } // End. ?>