Context Navigation

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

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

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

Download in other formats: