Context Navigation

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

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

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

Download in other formats: