Context Navigation

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

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

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

Download in other formats: