Context Navigation

App.inc.php @ 661

Last change on this file since 661 was 498, checked in by anonymous, 10 years ago
Hotfix for site version bug.
File size: 59.5 KB

Rev	Line
[1]	1	<?php
	2	/**
[362]	3	* The Strangecode Codebase - a general application development framework for PHP
	4	* For details visit the project site: <http://trac.strangecode.com/codebase/>
[396]	5	* Copyright 2001-2012 Strangecode, LLC
[452]	6	*
[362]	7	* This file is part of The Strangecode Codebase.
	8	*
	9	* The Strangecode Codebase is free software: you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License as published by the
	11	* Free Software Foundation, either version 3 of the License, or (at your option)
	12	* any later version.
[452]	13	*
[362]	14	* The Strangecode Codebase is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	16	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
	17	* details.
[452]	18	*
[362]	19	* You should have received a copy of the GNU General Public License along with
	20	* The Strangecode Codebase. If not, see <http://www.gnu.org/licenses/>.
	21	*/
	22
	23	/**
[1]	24	* App.inc.php
	25	*
	26	* Primary application framework class.
	27	*
	28	* @author Quinn Comendant <quinn@strangecode.com>
[136]	29	* @version 2.1
[1]	30	*/
[42]	31
[37]	32	// Message Types.
	33	define('MSG_ERR', 1);
	34	define('MSG_ERROR', MSG_ERR);
[1]	35	define('MSG_WARNING', 2);
[37]	36	define('MSG_NOTICE', 4);
	37	define('MSG_SUCCESS', 8);
[119]	38	define('MSG_ALL', MSG_SUCCESS \| MSG_NOTICE \| MSG_WARNING \| MSG_ERROR);
[1]	39
	40	require_once dirname(__FILE__) . '/Utilities.inc.php';
	41
	42	class App {
[42]	43
[487]	44	// Minimum version of PHP required for this version of the Codebase.
	45	const CODEBASE_MIN_PHP_VERSION = '5.3.0';
	46
[468]	47	// A place to keep an object instance for the singleton pattern.
[484]	48	protected static $instance = null;
[468]	49
[136]	50	// Namespace of this application instance.
[484]	51	protected $_ns;
[1]	52
[136]	53	// If $app->start has run successfully.
[468]	54	public $running = false;
[1]	55
	56	// Instance of database object.
[468]	57	public $db;
[42]	58
[20]	59	// Array of query arguments will be carried persistently between requests.
[484]	60	protected $_carry_queries = array();
[1]	61
[136]	62	// Dictionary of global application parameters.
[484]	63	protected $_params = array();
[1]	64
	65	// Default parameters.
[484]	66	protected $_param_defaults = array(
[1]	67
	68	// Public name and email address for this application.
	69	'site_name' => null,
[390]	70	'site_email' => '', // Set to no-reply@HTTP_HOST if not set here.
[39]	71	'site_url' => '', // URL automatically determined by _SERVER['HTTP_HOST'] if not set here.
[318]	72	'images_path' => '', // Location for codebase-generated interface widgets (ex: "/admin/i").
[491]	73	'site_version_file' => 'docs/version.txt', // File containing version number of this app, relative to the include path.
[1]	74
[136]	75	// The location the user will go if the system doesn't know where else to send them.
[1]	76	'redirect_home_url' => '/',
[42]	77
[136]	78	// SSL URL used when redirecting with $app->sslOn().
[1]	79	'ssl_domain' => null,
	80	'ssl_enabled' => false,
[42]	81
[20]	82	// Character set for page output. Used in the Content-Type header and the HTML <meta content-type> tag.
[1]	83	'character_set' => 'utf-8',
	84
	85	// Human-readable format used to display dates.
	86	'date_format' => 'd M Y',
[101]	87	'time_format' => 'h:i:s A',
[1]	88	'sql_date_format' => '%e %b %Y',
	89	'sql_time_format' => '%k:%i',
	90
	91	// Use php sessions?
	92	'enable_session' => false,
[242]	93	'session_name' => '_session',
[1]	94	'session_use_cookies' => true,
[452]	95
[293]	96	// Pass the session-id through URLs if cookies are not enabled?
	97	// Disable this to prevent session ID theft.
[242]	98	'session_use_trans_sid' => false,
[42]	99
[1]	100	// Use database?
	101	'enable_db' => false,
	102
	103	// Use db-based sessions?
	104	'enable_db_session_handler' => false,
[42]	105
[1]	106	// DB passwords should be set as apache environment variables in httpd.conf, readable only by root.
	107	'db_server' => 'localhost',
	108	'db_name' => null,
	109	'db_user' => null,
	110	'db_pass' => null,
	111
	112	// Database debugging.
	113	'db_always_debug' => false, // TRUE = display all SQL queries.
	114	'db_debug' => false, // TRUE = display db errors.
	115	'db_die_on_failure' => false, // TRUE = script stops on db error.
[42]	116
[1]	117	// For classes that require db tables, do we check that a table exists and create if missing?
[32]	118	'db_create_tables' => true,
[1]	119
[136]	120	// The level of error reporting. Don't change this to suppress messages, instead use display_errors to control display.
[1]	121	'error_reporting' => E_ALL,
	122
	123	// Don't display errors by default; it is preferable to log them to a file.
	124	'display_errors' => false,
[42]	125
[1]	126	// Directory in which to store log files.
[19]	127	'log_directory' => '',
[1]	128
	129	// PHP error log.
	130	'php_error_log' => 'php_error_log',
	131
	132	// General application log.
[136]	133	'log_filename' => 'app_log',
[1]	134
[390]	135	// Don't email or SMS duplicate messages that happen more often than this value (in seconds).
	136	'log_multiple_timeout' => 3600, // Hourly
[341]	137
[1]	138	// Logging priority can be any of the following, or false to deactivate:
	139	// LOG_EMERG system is unusable
	140	// LOG_ALERT action must be taken immediately
	141	// LOG_CRIT critical conditions
	142	// LOG_ERR error conditions
	143	// LOG_WARNING warning conditions
	144	// LOG_NOTICE normal, but significant, condition
	145	// LOG_INFO informational message
	146	// LOG_DEBUG debug-level message
[174]	147	'log_file_priority' => LOG_INFO,
[342]	148	'log_email_priority' => false,
[1]	149	'log_sms_priority' => false,
	150	'log_screen_priority' => false,
[42]	151
[390]	152	// Email address to receive log event emails. Use multiple addresses by separating them with commas.
[342]	153	'log_to_email_address' => null,
[42]	154
[392]	155	// SMS Email address to receive log event SMS messages. Use multiple addresses by separating them with commas.
[1]	156	'log_to_sms_address' => null,
[42]	157
[406]	158	// Should we avoid logging repeated logMsg() events? You might want to set this false if you need to see more accurate logging, particularly for long-running scripts.
	159	'log_ignore_repeated_events' => true,
	160
[348]	161	// Temporary files directory.
	162	'tmp_dir' => '/tmp',
[343]	163
[19]	164	// A key for calculating simple cryptographic signatures. Set using as an environment variables in the httpd.conf with 'SetEnv SIGNING_KEY <key>'.
[136]	165	// Existing password hashes rely on the same key/salt being used to compare encryptions.
	166	// Don't change this unless you know existing hashes or signatures will not be affected!
[1]	167	'signing_key' => 'aae6abd6209d82a691a9f96384a7634a',
	168	);
[42]	169
[1]	170	/**
	171	* Constructor.
	172	*/
[468]	173	public function __construct($namespace='')
[1]	174	{
[136]	175	// Set namespace of application instance.
[154]	176	$this->_ns = $namespace;
[42]	177
[1]	178	// Initialize default parameters.
	179	$this->_params = array_merge($this->_params, $this->_param_defaults);
[452]	180
[172]	181	// Begin timing script.
	182	require_once dirname(__FILE__) . '/ScriptTimer.inc.php';
	183	$this->timer = new ScriptTimer();
	184	$this->timer->start('_app');
[1]	185	}
	186
	187	/**
[468]	188	* This method enforces the singleton pattern for this class. Only one application is running at a time.
	189	*
	190	* $param string $namespace Name of this application.
	191	* @return object Reference to the global Cache object.
	192	* @access public
	193	* @static
	194	*/
	195	public static function &getInstance($namespace='')
	196	{
	197	if (self::$instance === null) {
	198	// TODO: Yep, having a namespace with one singletone instance is not very useful.
	199	self::$instance = new self($namespace);
	200	}
	201
	202	return self::$instance;
	203	}
	204
	205	/**
[1]	206	* Set (or overwrite existing) parameters by passing an array of new parameters.
	207	*
	208	* @access public
	209	* @param array $param Array of parameters (key => val pairs).
	210	*/
[468]	211	public function setParam($param=null)
[1]	212	{
	213	if (isset($param) && is_array($param)) {
	214	// Merge new parameters with old overriding only those passed.
[136]	215	$this->_params = array_merge($this->_params, $param);
[1]	216	}
	217	}
	218
	219	/**
	220	* Return the value of a parameter.
	221	*
	222	* @access public
	223	* @param string $param The key of the parameter to return.
	224	* @return mixed Parameter value, or null if not existing.
	225	*/
[468]	226	public function getParam($param=null)
[1]	227	{
	228	if ($param === null) {
[136]	229	return $this->_params;
[478]	230	} else if (array_key_exists($param, $this->_params)) {
[136]	231	return $this->_params[$param];
[1]	232	} else {
	233	return null;
	234	}
	235	}
[42]	236
[1]	237	/**
	238	* Begin running this application.
	239	*
	240	* @access public
	241	* @author Quinn Comendant <quinn@strangecode.com>
	242	* @since 15 Jul 2005 00:32:21
	243	*/
[468]	244	public function start()
[1]	245	{
	246	if ($this->running) {
	247	return false;
	248	}
[42]	249
[1]	250	// Error reporting.
	251	ini_set('error_reporting', $this->getParam('error_reporting'));
	252	ini_set('display_errors', $this->getParam('display_errors'));
	253	ini_set('log_errors', true);
	254	if (is_dir($this->getParam('log_directory')) && is_writable($this->getParam('log_directory'))) {
	255	ini_set('error_log', $this->getParam('log_directory') . '/' . $this->getParam('php_error_log'));
	256	}
[42]	257
[248]	258	// Set character set to use for multi-byte string functions.
	259	mb_internal_encoding($this->getParam('character_set'));
[249]	260	switch (mb_strtolower($this->getParam('character_set'))) {
	261	case 'utf-8' :
	262	mb_language('uni');
	263	break;
[42]	264
[249]	265	case 'iso-2022-jp' :
	266	mb_language('ja');
	267	break;
	268
	269	case 'iso-8859-1' :
	270	default :
	271	mb_language('en');
	272	break;
	273	}
	274
[1]	275	/**
	276	* 1. Start Database.
	277	*/
[42]	278
[103]	279	if (true === $this->getParam('enable_db')) {
[42]	280
[1]	281	// DB connection parameters taken from environment variables in the httpd.conf file, readable only by root.
[468]	282	if (!empty($_SERVER['DB_SERVER']) && !$this->getParam('db_server')) {
[1]	283	$this->setParam(array('db_server' => $_SERVER['DB_SERVER']));
	284	}
[468]	285	if (!empty($_SERVER['DB_NAME']) && !$this->getParam('db_name')) {
[1]	286	$this->setParam(array('db_name' => $_SERVER['DB_NAME']));
	287	}
[468]	288	if (!empty($_SERVER['DB_USER']) && !$this->getParam('db_user')) {
[1]	289	$this->setParam(array('db_user' => $_SERVER['DB_USER']));
	290	}
[468]	291	if (!empty($_SERVER['DB_PASS']) && !$this->getParam('db_pass')) {
[1]	292	$this->setParam(array('db_pass' => $_SERVER['DB_PASS']));
	293	}
[42]	294
[136]	295	// There will ever only be one instance of the DB object, and here is where it is instantiated.
[1]	296	require_once dirname(__FILE__) . '/DB.inc.php';
	297	$this->db =& DB::getInstance();
	298	$this->db->setParam(array(
	299	'db_server' => $this->getParam('db_server'),
	300	'db_name' => $this->getParam('db_name'),
	301	'db_user' => $this->getParam('db_user'),
	302	'db_pass' => $this->getParam('db_pass'),
	303	'db_always_debug' => $this->getParam('db_always_debug'),
	304	'db_debug' => $this->getParam('db_debug'),
	305	'db_die_on_failure' => $this->getParam('db_die_on_failure'),
	306	));
	307
	308	// Connect to database.
	309	$this->db->connect();
	310	}
[42]	311
	312
[1]	313	/**
	314	* 2. Start PHP session.
	315	*/
[42]	316
[433]	317	// Skip sessions if disabled or automatically skip if run in a CLI script.
	318	if (true === $this->getParam('enable_session') && !defined('_CLI')) {
[42]	319
[373]	320	// Session parameters.
	321	ini_set('session.gc_probability', 1);
	322	ini_set('session.gc_divisor', 1000);
	323	ini_set('session.gc_maxlifetime', 43200); // 12 hours
	324	ini_set('session.use_cookies', $this->getParam('session_use_cookies'));
	325	ini_set('session.use_trans_sid', false);
	326	ini_set('session.entropy_file', '/dev/urandom');
	327	ini_set('session.entropy_length', '512');
[410]	328	ini_set('session.cookie_httponly', true);
[373]	329	session_name($this->getParam('session_name'));
	330
[1]	331	if (true === $this->getParam('enable_db_session_handler') && true === $this->getParam('enable_db')) {
	332	// Database session handling.
	333	require_once dirname(__FILE__) . '/DBSessionHandler.inc.php';
	334	$db_save_handler = new DBSessionHandler($this->db, array(
	335	'db_table' => 'session_tbl',
	336	'create_table' => $this->getParam('db_create_tables'),
	337	));
	338	}
[42]	339
[22]	340	// Start the session.
[1]	341	session_start();
[42]	342
[154]	343	if (!isset($_SESSION['_app'][$this->_ns])) {
[22]	344	// Access session data using: $_SESSION['...'].
	345	// Initialize here _after_ session has started.
[154]	346	$_SESSION['_app'][$this->_ns] = array(
[22]	347	'messages' => array(),
	348	'boomerang' => array('url'),
	349	);
	350	}
[1]	351	}
[42]	352
	353
[1]	354	/**
	355	* 3. Misc setup.
	356	*/
	357
	358	// Script URI will be something like http://host.name.tld (no ending slash)
	359	// and is used whenever a URL need be used to the current site.
	360	// Not available on cli scripts obviously.
[41]	361	if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_url')) {
[14]	362	$this->setParam(array('site_url' => sprintf('%s://%s', ('on' == getenv('HTTPS') ? 'https' : 'http'), getenv('HTTP_HOST'))));
[1]	363	}
[452]	364
[390]	365	// In case site_email isn't set, use something halfway presentable.
	366	if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_email')) {
	367	$this->setParam(array('site_email' => sprintf('no-reply@%s', getenv('HTTP_HOST'))));
	368	}
[1]	369
	370	// A key for calculating simple cryptographic signatures.
	371	if (isset($_SERVER['SIGNING_KEY'])) {
	372	$this->setParam(array('signing_key' => $_SERVER['SIGNING_KEY']));
	373	}
[42]	374
[1]	375	// Character set. This should also be printed in the html header template.
[476]	376	if (!defined('_CLI')) {
	377	header('Content-type: text/html; charset=' . $this->getParam('character_set'));
	378	}
[452]	379
[136]	380	// Set the version of the codebase we're using.
	381	$codebase_version_file = dirname(__FILE__) . '/../docs/version.txt';
[487]	382	$codebase_version = '';
[491]	383	if (is_readable($codebase_version_file) && !is_dir($codebase_version_file)) {
[136]	384	$codebase_version = trim(file_get_contents($codebase_version_file));
[144]	385	$this->setParam(array('codebase_version' => $codebase_version));
[476]	386	if (!defined('_CLI')) {
	387	header('X-Codebase-Version: ' . $codebase_version);
	388	}
[136]	389	}
[42]	390
[487]	391	if (version_compare(PHP_VERSION, self::CODEBASE_MIN_PHP_VERSION, '<')) {
	392	$this->logMsg(sprintf('PHP %s required for Codebase %s, using %s; some things will break.', self::CODEBASE_MIN_PHP_VERSION, $codebase_version, PHP_VERSION), LOG_NOTICE, __FILE__, __LINE__);
	393	}
	394
[491]	395	// Set the application version if defined.
[498]	396	if (false !== stream_resolve_include_path($this->getParam('site_version_file'))) {
[491]	397	$site_version = trim(file_get_contents($this->getParam('site_version_file'), true));
[498]	398	$this->setParam(array('site_version' => $site_version));
	399	if (!defined('_CLI')) {
	400	header('X-Site-Version: ' . $site_version);
	401	}
[491]	402	}
	403
[1]	404	$this->running = true;
	405	}
[42]	406
[1]	407	/**
	408	* Stop running this application.
	409	*
	410	* @access public
	411	* @author Quinn Comendant <quinn@strangecode.com>
	412	* @since 17 Jul 2005 17:20:18
	413	*/
[468]	414	public function stop()
[1]	415	{
	416	session_write_close();
	417	$this->running = false;
[172]	418	$num_queries = 0;
[103]	419	if (true === $this->getParam('enable_db')) {
[172]	420	$num_queries = $this->db->numQueries();
[103]	421	$this->db->close();
	422	}
[452]	423	$mem_current = memory_get_usage();
	424	$mem_peak = memory_get_peak_usage();
[172]	425	$this->timer->stop('_app');
[452]	426	$this->logMsg(sprintf('Script ended gracefully. Execution time: %s. Number of db queries: %s. Memory usage: %s. Peak memory: %s.', $this->timer->getTime('_app'), $num_queries, $mem_current, $mem_peak), LOG_DEBUG, __FILE__, __LINE__);
[1]	427	}
[42]	428
	429
[1]	430	/**
[84]	431	* Add a message to the session, which is printed in the header.
[1]	432	* Just a simple way to print messages to the user.
	433	*
	434	* @access public
	435	*
	436	* @param string $message The text description of the message.
	437	* @param int $type The type of message: MSG_NOTICE,
	438	* MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
	439	* @param string $file __FILE__.
	440	* @param string $line __LINE__.
	441	*/
[468]	442	public function raiseMsg($message, $type=MSG_NOTICE, $file=null, $line=null)
[1]	443	{
[32]	444	$message = trim($message);
[1]	445
[203]	446	if (!$this->running) {
	447	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	448	return false;
	449	}
[42]	450
[203]	451	if ('' == trim($message)) {
	452	$this->logMsg(sprintf('Raised message is an empty string.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
	453	return false;
	454	}
[452]	455
[406]	456	// Avoid duplicate full-stops..
	457	$message = trim(preg_replace('/\.{2}$/', '.', $message));
[203]	458
[37]	459	// Save message in session under unique key to avoid duplicate messages.
[177]	460	$msg_id = md5($type . $message);
	461	if (!isset($_SESSION['_app'][$this->_ns]['messages'][$msg_id])) {
	462	$_SESSION['_app'][$this->_ns]['messages'][$msg_id] = array(
	463	'type' => $type,
	464	'message' => $message,
	465	'file' => $file,
	466	'line' => $line,
	467	'count' => (isset($_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) ? (1 + $_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) : 1)
	468	);
	469	}
[42]	470
[1]	471	if (!in_array($type, array(MSG_NOTICE, MSG_SUCCESS, MSG_WARNING, MSG_ERR))) {
[136]	472	$this->logMsg(sprintf('Invalid MSG_* type: %s', $type), LOG_NOTICE, __FILE__, __LINE__);
[1]	473	}
	474	}
[452]	475
[46]	476	/**
	477	* Returns an array of the raised messages.
	478	*
	479	* @access public
[334]	480	* @return array List of messages in FIFO order.
[46]	481	* @author Quinn Comendant <quinn@strangecode.com>
	482	* @since 21 Dec 2005 13:09:20
	483	*/
[468]	484	public function getRaisedMessages()
[46]	485	{
[136]	486	if (!$this->running) {
	487	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
	488	return false;
[46]	489	}
[154]	490	return isset($_SESSION['_app'][$this->_ns]['messages']) ? $_SESSION['_app'][$this->_ns]['messages'] : array();
[46]	491	}
[452]	492
[1]	493	/**
[46]	494	* Resets the message list.
	495	*
	496	* @access public
	497	* @author Quinn Comendant <quinn@strangecode.com>
	498	* @since 21 Dec 2005 13:21:54
	499	*/
[468]	500	public function clearRaisedMessages()
[46]	501	{
[136]	502	if (!$this->running) {
	503	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[46]	504	return false;
	505	}
[452]	506
[154]	507	$_SESSION['_app'][$this->_ns]['messages'] = array();
[46]	508	}
	509
	510	/**
[1]	511	* Prints the HTML for displaying raised messages.
	512	*
[413]	513	* @param string $above Additional message to print above error messages (e.g. "Oops!").
	514	* @param string $below Additional message to print below error messages (e.g. "Please fix and resubmit").
	515	* @param string $print_gotohash_js Print a line of javascript that scrolls the browser window down to view any error messages.
	516	* @param string $hash The #hashtag to scroll to.
[1]	517	* @access public
	518	* @author Quinn Comendant <quinn@strangecode.com>
	519	* @since 15 Jul 2005 01:39:14
	520	*/
[468]	521	public function printRaisedMessages($above='', $below='', $print_gotohash_js=false, $hash='sc-msg')
[1]	522	{
[468]	523
[136]	524	if (!$this->running) {
	525	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	526	return false;
	527	}
[452]	528
[136]	529	$messages = $this->getRaisedMessages();
[167]	530	if (!empty($messages)) {
[163]	531	?><div id="sc-msg" class="sc-msg"><?php
[413]	532	if ('' != $above) {
	533	?><div class="sc-above"><?php echo oTxt($above); ?></div><?php
	534	}
[167]	535	foreach ($messages as $m) {
	536	if (error_reporting() > 0 && $this->getParam('display_errors') && isset($m['file']) && isset($m['line'])) {
	537	echo "\n<!-- [" . $m['file'] . ' : ' . $m['line'] . '] -->';
	538	}
	539	switch ($m['type']) {
	540	case MSG_ERR:
	541	echo '<div class="sc-msg-error">' . $m['message'] . '</div>';
	542	break;
[42]	543
[167]	544	case MSG_WARNING:
	545	echo '<div class="sc-msg-warning">' . $m['message'] . '</div>';
	546	break;
[42]	547
[167]	548	case MSG_SUCCESS:
	549	echo '<div class="sc-msg-success">' . $m['message'] . '</div>';
	550	break;
[42]	551
[167]	552	case MSG_NOTICE:
	553	default:
	554	echo '<div class="sc-msg-notice">' . $m['message'] . '</div>';
	555	break;
[42]	556
[167]	557	}
[1]	558	}
[413]	559	if ('' != $below) {
	560	?><div class="sc-below"><?php echo oTxt($below); ?></div><?php
	561	}
[1]	562	?></div><?php
[413]	563	if ($print_gotohash_js) {
	564	?>
	565	<script type="text/javascript">
	566	/* <![CDATA[ */
	567	window.location.hash = '#<?php echo urlencode($hash); ?>';
	568	/* ]]> */
	569	</script>
	570	<?php
	571	}
[1]	572	}
[136]	573	$this->clearRaisedMessages();
[1]	574	}
[42]	575
[1]	576	/**
[44]	577	* Logs messages to defined channels: file, email, sms, and screen. Repeated messages are
[390]	578	* not repeated but printed once with count. Log events that match a sendable channel (email or SMS)
	579	* are sent once per 'log_multiple_timeout' setting (to avoid a flood of error emails).
[1]	580	*
	581	* @access public
	582	* @param string $message The text description of the message.
	583	* @param int $priority The type of message priority (in descending order):
[390]	584	* LOG_EMERG 0 system is unusable
	585	* LOG_ALERT 1 action must be taken immediately
	586	* LOG_CRIT 2 critical conditions
	587	* LOG_ERR 3 error conditions
	588	* LOG_WARNING 4 warning conditions
	589	* LOG_NOTICE 5 normal, but significant, condition
	590	* LOG_INFO 6 informational message
	591	* LOG_DEBUG 7 debug-level message
[1]	592	* @param string $file The file where the log event occurs.
	593	* @param string $line The line of the file where the log event occurs.
	594	*/
[468]	595	public function logMsg($message, $priority=LOG_INFO, $file=null, $line=null)
[1]	596	{
[44]	597	static $previous_events = array();
	598
[1]	599	// If priority is not specified, assume the worst.
[136]	600	if (!$this->logPriorityToString($priority)) {
	601	$this->logMsg(sprintf('Log priority %s not defined. (Message: %s)', $priority, $message), LOG_EMERG, $file, $line);
[1]	602	$priority = LOG_EMERG;
	603	}
[42]	604
[15]	605	// If log file is not specified, don't log to a file.
[136]	606	if (!$this->getParam('log_directory') \|\| !$this->getParam('log_filename') \|\| !is_dir($this->getParam('log_directory')) \|\| !is_writable($this->getParam('log_directory'))) {
	607	$this->setParam(array('log_file_priority' => false));
	608	// We must use trigger_error to report this problem rather than calling $app->logMsg, which might lead to an infinite loop.
	609	trigger_error(sprintf('Codebase error: log directory (%s) not found or writable.', $this->getParam('log_directory')), E_USER_NOTICE);
[1]	610	}
[452]	611
[390]	612	// Before we get any further, let's see if ANY log events are configured to be reported.
	613	if ((false === $this->getParam('log_file_priority') \|\| $priority > $this->getParam('log_file_priority'))
	614	&& (false === $this->getParam('log_email_priority') \|\| $priority > $this->getParam('log_email_priority'))
	615	&& (false === $this->getParam('log_sms_priority') \|\| $priority > $this->getParam('log_sms_priority'))
	616	&& (false === $this->getParam('log_screen_priority') \|\| $priority > $this->getParam('log_screen_priority'))) {
	617	// This event would not be recorded, skip it entirely.
	618	return false;
	619	}
[42]	620
[1]	621	// Make sure to log in the system's locale.
	622	$locale = setlocale(LC_TIME, 0);
	623	setlocale(LC_TIME, 'C');
[42]	624
[44]	625	// Strip HTML tags except any with more than 7 characters because that's probably not a HTML tag, e.g. <email@address.com>.
	626	preg_match_all('/(<[^>\s]{7,})[^>]*>/', $message, $strip_tags_allow);
	627	$message = strip_tags(preg_replace('/\s+/', ' ', $message), (!empty($strip_tags_allow[1]) ? join('> ', $strip_tags_allow[1]) . '>' : null));
	628
[479]	629	// Serialize multi-line messages.
	630	$message = preg_replace('/\s+/m', ' ', $message);
[477]	631
[44]	632	// Store this event under a unique key, counting each time it occurs so that it only gets reported a limited number of times.
	633	$msg_id = md5($message . $priority . $file . $line);
[406]	634	if ($this->getParam('log_ignore_repeated_events') && isset($previous_events[$msg_id])) {
[44]	635	$previous_events[$msg_id]++;
	636	if ($previous_events[$msg_id] == 2) {
[136]	637	$this->logMsg(sprintf('%s (Event repeated %s or more times)', $message, $previous_events[$msg_id]), $priority, $file, $line);
[44]	638	}
	639	return false;
	640	} else {
	641	$previous_events[$msg_id] = 1;
	642	}
[341]	643
[390]	644	// For email and SMS notification types use "lock" files to prevent sending email and SMS notices ad infinitum.
	645	if ((false !== $this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority'))
	646	\|\| (false !== $this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority'))) {
	647	// This event will generate a "send" notification. Prepare lock file.
	648	$site_hash = md5(empty($_SERVER['SERVER_NAME']) ? $_SERVER['SCRIPT_FILENAME'] : $_SERVER['SERVER_NAME']);
	649	$lock_dir = $this->getParam('tmp_dir') . "/codebase_msgs_$site_hash/";
[452]	650	// Just use the file and line for the msg_id to limit the number of possible messages
[390]	651	// (the message string itself shan't be used as it may contain innumerable combinations).
	652	$lock_file = $lock_dir . md5($file . ':' . $line);
	653	if (!is_dir($lock_dir)) {
	654	mkdir($lock_dir);
	655	}
	656	$send_notifications = true;
	657	if (is_file($lock_file)) {
	658	$msg_last_sent = filectime($lock_file);
	659	// Has this message been sent more recently than the timeout?
	660	if ((time() - $msg_last_sent) <= $this->getParam('log_multiple_timeout')) {
	661	// This message was already sent recently.
	662	$send_notifications = false;
	663	} else {
	664	// Timeout has expired; send notifications again and reset timeout.
	665	touch($lock_file);
	666	}
[341]	667	} else {
[390]	668	touch($lock_file);
[341]	669	}
	670	}
[452]	671
[1]	672	// Data to be stored for a log event.
[44]	673	$event = array(
	674	'date' => date('Y-m-d H:i:s'),
	675	'remote ip' => getRemoteAddr(),
[414]	676	'pid' => getmypid(),
[136]	677	'type' => $this->logPriorityToString($priority),
[44]	678	'file:line' => "$file : $line",
[475]	679	'url' => mb_substr(isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '', 0, 1024),
[44]	680	'message' => $message
	681	);
[475]	682	// Here's a shortened version of event data.
	683	$event_short = $event;
	684	$event_short['url'] = truncate($event_short['url'], 120);
[42]	685
[475]	686
[1]	687	// FILE ACTION
[390]	688	if (false !== $this->getParam('log_file_priority') && $priority <= $this->getParam('log_file_priority')) {
[475]	689	$event_str = '[' . join('] [', $event_short) . ']';
[247]	690	error_log(mb_substr($event_str, 0, 1024) . "\n", 3, $this->getParam('log_directory') . '/' . $this->getParam('log_filename'));
[1]	691	}
[42]	692
[390]	693	// EMAIL ACTION
	694	if (false !== $this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority') && $send_notifications) {
[422]	695	$hostname = (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : php_uname('n');
	696	$subject = sprintf('[%s %s] %s', $hostname, $event['type'], mb_substr($message, 0, 64));
	697	$email_msg = sprintf("A %s log event occurred on %s\n\n", $event['type'], $hostname);
[390]	698	$headers = 'From: ' . $this->getParam('site_email');
	699	foreach ($event as $k=>$v) {
	700	$email_msg .= sprintf("%-11s%s\n", $k, $v);
[1]	701	}
[390]	702	mb_send_mail($this->getParam('log_to_email_address'), $subject, $email_msg, $headers);
[1]	703	}
[390]	704
	705	// SMS ACTION
	706	if (false !== $this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority') && $send_notifications) {
[422]	707	$hostname = (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : php_uname('n');
	708	$subject = sprintf('[%s %s]', $hostname, $priority);
[475]	709	$sms_msg = sprintf('%s [%s:%s]', mb_substr($event_short['message'], 0, 64), basename($file), $line);
[390]	710	$headers = 'From: ' . $this->getParam('site_email');
	711	mb_send_mail($this->getParam('log_to_sms_address'), $subject, $sms_msg, $headers);
	712	}
[452]	713
[1]	714	// SCREEN ACTION
[390]	715	if (false !== $this->getParam('log_screen_priority') && $priority <= $this->getParam('log_screen_priority')) {
[468]	716	file_put_contents('php://stderr', "[{$event['type']}] [{$event['message']}]\n", FILE_APPEND);
[1]	717	}
[42]	718
[1]	719	// Restore original locale.
	720	setlocale(LC_TIME, $locale);
[452]	721
[475]	722	unset($event, $event_short);
	723
[390]	724	return true;
[1]	725	}
[42]	726
[1]	727	/**
	728	* Returns the string representation of a LOG_* integer constant.
	729	*
	730	* @param int $priority The LOG_* integer constant.
	731	*
	732	* @return The string representation of $priority.
	733	*/
[468]	734	public function logPriorityToString($priority) {
[1]	735	$priorities = array(
	736	LOG_EMERG => 'emergency',
	737	LOG_ALERT => 'alert',
	738	LOG_CRIT => 'critical',
	739	LOG_ERR => 'error',
	740	LOG_WARNING => 'warning',
	741	LOG_NOTICE => 'notice',
	742	LOG_INFO => 'info',
	743	LOG_DEBUG => 'debug'
	744	);
	745	if (isset($priorities[$priority])) {
	746	return $priorities[$priority];
	747	} else {
	748	return false;
	749	}
	750	}
[42]	751
[1]	752	/**
[334]	753	* Forcefully set a query argument even if one currently exists in the request.
[136]	754	* Values in the _carry_queries array will be copied to URLs (via $app->url()) and
[20]	755	* to hidden input values (via printHiddenSession()).
	756	*
	757	* @access public
[282]	758	* @param mixed $query_key The key (or keys, as an array) of the query argument to save.
	759	* @param mixed $val The new value of the argument key.
	760	* @author Quinn Comendant <quinn@strangecode.com>
	761	* @since 13 Oct 2007 11:34:51
	762	*/
[468]	763	public function setQuery($query_key, $val)
[282]	764	{
	765	if (!is_array($query_key)) {
	766	$query_key = array($query_key);
	767	}
	768	foreach ($query_key as $k) {
	769	// Set the value of the specified query argument into the _carry_queries array.
	770	$this->_carry_queries[$k] = $val;
	771	}
	772	}
	773
	774	/**
	775	* Specify which query arguments will be carried persistently between requests.
	776	* Values in the _carry_queries array will be copied to URLs (via $app->url()) and
	777	* to hidden input values (via printHiddenSession()).
	778	*
	779	* @access public
[259]	780	* @param mixed $query_key The key (or keys, as an array) of the query argument to save.
[170]	781	* @param mixed $default If the key is not available, set to this default value.
[20]	782	* @author Quinn Comendant <quinn@strangecode.com>
	783	* @since 14 Nov 2005 19:24:52
	784	*/
[468]	785	public function carryQuery($query_key, $default=false)
[20]	786	{
[259]	787	if (!is_array($query_key)) {
	788	$query_key = array($query_key);
[20]	789	}
[259]	790	foreach ($query_key as $k) {
	791	// If not already set, and there is a non-empty value provided in the request...
	792	if (!isset($this->_carry_queries[$k]) && false !== getFormData($k, $default)) {
	793	// Copy the value of the specified query argument into the _carry_queries array.
	794	$this->_carry_queries[$k] = getFormData($k, $default);
[331]	795	$this->logMsg(sprintf('Carrying query: %s => %s', $k, truncate(getDump($this->_carry_queries[$k], true), 128, 'end')), LOG_DEBUG, __FILE__, __LINE__);
[259]	796	}
	797	}
[20]	798	}
[42]	799
[20]	800	/**
[452]	801	* dropQuery() is the opposite of carryQuery(). The specified value will not appear in
[259]	802	* url()/ohref()/printHiddenSession() modified URLs unless explicitly written in.
[452]	803	*
[259]	804	* @access public
	805	* @param mixed $query_key The key (or keys, as an array) of the query argument to remove.
[407]	806	* @param bool $unset Remove any values set in the request matching the given $query_key.
[259]	807	* @author Quinn Comendant <quinn@strangecode.com>
	808	* @since 18 Jun 2007 20:57:29
	809	*/
[468]	810	public function dropQuery($query_key, $unset=false)
[259]	811	{
	812	if (!is_array($query_key)) {
	813	$query_key = array($query_key);
	814	}
	815	foreach ($query_key as $k) {
[478]	816	if (array_key_exists($k, $this->_carry_queries)) {
[259]	817	// Remove the value of the specified query argument from the _carry_queries array.
[325]	818	$this->logMsg(sprintf('Dropping carried query: %s => %s', $k, $this->_carry_queries[$k]), LOG_DEBUG, __FILE__, __LINE__);
[260]	819	unset($this->_carry_queries[$k]);
[259]	820	}
[480]	821	if ($unset && (isset($_REQUEST) && array_key_exists($k, $_REQUEST))) {
[325]	822	unset($_REQUEST[$k], $_GET[$k], $_POST[$k], $_COOKIE[$k]);
	823	}
[259]	824	}
	825	}
	826
	827	/**
[1]	828	* Outputs a fully qualified URL with a query of all the used (ie: not empty)
[42]	829	* keys and values, including optional queries. This allows mindless retention
[32]	830	* of query arguments across page requests. If cookies are not
[325]	831	* used, the session id will be propagated in the URL.
[1]	832	*
[32]	833	* @param string $url The initial url
	834	* @param mixed $carry_args Additional url arguments to carry in the query,
	835	* or FALSE to prevent carrying queries. Can be any of the following formats:
	836	* array('key1', key2', key3') <-- to save these keys if in the form data.
	837	* array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data.
	838	* false <-- To not carry any queries. If URL already has queries those will be retained.
[1]	839	*
	840	* @param mixed $always_include_sid Always add the session id, even if using_trans_sid = true. This is required when
	841	* URL starts with http, since PHP using_trans_sid doesn't do those and also for
	842	* header('Location...') redirections.
	843	*
	844	* @return string url with attached queries and, if not using cookies, the session id
	845	*/
[468]	846	public function url($url, $carry_args=null, $always_include_sid=false)
[1]	847	{
[136]	848	if (!$this->running) {
	849	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	850	return false;
	851	}
[42]	852
[20]	853	// Get any provided query arguments to include in the final URL.
	854	// If FALSE is a provided here, DO NOT carry the queries.
[1]	855	$do_carry_queries = true;
	856	$one_time_carry_queries = array();
	857	if (!is_null($carry_args)) {
	858	if (is_array($carry_args) && !empty($carry_args)) {
	859	foreach ($carry_args as $key=>$arg) {
	860	// Get query from appropriate source.
	861	if (false === $arg) {
	862	$do_carry_queries = false;
	863	} else if (false !== getFormData($arg, false)) {
	864	$one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available.
	865	} else if (!is_numeric($key) && '' != $arg) {
	866	$one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data).
	867	}
	868	}
	869	} else if (false !== getFormData($carry_args, false)) {
	870	$one_time_carry_queries[$carry_args] = getFormData($carry_args);
	871	} else if (false === $carry_args) {
	872	$do_carry_queries = false;
	873	}
	874	}
[42]	875
[1]	876	// Get the first delimiter that is needed in the url.
[247]	877	$delim = mb_strpos($url, '?') !== false ? ini_get('arg_separator.output') : '?';
[32]	878
[1]	879	$q = '';
	880	if ($do_carry_queries) {
[20]	881	// Join the global _carry_queries and local one_time_carry_queries.
[136]	882	$query_args = urlEncodeArray(array_merge($this->_carry_queries, $one_time_carry_queries));
[1]	883	foreach ($query_args as $key=>$val) {
	884	// Check value is set and value does not already exist in the url.
	885	if (!preg_match('/[?&]' . preg_quote($key) . '=/', $url)) {
	886	$q .= $delim . $key . '=' . $val;
	887	$delim = ini_get('arg_separator.output');
	888	}
	889	}
	890	}
[42]	891
[1]	892	// Include the necessary SID if the following is true:
	893	// - no cookie in http request OR cookies disabled in App
	894	// - sessions are enabled
	895	// - the link stays on our site
[334]	896	// - transparent SID propagation with session.use_trans_sid is not being used OR url begins with protocol (using_trans_sid has no effect here)
[42]	897	// OR
[1]	898	// - 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)
	899	// AND
	900	// - the SID is not already in the query.
	901	if (
	902	(
	903	(
	904	(
[42]	905	!isset($_COOKIE[session_name()])
[136]	906	\|\| !$this->getParam('session_use_cookies')
[42]	907	)
[242]	908	&& $this->getParam('session_use_trans_sid')
[136]	909	&& $this->getParam('enable_session')
[42]	910	&& isMyDomain($url)
[242]	911	&& (
[20]	912	!ini_get('session.use_trans_sid')
[1]	913	\|\| preg_match('!^(http\|https)://!i', $url)
	914	)
[42]	915	)
[1]	916	\|\| $always_include_sid
	917	)
	918	&& !preg_match('/[?&]' . preg_quote(session_name()) . '=/', $url)
	919	) {
	920	$url .= $q . $delim . session_name() . '=' . session_id();
	921	} else {
	922	$url .= $q;
	923	}
[492]	924
	925	return $url;
[1]	926	}
[32]	927
	928	/**
[136]	929	* Returns a HTML-friendly URL processed with $app->url and & replaced with &
[32]	930	*
	931	* @access public
	932	* @param string $url Input URL to parse.
[334]	933	* @return string URL passed through $app->url() and then & turned to $amp;.
[32]	934	* @author Quinn Comendant <quinn@strangecode.com>
	935	* @since 09 Dec 2005 17:58:45
	936	*/
[468]	937	public function oHREF($url, $carry_args=null, $always_include_sid=false)
[32]	938	{
[136]	939	$url = $this->url($url, $carry_args, $always_include_sid);
[42]	940
[32]	941	// Replace any & not followed by an html or unicode entity with it's & equivalent.
	942	$url = preg_replace('/&(?![\w\d#]{1,10};)/', '&', $url);
[42]	943
[32]	944	return $url;
	945	}
[42]	946
[492]	947	/*
	948	* Return a URL with a version number attached. This is useful for overriding network caches ("cache buster") for sourced media, e.g., /style.css?812763482
	949	*
	950	* @access public
	951	* @param string $url URL to media (e.g., /foo.js)
	952	* @return string URL with cache-busting version appended (/foo.js?v=1234567890)
	953	* @author Quinn Comendant <quinn@strangecode.com>
	954	* @version 1.0
	955	* @since 03 Sep 2014 22:40:24
	956	*/
	957	public function cacheBustURL($url)
	958	{
	959	// Get the first delimiter that is needed in the url.
	960	$delim = mb_strpos($url, '?') !== false ? ini_get('arg_separator.output') : '?';
	961	$v = crc32($this->getParam('codebase_version') . '\|' . $this->getParam('site_version'));
	962	return sprintf('%s%sv=%s', $url, $delim, $v);
	963	}
	964
[1]	965	/**
	966	* Prints a hidden form element with the PHPSESSID when cookies are not used, as well
[42]	967	* as hidden form elements for GET_VARS that might be in use.
[1]	968	*
	969	* @param mixed $carry_args Additional url arguments to carry in the query,
	970	* or FALSE to prevent carrying queries. Can be any of the following formats:
[32]	971	* array('key1', key2', key3') <-- to save these keys if in the form data.
	972	* array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data.
	973	* false <-- To not carry any queries. If URL already has queries those will be retained.
[1]	974	*/
[468]	975	public function printHiddenSession($carry_args=null)
[32]	976	{
[136]	977	if (!$this->running) {
	978	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	979	return false;
	980	}
[42]	981
[20]	982	// Get any provided query arguments to include in the final hidden form data.
	983	// If FALSE is a provided here, DO NOT carry the queries.
[1]	984	$do_carry_queries = true;
	985	$one_time_carry_queries = array();
	986	if (!is_null($carry_args)) {
	987	if (is_array($carry_args) && !empty($carry_args)) {
	988	foreach ($carry_args as $key=>$arg) {
	989	// Get query from appropriate source.
	990	if (false === $arg) {
	991	$do_carry_queries = false;
	992	} else if (false !== getFormData($arg, false)) {
	993	$one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available.
	994	} else if (!is_numeric($key) && '' != $arg) {
	995	$one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data).
	996	}
	997	}
	998	} else if (false !== getFormData($carry_args, false)) {
	999	$one_time_carry_queries[$carry_args] = getFormData($carry_args);
	1000	} else if (false === $carry_args) {
	1001	$do_carry_queries = false;
	1002	}
	1003	}
[42]	1004
[313]	1005	// For each existing request value, we create a hidden input to carry it through a form.
[1]	1006	if ($do_carry_queries) {
[20]	1007	// Join the global _carry_queries and local one_time_carry_queries.
	1008	// urlencode is not used here, not for form data!
[136]	1009	$query_args = array_merge($this->_carry_queries, $one_time_carry_queries);
[453]	1010	foreach ($query_args as $key => $val) {
	1011	if (is_array($val)) {
	1012	foreach ($val as $subval) {
	1013	printf('<input type="hidden" name="%s[]" value="%s" />', $key, $subval);
	1014	}
	1015	} else {
	1016	printf('<input type="hidden" name="%s" value="%s" />', $key, $val);
	1017	}
[1]	1018	}
[453]	1019	unset($query_args, $key, $val, $subval);
[1]	1020	}
[42]	1021
[1]	1022	// Include the SID if cookies are disabled.
[20]	1023	if (!isset($_COOKIE[session_name()]) && !ini_get('session.use_trans_sid')) {
[136]	1024	printf('<input type="hidden" name="%s" value="%s" />', session_name(), session_id());
[1]	1025	}
	1026	}
[42]	1027
[1]	1028	/**
	1029	* Uses an http header to redirect the client to the given $url. If sessions are not used
	1030	* and the session is not already defined in the given $url, the SID is appended as a URI query.
	1031	* As with all header generating functions, make sure this is called before any other output.
	1032	*
	1033	* @param string $url The URL the client will be redirected to.
	1034	* @param mixed $carry_args Additional url arguments to carry in the query,
	1035	* or FALSE to prevent carrying queries. Can be any of the following formats:
	1036	* -array('key1', key2', key3') <-- to save these keys if in the form data.
[136]	1037	* -array('key1' => 'value', key2' => 'value') <-- to set keys to default values if not present in form data.
[1]	1038	* -false <-- To not carry any queries. If URL already has queries those will be retained.
	1039	* @param bool $always_include_sid Force session id to be added to Location header.
	1040	*/
[468]	1041	public function dieURL($url, $carry_args=null, $always_include_sid=false)
[1]	1042	{
[136]	1043	if (!$this->running) {
	1044	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	1045	return false;
	1046	}
[42]	1047
[1]	1048	if ('' == $url) {
	1049	// If URL is not specified, use the redirect_home_url.
[136]	1050	$url = $this->getParam('redirect_home_url');
[1]	1051	}
[42]	1052
[1]	1053	if (preg_match('!^/!', $url)) {
	1054	// If relative URL is given, prepend correct local hostname.
[22]	1055	$scheme = 'on' == getenv('HTTPS') ? 'https' : 'http';
	1056	$host = getenv('HTTP_HOST');
	1057	$url = sprintf('%s://%s%s', $scheme, $host, $url);
[1]	1058	}
[22]	1059
[136]	1060	$url = $this->url($url, $carry_args, $always_include_sid);
[42]	1061
[202]	1062	// Should we send a "303 See Other" header here instead of relying on the 302 sent automatically by PHP?
[1]	1063	header(sprintf('Location: %s', $url));
[136]	1064	$this->logMsg(sprintf('dieURL: %s', $url), LOG_DEBUG, __FILE__, __LINE__);
[42]	1065
[202]	1066	// End application.
[1]	1067	// Recommended, although I'm not sure it's necessary: http://cn2.php.net/session_write_close
[136]	1068	$this->stop();
[1]	1069	die;
	1070	}
[42]	1071
[84]	1072	/*
[136]	1073	* Redirects a user by calling $app->dieURL(). It will use:
[84]	1074	* 1. the stored boomerang URL, it it exists
	1075	* 2. a specified $default_url, it it exists
	1076	* 3. the referring URL, it it exists.
	1077	* 4. redirect_home_url configuration variable.
	1078	*
	1079	* @access public
	1080	* @param string $id Identifier for this script.
[136]	1081	* @param mixed $carry_args Additional arguments to carry in the URL automatically (see $app->oHREF()).
[84]	1082	* @param string $default_url A default URL if there is not a valid specified boomerang URL.
[159]	1083	* @param bool $queryless_referrer_comparison Exclude the URL query from the refererIsMe() comparison.
[84]	1084	* @return bool False if the session is not running. No return otherwise.
	1085	* @author Quinn Comendant <quinn@strangecode.com>
	1086	* @since 31 Mar 2006 19:17:00
	1087	*/
[468]	1088	public function dieBoomerangURL($id=null, $carry_args=null, $default_url=null, $queryless_referrer_comparison=false)
[1]	1089	{
[136]	1090	if (!$this->running) {
	1091	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	1092	return false;
	1093	}
[42]	1094
[1]	1095	// Get URL from stored boomerang. Allow non specific URL if ID not valid.
[136]	1096	if ($this->validBoomerangURL($id, true)) {
[154]	1097	if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
	1098	$url = $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id];
[136]	1099	$this->logMsg(sprintf('dieBoomerangURL(%s) found: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[1]	1100	} else {
[154]	1101	$url = end($_SESSION['_app'][$this->_ns]['boomerang']['url']);
[136]	1102	$this->logMsg(sprintf('dieBoomerangURL(%s) using: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[1]	1103	}
[22]	1104	// Delete stored boomerang.
[136]	1105	$this->deleteBoomerangURL($id);
[84]	1106	} else if (isset($default_url)) {
	1107	$url = $default_url;
[159]	1108	} else if (!refererIsMe(true === $queryless_referrer_comparison)) {
[1]	1109	// Ensure that the redirecting page is not also the referrer.
	1110	$url = getenv('HTTP_REFERER');
[136]	1111	$this->logMsg(sprintf('dieBoomerangURL(%s) using referrer: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[1]	1112	} else {
[22]	1113	// If URL is not specified, use the redirect_home_url.
[136]	1114	$url = $this->getParam('redirect_home_url');
[203]	1115	$this->logMsg(sprintf('dieBoomerangURL(%s) using redirect_home_url: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[1]	1116	}
[42]	1117
[84]	1118	// A redirection will never happen immediately twice.
[1]	1119	// Set the time so ensure this doesn't happen.
[154]	1120	$_SESSION['_app'][$this->_ns]['boomerang']['time'] = time();
[136]	1121	$this->dieURL($url, $carry_args);
[1]	1122	}
[42]	1123
[1]	1124	/**
[136]	1125	* Set the URL to return to when $app->dieBoomerangURL() is called.
[1]	1126	*
	1127	* @param string $url A fully validated URL.
	1128	* @param bool $id An identification tag for this url.
	1129	* FIXME: url garbage collection?
	1130	*/
[468]	1131	public function setBoomerangURL($url=null, $id=null)
[1]	1132	{
[136]	1133	if (!$this->running) {
	1134	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	1135	return false;
	1136	}
[84]	1137	// A redirection will never happen immediately after setting the boomerangURL.
[136]	1138	// Set the time so ensure this doesn't happen. See $app->validBoomerangURL for more.
[42]	1139
[22]	1140	if ('' != $url && is_string($url)) {
[242]	1141	// Delete any boomerang request keys in the query string (along with any trailing delimiters after the deletion).
	1142	$url = preg_replace(array('/([&?])boomerang=\w+[&?]?/', '/[&?]$/'), array('$1', ''), $url);
[42]	1143
[154]	1144	if (isset($_SESSION['_app'][$this->_ns]['boomerang']['url']) && is_array($_SESSION['_app'][$this->_ns]['boomerang']['url']) && !empty($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
[1]	1145	// If the URL currently exists in the boomerang array, delete.
[154]	1146	while ($existing_key = array_search($url, $_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
	1147	unset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$existing_key]);
[1]	1148	}
	1149	}
[42]	1150
[1]	1151	if (isset($id)) {
[154]	1152	$_SESSION['_app'][$this->_ns]['boomerang']['url'][$id] = $url;
[1]	1153	} else {
[154]	1154	$_SESSION['_app'][$this->_ns]['boomerang']['url'][] = $url;
[1]	1155	}
[136]	1156	$this->logMsg(sprintf('setBoomerangURL(%s): %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[1]	1157	return true;
	1158	} else {
[136]	1159	$this->logMsg(sprintf('setBoomerangURL(%s) is empty!', $id, $url), LOG_NOTICE, __FILE__, __LINE__);
[1]	1160	return false;
	1161	}
	1162	}
[42]	1163
[1]	1164	/**
[333]	1165	* Return the URL set for the specified $id, or an empty string if one isn't set.
[1]	1166	*
	1167	* @param string $id An identification tag for this url.
	1168	*/
[468]	1169	public function getBoomerangURL($id=null)
[1]	1170	{
[136]	1171	if (!$this->running) {
	1172	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	1173	return false;
	1174	}
[42]	1175
[1]	1176	if (isset($id)) {
[154]	1177	if (isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
	1178	return $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id];
[1]	1179	} else {
	1180	return '';
	1181	}
[154]	1182	} else if (is_array($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
	1183	return end($_SESSION['_app'][$this->_ns]['boomerang']['url']);
[1]	1184	} else {
	1185	return false;
	1186	}
	1187	}
[42]	1188
[1]	1189	/**
	1190	* Delete the URL set for the specified $id.
	1191	*
	1192	* @param string $id An identification tag for this url.
	1193	*/
[468]	1194	public function deleteBoomerangURL($id=null)
[1]	1195	{
[136]	1196	if (!$this->running) {
	1197	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	1198	return false;
	1199	}
[42]	1200
[136]	1201	$this->logMsg(sprintf('deleteBoomerangURL(%s): %s', $id, $this->getBoomerangURL($id)), LOG_DEBUG, __FILE__, __LINE__);
[22]	1202
[154]	1203	if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
	1204	unset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id]);
	1205	} else if (is_array($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
	1206	array_pop($_SESSION['_app'][$this->_ns]['boomerang']['url']);
[1]	1207	}
	1208	}
[42]	1209
[1]	1210	/**
[103]	1211	* Check if a valid boomerang URL value has been set. A boomerang URL is considered
	1212	* valid if: 1) it is not empty, 2) it is not the current URL, and 3) has not been accessed within n seconds.
[1]	1213	*
[103]	1214	* @return bool True if it is set and valid, false otherwise.
[1]	1215	*/
[468]	1216	public function validBoomerangURL($id=null, $use_nonspecificboomerang=false)
[1]	1217	{
[136]	1218	if (!$this->running) {
	1219	$this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
[1]	1220	return false;
	1221	}
[42]	1222
[154]	1223	if (!isset($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
[136]	1224	$this->logMsg(sprintf('validBoomerangURL(%s) no boomerang URL set.', $id), LOG_DEBUG, __FILE__, __LINE__);
[1]	1225	return false;
	1226	}
[42]	1227
[334]	1228	// Time is the time stamp of a boomerangURL redirection, or setting of a boomerangURL.
[1]	1229	// a boomerang redirection will always occur at least several seconds after the last boomerang redirect
	1230	// or a boomerang being set.
[154]	1231	$boomerang_time = isset($_SESSION['_app'][$this->_ns]['boomerang']['time']) ? $_SESSION['_app'][$this->_ns]['boomerang']['time'] : 0;
[42]	1232
[22]	1233	$url = '';
[154]	1234	if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
	1235	$url = $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id];
[1]	1236	} else if (!isset($id) \|\| $use_nonspecificboomerang) {
	1237	// Use non specific boomerang if available.
[154]	1238	$url = end($_SESSION['_app'][$this->_ns]['boomerang']['url']);
[1]	1239	}
[42]	1240
[136]	1241	$this->logMsg(sprintf('validBoomerangURL(%s) testing: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[22]	1242
	1243	if ('' == $url) {
[136]	1244	$this->logMsg(sprintf('validBoomerangURL(%s) not valid, empty!', $id), LOG_DEBUG, __FILE__, __LINE__);
[1]	1245	return false;
	1246	}
	1247	if ($url == absoluteMe()) {
	1248	// The URL we are directing to is the current page.
[136]	1249	$this->logMsg(sprintf('validBoomerangURL(%s) not valid, same as absoluteMe: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[1]	1250	return false;
	1251	}
	1252	if ($boomerang_time >= (time() - 2)) {
[159]	1253	// Last boomerang direction was less than 2 seconds ago.
	1254	$this->logMsg(sprintf('validBoomerangURL(%s) not valid, boomerang_time too short: %s seconds', $id, time() - $boomerang_time), LOG_DEBUG, __FILE__, __LINE__);
[1]	1255	return false;
	1256	}
[42]	1257
[136]	1258	$this->logMsg(sprintf('validBoomerangURL(%s) is valid: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
[1]	1259	return true;
	1260	}
	1261
	1262	/**
	1263	* Force the user to connect via https (port 443) by redirecting them to
	1264	* the same page but with https.
	1265	*/
[468]	1266	public function sslOn()
[1]	1267	{
[38]	1268	if (function_exists('apache_get_modules')) {
[42]	1269	$modules = apache_get_modules();
[38]	1270	} else {
	1271	// It's safe to assume we have mod_ssl if we can't determine otherwise.
	1272	$modules = array('mod_ssl');
	1273	}
[42]	1274
[136]	1275	if ('' == getenv('HTTPS') && $this->getParam('ssl_enabled') && in_array('mod_ssl', $modules)) {
	1276	$this->raiseMsg(sprintf(_("Secure SSL connection made to %s"), $this->getParam('ssl_domain')), MSG_NOTICE, __FILE__, __LINE__);
[1]	1277	// Always append session because some browsers do not send cookie when crossing to SSL URL.
[136]	1278	$this->dieURL('https://' . $this->getParam('ssl_domain') . getenv('REQUEST_URI'), null, true);
[1]	1279	}
	1280	}
[42]	1281
[1]	1282	/**
	1283	* to enforce the user to connect via http (port 80) by redirecting them to
	1284	* a http version of the current url.
	1285	*/
[468]	1286	public function sslOff()
[1]	1287	{
[53]	1288	if ('' != getenv('HTTPS')) {
[1]	1289	$this->dieURL('http://' . getenv('HTTP_HOST') . getenv('REQUEST_URI'), null, true);
	1290	}
	1291	}
[477]	1292
[479]	1293	/*
	1294	* Sets a cookie, with error checking and some sane defaults.
	1295	*
	1296	* @access public
	1297	* @param string $name The name of the cookie.
	1298	* @param string $value The value of the cookie.
	1299	* @param string $expire The time the cookie expires, as a unix timestamp or string value passed to strtotime.
[489]	1300	* @param string $path The path on the server in which the cookie will be available on.
	1301	* @param string $domain The domain that the cookie is available to.
[479]	1302	* @param bool $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client.
	1303	* @param bool $httponly When TRUE the cookie will be made accessible only through the HTTP protocol (makes cookies unreadable to javascript).
	1304	* @return bool True on success, false on error.
	1305	* @author Quinn Comendant <quinn@strangecode.com>
	1306	* @version 1.0
	1307	* @since 02 May 2014 16:36:34
	1308	*/
[489]	1309	public function setCookie($name, $value, $expire='+10 years', $path='/', $domain=null, $secure=null, $httponly=null)
[479]	1310	{
	1311	if (!is_scalar($name)) {
	1312	$this->logMsg(sprintf('Cookie name must be scalar, is not: %s', getDump($name)), LOG_NOTICE, __FILE__, __LINE__);
	1313	return false;
	1314	}
	1315	if (!is_scalar($value)) {
	1316	$this->logMsg(sprintf('Cookie "%s" value must be scalar, is not: %s', $name, getDump($value)), LOG_NOTICE, __FILE__, __LINE__);
	1317	return false;
	1318	}
[477]	1319
[479]	1320	// Defaults.
	1321	$expire = (is_numeric($expire) ? $expire : (is_string($expire) ? strtotime($expire) : $expire));
	1322	$secure = $secure ?: ('' != getenv('HTTPS') && $this->getParam('ssl_enabled'));
	1323	$httponly = $httponly ?: true;
[477]	1324
[479]	1325	// Make sure the expiration date is a valid 32bit integer.
	1326	if (is_int($expire) && $expire > 2147483647) {
	1327	$this->logMsg(sprintf('Cookie "%s" expire time exceeds a 32bit integer (%s)', $key, date('r', $expire)), LOG_NOTICE, __FILE__, __LINE__);
	1328	}
[477]	1329
[479]	1330	// Measure total cookie length and warn if larger than max recommended size of 4093.
	1331	// https://stackoverflow.com/questions/640938/what-is-the-maximum-size-of-a-web-browsers-cookies-key
	1332	// The date the header name include 51 bytes: Set-Cookie: ; expires=Fri, 03-May-2024 00:04:47 GMT
	1333	$cookielen = strlen($name . $value . $path . $domain . ($secure ? '; secure' : '') . ($httponly ? '; httponly' : '')) + 51;
	1334	if ($cookielen > 4093) {
	1335	$this->logMsg(sprintf('Cookie "%s" has a size greater than 4093 bytes (is %s bytes)', $key, $cookielen), LOG_NOTICE, __FILE__, __LINE__);
	1336	}
[477]	1337
[479]	1338	// Ensure PHP version allow use of httponly.
	1339	if (version_compare(PHP_VERSION, '5.2.0', '>=')) {
	1340	$ret = setcookie($name, $value, $expire, $path, $domain, $secure, $httponly);
	1341	} else {
	1342	$ret = setcookie($name, $value, $expire, $path, $domain, $secure);
	1343	}
[477]	1344
[479]	1345	if (false === $ret) {
	1346	$this->logMsg(sprintf('Failed to set cookie (%s=%s) probably due to output before headers.', $name, $value), LOG_NOTICE, __FILE__, __LINE__);
	1347	}
	1348	return $ret;
	1349	}
[1]	1350	} // End.

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: tags/2.1.8/lib/App.inc.php @ 661

Download in other formats: