Context Navigation

source: trunk/lib/App.inc.php @ 603

Last change on this file since 603 was 603, checked in by anonymous, 7 years ago
Add application-wide cache control setting 'http_cache_headers'
File size: 78.4 KB

Line
1	<?php
2	/**
3	* The Strangecode Codebase - a general application development framework for PHP
4	* For details visit the project site: <http://trac.strangecode.com/codebase/>
5	* Copyright 2001-2012 Strangecode, LLC
6	*
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.
13	*
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.
18	*
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	/**
24	* App.inc.php
25	*
26	* Primary application framework class.
27	*
28	* @author Quinn Comendant <quinn@strangecode.com>
29	* @version 2.1
30	*/
31
32	// Message Types.
33	define('MSG_ERR', 1);
34	define('MSG_ERROR', MSG_ERR);
35	define('MSG_WARNING', 2);
36	define('MSG_NOTICE', 4);
37	define('MSG_SUCCESS', 8);
38	define('MSG_ALL', MSG_SUCCESS \| MSG_NOTICE \| MSG_WARNING \| MSG_ERROR);
39
40	require_once dirname(__FILE__) . '/Utilities.inc.php';
41
42	class App
43	{
44	// Minimum version of PHP required for this version of the Codebase.
45	const CODEBASE_MIN_PHP_VERSION = '5.3.0';
46
47	// A place to keep an object instance for the singleton pattern.
48	protected static $instance = null;
49
50	// Namespace of this application instance.
51	protected $_ns;
52
53	// If $app->start has run successfully.
54	public $running = false;
55
56	// Instance of database object.
57	public $db;
58
59	// Instance of database session handler object.
60	public $db_session;
61
62	// Array of query arguments will be carried persistently between requests.
63	protected $_carry_queries = array();
64
65	// Array of raised message counters.
66	protected $_raised_msg_counter = array(MSG_NOTICE => 0, MSG_SUCCESS => 0, MSG_WARNING => 0, MSG_ERR => 0);
67
68	// We're running as CLI. Public because we must force this as false when testing sessions via CLI.
69	public $cli = false;
70
71	// Dictionary of global application parameters.
72	protected $_params = array();
73
74	// Default parameters.
75	protected $_param_defaults = array(
76
77	// Public name and email address for this application.
78	'site_name' => null,
79	'site_email' => '', // Set to no-reply@HTTP_HOST if not set here.
80	'site_url' => '', // URL to the root of the site (created during App->start()).
81	'page_url' => '', // URL to the current page (created during App->start()).
82	'images_path' => '', // Location for codebase-generated interface widgets (ex: "/admin/i").
83	'site_version' => '', // Version of this application (set automatically during start() if site_version_file is used).
84	'site_version_file' => 'docs/version.txt', // File containing version number of this app, relative to the include path.
85
86	// The location the user will go if the system doesn't know where else to send them.
87	'redirect_home_url' => '/',
88
89	// SSL URL used when redirecting with $app->sslOn().
90	'ssl_domain' => null,
91	'ssl_enabled' => false,
92
93	// Use CSRF tokens. See notes in the getCSRFToken() method.
94	'csrf_token_enabled' => true,
95	// Form tokens will expire after this duration, in seconds.
96	'csrf_token_timeout' => 259200, // 259200 seconds = 3 days.
97	'csrf_token_name' => 'csrf_token',
98
99	// HMAC signing method
100	'signing_method' => 'sha512+base64',
101
102	// Content type of output sent in the Content-type: http header.
103	'content_type' => 'text/html',
104
105	// Allow HTTP caching with max-age setting. Possible values:
106	// >= 1 Allow HTTP caching with this value set as the max-age (in seconds, i.e., 3600 = 1 hour).
107	// 0 Disallow HTTP caching.
108	// false Don't send any cache-related HTTP headers (if you want to control this via server config or custom headers)
109	// This should be '0' for websites that use authentication or have frequently changing dynamic content.
110	'http_cache_headers' => 0,
111
112	// Character set for page output. Used in the Content-Type header and the HTML <meta content-type> tag.
113	'character_set' => 'utf-8',
114
115	// Human-readable format used to display dates.
116	'date_format' => 'd M Y',
117	'time_format' => 'h:i:s A',
118	'sql_date_format' => '%e %b %Y',
119	'sql_time_format' => '%k:%i',
120
121	// Use php sessions?
122	'enable_session' => false,
123	'session_name' => '_session',
124	'session_use_cookies' => true,
125
126	// Pass the session-id through URLs if cookies are not enabled?
127	// Disable this to prevent session ID theft.
128	'session_use_trans_sid' => false,
129
130	// Use database?
131	'enable_db' => false,
132
133	// Use db-based sessions?
134	'enable_db_session_handler' => false,
135
136	// DB credentials should be set as apache environment variables in httpd.conf, readable only by root.
137	'db_server' => null,
138	'db_name' => null,
139	'db_user' => null,
140	'db_pass' => null,
141
142	// And for CLI scripts, which should include a JSON file at this specified location in the include path.
143	'db_auth_file' => 'db_auth.json',
144
145	// Database debugging.
146	'db_always_debug' => false, // TRUE = display all SQL queries.
147	'db_debug' => false, // TRUE = display db errors.
148	'db_die_on_failure' => false, // TRUE = script stops on db error.
149
150	// For classes that require db tables, do we check that a table exists and create if missing?
151	'db_create_tables' => true,
152
153	// The level of error reporting. Don't change this to suppress messages, instead use display_errors to control display.
154	'error_reporting' => E_ALL,
155
156	// Don't display errors by default; it is preferable to log them to a file. For CLI scripts, set this to the string 'stderr'.
157	'display_errors' => false,
158
159	// Directory in which to store log files.
160	'log_directory' => '',
161
162	// PHP error log.
163	'php_error_log' => 'php_error_log',
164
165	// General application log.
166	'log_filename' => 'app_log',
167
168	// Don't email or SMS duplicate messages that happen more often than this value (in seconds).
169	'log_multiple_timeout' => 3600, // Hourly
170
171	// Logging priority can be any of the following, or false to deactivate:
172	// LOG_EMERG system is unusable
173	// LOG_ALERT action must be taken immediately
174	// LOG_CRIT critical conditions
175	// LOG_ERR error conditions
176	// LOG_WARNING warning conditions
177	// LOG_NOTICE normal, but significant, condition
178	// LOG_INFO informational message
179	// LOG_DEBUG debug-level message
180	'log_file_priority' => LOG_INFO,
181	'log_email_priority' => false,
182	'log_sms_priority' => false,
183	'log_screen_priority' => false,
184
185	// Email address to receive log event emails. Use multiple addresses by separating them with commas.
186	'log_to_email_address' => null,
187
188	// SMS Email address to receive log event SMS messages. Use multiple addresses by separating them with commas.
189	'log_to_sms_address' => null,
190
191	// 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.
192	'log_ignore_repeated_events' => true,
193
194	// Maximum length of log messages, in bytes.
195	'log_message_max_length' => 1024,
196
197	// Temporary files directory.
198	'tmp_dir' => '/tmp',
199
200	// A key for calculating simple cryptographic signatures. Set using as an environment variables in the httpd.conf with 'SetEnv SIGNING_KEY <key>'.
201	// Existing password hashes rely on the same key/salt being used to compare encryptions.
202	// Don't change this unless you know existing hashes or signatures will not be affected!
203	'signing_key' => 'aae6abd6209d82a691a9f96384a7634a',
204
205	// Force getFormData, getPost, and getGet to always run dispelMagicQuotes() with stripslashes().
206	// This should be set to 'true' when using the codebase with Wordpress because
207	// WP forcefully adds slashes to all input despite the setting of magic_quotes_gpc.
208	'always_dispel_magicquotes' => false,
209	);
210
211	/**
212	* Constructor.
213	*/
214	public function __construct($namespace='')
215	{
216	// Initialize default parameters.
217	$this->_params = array_merge($this->_params, $this->_param_defaults);
218
219	// Begin timing script.
220	require_once dirname(__FILE__) . '/ScriptTimer.inc.php';
221	$this->timer = new ScriptTimer();
222	$this->timer->start('_app');
223
224	// Are we running as a CLI?
225	$this->cli = ('cli' === php_sapi_name() \|\| defined('_CLI'));
226	}
227
228	/**
229	* This method enforces the singleton pattern for this class. Only one application is running at a time.
230	*
231	* $param string $namespace Name of this application.
232	* @return object Reference to the global Cache object.
233	* @access public
234	* @static
235	*/
236	public static function &getInstance($namespace='')
237	{
238	if (self::$instance === null) {
239	// FIXME: Yep, having a namespace with one singleton instance is not very useful. This is a design flaw with the Codebase.
240	// We're currently getting instances of App throughout the codebase using `$app =& App::getInstance();`
241	// with no way to determine what the namespace of the containing application is (e.g., `public` vs. `admin`).
242	// Option 1: provide the project namespace to all classes that use App, and then instantiate with `$app =& App::getInstance($this->_ns);`.
243	// In this case the namespace of the App and the namespace of the auxiliary class must match.
244	// Option 2: may be to clone a specific instance to the "default" instance, so, e.g., `$app =& App::getInstance();`
245	// refers to the same namespace as `$app =& App::getInstance('admin');`
246	// Option 3: is to check if there is only one instance, and return it if an unspecified namespace is requested.
247	// However, in the case when multiple namespaces are in play at the same time, this will fail; unspecified namespaces
248	// would cause the creation of an additional instance, since there would not be an obvious named instance to return.
249	self::$instance = new self($namespace);
250	}
251
252	if ('' != $namespace) {
253	// We may not be able to request a specific instance, but we can specify a specific namespace.
254	// We're ignoring all instance requests with a blank namespace, so we use the last given one.
255	self::$instance->_ns = $namespace;
256	}
257
258	return self::$instance;
259	}
260
261	/**
262	* Set (or overwrite existing) parameters by passing an array of new parameters.
263	*
264	* @access public
265	* @param array $param Array of parameters (key => val pairs).
266	*/
267	public function setParam($param=null)
268	{
269	if (isset($param) && is_array($param)) {
270	// Merge new parameters with old overriding old ones that are passed.
271	$this->_params = array_merge($this->_params, $param);
272
273	if ($this->running) {
274	// Params that require additional processing if set during runtime.
275	foreach ($param as $key => $val) {
276	switch ($key) {
277	case 'session_name':
278	session_name($val);
279	break;
280
281	case 'session_use_cookies':
282	ini_set('session.use_cookies', $val);
283	break;
284
285	case 'error_reporting':
286	ini_set('error_reporting', $val);
287	break;
288
289	case 'display_errors':
290	ini_set('display_errors', $val);
291	break;
292
293	case 'log_errors':
294	ini_set('log_errors', true);
295	break;
296
297	case 'log_directory':
298	if (is_dir($val) && is_writable($val)) {
299	ini_set('error_log', $val . '/' . $this->getParam('php_error_log'));
300	}
301	break;
302	}
303	}
304	}
305	}
306	}
307
308	/**
309	* Return the value of a parameter.
310	*
311	* @access public
312	* @param string $param The key of the parameter to return.
313	* @return mixed Parameter value, or null if not existing.
314	*/
315	public function getParam($param=null)
316	{
317	if ($param === null) {
318	return $this->_params;
319	} else if (array_key_exists($param, $this->_params)) {
320	return $this->_params[$param];
321	} else {
322	return null;
323	}
324	}
325
326	/**
327	* Begin running this application.
328	*
329	* @access public
330	* @author Quinn Comendant <quinn@strangecode.com>
331	* @since 15 Jul 2005 00:32:21
332	*/
333	public function start()
334	{
335	if ($this->running) {
336	return false;
337	}
338
339	// Error reporting.
340	ini_set('error_reporting', $this->getParam('error_reporting'));
341	ini_set('display_errors', $this->getParam('display_errors'));
342	ini_set('log_errors', true);
343	if (is_dir($this->getParam('log_directory')) && is_writable($this->getParam('log_directory'))) {
344	ini_set('error_log', $this->getParam('log_directory') . '/' . $this->getParam('php_error_log'));
345	}
346
347	// Set character set to use for multi-byte string functions.
348	mb_internal_encoding($this->getParam('character_set'));
349	ini_set('default_charset', $this->getParam('character_set'));
350	switch (mb_strtolower($this->getParam('character_set'))) {
351	case 'utf-8' :
352	mb_language('uni');
353	break;
354
355	case 'iso-2022-jp' :
356	mb_language('ja');
357	break;
358
359	case 'iso-8859-1' :
360	default :
361	mb_language('en');
362	break;
363	}
364
365	/**
366	* 1. Start Database.
367	*/
368
369	if (true === $this->getParam('enable_db')) {
370
371	// DB connection parameters taken from environment variables in the server httpd.conf file (readable only by root)âŠ
372	if (!empty($_SERVER['DB_SERVER']) && !$this->getParam('db_server')) {
373	$this->setParam(array('db_server' => $_SERVER['DB_SERVER']));
374	}
375	if (!empty($_SERVER['DB_NAME']) && !$this->getParam('db_name')) {
376	$this->setParam(array('db_name' => $_SERVER['DB_NAME']));
377	}
378	if (!empty($_SERVER['DB_USER']) && !$this->getParam('db_user')) {
379	$this->setParam(array('db_user' => $_SERVER['DB_USER']));
380	}
381	if (!empty($_SERVER['DB_PASS']) && !$this->getParam('db_pass')) {
382	$this->setParam(array('db_pass' => $_SERVER['DB_PASS']));
383	}
384
385	// DB credentials for CLI scripts stored in a JSON file with read rights given only to the user who will be executing the scripts: -r--------
386	// But not if all DB credentials have been defined already by other means.
387	if ($this->cli && (!$this->getParam('db_server') \|\| !$this->getParam('db_name') \|\| !$this->getParam('db_user') \|\| !$this->getParam('db_pass'))) {
388	if (false !== $db_auth_file = stream_resolve_include_path($this->getParam('db_auth_file'))) {
389	if (is_readable($db_auth_file)) {
390	$this->setParam(json_decode(file_get_contents($db_auth_file), true));
391	} else {
392	$this->logMsg(sprintf('Unable to read DB auth file: %s', $db_auth_file), LOG_ALERT, __FILE__, __LINE__);
393	}
394	} else {
395	$this->logMsg(sprintf('DB auth file not found: %s', $this->getParam('db_auth_file')), LOG_ALERT, __FILE__, __LINE__);
396	}
397	}
398
399	// There will ever only be one instance of the DB object, and here is where it is instantiated.
400	require_once dirname(__FILE__) . '/DB.inc.php';
401	$this->db =& DB::getInstance();
402	$this->db->setParam(array(
403	'db_server' => $this->getParam('db_server'),
404	'db_name' => $this->getParam('db_name'),
405	'db_user' => $this->getParam('db_user'),
406	'db_pass' => $this->getParam('db_pass'),
407	'db_always_debug' => $this->getParam('db_always_debug'),
408	'db_debug' => $this->getParam('db_debug'),
409	'db_die_on_failure' => $this->getParam('db_die_on_failure'),
410	));
411
412	// Connect to database.
413	$this->db->connect();
414	}
415
416
417	/**
418	* 2. Start PHP session.
419	*/
420
421	// Use sessions if enabled and not a CLI script.
422	if (true === $this->getParam('enable_session') && !$this->cli) {
423
424	// Session parameters.
425	ini_set('session.gc_probability', 1);
426	ini_set('session.gc_divisor', 1000);
427	ini_set('session.gc_maxlifetime', 43200); // 12 hours
428	ini_set('session.use_cookies', $this->getParam('session_use_cookies'));
429	ini_set('session.use_trans_sid', false);
430	ini_set('session.entropy_file', '/dev/urandom');
431	ini_set('session.entropy_length', '512');
432	ini_set('session.cookie_httponly', true);
433	session_name($this->getParam('session_name'));
434
435	if (true === $this->getParam('enable_db_session_handler') && true === $this->getParam('enable_db')) {
436	// Database session handling.
437	require_once dirname(__FILE__) . '/DBSessionHandler.inc.php';
438	$this->db_session = new DBSessionHandler($this->db, array(
439	'db_table' => 'session_tbl',
440	'create_table' => $this->getParam('db_create_tables'),
441	));
442	}
443
444	// Start the session.
445	session_start();
446
447	if (!isset($_SESSION['_app'][$this->_ns])) {
448	// Access session data using: $_SESSION['...'].
449	// Initialize here _after_ session has started.
450	$_SESSION['_app'][$this->_ns] = array(
451	'messages' => array(),
452	'boomerang' => array(),
453	);
454	}
455	}
456
457
458	/**
459	* 3. Misc setup.
460	*/
461
462	// Site URL will become something like http://host.name.tld (no ending slash)
463	// and is used whenever a URL need be used to the current site.
464	// Not available on CLI scripts obviously.
465	if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_url')) {
466	$this->setParam(array('site_url' => sprintf('%s://%s', ('on' == getenv('HTTPS') ? 'https' : 'http'), getenv('HTTP_HOST'))));
467	}
468
469	// Page URL will become a permalink to the current page.
470	// Also not available on CLI scripts obviously.
471	if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST']) {
472	$this->setParam(array('page_url' => sprintf('%s://%s%s', ('on' == getenv('HTTPS') ? 'https' : 'http'), getenv('HTTP_HOST'), getenv('REQUEST_URI'))));
473	}
474
475	// In case site_email isn't set, use something halfway presentable.
476	if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_email')) {
477	$this->setParam(array('site_email' => sprintf('no-reply@%s', getenv('HTTP_HOST'))));
478	}
479
480	// A key for calculating simple cryptographic signatures.
481	if (isset($_SERVER['SIGNING_KEY'])) {
482	$this->setParam(array('signing_key' => $_SERVER['SIGNING_KEY']));
483	}
484
485	// Character set. This should also be printed in the html header template.
486	if (!$this->cli) {
487	if (!headers_sent($h_file, $h_line)) {
488	header(sprintf('Content-type: %s; charset=%s', $this->getParam('content_type'), $this->getParam('character_set')));
489	} else {
490	$this->logMsg(sprintf('Unable to set Content-type; headers already sent (output started in %s : %s)', $h_file, $h_line), LOG_DEBUG, __FILE__, __LINE__);
491	}
492	}
493
494	// Cache control headers.
495	if (!$this->cli && false !== $this->getParam('http_cache_headers')) {
496	if (!headers_sent($h_file, $h_line)) {
497	if ($this->getParam('http_cache_headers') > 0) {
498	// Allow HTTP caching, for this many seconds.
499	header(sprintf('Cache-Control: no-transform, public, max-age=%d', $this->getParam('http_cache_headers')));
500	header('Vary: Accept-Encoding');
501	} else {
502	// Disallow HTTP caching entirely. http://stackoverflow.com/a/2068407
503	header('Cache-Control: no-cache, no-store, must-revalidate'); // HTTP 1.1.
504	header('Pragma: no-cache'); // HTTP 1.0.
505	header('Expires: 0'); // Proxies.
506	}
507	} else {
508	$this->logMsg(sprintf('Unable to set Cache-Control; headers already sent (output started in %s : %s)', $h_file, $h_line), LOG_DEBUG, __FILE__, __LINE__);
509	}
510	}
511
512	// Set the version of the codebase we're using.
513	$codebase_version_file = dirname(__FILE__) . '/../docs/version.txt';
514	$codebase_version = '';
515	if (is_readable($codebase_version_file) && !is_dir($codebase_version_file)) {
516	$codebase_version = trim(file_get_contents($codebase_version_file));
517	$this->setParam(array('codebase_version' => $codebase_version));
518	if (!$this->cli && $this->getParam('codebase_version')) {
519	if (!headers_sent($h_file, $h_line)) {
520	header(sprintf('X-Codebase-Version: %s', $this->getParam('codebase_version')));
521	} else {
522	$this->logMsg(sprintf('Unable to set X-Codebase-Version; headers already sent (output started in %s : %s)', $h_file, $h_line), LOG_DEBUG, __FILE__, __LINE__);
523	}
524	}
525	}
526
527	if (version_compare(PHP_VERSION, self::CODEBASE_MIN_PHP_VERSION, '<')) {
528	$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__);
529	}
530
531	// Set the application version if defined.
532	if (false !== $site_version_file = stream_resolve_include_path($this->getParam('site_version_file'))) {
533	if (mb_strpos($site_version_file, '.json') !== false) {
534	$version_json = json_decode(trim(file_get_contents($site_version_file)), true);
535	$site_version = isset($version_json['version']) ? $version_json['version'] : null;
536	} else {
537	$site_version = trim(file_get_contents($site_version_file));
538	}
539	$this->setParam(array('site_version' => $site_version));
540	}
541	if (!$this->cli && $this->getParam('site_version')) {
542	if (!headers_sent($h_file, $h_line)) {
543	header(sprintf('X-Site-Version: %s', $this->getParam('site_version')));
544	} else {
545	$this->logMsg(sprintf('Unable to set X-Site-Version; headers already sent (output started in %s : %s)', $h_file, $h_line), LOG_DEBUG, __FILE__, __LINE__);
546	}
547	}
548
549	// Unset environment variables we're done with.
550	unset($_SERVER['DB_SERVER'], $_SERVER['DB_NAME'], $_SERVER['DB_USER'], $_SERVER['DB_PASS'], $_SERVER['SIGNING_KEY']);
551
552	$this->running = true;
553	return true;
554	}
555
556	/**
557	* Stop running this application.
558	*
559	* @access public
560	* @author Quinn Comendant <quinn@strangecode.com>
561	* @since 17 Jul 2005 17:20:18
562	*/
563	public function stop()
564	{
565	session_write_close();
566	$this->running = false;
567	$num_queries = 0;
568	if (is_a($this->db, 'DB') && true === $this->getParam('enable_db')) {
569	$num_queries = $this->db->numQueries();
570	$this->db->close();
571	}
572	$mem_current = memory_get_usage();
573	$mem_peak = memory_get_peak_usage();
574	$this->timer->stop('_app');
575	$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__);
576	}
577
578
579	/**
580	* Add a message to the session, which is printed in the header.
581	* Just a simple way to print messages to the user.
582	*
583	* @access public
584	*
585	* @param string $message The text description of the message.
586	* @param int $type The type of message: MSG_NOTICE,
587	* MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
588	* @param string $file __FILE__.
589	* @param string $line __LINE__.
590	*/
591	public function raiseMsg($message, $type=MSG_NOTICE, $file=null, $line=null)
592	{
593	$message = trim($message);
594
595	if (!$this->running) {
596	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
597	return false;
598	}
599
600	if (!$this->getParam('enable_session')) {
601	$this->logMsg(sprintf('Canceled %s, session not enabled.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
602	return false;
603	}
604
605	if ('' == trim($message)) {
606	$this->logMsg(sprintf('Raised message is an empty string.', null), LOG_NOTICE, __FILE__, __LINE__);
607	return false;
608	}
609
610	// Avoid duplicate full-stops..
611	$message = trim(preg_replace('/\.{2}$/', '.', $message));
612
613	// Save message in session under unique key to avoid duplicate messages.
614	$msg_id = md5($type . $message);
615	if (!isset($_SESSION['_app'][$this->_ns]['messages'][$msg_id])) {
616	$_SESSION['_app'][$this->_ns]['messages'][$msg_id] = array(
617	'type' => $type,
618	'message' => $message,
619	'file' => $file,
620	'line' => $line,
621	'count' => (isset($_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) ? (1 + $_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) : 1)
622	);
623	}
624
625	if (!in_array($type, array(MSG_NOTICE, MSG_SUCCESS, MSG_WARNING, MSG_ERR))) {
626	$this->logMsg(sprintf('Invalid MSG_* type: %s', $type), LOG_NOTICE, __FILE__, __LINE__);
627	}
628
629	// Increment the counter for this message type.
630	$this->_raised_msg_counter[$type] += 1;
631	}
632
633	/*
634	* Returns the number of raised message (all, or by type) for the current script execution (this number may not match the total number of messages stored in session for multiple script executions)
635	*
636	* @access public
637	* @param
638	* @return
639	* @author Quinn Comendant <quinn@strangecode.com>
640	* @version 1.0
641	* @since 30 Apr 2015 17:13:03
642	*/
643	public function getRaisedMessageCount($type='all')
644	{
645	if ('all' == $type) {
646	return array_sum($this->_raised_msg_counter);
647	} else if (isset($this->_raised_msg_counter[$type])) {
648	return $this->_raised_msg_counter[$type];
649	} else {
650	$this->logMsg(sprintf('Cannot return count of unknown raised message type: %s', $type), LOG_WARNING, __FILE__, __LINE__);
651	return false;
652	}
653	}
654
655	/**
656	* Returns an array of the raised messages.
657	*
658	* @access public
659	* @return array List of messages in FIFO order.
660	* @author Quinn Comendant <quinn@strangecode.com>
661	* @since 21 Dec 2005 13:09:20
662	*/
663	public function getRaisedMessages()
664	{
665	if (!$this->running) {
666	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
667	return false;
668	}
669	return isset($_SESSION['_app'][$this->_ns]['messages']) ? $_SESSION['_app'][$this->_ns]['messages'] : array();
670	}
671
672	/**
673	* Resets the message list.
674	*
675	* @access public
676	* @author Quinn Comendant <quinn@strangecode.com>
677	* @since 21 Dec 2005 13:21:54
678	*/
679	public function clearRaisedMessages()
680	{
681	if (!$this->running) {
682	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
683	return false;
684	}
685
686	$_SESSION['_app'][$this->_ns]['messages'] = array();
687	}
688
689	/**
690	* Prints the HTML for displaying raised messages.
691	*
692	* @param string $above Additional message to print above error messages (e.g. "Oops!").
693	* @param string $below Additional message to print below error messages (e.g. "Please fix and resubmit").
694	* @param string $print_gotohash_js Print a line of javascript that scrolls the browser window down to view any error messages.
695	* @param string $hash The #hashtag to scroll to.
696	* @access public
697	* @author Quinn Comendant <quinn@strangecode.com>
698	* @since 15 Jul 2005 01:39:14
699	*/
700	public function printRaisedMessages($above='', $below='', $print_gotohash_js=false, $hash='sc-msg')
701	{
702
703	if (!$this->running) {
704	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
705	return false;
706	}
707
708	$messages = $this->getRaisedMessages();
709	if (!empty($messages)) {
710	?><div id="sc-msg" class="sc-msg"><?php
711	if ('' != $above) {
712	?><div class="sc-above"><?php echo oTxt($above); ?></div><?php
713	}
714	foreach ($messages as $m) {
715	if (error_reporting() > 0 && $this->getParam('display_errors') && isset($m['file']) && isset($m['line'])) {
716	echo "\n<!-- [" . $m['file'] . ' : ' . $m['line'] . '] -->';
717	}
718	switch ($m['type']) {
719	case MSG_ERR:
720	echo '<div data-alert class="sc-msg-error alert-box alert">' . $m['message'] . '<a href="#" class="close">×</a></div>';
721	break;
722
723	case MSG_WARNING:
724	echo '<div data-alert class="sc-msg-warning alert-box warning">' . $m['message'] . '<a href="#" class="close">×</a></div>';
725	break;
726
727	case MSG_SUCCESS:
728	echo '<div data-alert class="sc-msg-success alert-box success">' . $m['message'] . '<a href="#" class="close">×</a></div>';
729	break;
730
731	case MSG_NOTICE:
732	default:
733	echo '<div data-alert class="sc-msg-notice alert-box info">' . $m['message'] . '<a href="#" class="close">×</a></div>';
734	break;
735	}
736	}
737	if ('' != $below) {
738	?><div class="sc-below"><?php echo oTxt($below); ?></div><?php
739	}
740	?></div><?php
741	if ($print_gotohash_js) {
742	?>
743	<script type="text/javascript">
744	/* <![CDATA[ */
745	window.location.hash = '#<?php echo urlencode($hash); ?>';
746	/* ]]> */
747	</script>
748	<?php
749	}
750	}
751	$this->clearRaisedMessages();
752	}
753
754	/**
755	* Logs messages to defined channels: file, email, sms, and screen. Repeated messages are
756	* not repeated but printed once with count. Log events that match a sendable channel (email or SMS)
757	* are sent once per 'log_multiple_timeout' setting (to avoid a flood of error emails).
758	*
759	* @access public
760	* @param string $message The text description of the message.
761	* @param int $priority The type of message priority (in descending order):
762	* LOG_EMERG 0 system is unusable
763	* LOG_ALERT 1 action must be taken immediately
764	* LOG_CRIT 2 critical conditions
765	* LOG_ERR 3 error conditions
766	* LOG_WARNING 4 warning conditions
767	* LOG_NOTICE 5 normal, but significant, condition
768	* LOG_INFO 6 informational message
769	* LOG_DEBUG 7 debug-level message
770	* @param string $file The file where the log event occurs.
771	* @param string $line The line of the file where the log event occurs.
772	* @param string $url The URL where the log event occurs ($_SERVER['REQUEST_URI'] will be used if left null).
773	*/
774	public function logMsg($message, $priority=LOG_INFO, $file=null, $line=null, $url=null)
775	{
776	static $previous_events = array();
777
778	// If priority is not specified, assume the worst.
779	if (!$this->logPriorityToString($priority)) {
780	$this->logMsg(sprintf('Log priority %s not defined. (Message: %s)', $priority, $message), LOG_EMERG, $file, $line);
781	$priority = LOG_EMERG;
782	}
783
784	// In case __FILE__ and __LINE__ are not provided, note that fact.
785	$file = '' == $file ? 'unknown-file' : $file;
786	$line = '' == $line ? 'unknown-line' : $line;
787
788	// Get the URL, or used the provided value.
789	if (!isset($url)) {
790	$url = isset($_SERVER['REQUEST_URI']) ? mb_substr($_SERVER['REQUEST_URI'], 0, $this->getParam('log_message_max_length')) : '';
791	}
792
793	// If log file is not specified, don't log to a file.
794	if (!$this->getParam('log_directory') \|\| !$this->getParam('log_filename') \|\| !is_dir($this->getParam('log_directory')) \|\| !is_writable($this->getParam('log_directory'))) {
795	$this->setParam(array('log_file_priority' => false));
796	// We must use trigger_error to report this problem rather than calling $app->logMsg, which might lead to an infinite loop.
797	trigger_error(sprintf('Codebase error: log directory (%s) not found or writable.', $this->getParam('log_directory')), E_USER_NOTICE);
798	}
799
800	// Before we get any further, let's see if ANY log events are configured to be reported.
801	if ((false === $this->getParam('log_file_priority') \|\| $priority > $this->getParam('log_file_priority'))
802	&& (false === $this->getParam('log_email_priority') \|\| $priority > $this->getParam('log_email_priority'))
803	&& (false === $this->getParam('log_sms_priority') \|\| $priority > $this->getParam('log_sms_priority'))
804	&& (false === $this->getParam('log_screen_priority') \|\| $priority > $this->getParam('log_screen_priority'))) {
805	// This event would not be recorded, skip it entirely.
806	return false;
807	}
808
809	// Strip HTML tags except any with more than 7 characters because that's probably not a HTML tag, e.g. <email@address.com>.
810	preg_match_all('/(<[^>\s]{7,})[^>]*>/', $message, $strip_tags_allow);
811	$message = strip_tags(preg_replace('/\s+/', ' ', $message), (!empty($strip_tags_allow[1]) ? join('> ', $strip_tags_allow[1]) . '>' : null));
812
813	// Serialize multi-line messages.
814	$message = preg_replace('/\s+/m', ' ', trim($message));
815
816	// Store this event under a unique key, counting each time it occurs so that it only gets reported a limited number of times.
817	$msg_id = md5($message . $priority . $file . $line);
818	if ($this->getParam('log_ignore_repeated_events') && isset($previous_events[$msg_id])) {
819	$previous_events[$msg_id]++;
820	if ($previous_events[$msg_id] == 2) {
821	$this->logMsg(sprintf('%s (Event repeated %s or more times)', $message, $previous_events[$msg_id]), $priority, $file, $line);
822	}
823	return false;
824	} else {
825	$previous_events[$msg_id] = 1;
826	}
827
828	// For email and SMS notification types use "lock" files to prevent sending email and SMS notices ad infinitum.
829	if ((false !== $this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority'))
830	\|\| (false !== $this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority'))) {
831	// This event will generate a "send" notification. Prepare lock file.
832	$site_hash = md5(empty($_SERVER['SERVER_NAME']) ? $_SERVER['SCRIPT_FILENAME'] : $_SERVER['SERVER_NAME']);
833	$lock_dir = $this->getParam('tmp_dir') . "/codebase_msgs_$site_hash/";
834	// Just use the file and line for the msg_id to limit the number of possible messages
835	// (the message string itself shan't be used as it may contain innumerable combinations).
836	$lock_file = $lock_dir . md5($file . ':' . $line);
837	if (!is_dir($lock_dir)) {
838	mkdir($lock_dir);
839	}
840	$send_notifications = true;
841	if (is_file($lock_file)) {
842	$msg_last_sent = filectime($lock_file);
843	// Has this message been sent more recently than the timeout?
844	if ((time() - $msg_last_sent) <= $this->getParam('log_multiple_timeout')) {
845	// This message was already sent recently.
846	$send_notifications = false;
847	} else {
848	// Timeout has expired; send notifications again and reset timeout.
849	touch($lock_file);
850	}
851	} else {
852	touch($lock_file);
853	}
854	}
855
856	// Make sure to log in the system's locale.
857	$locale = setlocale(LC_TIME, 0);
858	setlocale(LC_TIME, 'C');
859
860	// Data to be stored for a log event.
861	$event = array(
862	'date' => date('Y-m-d H:i:s'),
863	'remote ip' => getRemoteAddr(),
864	'pid' => getmypid(),
865	'type' => $this->logPriorityToString($priority),
866	'file:line' => "$file : $line",
867	'url' => $url,
868	'message' => mb_substr($message, 0, $this->getParam('log_message_max_length')),
869	);
870	// Here's a shortened version of event data.
871	$event_short = $event;
872	$event_short['url'] = truncate($event_short['url'], 120);
873
874	// Restore original locale.
875	setlocale(LC_TIME, $locale);
876
877	// FILE ACTION
878	if (false !== $this->getParam('log_file_priority') && $priority <= $this->getParam('log_file_priority')) {
879	$event_str = '[' . join('] [', $event_short) . ']';
880	error_log("$event_str\n", 3, $this->getParam('log_directory') . '/' . $this->getParam('log_filename'));
881	}
882
883	// EMAIL ACTION
884	if (false !== $this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority') && $send_notifications) {
885	$hostname = (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : php_uname('n');
886	$subject = sprintf('[%s %s] %s', $hostname, $event['type'], mb_substr($event['message'], 0, 64));
887	$email_msg = sprintf("A log event of type '%s' occurred on %s\n\n", $event['type'], $hostname);
888	$headers = 'From: ' . $this->getParam('site_email');
889	foreach ($event as $k=>$v) {
890	$email_msg .= sprintf("%-16s %s\n", $k, $v);
891	}
892	$email_msg .= sprintf("%-16s %s\n", 'codebase version', $this->getParam('codebase_version'));
893	$email_msg .= sprintf("%-16s %s\n", 'site version', $this->getParam('site_version'));
894	mb_send_mail($this->getParam('log_to_email_address'), $subject, $email_msg, $headers);
895	}
896
897	// SMS ACTION
898	if (false !== $this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority') && $send_notifications) {
899	$hostname = (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : php_uname('n');
900	$subject = sprintf('[%s %s]', $hostname, $priority);
901	$sms_msg = sprintf('%s [%s:%s]', mb_substr($event_short['message'], 0, 64), basename($file), $line);
902	$headers = 'From: ' . $this->getParam('site_email');
903	mb_send_mail($this->getParam('log_to_sms_address'), $subject, $sms_msg, $headers);
904	}
905
906	// SCREEN ACTION
907	if (false !== $this->getParam('log_screen_priority') && $priority <= $this->getParam('log_screen_priority')) {
908	file_put_contents('php://stderr', "[{$event['type']}] [{$event['message']}]\n", FILE_APPEND);
909	}
910
911	return true;
912	}
913
914	/**
915	* Returns the string representation of a LOG_* integer constant.
916	* Updated: also returns the LOG_* integer constant if passed a string log value ('info' returns 6).
917	*
918	* @param int $priority The LOG_* integer constant (to return the string name), or a string name of a log priority to return the integer LOG_* value..
919	*
920	* @return The string representation of $priority (if integer given), or integer representation (if string given).
921	*/
922	public function logPriorityToString($priority) {
923	$priorities = array(
924	LOG_EMERG => 'emergency',
925	LOG_ALERT => 'alert',
926	LOG_CRIT => 'critical',
927	LOG_ERR => 'error',
928	LOG_WARNING => 'warning',
929	LOG_NOTICE => 'notice',
930	LOG_INFO => 'info',
931	LOG_DEBUG => 'debug'
932	);
933	if (isset($priorities[$priority])) {
934	return $priorities[$priority];
935	} else if (is_string($priority) && false !== ($key = array_search($priority, $priorities))) {
936	return $key;
937	} else {
938	return false;
939	}
940	}
941
942	/**
943	* Forcefully set a query argument even if one currently exists in the request.
944	* Values in the _carry_queries array will be copied to URLs (via $app->url()) and
945	* to hidden input values (via printHiddenSession()).
946	*
947	* @access public
948	* @param mixed $query_key The key (or keys, as an array) of the query argument to save.
949	* @param mixed $val The new value of the argument key.
950	* @author Quinn Comendant <quinn@strangecode.com>
951	* @since 13 Oct 2007 11:34:51
952	*/
953	public function setQuery($query_key, $val)
954	{
955	if (!is_array($query_key)) {
956	$query_key = array($query_key);
957	}
958	foreach ($query_key as $k) {
959	// Set the value of the specified query argument into the _carry_queries array.
960	$this->_carry_queries[$k] = $val;
961	}
962	}
963
964	/**
965	* Specify which query arguments will be carried persistently between requests.
966	* Values in the _carry_queries array will be copied to URLs (via $app->url()) and
967	* to hidden input values (via printHiddenSession()).
968	*
969	* @access public
970	* @param mixed $query_key The key (or keys, as an array) of the query argument to save.
971	* @param mixed $default If the key is not available, set to this default value.
972	* @author Quinn Comendant <quinn@strangecode.com>
973	* @since 14 Nov 2005 19:24:52
974	*/
975	public function carryQuery($query_key, $default=false)
976	{
977	if (!is_array($query_key)) {
978	$query_key = array($query_key);
979	}
980	foreach ($query_key as $k) {
981	// If not already set, and there is a non-empty value provided in the request...
982	if (isset($k) && '' != $k && !isset($this->_carry_queries[$k]) && false !== getFormData($k, $default)) {
983	// Copy the value of the specified query argument into the _carry_queries array.
984	$this->_carry_queries[$k] = getFormData($k, $default);
985	$this->logMsg(sprintf('Carrying query: %s => %s', $k, truncate(getDump($this->_carry_queries[$k], true), 128, 'end')), LOG_DEBUG, __FILE__, __LINE__);
986	}
987	}
988	}
989
990	/**
991	* dropQuery() is the opposite of carryQuery(). The specified value will not appear in
992	* url()/ohref()/printHiddenSession() modified URLs unless explicitly written in.
993	*
994	* @access public
995	* @param mixed $query_key The key (or keys, as an array) of the query argument to remove.
996	* @param bool $unset Remove any values set in the request matching the given $query_key.
997	* @author Quinn Comendant <quinn@strangecode.com>
998	* @since 18 Jun 2007 20:57:29
999	*/
1000	public function dropQuery($query_key, $unset=false)
1001	{
1002	if (!is_array($query_key)) {
1003	$query_key = array($query_key);
1004	}
1005	foreach ($query_key as $k) {
1006	if (array_key_exists($k, $this->_carry_queries)) {
1007	// Remove the value of the specified query argument from the _carry_queries array.
1008	$this->logMsg(sprintf('Dropping carried query: %s => %s', $k, $this->_carry_queries[$k]), LOG_DEBUG, __FILE__, __LINE__);
1009	unset($this->_carry_queries[$k]);
1010	}
1011	if ($unset && (isset($_REQUEST) && array_key_exists($k, $_REQUEST))) {
1012	unset($_REQUEST[$k], $_GET[$k], $_POST[$k], $_COOKIE[$k]);
1013	}
1014	}
1015	}
1016
1017	/**
1018	* Outputs a fully qualified URL with a query of all the used (ie: not empty)
1019	* keys and values, including optional queries. This allows mindless retention
1020	* of query arguments across page requests. If cookies are not
1021	* used and session_use_trans_sid=true the session id will be propagated in the URL.
1022	*
1023	* @param string $url The initial url
1024	* @param mixed $carry_args Additional url arguments to carry in the query,
1025	* or FALSE to prevent carrying queries. Can be any of the following formats:
1026	* array('key1', key2', key3') <-- to save these keys if in the form data.
1027	* array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data.
1028	* false <-- To not carry any queries. If URL already has queries those will be retained.
1029	*
1030	* @param mixed $always_include_sid Always add the session id, even if using_trans_sid = true. This is required when
1031	* URL starts with http, since PHP using_trans_sid doesn't do those and also for
1032	* header('Location...') redirections.
1033	*
1034	* @param bool $include_csrf_token Set to true to include the csrf_token in the form. Only use this for forms with action="post" to prevent the token from being revealed in the URL.
1035	* @return string url with attached queries and, if not using cookies, the session id
1036	*/
1037	public function url($url, $carry_args=null, $always_include_sid=false, $include_csrf_token=false)
1038	{
1039	if (!$this->running) {
1040	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1041	return false;
1042	}
1043
1044	if ($this->getParam('csrf_token_enabled') && $include_csrf_token) {
1045	// Include the csrf_token as a carried query argument.
1046	// This token can be validated upon form submission with $app->verifyCSRFToken() or $app->requireValidCSRFToken()
1047	$carry_args = is_array($carry_args) ? $carry_args : array();
1048	$carry_args = array_merge($carry_args, array($this->getParam('csrf_token_name') => $this->getCSRFToken()));
1049	}
1050
1051	// Get any provided query arguments to include in the final URL.
1052	// If FALSE is a provided here, DO NOT carry the queries.
1053	$do_carry_queries = true;
1054	$one_time_carry_queries = array();
1055	if (!is_null($carry_args)) {
1056	if (is_array($carry_args)) {
1057	if (!empty($carry_args)) {
1058	foreach ($carry_args as $key=>$arg) {
1059	// Get query from appropriate source.
1060	if (false === $arg) {
1061	$do_carry_queries = false;
1062	} else if (false !== getFormData($arg, false)) {
1063	$one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available.
1064	} else if (!is_numeric($key) && '' != $arg) {
1065	$one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data).
1066	}
1067	}
1068	}
1069	} else if (false !== getFormData($carry_args, false)) {
1070	$one_time_carry_queries[$carry_args] = getFormData($carry_args);
1071	} else if (false === $carry_args) {
1072	$do_carry_queries = false;
1073	}
1074	}
1075
1076	// Get the first delimiter that is needed in the url.
1077	$delim = mb_strpos($url, '?') !== false ? ini_get('arg_separator.output') : '?';
1078
1079	$q = '';
1080	if ($do_carry_queries) {
1081	// Join the global _carry_queries and local one_time_carry_queries.
1082	$query_args = urlEncodeArray(array_merge($this->_carry_queries, $one_time_carry_queries));
1083	foreach ($query_args as $key=>$val) {
1084	// Avoid indexed-array query params because in a URL array param keys should all match.
1085	// I.e, we want to use `array[]=A&array[]=B` instead of `array[0]=A&array[1]=B`.
1086	$key = preg_replace('/\[\d+\]$/', '[]', $key);
1087	// Check value is set and value does not already exist in the url.
1088	if (!preg_match('/[?&]' . preg_quote($key) . '=/', $url)) {
1089	$q .= $delim . $key . '=' . $val;
1090	$delim = ini_get('arg_separator.output');
1091	}
1092	}
1093	}
1094
1095	// Pop off any named anchors to push them back on after appending additional query args.
1096	$parts = explode('#', $url, 2);
1097	$url = $parts[0];
1098	$anchor = isset($parts[1]) ? $parts[1] : '';
1099
1100	// $anchor =
1101
1102	// Include the necessary SID if the following is true:
1103	// - no cookie in http request OR cookies disabled in App
1104	// - sessions are enabled
1105	// - the link stays on our site
1106	// - transparent SID propagation with session.use_trans_sid is not being used OR url begins with protocol (using_trans_sid has no effect here)
1107	// OR
1108	// - 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)
1109	// AND
1110	// - the SID is not already in the query.
1111	if (
1112	(
1113	(
1114	(
1115	!isset($_COOKIE[session_name()])
1116	\|\| !$this->getParam('session_use_cookies')
1117	)
1118	&& $this->getParam('session_use_trans_sid')
1119	&& $this->getParam('enable_session')
1120	&& isMyDomain($url)
1121	&& (
1122	!ini_get('session.use_trans_sid')
1123	\|\| preg_match('!^(http\|https)://!i', $url)
1124	)
1125	)
1126	\|\| $always_include_sid
1127	)
1128	&& !preg_match('/[?&]' . preg_quote(session_name()) . '=/', $url)
1129	) {
1130	$url = sprintf('%s%s%s%s=%s%s', $url, $q, $delim, session_name(), session_id(), ('' == $anchor ? '' : "#$anchor"));
1131	} else {
1132	$url = sprintf('%s%s%s', $url, $q, ('' == $anchor ? '' : "#$anchor"));
1133	}
1134
1135	return $url;
1136	}
1137
1138	/**
1139	* Returns a HTML-friendly URL processed with $app->url and & replaced with &
1140	*
1141	* @access public
1142	* @param (see param reference for url() method)
1143	* @return string URL passed through $app->url() with ampersands transformed to $amp;
1144	* @author Quinn Comendant <quinn@strangecode.com>
1145	* @since 09 Dec 2005 17:58:45
1146	*/
1147	public function oHREF($url, $carry_args=null, $always_include_sid=false, $include_csrf_token=false)
1148	{
1149	// Process the URL.
1150	$url = $this->url($url, $carry_args, $always_include_sid, $include_csrf_token);
1151
1152	// Replace any & not followed by an html or unicode entity with its & equivalent.
1153	$url = preg_replace('/&(?![\w\d#]{1,10};)/', '&', $url);
1154
1155	return $url;
1156	}
1157
1158	/**
1159	* Prints a hidden form element with the PHPSESSID when cookies are not used, as well
1160	* as hidden form elements for GET_VARS that might be in use.
1161	*
1162	* @param mixed $carry_args Additional url arguments to carry in the query,
1163	* or FALSE to prevent carrying queries. Can be any of the following formats:
1164	* array('key1', key2', key3') <-- to save these keys if in the form data.
1165	* array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data.
1166	* false <-- To not carry any queries. If URL already has queries those will be retained.
1167	* @param bool $include_csrf_token Set to true to include the csrf_token in the form. Only use this for forms with action="post" to prevent the token from being revealed in the URL.
1168	*/
1169	public function printHiddenSession($carry_args=null, $include_csrf_token=false)
1170	{
1171	if (!$this->running) {
1172	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1173	return false;
1174	}
1175
1176	// Get any provided query arguments to include in the final hidden form data.
1177	// If FALSE is a provided here, DO NOT carry the queries.
1178	$do_carry_queries = true;
1179	$one_time_carry_queries = array();
1180	if (!is_null($carry_args)) {
1181	if (is_array($carry_args)) {
1182	if (!empty($carry_args)) {
1183	foreach ($carry_args as $key=>$arg) {
1184	// Get query from appropriate source.
1185	if (false === $arg) {
1186	$do_carry_queries = false;
1187	} else if (false !== getFormData($arg, false)) {
1188	$one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available.
1189	} else if (!is_numeric($key) && '' != $arg) {
1190	$one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data).
1191	}
1192	}
1193	}
1194	} else if (false !== getFormData($carry_args, false)) {
1195	$one_time_carry_queries[$carry_args] = getFormData($carry_args);
1196	} else if (false === $carry_args) {
1197	$do_carry_queries = false;
1198	}
1199	}
1200
1201	// For each existing request value, we create a hidden input to carry it through a form.
1202	if ($do_carry_queries) {
1203	// Join the global _carry_queries and local one_time_carry_queries.
1204	// urlencode is not used here, not for form data!
1205	$query_args = array_merge($this->_carry_queries, $one_time_carry_queries);
1206	foreach ($query_args as $key => $val) {
1207	if (is_array($val)) {
1208	foreach ($val as $subval) {
1209	if ('' != $key && '' != $subval) {
1210	printf('<input type="hidden" name="%s[]" value="%s" />', $key, $subval);
1211	}
1212	}
1213	} else if ('' != $key && '' != $val) {
1214	printf('<input type="hidden" name="%s" value="%s" />', $key, $val);
1215	}
1216	}
1217	unset($query_args, $key, $val, $subval);
1218	}
1219
1220	// Include the SID if:
1221	// * cookies are disabled
1222	// * the system isn't automatically adding trans_sid
1223	// * the session is enabled
1224	// * and we're configured to use trans_sid
1225	if (!isset($_COOKIE[session_name()])
1226	&& !ini_get('session.use_trans_sid')
1227	&& $this->getParam('enable_session')
1228	&& $this->getParam('session_use_trans_sid')
1229	) {
1230	printf('<input type="hidden" name="%s" value="%s" />', session_name(), session_id());
1231	}
1232
1233	// Include the csrf_token in the form.
1234	// This token can be validated upon form submission with $app->verifyCSRFToken() or $app->requireValidCSRFToken()
1235	if ($this->getParam('csrf_token_enabled') && $include_csrf_token) {
1236	printf('<input type="hidden" name="%s" value="%s" />', $this->getParam('csrf_token_name'), $this->getCSRFToken());
1237	}
1238	}
1239
1240	/*
1241	* 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
1242	*
1243	* @access public
1244	* @param string $url URL to media (e.g., /foo.js)
1245	* @return string URL with cache-busting version appended (/foo.js?v=1234567890)
1246	* @author Quinn Comendant <quinn@strangecode.com>
1247	* @version 1.0
1248	* @since 03 Sep 2014 22:40:24
1249	*/
1250	public function cacheBustURL($url)
1251	{
1252	// Get the first delimiter that is needed in the url.
1253	$delim = mb_strpos($url, '?') !== false ? ini_get('arg_separator.output') : '?';
1254	$v = crc32($this->getParam('codebase_version') . '\|' . $this->getParam('site_version'));
1255	return sprintf('%s%sv=%s', $url, $delim, $v);
1256	}
1257
1258	/*
1259	* Generate a csrf_token if it doesn't exist or is expired, save it to the session and return its value.
1260	* Otherwise just return the current token.
1261	* Details on the synchronizer token pattern:
1262	* https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet#General_Recommendation:_Synchronizer_Token_Pattern
1263	*
1264	* @access public
1265	* @return string The new or current csrf_token
1266	* @author Quinn Comendant <quinn@strangecode.com>
1267	* @version 1.0
1268	* @since 15 Nov 2014 17:57:17
1269	*/
1270	public function getCSRFToken()
1271	{
1272	if (!isset($_SESSION['_app'][$this->_ns]['csrf_token']) \|\| (removeSignature($_SESSION['_app'][$this->_ns]['csrf_token']) + $this->getParam('csrf_token_timeout') < time())) {
1273	// No token, or token is expired; generate one and return it.
1274	return $_SESSION['_app'][$this->_ns]['csrf_token'] = addSignature(time(), null, 64);
1275	}
1276	// Current token is not expired; return it.
1277	return $_SESSION['_app'][$this->_ns]['csrf_token'];
1278	}
1279
1280	/*
1281	* Compares the given csrf_token with the current or previous one saved in the session.
1282	*
1283	* @access public
1284	* @param string $user_submitted_csrf_token The user-submitted token to compare with the session token.
1285	* @param string $csrf_token The token to compare with the session token.
1286	* @return bool True if the tokens match, false otherwise.
1287	* @author Quinn Comendant <quinn@strangecode.com>
1288	* @version 1.0
1289	* @since 15 Nov 2014 18:06:55
1290	*/
1291	public function verifyCSRFToken($user_submitted_csrf_token)
1292	{
1293
1294	if (!$this->getParam('csrf_token_enabled')) {
1295	$this->logMsg(sprintf('%s called, but csrf_token_enabled=false', __METHOD__), LOG_ERR, __FILE__, __LINE__);
1296	return true;
1297	}
1298	if ('' == trim($user_submitted_csrf_token)) {
1299	$this->logMsg(sprintf('Empty string failed CSRF verification.', null), LOG_NOTICE, __FILE__, __LINE__);
1300	return false;
1301	}
1302	if (!verifySignature($user_submitted_csrf_token, null, 64)) {
1303	$this->logMsg(sprintf('Input failed CSRF verification (invalid signature in %s).', $user_submitted_csrf_token), LOG_WARNING, __FILE__, __LINE__);
1304	return false;
1305	}
1306	$csrf_token = $this->getCSRFToken();
1307	if ($user_submitted_csrf_token != $csrf_token) {
1308	$this->logMsg(sprintf('Input failed CSRF verification (%s not in %s).', $user_submitted_csrf_token, $csrf_token), LOG_WARNING, __FILE__, __LINE__);
1309	return false;
1310	}
1311	$this->logMsg(sprintf('Verified CSRF token %s', $user_submitted_csrf_token), LOG_DEBUG, __FILE__, __LINE__);
1312	return true;
1313	}
1314
1315	/*
1316	* Bounce user if they submit a token that doesn't match the one saved in the session.
1317	* Because this function calls dieURL() it must be called before any other HTTP header output.
1318	*
1319	* @access public
1320	* @param string $message Optional message to display to the user (otherwise default message will display). Set to an empty string to display no message.
1321	* @param int $type The type of message: MSG_NOTICE,
1322	* MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
1323	* @param string $file __FILE__.
1324	* @param string $line __LINE__.
1325	* @return void
1326	* @author Quinn Comendant <quinn@strangecode.com>
1327	* @version 1.0
1328	* @since 15 Nov 2014 18:10:17
1329	*/
1330	public function requireValidCSRFToken($message=null, $type=MSG_NOTICE, $file=null, $line=null)
1331	{
1332	if (!$this->verifyCSRFToken(getFormData($this->getParam('csrf_token_name')))) {
1333	$message = isset($message) ? $message : _("Sorry, the form token expired. Please try again.");
1334	$this->raiseMsg($message, $type, $file, $line);
1335	$this->dieBoomerangURL();
1336	}
1337	}
1338
1339	/**
1340	* Uses an http header to redirect the client to the given $url. If sessions are not used
1341	* and the session is not already defined in the given $url, the SID is appended as a URI query.
1342	* As with all header generating functions, make sure this is called before any other output.
1343	*
1344	* @param string $url The URL the client will be redirected to.
1345	* @param mixed $carry_args Additional url arguments to carry in the query,
1346	* or FALSE to prevent carrying queries. Can be any of the following formats:
1347	* -array('key1', key2', key3') <-- to save these keys if in the form data.
1348	* -array('key1' => 'value', key2' => 'value') <-- to set keys to default values if not present in form data.
1349	* -false <-- To not carry any queries. If URL already has queries those will be retained.
1350	* @param bool $always_include_sid Force session id to be added to Location header.
1351	*/
1352	public function dieURL($url, $carry_args=null, $always_include_sid=false)
1353	{
1354	if (!$this->running) {
1355	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1356	return false;
1357	}
1358
1359	if (!$url) {
1360	// If URL is not specified, use the redirect_home_url.
1361	$url = $this->getParam('redirect_home_url');
1362	}
1363
1364	if (preg_match('!^/!', $url)) {
1365	// If relative URL is given, prepend correct local hostname.
1366	$scheme = 'on' == getenv('HTTPS') ? 'https' : 'http';
1367	$host = getenv('HTTP_HOST');
1368	$url = sprintf('%s://%s%s', $scheme, $host, $url);
1369	}
1370
1371	$url = $this->url($url, $carry_args, $always_include_sid);
1372
1373	// Should we send a "303 See Other" header here instead of relying on the 302 sent automatically by PHP?
1374	if (!headers_sent($h_file, $h_line)) {
1375	header(sprintf('Location: %s', $url));
1376	$this->logMsg(sprintf('dieURL: %s', $url), LOG_DEBUG, __FILE__, __LINE__);
1377	} else {
1378	// Fallback: die using meta refresh instead.
1379	printf('<meta http-equiv="refresh" content="0;url=%s" />', $url);
1380	$this->logMsg(sprintf('dieURL (refresh): %s; headers already sent (output started in %s : %s)', $url, $h_file, $h_line), LOG_NOTICE, __FILE__, __LINE__);
1381	}
1382
1383	// End application.
1384	// Recommended, although I'm not sure it's necessary: http://cn2.php.net/session_write_close
1385	$this->stop();
1386	die;
1387	}
1388
1389	/*
1390	* Redirects a user by calling $app->dieURL(). It will use:
1391	* 1. the stored boomerang URL, it it exists
1392	* 2. a specified $default_url, it it exists
1393	* 3. the referring URL, it it exists.
1394	* 4. redirect_home_url configuration variable.
1395	*
1396	* @access public
1397	* @param string $id Identifier for this script.
1398	* @param mixed $carry_args Additional arguments to carry in the URL automatically (see $app->url()).
1399	* @param string $default_url A default URL if there is not a valid specified boomerang URL.
1400	* @param bool $queryless_referrer_comparison Exclude the URL query from the refererIsMe() comparison.
1401	* @return bool False if the session is not running. No return otherwise.
1402	* @author Quinn Comendant <quinn@strangecode.com>
1403	* @since 31 Mar 2006 19:17:00
1404	*/
1405	public function dieBoomerangURL($id=null, $carry_args=null, $default_url=null, $queryless_referrer_comparison=false)
1406	{
1407	if (!$this->running) {
1408	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1409	return false;
1410	}
1411
1412	// Get URL from stored boomerang. Allow non specific URL if ID not valid.
1413	if ($this->validBoomerangURL($id, true)) {
1414	if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang'][$id])) {
1415	$url = $_SESSION['_app'][$this->_ns]['boomerang'][$id]['url'];
1416	$this->logMsg(sprintf('dieBoomerangURL(%s) found: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1417	} else {
1418	$url = end($_SESSION['_app'][$this->_ns]['boomerang'])['url'];
1419	$this->logMsg(sprintf('dieBoomerangURL(%s) using: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1420	}
1421	// Delete stored boomerang.
1422	$this->deleteBoomerangURL($id);
1423	} else if (isset($default_url)) {
1424	$url = $default_url;
1425	} else if (!refererIsMe(true === $queryless_referrer_comparison) && '' != ($url = getenv('HTTP_REFERER'))) {
1426	// Ensure that the redirecting page is not also the referrer.
1427	$this->logMsg(sprintf('dieBoomerangURL(%s) using referrer: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1428	} else {
1429	// If URL is not specified, use the redirect_home_url.
1430	$url = $this->getParam('redirect_home_url');
1431	$this->logMsg(sprintf('dieBoomerangURL(%s) using redirect_home_url: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1432	}
1433
1434	// A redirection will never happen immediately twice. Set the time so we can ensure this doesn't happen.
1435	$_SESSION['_app'][$this->_ns]['boomerang_last_redirect_time'] = time();
1436
1437	// Do it.
1438	$this->dieURL($url, $carry_args);
1439	}
1440
1441	/**
1442	* Set the URL to return to when $app->dieBoomerangURL() is called.
1443	*
1444	* @param string $url A fully validated URL.
1445	* @param bool $id An identification tag for this url.
1446	* FIXME: url garbage collection?
1447	*/
1448	public function setBoomerangURL($url=null, $id=null)
1449	{
1450	if (!$this->running) {
1451	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1452	return false;
1453	}
1454
1455	if ('' != $url && is_string($url)) {
1456	// Delete any boomerang request keys in the query string (along with any trailing delimiters after the deletion).
1457	$url = preg_replace(array('/([&?])boomerang=[^&?]+[&?]?/', '/[&?]$/'), array('$1', ''), $url);
1458
1459	if (isset($_SESSION['_app'][$this->_ns]['boomerang']) && is_array($_SESSION['_app'][$this->_ns]['boomerang']) && !empty($_SESSION['_app'][$this->_ns]['boomerang'])) {
1460	// If the ID already exists in the boomerang array, delete it.
1461	foreach (array_keys($_SESSION['_app'][$this->_ns]['boomerang']) as $existing_id) {
1462	// $existing_id could be null if existing boomerang URL was set without an ID.
1463	if ($existing_id === $id) {
1464	$this->logMsg(sprintf('Deleted existing boomerang URL matching ID: %s=>%s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1465	unset($_SESSION['_app'][$this->_ns]['boomerang'][$existing_id]);
1466	}
1467	}
1468	}
1469
1470	// A redirection will never happen immediately after setting the boomerang URL.
1471	// Set the time so ensure this doesn't happen. See $app->validBoomerangURL for more.
1472	if (isset($id)) {
1473	$_SESSION['_app'][$this->_ns]['boomerang'][$id] = array(
1474	'url' => $url,
1475	'added_time' => time(),
1476	);
1477	} else {
1478	$_SESSION['_app'][$this->_ns]['boomerang'][] = array(
1479	'url' => $url,
1480	'added_time' => time(),
1481	);
1482	}
1483
1484	$this->logMsg(sprintf('setBoomerangURL(%s): %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1485	return true;
1486	} else {
1487	$this->logMsg(sprintf('setBoomerangURL(%s) is empty!', $id, $url), LOG_NOTICE, __FILE__, __LINE__);
1488	return false;
1489	}
1490	}
1491
1492	/**
1493	* Return the URL set for the specified $id, or an empty string if one isn't set.
1494	*
1495	* @param string $id An identification tag for this url.
1496	*/
1497	public function getBoomerangURL($id=null)
1498	{
1499	if (!$this->running) {
1500	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1501	return false;
1502	}
1503
1504	if (isset($id)) {
1505	if (isset($_SESSION['_app'][$this->_ns]['boomerang'][$id])) {
1506	return $_SESSION['_app'][$this->_ns]['boomerang'][$id]['url'];
1507	} else {
1508	return '';
1509	}
1510	} else if (isset($_SESSION['_app'][$this->_ns]['boomerang']) && is_array($_SESSION['_app'][$this->_ns]['boomerang']) && !empty($_SESSION['_app'][$this->_ns]['boomerang'])) {
1511	return end($_SESSION['_app'][$this->_ns]['boomerang'])['url'];
1512	} else {
1513	return false;
1514	}
1515	}
1516
1517	/**
1518	* Delete the URL set for the specified $id.
1519	*
1520	* @param string $id An identification tag for this url.
1521	*/
1522	public function deleteBoomerangURL($id=null)
1523	{
1524	if (!$this->running) {
1525	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1526	return false;
1527	}
1528
1529	if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang'][$id])) {
1530	$url = $this->getBoomerangURL($id);
1531	unset($_SESSION['_app'][$this->_ns]['boomerang'][$id]);
1532	} else if (is_array($_SESSION['_app'][$this->_ns]['boomerang'])) {
1533	$url = array_pop($_SESSION['_app'][$this->_ns]['boomerang'])['url'];
1534	}
1535	$this->logMsg(sprintf('deleteBoomerangURL(%s): %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1536	}
1537
1538	/**
1539	* Check if a valid boomerang URL value has been set. A boomerang URL is considered
1540	* valid if: 1) it is not empty, 2) it is not the current URL, and 3) has not been accessed within n seconds.
1541	*
1542	* @return bool True if it is set and valid, false otherwise.
1543	*/
1544	public function validBoomerangURL($id=null, $use_nonspecificboomerang=false)
1545	{
1546	if (!$this->running) {
1547	$this->logMsg(sprintf('Canceled %s, application not running.', __METHOD__), LOG_NOTICE, __FILE__, __LINE__);
1548	return false;
1549	}
1550
1551	if (!isset($_SESSION['_app'][$this->_ns]['boomerang']) \|\| !is_array($_SESSION['_app'][$this->_ns]['boomerang']) \|\| empty($_SESSION['_app'][$this->_ns]['boomerang'])) {
1552	$this->logMsg(sprintf('validBoomerangURL(%s) no boomerang URL set, not an array, or empty.', $id), LOG_DEBUG, __FILE__, __LINE__);
1553	return false;
1554	}
1555
1556	$url = '';
1557	if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang'][$id])) {
1558	$url = $_SESSION['_app'][$this->_ns]['boomerang'][$id]['url'];
1559	$added_time = $_SESSION['_app'][$this->_ns]['boomerang'][$id]['added_time'];
1560	} else if (!isset($id) \|\| $use_nonspecificboomerang) {
1561	// Use most recent, non-specific boomerang if available.
1562	$url = end($_SESSION['_app'][$this->_ns]['boomerang'])['url'];
1563	$added_time = end($_SESSION['_app'][$this->_ns]['boomerang'])['added_time'];
1564	}
1565
1566	if ('' == trim($url)) {
1567	$this->logMsg(sprintf('validBoomerangURL(%s) not valid, empty!', $id), LOG_DEBUG, __FILE__, __LINE__);
1568	return false;
1569	}
1570
1571	if ($url == absoluteMe()) {
1572	// The URL we are directing to is the current page.
1573	$this->logMsg(sprintf('validBoomerangURL(%s) not valid, same as absoluteMe: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1574	return false;
1575	}
1576
1577	// Last redirect time is the time stamp of the last boomerangURL redirection, if any. A boomerang redirection should always occur at least several seconds after the last boomerang redirect (time it takes to load a page and receive user interaction).
1578	$boomerang_last_redirect_time = isset($_SESSION['_app'][$this->_ns]['boomerang_last_redirect_time']) ? $_SESSION['_app'][$this->_ns]['boomerang_last_redirect_time'] : null;
1579	if (isset($boomerang_last_redirect_time) && $boomerang_last_redirect_time >= (time() - 2)) {
1580	// Last boomerang direction was less than 2 seconds ago.
1581	$this->logMsg(sprintf('validBoomerangURL(%s) not valid, boomerang_last_redirect_time too short: %s seconds', $id, time() - $boomerang_last_redirect_time), LOG_DEBUG, __FILE__, __LINE__);
1582	return false;
1583	}
1584
1585	if (isset($added_time) && $added_time < (time() - 72000)) {
1586	// Last boomerang direction was more than 20 hours ago.
1587	$this->logMsg(sprintf('validBoomerangURL(%s) not valid, added_time too old: %s seconds', $id, time() - $added_time), LOG_DEBUG, __FILE__, __LINE__);
1588	// Delete this defunct boomerang.
1589	$this->deleteBoomerangURL($id);
1590	return false;
1591	}
1592
1593	$this->logMsg(sprintf('validBoomerangURL(%s) is valid: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1594	return true;
1595	}
1596
1597	/**
1598	* Force the user to connect via https (port 443) by redirecting them to
1599	* the same page but with https.
1600	*/
1601	public function sslOn()
1602	{
1603	if (function_exists('apache_get_modules')) {
1604	$modules = apache_get_modules();
1605	} else {
1606	// It's safe to assume we have mod_ssl if we can't determine otherwise.
1607	$modules = array('mod_ssl');
1608	}
1609
1610	if ('' == getenv('HTTPS') && $this->getParam('ssl_enabled') && in_array('mod_ssl', $modules)) {
1611	$this->raiseMsg(sprintf(_("Secure SSL connection made to %s"), $this->getParam('ssl_domain')), MSG_NOTICE, __FILE__, __LINE__);
1612	// Always append session because some browsers do not send cookie when crossing to SSL URL.
1613	$this->dieURL('https://' . $this->getParam('ssl_domain') . getenv('REQUEST_URI'), null, true);
1614	}
1615	}
1616
1617	/**
1618	* This function has changed to do nothing. There is no reason to prefer a non-SSL connection, and doing so may result in a redirect loop.
1619	*/
1620	public function sslOff()
1621	{
1622	$app =& App::getInstance();
1623	$app->logMsg(sprintf('sslOff was called and ignored.', null), LOG_INFO, __FILE__, __LINE__);
1624	}
1625
1626	/*
1627	* Sets a cookie, with error checking and some sane defaults.
1628	*
1629	* @access public
1630	* @param string $name The name of the cookie.
1631	* @param string $value The value of the cookie.
1632	* @param string $expire The time the cookie expires, as a unix timestamp or string value passed to strtotime.
1633	* @param string $path The path on the server in which the cookie will be available on.
1634	* @param string $domain The domain that the cookie is available to.
1635	* @param bool $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client.
1636	* @param bool $httponly When TRUE the cookie will be made accessible only through the HTTP protocol (makes cookies unreadable to javascript).
1637	* @return bool True on success, false on error.
1638	* @author Quinn Comendant <quinn@strangecode.com>
1639	* @version 1.0
1640	* @since 02 May 2014 16:36:34
1641	*/
1642	public function setCookie($name, $value, $expire='+10 years', $path='/', $domain=null, $secure=null, $httponly=null)
1643	{
1644	if (!is_scalar($name)) {
1645	$this->logMsg(sprintf('Cookie name must be scalar, is not: %s', getDump($name)), LOG_NOTICE, __FILE__, __LINE__);
1646	return false;
1647	}
1648	if (!is_scalar($value)) {
1649	$this->logMsg(sprintf('Cookie "%s" value must be scalar, is not: %s', $name, getDump($value)), LOG_NOTICE, __FILE__, __LINE__);
1650	return false;
1651	}
1652
1653	// Defaults.
1654	$expire = (is_numeric($expire) ? $expire : (is_string($expire) ? strtotime($expire) : $expire));
1655	$secure = $secure ?: ('' != getenv('HTTPS') && $this->getParam('ssl_enabled'));
1656	$httponly = $httponly ?: true;
1657
1658	// Make sure the expiration date is a valid 32bit integer.
1659	if (is_int($expire) && $expire > 2147483647) {
1660	$this->logMsg(sprintf('Cookie "%s" expire time exceeds a 32bit integer (%s)', $key, date('r', $expire)), LOG_NOTICE, __FILE__, __LINE__);
1661	}
1662
1663	// Measure total cookie length and warn if larger than max recommended size of 4093.
1664	// https://stackoverflow.com/questions/640938/what-is-the-maximum-size-of-a-web-browsers-cookies-key
1665	// The date the header name include 51 bytes: Set-Cookie: ; expires=Fri, 03-May-2024 00:04:47 GMT
1666	$cookielen = strlen($name . $value . $path . $domain . ($secure ? '; secure' : '') . ($httponly ? '; httponly' : '')) + 51;
1667	if ($cookielen > 4093) {
1668	$this->logMsg(sprintf('Cookie "%s" has a size greater than 4093 bytes (is %s bytes)', $key, $cookielen), LOG_NOTICE, __FILE__, __LINE__);
1669	}
1670
1671	// Ensure PHP version allow use of httponly.
1672	if (version_compare(PHP_VERSION, '5.2.0', '>=')) {
1673	$ret = setcookie($name, $value, $expire, $path, $domain, $secure, $httponly);
1674	} else {
1675	$ret = setcookie($name, $value, $expire, $path, $domain, $secure);
1676	}
1677
1678	if (false === $ret) {
1679	$this->logMsg(sprintf('Failed to set cookie (%s=%s) probably due to output before headers.', $name, $value), LOG_NOTICE, __FILE__, __LINE__);
1680	}
1681	return $ret;
1682	}
1683	} // End.

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

Download in other formats: