qa-base.php 58.1 KB
Newer Older
Scott committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<?php
/*
	Question2Answer by Gideon Greenspan and contributors
	http://www.question2answer.org/

	Description: Sets up Q2A environment, plus many globally useful functions


	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License
	as published by the Free Software Foundation; either version 2
	of the License, or (at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	More about this license: http://www.question2answer.org/license.php
*/


Scott committed
23 24
define('QA_VERSION', '1.8.3'); // also used as suffix for .js and .css requests
define('QA_BUILD_DATE', '2019-01-12');
Scott committed
25 26


Scott committed
27 28 29 30 31 32 33 34 35 36
/**
 * Autoloads some Q2A classes so it's possible to use them without adding a require_once first. From version 1.7 onwards.
 * These loosely follow PHP-FIG's PSR-0 standard where faux namespaces are separated by underscores. This is being done
 * slowly and carefully to maintain backwards compatibility, and does not apply to plugins, themes, nor most of the core
 * for that matter.
 *
 * Classes are stored in the qa-include/Q2A folder, and then in subfolders depending on their categorization.
 * Class names should be of the form Q2A_<Namespace>_<Class>, e.g. Q2A_Util_Debug. There may be multiple "namespaces".
 * Classes are mapped to PHP files with the underscores converted to directory separators. The Q2A_Util_Debug class is in
 * the file qa-include/Q2A/Util/Debug.php. A class named Q2A_Db_User_Messages would be in a file qa-include/Q2A/Db/User/Messages.php.
Scott committed
37 38
 *
 * @param $class
Scott committed
39 40 41 42 43
 */
function qa_autoload($class)
{
	if (strpos($class, 'Q2A_') === 0)
		require QA_INCLUDE_DIR . strtr($class, '_', '/') . '.php';
Scott committed
44 45 46 47

	if (strpos($class, 'Q2A\\') === 0) {
		require QA_BASE_DIR . 'qa-src/' . strtr(substr($class, 4), '\\', '/') . '.php';
	}
Scott committed
48 49
}
spl_autoload_register('qa_autoload');
Scott committed
50

51
use Q2A\App\Application;
Scott committed
52

Scott committed
53
// Execution section of this file - remainder contains function definitions
54

Scott committed
55 56
qa_initialize_php();
qa_initialize_constants_1();
Scott committed
57

Scott committed
58 59 60 61 62 63 64
if (defined('QA_WORDPRESS_LOAD_FILE')) {
	// if relevant, load WordPress integration in global scope
	require_once QA_WORDPRESS_LOAD_FILE;
} elseif (defined('QA_JOOMLA_LOAD_FILE')) {
	// if relevant, load Joomla JConfig class into global scope
	require_once QA_JOOMLA_LOAD_FILE;
}
Scott committed
65

Scott committed
66 67 68
qa_initialize_constants_2();
qa_initialize_modularity();
qa_register_core_modules();
69

70
qa_initialize_predb_plugins();
Scott committed
71
require_once QA_INCLUDE_DIR . 'qa-db.php';
72
qa_db_allow_connect();
Scott committed
73

74 75 76 77 78 79
// $qa_autoconnect defaults to true so that optional plugins will load for external code. Q2A core
// code sets $qa_autoconnect to false so that we can use custom fail handlers.
if (!isset($qa_autoconnect) || $qa_autoconnect !== false) {
	qa_db_connect('qa_page_db_fail_handler');
	qa_initialize_postdb_plugins();
}
80

Scott committed
81

Scott committed
82
// Version comparison functions
Scott committed
83

Scott committed
84 85 86
/**
 * Converts the $version string (e.g. 1.6.2.2) to a floating point that can be used for greater/lesser comparisons
 * (PHP's version_compare() function is not quite suitable for our needs)
Scott committed
87
 * @deprecated 1.8.2 no longer used
Scott committed
88 89
 * @param $version
 * @return float
Scott committed
90 91 92 93
 */
function qa_version_to_float($version)
{
	$value = 0.0;
Scott committed
94

Scott committed
95 96 97
	if (preg_match('/[0-9\.]+/', $version, $matches)) {
		$parts = explode('.', $matches[0]);
		$units = 1.0;
Scott committed
98

Scott committed
99 100 101
		foreach ($parts as $part) {
			$value += min($part, 999) * $units;
			$units /= 1000;
Scott committed
102 103 104
		}
	}

Scott committed
105 106
	return $value;
}
Scott committed
107 108


Scott committed
109
/**
Scott committed
110
 * Returns true if the current Q2A version is lower than $version
Scott committed
111 112
 * @param $version
 * @return bool
Scott committed
113 114 115
 */
function qa_qa_version_below($version)
{
Scott committed
116
	return version_compare(QA_VERSION, $version) < 0;
Scott committed
117
}
Scott committed
118 119


Scott committed
120
/**
Scott committed
121
 * Returns true if the current PHP version is lower than $version
Scott committed
122 123
 * @param $version
 * @return bool
Scott committed
124 125 126
 */
function qa_php_version_below($version)
{
Scott committed
127
	return version_compare(phpversion(), $version) < 0;
Scott committed
128
}
Scott committed
129 130


Scott committed
131
// Initialization functions called above
Scott committed
132

Scott committed
133 134 135 136 137 138 139
/**
 * Set up and verify the PHP environment for Q2A, including unregistering globals if necessary
 */
function qa_initialize_php()
{
	if (qa_php_version_below('5.1.6'))
		qa_fatal_error('Q2A requires PHP 5.1.6 or later');
Scott committed
140

Scott committed
141
	error_reporting(E_ALL); // be ultra-strict about error checking
Scott committed
142

Scott committed
143
	@ini_set('magic_quotes_runtime', 0);
Scott committed
144

Scott committed
145
	@setlocale(LC_CTYPE, 'C'); // prevent strtolower() et al affecting non-ASCII characters (appears important for IIS)
Scott committed
146

Scott committed
147 148
	if (function_exists('date_default_timezone_set') && function_exists('date_default_timezone_get'))
		@date_default_timezone_set(@date_default_timezone_get()); // prevent PHP notices where default timezone not set
Scott committed
149

Scott committed
150 151 152
	if (ini_get('register_globals')) {
		$checkarrays = array('_ENV', '_GET', '_POST', '_COOKIE', '_SERVER', '_FILES', '_REQUEST', '_SESSION'); // unregister globals if they're registered
		$keyprotect = array_flip(array_merge($checkarrays, array('GLOBALS')));
Scott committed
153

Scott committed
154 155 156 157 158 159 160 161 162 163
		foreach ($checkarrays as $checkarray) {
			if (isset(${$checkarray}) && is_array(${$checkarray})) {
				foreach (${$checkarray} as $checkkey => $checkvalue) {
					if (isset($keyprotect[$checkkey])) {
						qa_fatal_error('My superglobals are not for overriding');
					} else {
						unset($GLOBALS[$checkkey]);
					}
				}
			}
Scott committed
164 165
		}
	}
Scott committed
166
}
Scott committed
167 168


Scott committed
169 170 171 172 173 174
/**
 * First stage of setting up Q2A constants, before (if necessary) loading WordPress or Joomla! integration
 */
function qa_initialize_constants_1()
{
	global $qa_request_map;
Scott committed
175

Scott committed
176
	define('QA_CATEGORY_DEPTH', 4); // you can't change this number!
Scott committed
177

Scott committed
178 179
	if (!defined('QA_BASE_DIR'))
		define('QA_BASE_DIR', dirname(dirname(__FILE__)) . '/'); // try out best if not set in index.php or qa-index.php - won't work with symbolic links
Scott committed
180

Scott committed
181 182 183 184 185
	define('QA_EXTERNAL_DIR', QA_BASE_DIR . 'qa-external/');
	define('QA_INCLUDE_DIR', QA_BASE_DIR . 'qa-include/');
	define('QA_LANG_DIR', QA_BASE_DIR . 'qa-lang/');
	define('QA_THEME_DIR', QA_BASE_DIR . 'qa-theme/');
	define('QA_PLUGIN_DIR', QA_BASE_DIR . 'qa-plugin/');
Scott committed
186

Scott committed
187 188
	if (!file_exists(QA_BASE_DIR . 'qa-config.php'))
		qa_fatal_error('The config file could not be found. Please read the instructions in qa-config-example.php.');
Scott committed
189

Scott committed
190
	require_once QA_BASE_DIR . 'qa-config.php';
Scott committed
191

Scott committed
192
	$qa_request_map = isset($QA_CONST_PATH_MAP) && is_array($QA_CONST_PATH_MAP) ? $QA_CONST_PATH_MAP : array();
Scott committed
193

Scott committed
194 195 196
	if (defined('QA_WORDPRESS_INTEGRATE_PATH') && strlen(QA_WORDPRESS_INTEGRATE_PATH)) {
		define('QA_FINAL_WORDPRESS_INTEGRATE_PATH', QA_WORDPRESS_INTEGRATE_PATH . ((substr(QA_WORDPRESS_INTEGRATE_PATH, -1) == '/') ? '' : '/'));
		define('QA_WORDPRESS_LOAD_FILE', QA_FINAL_WORDPRESS_INTEGRATE_PATH . 'wp-load.php');
Scott committed
197

Scott committed
198 199
		if (!is_readable(QA_WORDPRESS_LOAD_FILE)) {
			qa_fatal_error('Could not find wp-load.php file for WordPress integration - please check QA_WORDPRESS_INTEGRATE_PATH in qa-config.php');
Scott committed
200
		}
Scott committed
201 202 203
	} elseif (defined('QA_JOOMLA_INTEGRATE_PATH') && strlen(QA_JOOMLA_INTEGRATE_PATH)) {
		define('QA_FINAL_JOOMLA_INTEGRATE_PATH', QA_JOOMLA_INTEGRATE_PATH . ((substr(QA_JOOMLA_INTEGRATE_PATH, -1) == '/') ? '' : '/'));
		define('QA_JOOMLA_LOAD_FILE', QA_FINAL_JOOMLA_INTEGRATE_PATH . 'configuration.php');
204

Scott committed
205 206
		if (!is_readable(QA_JOOMLA_LOAD_FILE)) {
			qa_fatal_error('Could not find configuration.php file for Joomla integration - please check QA_JOOMLA_INTEGRATE_PATH in qa-config.php');
207
		}
Scott committed
208
	}
209

Scott committed
210
	// Polyfills
211

Scott committed
212 213 214 215 216
	// password_hash compatibility for 5.3-5.4
	define('QA_PASSWORD_HASH', !qa_php_version_below('5.3.7'));
	if (QA_PASSWORD_HASH) {
		require_once QA_INCLUDE_DIR . 'vendor/password_compat.php';
	}
Scott committed
217

Scott committed
218 219 220 221 222 223 224 225 226
	// http://php.net/manual/en/function.hash-equals.php#115635
	if (!function_exists('hash_equals')) {
		function hash_equals($str1, $str2)
		{
			if (strlen($str1) != strlen($str2)) {
				return false;
			} else {
				$res = $str1 ^ $str2;
				$ret = 0;
227 228
				for ($i = strlen($res) - 1; $i >= 0; $i--)
					$ret |= ord($res[$i]);
Scott committed
229
				return !$ret;
230 231
			}
		}
Scott committed
232
	}
Scott committed
233
}
Scott committed
234 235


Scott committed
236 237 238 239 240 241
/**
 * Second stage of setting up Q2A constants, after (if necessary) loading WordPress or Joomla! integration
 */
function qa_initialize_constants_2()
{
	// Default values if not set in qa-config.php
Scott committed
242

243 244 245 246 247 248 249 250 251 252 253 254
	$defaults = array(
		'QA_COOKIE_DOMAIN' => '',
		'QA_HTML_COMPRESSION' => true,
		'QA_MAX_LIMIT_START' => 19999,
		'QA_IGNORED_WORDS_FREQ' => 10000,
		'QA_ALLOW_UNINDEXED_QUERIES' => false,
		'QA_OPTIMIZE_LOCAL_DB' => true,
		'QA_OPTIMIZE_DISTANT_DB' => false,
		'QA_PERSISTENT_CONN_DB' => false,
		'QA_DEBUG_PERFORMANCE' => false,
	);

Scott committed
255
	foreach ($defaults as $key => $def) {
256 257 258 259
		if (!defined($key)) {
			define($key, $def);
		}
	}
Scott committed
260

Scott committed
261
	// Start performance monitoring
Scott committed
262

Scott committed
263 264 265 266 267 268
	if (QA_DEBUG_PERFORMANCE) {
		global $qa_usage;
		$qa_usage = new Q2A_Util_Usage;
		// ensure errors are displayed
		@ini_set('display_errors', 'On');
	}
Scott committed
269

Scott committed
270
	// More for WordPress integration
Scott committed
271

Scott committed
272 273 274 275 276 277
	if (defined('QA_FINAL_WORDPRESS_INTEGRATE_PATH')) {
		define('QA_FINAL_MYSQL_HOSTNAME', DB_HOST);
		define('QA_FINAL_MYSQL_USERNAME', DB_USER);
		define('QA_FINAL_MYSQL_PASSWORD', DB_PASSWORD);
		define('QA_FINAL_MYSQL_DATABASE', DB_NAME);
		define('QA_FINAL_EXTERNAL_USERS', true);
Scott committed
278

Scott committed
279
		// Undo WordPress's addition of magic quotes to various things (leave $_COOKIE as is since WP code might need that)
Scott committed
280

Scott committed
281 282 283 284 285
		function qa_undo_wordpress_quoting($param, $isget)
		{
			if (is_array($param)) { //
				foreach ($param as $key => $value)
					$param[$key] = qa_undo_wordpress_quoting($value, $isget);
Scott committed
286

Scott committed
287 288 289 290
			} else {
				$param = stripslashes($param);
				if ($isget)
					$param = strtr($param, array('\\\'' => '\'', '\"' => '"')); // also compensate for WordPress's .htaccess file
Scott committed
291 292
			}

Scott committed
293
			return $param;
294 295
		}

Scott committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
		$_GET = qa_undo_wordpress_quoting($_GET, true);
		$_POST = qa_undo_wordpress_quoting($_POST, false);
		$_SERVER['PHP_SELF'] = stripslashes($_SERVER['PHP_SELF']);

	} elseif (defined('QA_FINAL_JOOMLA_INTEGRATE_PATH')) {
		// More for Joomla integration
		$jconfig = new JConfig();
		define('QA_FINAL_MYSQL_HOSTNAME', $jconfig->host);
		define('QA_FINAL_MYSQL_USERNAME', $jconfig->user);
		define('QA_FINAL_MYSQL_PASSWORD', $jconfig->password);
		define('QA_FINAL_MYSQL_DATABASE', $jconfig->db);
		define('QA_FINAL_EXTERNAL_USERS', true);
	} else {
		define('QA_FINAL_MYSQL_HOSTNAME', QA_MYSQL_HOSTNAME);
		define('QA_FINAL_MYSQL_USERNAME', QA_MYSQL_USERNAME);
		define('QA_FINAL_MYSQL_PASSWORD', QA_MYSQL_PASSWORD);
		define('QA_FINAL_MYSQL_DATABASE', QA_MYSQL_DATABASE);
		define('QA_FINAL_EXTERNAL_USERS', QA_EXTERNAL_USERS);
	}

	if (defined('QA_MYSQL_PORT')) {
		define('QA_FINAL_MYSQL_PORT', QA_MYSQL_PORT);
	}

	// Possible URL schemes for Q2A and the string used for url scheme testing

	define('QA_URL_FORMAT_INDEX', 0);  // http://...../index.php/123/why-is-the-sky-blue
	define('QA_URL_FORMAT_NEAT', 1);   // http://...../123/why-is-the-sky-blue [requires .htaccess]
	define('QA_URL_FORMAT_PARAM', 3);  // http://...../?qa=123/why-is-the-sky-blue
	define('QA_URL_FORMAT_PARAMS', 4); // http://...../?qa=123&qa_1=why-is-the-sky-blue
	define('QA_URL_FORMAT_SAFEST', 5); // http://...../index.php?qa=123&qa_1=why-is-the-sky-blue

	define('QA_URL_TEST_STRING', '$&-_~#%\\@^*()][`\';=:|".{},!<>?# π§½Жש'); // tests escaping, spaces, quote slashing and unicode - but not + and /
}


/**
 * Gets everything ready to start using modules, layers and overrides
 */
function qa_initialize_modularity()
{
	global $qa_modules, $qa_layers, $qa_override_files, $qa_override_files_temp, $qa_overrides, $qa_direct;

	$qa_modules = array();
	$qa_layers = array();
	$qa_override_files = array();
	$qa_override_files_temp = array();
	$qa_overrides = array();
	$qa_direct = array();
}


/**
 * Set up output buffering. Use gzip compression if option set and it's not an admin page (since some of these contain lengthy processes).
 * @param $request
 * @return bool whether buffering was used
 */
function qa_initialize_buffering($request = '')
{
	if (headers_sent()) {
		return false;
	}

	$useGzip = QA_HTML_COMPRESSION && substr($request, 0, 6) !== 'admin/' && extension_loaded('zlib');
	ob_start($useGzip ? 'ob_gzhandler' : null);
	return true;
}


/**
 * Register all modules that come as part of the Q2A core (as opposed to plugins)
 */
function qa_register_core_modules()
{
	qa_register_module('filter', 'plugins/qa-filter-basic.php', 'qa_filter_basic', '');
	qa_register_module('editor', 'plugins/qa-editor-basic.php', 'qa_editor_basic', '');
	qa_register_module('viewer', 'plugins/qa-viewer-basic.php', 'qa_viewer_basic', '');
	qa_register_module('event', 'plugins/qa-event-limits.php', 'qa_event_limits', 'Q2A Event Limits');
	qa_register_module('event', 'plugins/qa-event-notify.php', 'qa_event_notify', 'Q2A Event Notify');
	qa_register_module('event', 'plugins/qa-event-updates.php', 'qa_event_updates', 'Q2A Event Updates');
	qa_register_module('search', 'plugins/qa-search-basic.php', 'qa_search_basic', '');
	qa_register_module('widget', 'plugins/qa-widget-activity-count.php', 'qa_activity_count', 'Activity Count');
	qa_register_module('widget', 'plugins/qa-widget-ask-box.php', 'qa_ask_box', 'Ask Box');
	qa_register_module('widget', 'plugins/qa-widget-related-qs.php', 'qa_related_qs', 'Related Questions');
	qa_register_module('widget', 'plugins/qa-widget-category-list.php', 'qa_category_list', 'Categories');
}


/**
385 386
 * Load plugins before database is available. Generally this includes database overrides and
 * process plugins that run early in the request lifecycle.
Scott committed
387
 */
388
function qa_initialize_predb_plugins()
Scott committed
389
{
390 391 392
	global $qa_pluginManager;
	$qa_pluginManager = new Q2A_Plugin_PluginManager();
	$qa_pluginManager->readAllPluginMetadatas();
Scott committed
393

394
	$qa_pluginManager->loadPluginsBeforeDbInit();
Scott committed
395
	qa_load_override_files();
396 397
}

398

399 400 401 402 403 404
/**
 * Load plugins after database is available. Plugins loaded here are able to be disabled in admin.
 */
function qa_initialize_postdb_plugins()
{
	global $qa_pluginManager;
Scott committed
405

406 407
	require_once QA_INCLUDE_DIR . 'app/options.php';
	qa_preload_options();
Scott committed
408

409
	$qa_pluginManager->loadPluginsAfterDbInit();
Scott committed
410
	qa_load_override_files();
411 412

	qa_report_process_stage('plugins_loaded');
Scott committed
413 414 415
}


416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
/**
 * Standard database failure handler function which bring up the install/repair/upgrade page
 * @param $type
 * @param int $errno
 * @param string $error
 * @param string $query
 * @return mixed
 */
function qa_page_db_fail_handler($type, $errno = null, $error = null, $query = null)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }

	$pass_failure_type = $type;
	$pass_failure_errno = $errno;
	$pass_failure_error = $error;
	$pass_failure_query = $query;

	require_once QA_INCLUDE_DIR . 'qa-install.php';

	qa_exit('error');
}


Scott committed
439 440 441 442 443 444
/**
 * Retrieve metadata information from the $contents of a qa-theme.php or qa-plugin.php file, specified by $type ('Plugin' or 'Theme').
 * If $versiononly is true, only min version metadata is parsed.
 * Name, Description, Min Q2A & Min PHP are not currently used by themes.
 *
 * @deprecated Deprecated from 1.7; Q2A_Util_Metadata class and metadata.json files should be used instead
Scott committed
445 446 447 448
 * @param $contents
 * @param $type
 * @param bool $versiononly
 * @return array
Scott committed
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
 */
function qa_addon_metadata($contents, $type, $versiononly = false)
{
	$fields = array(
		'min_q2a' => 'Minimum Question2Answer Version',
		'min_php' => 'Minimum PHP Version',
	);
	if (!$versiononly) {
		$fields = array_merge($fields, $fields = array(
			'name' => 'Name',
			'uri' => 'URI',
			'description' => 'Description',
			'version' => 'Version',
			'date' => 'Date',
			'author' => 'Author',
			'author_uri' => 'Author URI',
			'license' => 'License',
			'update_uri' => 'Update Check URI',
		));
468 469
	}

Scott committed
470 471 472 473 474 475
	$metadata = array();
	foreach ($fields as $key => $field) {
		// prepend 'Theme'/'Plugin' and search for key data
		$fieldregex = str_replace(' ', '[ \t]*', preg_quote("$type $field", '/'));
		if (preg_match('/' . $fieldregex . ':[ \t]*([^\n\f]*)[\n\f]/i', $contents, $matches))
			$metadata[$key] = trim($matches[1]);
Scott committed
476 477
	}

Scott committed
478 479
	return $metadata;
}
Scott committed
480 481


Scott committed
482 483 484 485 486 487
/**
 * Apply all the function overrides in override files that have been registered by plugins
 */
function qa_load_override_files()
{
	global $qa_override_files, $qa_override_files_temp, $qa_overrides;
Scott committed
488

Scott committed
489
	$functionindex = array();
Scott committed
490

Scott committed
491 492 493 494
	foreach ($qa_override_files_temp as $override) {
		$qa_override_files[] = $override;
		$filename = $override['directory'] . $override['include'];
		$functionsphp = file_get_contents($filename);
Scott committed
495

Scott committed
496
		preg_match_all('/\Wfunction\s+(qa_[a-z_]+)\s*\(/im', $functionsphp, $rawmatches, PREG_PATTERN_ORDER | PREG_OFFSET_CAPTURE);
Scott committed
497

Scott committed
498 499 500 501
		$reversematches = array_reverse($rawmatches[1], true); // reverse so offsets remain correct as we step through
		$postreplace = array();
		// include file name in defined function names to make debugging easier if there is an error
		$suffix = '_in_' . preg_replace('/[^A-Za-z0-9_]+/', '_', basename($override['include']));
Scott committed
502

Scott committed
503 504 505
		foreach ($reversematches as $rawmatch) {
			$function = strtolower($rawmatch[0]);
			$position = $rawmatch[1];
Scott committed
506

Scott committed
507 508
			if (isset($qa_overrides[$function]))
				$postreplace[$function . '_base'] = $qa_overrides[$function];
Scott committed
509

Scott committed
510 511 512 513
			$newname = $function . '_override_' . (@++$functionindex[$function]) . $suffix;
			$functionsphp = substr_replace($functionsphp, $newname, $position, strlen($function));
			$qa_overrides[$function] = $newname;
		}
Scott committed
514

Scott committed
515 516 517 518 519
		foreach ($postreplace as $oldname => $newname) {
			if (preg_match_all('/\W(' . preg_quote($oldname) . ')\s*\(/im', $functionsphp, $matches, PREG_PATTERN_ORDER | PREG_OFFSET_CAPTURE)) {
				$searchmatches = array_reverse($matches[1]);
				foreach ($searchmatches as $searchmatch) {
					$functionsphp = substr_replace($functionsphp, $newname, $searchmatch[1], strlen($searchmatch[0]));
Scott committed
520
				}
Scott committed
521
			}
Scott committed
522
		}
523

Scott committed
524 525 526
		// echo '<pre style="text-align:left;">'.htmlspecialchars($functionsphp).'</pre>'; // to debug munged code

		qa_eval_from_file($functionsphp, $filename);
Scott committed
527 528
	}

Scott committed
529 530
	$qa_override_files_temp = array();
}
Scott committed
531 532


Scott committed
533
// Functions for registering different varieties of Q2A modularity
Scott committed
534

Scott committed
535 536 537
/**
 * Register a module of $type named $name, whose class named $class is defined in file $include (or null if no include necessary)
 * If this module comes from a plugin, pass in the local plugin $directory and the $urltoroot relative url for that directory
Scott committed
538 539 540 541 542 543
 * @param $type
 * @param $include
 * @param $class
 * @param $name
 * @param string $directory
 * @param string $urltoroot
Scott committed
544 545 546 547
 */
function qa_register_module($type, $include, $class, $name, $directory = QA_INCLUDE_DIR, $urltoroot = null)
{
	global $qa_modules;
Scott committed
548

Scott committed
549
	$previous = @$qa_modules[$type][$name];
Scott committed
550

Scott committed
551 552 553
	if (isset($previous)) {
		qa_fatal_error('A ' . $type . ' module named ' . $name . ' already exists. Please check there are no duplicate plugins. ' .
			"\n\nModule 1: " . $previous['directory'] . $previous['include'] . "\nModule 2: " . $directory . $include);
Scott committed
554 555
	}

Scott committed
556 557 558 559 560 561 562
	$qa_modules[$type][$name] = array(
		'directory' => $directory,
		'urltoroot' => $urltoroot,
		'include' => $include,
		'class' => $class,
	);
}
Scott committed
563 564


Scott committed
565 566 567
/**
 * Register a layer named $name, defined in file $include. If this layer comes from a plugin (as all currently do),
 * pass in the local plugin $directory and the $urltoroot relative url for that directory
Scott committed
568 569 570 571
 * @param $include
 * @param $name
 * @param string $directory
 * @param string $urltoroot
Scott committed
572 573 574 575
 */
function qa_register_layer($include, $name, $directory = QA_INCLUDE_DIR, $urltoroot = null)
{
	global $qa_layers;
Scott committed
576

Scott committed
577
	$previous = @$qa_layers[$name];
Scott committed
578

Scott committed
579 580 581
	if (isset($previous)) {
		qa_fatal_error('A layer named ' . $name . ' already exists. Please check there are no duplicate plugins. ' .
			"\n\nLayer 1: " . $previous['directory'] . $previous['include'] . "\nLayer 2: " . $directory . $include);
Scott committed
582 583
	}

Scott committed
584 585 586 587 588 589
	$qa_layers[$name] = array(
		'directory' => $directory,
		'urltoroot' => $urltoroot,
		'include' => $include,
	);
}
Scott committed
590 591


Scott committed
592 593 594
/**
 * Register a file $include containing override functions. If this file comes from a plugin (as all currently do),
 * pass in the local plugin $directory and the $urltoroot relative url for that directory
Scott committed
595 596 597
 * @param $include
 * @param string $directory
 * @param string $urltoroot
Scott committed
598 599 600 601
 */
function qa_register_overrides($include, $directory = QA_INCLUDE_DIR, $urltoroot = null)
{
	global $qa_override_files_temp;
Scott committed
602

Scott committed
603 604 605 606 607 608
	$qa_override_files_temp[] = array(
		'directory' => $directory,
		'urltoroot' => $urltoroot,
		'include' => $include,
	);
}
Scott committed
609 610


Scott committed
611 612 613 614
/**
 * Register a set of language phrases, which should be accessed by the prefix $name/ in the qa_lang_*() functions.
 * Pass in the $pattern representing the PHP files that define these phrases, where * in the pattern is replaced with
 * the language code (e.g. 'fr') and/or 'default'. These files should be formatted like Q2A's qa-lang-*.php files.
Scott committed
615 616
 * @param $pattern
 * @param $name
Scott committed
617 618 619 620
 */
function qa_register_phrases($pattern, $name)
{
	global $qa_lang_file_pattern;
Scott committed
621

Scott committed
622 623 624
	if (file_exists(QA_INCLUDE_DIR . 'lang/qa-lang-' . $name . '.php')) {
		qa_fatal_error('The name "' . $name . '" for phrases is reserved and cannot be used by plugins.' . "\n\nPhrases: " . $pattern);
	}
Scott committed
625

Scott committed
626 627 628
	if (isset($qa_lang_file_pattern[$name])) {
		qa_fatal_error('A set of phrases named ' . $name . ' already exists. Please check there are no duplicate plugins. ' .
			"\n\nPhrases 1: " . $qa_lang_file_pattern[$name] . "\nPhrases 2: " . $pattern);
Scott committed
629 630
	}

Scott committed
631 632
	$qa_lang_file_pattern[$name] = $pattern;
}
Scott committed
633 634


Scott committed
635
// Function for registering varieties of Q2A modularity, which are (only) called from qa-plugin.php files
Scott committed
636

Scott committed
637 638 639
/**
 * Register a plugin module of $type named $name, whose class named $class is defined in file $include (or null if no include necessary)
 * This function relies on some global variable values and can only be called from a plugin's qa-plugin.php file
Scott committed
640 641 642 643
 * @param $type
 * @param $include
 * @param $class
 * @param $name
Scott committed
644 645 646 647
 */
function qa_register_plugin_module($type, $include, $class, $name)
{
	global $qa_plugin_directory, $qa_plugin_urltoroot;
Scott committed
648

Scott committed
649 650
	if (empty($qa_plugin_directory) || empty($qa_plugin_urltoroot)) {
		qa_fatal_error('qa_register_plugin_module() can only be called from a plugin qa-plugin.php file');
Scott committed
651 652
	}

Scott committed
653 654
	qa_register_module($type, $include, $class, $name, $qa_plugin_directory, $qa_plugin_urltoroot);
}
Scott committed
655 656


Scott committed
657 658
/**
 * Register a plugin layer named $name, defined in file $include. Can only be called from a plugin's qa-plugin.php file
Scott committed
659 660
 * @param $include
 * @param $name
Scott committed
661 662 663 664
 */
function qa_register_plugin_layer($include, $name)
{
	global $qa_plugin_directory, $qa_plugin_urltoroot;
Scott committed
665

Scott committed
666 667
	if (empty($qa_plugin_directory) || empty($qa_plugin_urltoroot)) {
		qa_fatal_error('qa_register_plugin_layer() can only be called from a plugin qa-plugin.php file');
Scott committed
668 669
	}

Scott committed
670 671
	qa_register_layer($include, $name, $qa_plugin_directory, $qa_plugin_urltoroot);
}
Scott committed
672 673


Scott committed
674 675
/**
 * Register a plugin file $include containing override functions. Can only be called from a plugin's qa-plugin.php file
Scott committed
676
 * @param $include
Scott committed
677 678 679 680
 */
function qa_register_plugin_overrides($include)
{
	global $qa_plugin_directory, $qa_plugin_urltoroot;
Scott committed
681

Scott committed
682 683
	if (empty($qa_plugin_directory) || empty($qa_plugin_urltoroot)) {
		qa_fatal_error('qa_register_plugin_overrides() can only be called from a plugin qa-plugin.php file');
Scott committed
684 685
	}

Scott committed
686 687
	qa_register_overrides($include, $qa_plugin_directory, $qa_plugin_urltoroot);
}
Scott committed
688 689


Scott committed
690 691
/**
 * Register a file name $pattern within a plugin directory containing language phrases accessed by the prefix $name
Scott committed
692 693
 * @param $pattern
 * @param $name
Scott committed
694 695 696 697
 */
function qa_register_plugin_phrases($pattern, $name)
{
	global $qa_plugin_directory, $qa_plugin_urltoroot;
Scott committed
698

Scott committed
699 700
	if (empty($qa_plugin_directory) || empty($qa_plugin_urltoroot)) {
		qa_fatal_error('qa_register_plugin_phrases() can only be called from a plugin qa-plugin.php file');
Scott committed
701 702
	}

Scott committed
703 704
	qa_register_phrases($qa_plugin_directory . $pattern, $name);
}
Scott committed
705 706


Scott committed
707
// Low-level functions used throughout Q2A
Scott committed
708

Scott committed
709 710 711
/**
 * Calls eval() on the PHP code in $eval which came from the file $filename. It supplements PHP's regular error reporting by
 * displaying/logging (as appropriate) the original source filename, if an error occurred when evaluating the code.
Scott committed
712 713
 * @param $eval
 * @param $filename
Scott committed
714 715 716 717
 */
function qa_eval_from_file($eval, $filename)
{
	// could also use ini_set('error_append_string') but apparently it doesn't work for errors logged on disk
Scott committed
718

Scott committed
719
	global $php_errormsg;
Scott committed
720

Scott committed
721 722
	$oldtrackerrors = @ini_set('track_errors', 1);
	$php_errormsg = null;
Scott committed
723

Scott committed
724
	eval('?' . '>' . $eval);
Scott committed
725

Scott committed
726 727 728 729 730 731 732 733 734 735
	if (strlen($php_errormsg)) {
		switch (strtolower(@ini_get('display_errors'))) {
			case 'on':
			case '1':
			case 'yes':
			case 'true':
			case 'stdout':
			case 'stderr':
				echo ' of ' . qa_html($filename) . "\n";
				break;
Scott committed
736 737
		}

Scott committed
738 739 740 741 742 743 744 745 746
		@error_log('PHP Question2Answer more info: ' . $php_errormsg . " in eval()'d code from " . qa_html($filename));
	}

	@ini_set('track_errors', $oldtrackerrors);
}


/**
 * Call $function with the arguments in the $args array (doesn't work with call-by-reference functions)
Scott committed
747 748 749
 * @param $function
 * @param $args
 * @return mixed
Scott committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
 */
function qa_call($function, $args)
{
	// call_user_func_array(...) is very slow, so we break out most common cases first
	switch (count($args)) {
		case 0:
			return $function();
		case 1:
			return $function($args[0]);
		case 2:
			return $function($args[0], $args[1]);
		case 3:
			return $function($args[0], $args[1], $args[2]);
		case 4:
			return $function($args[0], $args[1], $args[2], $args[3]);
		case 5:
			return $function($args[0], $args[1], $args[2], $args[3], $args[4]);
	}

	return call_user_func_array($function, $args);
}


/**
 * Determines whether a function is to be overridden by a plugin. But if the function is being called with
 * the _base suffix, any override will be bypassed due to $qa_direct.
 *
 * @param string $function The function to override
 * @return string|null The name of the overriding function (of the form `qa_functionname_override_1_in_filename`)
 */
function qa_to_override($function)
{
	global $qa_overrides, $qa_direct;

	// handle most common case first
	if (!isset($qa_overrides[$function])) {
		return null;
Scott committed
787 788
	}

Scott committed
789 790
	if (strpos($function, '_override_') !== false) {
		qa_fatal_error('Override functions should not be calling qa_to_override()!');
Scott committed
791 792
	}

Scott committed
793 794 795
	if (@$qa_direct[$function]) {
		unset($qa_direct[$function]); // bypass the override just this once
		return null;
Scott committed
796 797
	}

Scott committed
798 799
	return $qa_overrides[$function];
}
Scott committed
800 801


Scott committed
802 803
/**
 * Call the function which immediately overrides $function with the arguments in the $args array
Scott committed
804 805 806
 * @param $function
 * @param $args
 * @return mixed
Scott committed
807 808 809 810
 */
function qa_call_override($function, $args)
{
	global $qa_overrides;
Scott committed
811

Scott committed
812 813
	if (strpos($function, '_override_') !== false) {
		qa_fatal_error('Override functions should not be calling qa_call_override()!');
Scott committed
814 815
	}

Scott committed
816 817 818
	if (!function_exists($function . '_base')) {
		// define the base function the first time that it's needed
		eval('function ' . $function . '_base() { global $qa_direct; $qa_direct[\'' . $function . '\']=true; $args=func_get_args(); return qa_call(\'' . $function . '\', $args); }');
Scott committed
819 820
	}

Scott committed
821 822
	return qa_call($qa_overrides[$function], $args);
}
Scott committed
823 824


Scott committed
825 826
/**
 * Exit PHP immediately after reporting a shutdown with $reason to any installed process modules
Scott committed
827
 * @param string $reason
Scott committed
828 829 830 831
 */
function qa_exit($reason = null)
{
	qa_report_process_stage('shutdown', $reason);
Scott committed
832

Scott committed
833 834 835
	$code = $reason === 'error' ? 1 : 0;
	exit($code);
}
Scott committed
836 837


Scott committed
838 839
/**
 * Display $message in the browser, write it to server error log, and then stop abruptly
Scott committed
840 841
 * @param $message
 * @return mixed
Scott committed
842 843 844 845
 */
function qa_fatal_error($message)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
846

Scott committed
847 848 849
	echo 'Question2Answer fatal error:<p style="color: red">' . qa_html($message, true) . '</p>';
	@error_log('PHP Question2Answer fatal error: ' . $message);
	echo '<p>Stack trace:<p>';
Scott committed
850

Scott committed
851 852 853 854 855 856 857
	$backtrace = array_reverse(array_slice(debug_backtrace(), 1));
	foreach ($backtrace as $trace) {
		$color = strpos(@$trace['file'], '/qa-plugin/') !== false ? 'red' : '#999';
		echo sprintf(
			'<code style="color: %s">%s() in %s:%s</code><br>',
			$color, qa_html(@$trace['function']), basename(@$trace['file']), @$trace['line']
		);
Scott committed
858 859
	}

Scott committed
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
	qa_exit('error');
}


// Functions for listing, loading and getting info on modules

/**
 * Return an array with all registered modules' information
 */
function qa_list_modules_info()
{
	global $qa_modules;
	return $qa_modules;
}

/**
 * Return an array of all the module types for which at least one module has been registered
 */
function qa_list_module_types()
{
	return array_keys(qa_list_modules_info());
}

/**
 * Return a list of names of registered modules of $type
Scott committed
885 886
 * @param $type
 * @return array
Scott committed
887 888 889 890 891 892 893 894 895
 */
function qa_list_modules($type)
{
	$modules = qa_list_modules_info();
	return is_array(@$modules[$type]) ? array_keys($modules[$type]) : array();
}

/**
 * Return an array containing information about the module of $type named $name
Scott committed
896 897
 * @param $type
 * @param $name
898
 * @return array
Scott committed
899 900 901 902 903 904 905 906 907
 */
function qa_get_module_info($type, $name)
{
	$modules = qa_list_modules_info();
	return @$modules[$type][$name];
}

/**
 * Return an instantiated class for module of $type named $name, whose functions can be called, or null if it doesn't exist
Scott committed
908 909 910
 * @param $type
 * @param $name
 * @return mixed|null
Scott committed
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
 */
function qa_load_module($type, $name)
{
	global $qa_modules;

	$module = @$qa_modules[$type][$name];

	if (is_array($module)) {
		if (isset($module['object']))
			return $module['object'];

		if (strlen(@$module['include']))
			require_once $module['directory'] . $module['include'];

		if (strlen(@$module['class'])) {
			$object = new $module['class'];

			if (method_exists($object, 'load_module'))
				$object->load_module($module['directory'], qa_path_to_root() . $module['urltoroot'], $type, $name);

			$qa_modules[$type][$name]['object'] = $object;
			return $object;
		}
Scott committed
934 935
	}

Scott committed
936 937
	return null;
}
Scott committed
938

Scott committed
939 940 941
/**
 * Return an array of instantiated clases for modules which have defined $method
 * (all modules are loaded but not included in the returned array)
Scott committed
942 943
 * @param $method
 * @return array
Scott committed
944 945 946 947
 */
function qa_load_all_modules_with($method)
{
	$modules = array();
Scott committed
948

Scott committed
949
	$regmodules = qa_list_modules_info();
Scott committed
950

Scott committed
951 952 953
	foreach ($regmodules as $moduletype => $modulesinfo) {
		foreach ($modulesinfo as $modulename => $moduleinfo) {
			$module = qa_load_module($moduletype, $modulename);
Scott committed
954

Scott committed
955 956
			if (method_exists($module, $method))
				$modules[$modulename] = $module;
Scott committed
957 958 959
		}
	}

Scott committed
960 961
	return $modules;
}
Scott committed
962

Scott committed
963 964 965
/**
 * Return an array of instantiated clases for modules of $type which have defined $method
 * (other modules of that type are also loaded but not included in the returned array)
Scott committed
966 967 968
 * @param $type
 * @param $method
 * @return array
Scott committed
969 970 971 972
 */
function qa_load_modules_with($type, $method)
{
	$modules = array();
Scott committed
973

Scott committed
974
	$trynames = qa_list_modules($type);
Scott committed
975

Scott committed
976 977
	foreach ($trynames as $tryname) {
		$module = qa_load_module($type, $tryname);
Scott committed
978

Scott committed
979 980
		if (method_exists($module, $method))
			$modules[$tryname] = $module;
Scott committed
981 982
	}

Scott committed
983 984
	return $modules;
}
Scott committed
985 986


Scott committed
987
// HTML and Javascript escaping and sanitization
Scott committed
988

Scott committed
989 990
/**
 * Return HTML representation of $string, work well with blocks of text if $multiline is true
Scott committed
991 992 993
 * @param $string
 * @param bool $multiline
 * @return mixed|string
Scott committed
994 995 996 997
 */
function qa_html($string, $multiline = false)
{
	$html = htmlspecialchars((string)$string);
Scott committed
998

Scott committed
999 1000 1001 1002 1003
	if ($multiline) {
		$html = preg_replace('/\r\n?/', "\n", $html);
		$html = preg_replace('/(?<=\s) /', '&nbsp;', $html);
		$html = str_replace("\t", '&nbsp; &nbsp; ', $html);
		$html = nl2br($html);
Scott committed
1004 1005
	}

Scott committed
1006 1007
	return $html;
}
Scott committed
1008 1009


Scott committed
1010 1011 1012 1013
/**
 * Return $html after ensuring it is safe, i.e. removing Javascripts and the like - uses htmLawed library
 * Links open in a new window if $linksnewwindow is true. Set $storage to true if sanitization is for
 * storing in the database, rather than immediate display to user - some think this should be less strict.
Scott committed
1014 1015 1016 1017
 * @param $html
 * @param bool $linksnewwindow
 * @param bool $storage
 * @return mixed|string
Scott committed
1018
 */
Scott committed
1019
function qa_sanitize_html($html, $linksnewwindow = false, $storage = false)
Scott committed
1020 1021
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1022

Scott committed
1023
	require_once 'vendor/htmLawed.php';
Scott committed
1024

Scott committed
1025
	global $qa_sanitize_html_newwindow;
Scott committed
1026

Scott committed
1027
	$qa_sanitize_html_newwindow = $linksnewwindow;
Scott committed
1028

Scott committed
1029 1030 1031 1032 1033 1034 1035 1036
	$safe = htmLawed($html, array(
		'safe' => 1,
		'elements' => '*+embed+object-form',
		'schemes' => 'href: aim, feed, file, ftp, gopher, http, https, irc, mailto, news, nntp, sftp, ssh, telnet; *:file, http, https; style: !; classid:clsid',
		'keep_bad' => 0,
		'anti_link_spam' => array('/.*/', ''),
		'hook_tag' => 'qa_sanitize_html_hook_tag',
	));
Scott committed
1037

Scott committed
1038 1039
	return $safe;
}
Scott committed
1040 1041


Scott committed
1042 1043
/**
 * htmLawed hook function used to process tags in qa_sanitize_html(...)
Scott committed
1044 1045 1046
 * @param $element
 * @param array $attributes
 * @return string
Scott committed
1047 1048 1049 1050
 */
function qa_sanitize_html_hook_tag($element, $attributes = null)
{
	global $qa_sanitize_html_newwindow;
Scott committed
1051

Scott committed
1052 1053
	if (!isset($attributes)) // it's a closing tag
		return '</' . $element . '>';
Scott committed
1054

Scott committed
1055
	if ($element == 'param' && trim(strtolower(@$attributes['name'])) == 'allowscriptaccess')
Scott committed
1056
		$attributes['name'] = 'allowscriptaccess_denied';
Scott committed
1057

Scott committed
1058 1059
	if ($element == 'embed')
		unset($attributes['allowscriptaccess']);
Scott committed
1060

Scott committed
1061
	if ($element == 'a' && isset($attributes['href']) && $qa_sanitize_html_newwindow)
Scott committed
1062
		$attributes['target'] = '_blank';
Scott committed
1063

Scott committed
1064 1065 1066
	$html = '<' . $element;
	foreach ($attributes as $key => $value)
		$html .= ' ' . $key . '="' . $value . '"';
Scott committed
1067

Scott committed
1068 1069
	return $html . '>';
}
Scott committed
1070 1071


Scott committed
1072 1073
/**
 * Return XML representation of $string, which is similar to HTML but ASCII control characters are also disallowed
Scott committed
1074 1075
 * @param $string
 * @return string
Scott committed
1076 1077 1078 1079 1080
 */
function qa_xml($string)
{
	return htmlspecialchars(preg_replace('/[\x00-\x08\x0B\x0C\x0E-\x1F]/', '', (string)$string));
}
Scott committed
1081 1082


Scott committed
1083 1084 1085
/**
 * Return JavaScript representation of $value, putting in quotes if non-numeric or if $forcequotes is true. In the
 * case of boolean values they are returned as the appropriate true or false string
Scott committed
1086 1087 1088
 * @param $value
 * @param bool $forcequotes
 * @return string
Scott committed
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
 */
function qa_js($value, $forcequotes = false)
{
	$boolean = is_bool($value);
	if ($boolean)
		$value = $value ? 'true' : 'false';
	if ((is_numeric($value) || $boolean) && !$forcequotes)
		return $value;
	else
		return "'" . strtr($value, array(
Scott committed
1099 1100 1101 1102 1103
				"'" => "\\'",
				'/' => '\\/',
				'\\' => '\\\\',
				"\n" => "\\n",
				"\r" => "\\n",
Scott committed
1104 1105
			)) . "'";
}
Scott committed
1106 1107


Scott committed
1108 1109 1110 1111 1112
// Finding out more about the current request

/**
 * Inform Q2A that the current request is $request (slash-separated, independent of the url scheme chosen),
 * that the relative path to the Q2A root apperas to be $relativeroot, and the url scheme appears to be $usedformat
Scott committed
1113 1114 1115 1116
 * @param $request
 * @param $relativeroot
 * @param $usedformat
 * @return mixed
Scott committed
1117
 */
Scott committed
1118
function qa_set_request($request, $relativeroot, $usedformat = null)
Scott committed
1119 1120
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1121

Scott committed
1122
	global $qa_request, $qa_root_url_relative, $qa_used_url_format;
Scott committed
1123

Scott committed
1124 1125 1126 1127
	$qa_request = $request;
	$qa_root_url_relative = $relativeroot;
	$qa_used_url_format = $usedformat;
}
Scott committed
1128 1129


Scott committed
1130 1131 1132 1133 1134 1135
/**
 * Returns the current Q2A request (slash-separated, independent of the url scheme chosen)
 */
function qa_request()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1136

Scott committed
1137 1138 1139
	global $qa_request;
	return $qa_request;
}
Scott committed
1140 1141


Scott committed
1142 1143
/**
 * Returns the indexed $part (as separated by slashes) of the current Q2A request, or null if it doesn't exist
Scott committed
1144 1145
 * @param $part
 * @return
Scott committed
1146 1147 1148 1149 1150 1151
 */
function qa_request_part($part)
{
	$parts = explode('/', qa_request());
	return @$parts[$part];
}
Scott committed
1152 1153


Scott committed
1154 1155
/**
 * Returns an array of parts (as separated by slashes) of the current Q2A request, starting at part $start
Scott committed
1156 1157
 * @param int $start
 * @return array
Scott committed
1158 1159 1160 1161 1162
 */
function qa_request_parts($start = 0)
{
	return array_slice(explode('/', qa_request()), $start);
}
Scott committed
1163 1164


Scott committed
1165 1166
/**
 * Return string for incoming GET/POST/COOKIE value, stripping slashes if appropriate
Scott committed
1167 1168
 * @param $string
 * @return mixed|string
Scott committed
1169 1170 1171 1172
 */
function qa_gpc_to_string($string)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1173

Scott committed
1174 1175
	return get_magic_quotes_gpc() ? stripslashes($string) : $string;
}
Scott committed
1176 1177


Scott committed
1178 1179
/**
 * Return string with slashes added, if appropriate for later removal by qa_gpc_to_string()
Scott committed
1180 1181
 * @param $string
 * @return mixed|string
Scott committed
1182 1183 1184 1185
 */
function qa_string_to_gpc($string)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1186

Scott committed
1187 1188
	return get_magic_quotes_gpc() ? addslashes($string) : $string;
}
Scott committed
1189 1190


Scott committed
1191 1192
/**
 * Return string for incoming GET field, or null if it's not defined
Scott committed
1193 1194
 * @param $field
 * @return mixed|null|string
Scott committed
1195 1196 1197 1198
 */
function qa_get($field)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1199

Scott committed
1200 1201
	return isset($_GET[$field]) ? qa_gpc_to_string($_GET[$field]) : null;
}
Scott committed
1202 1203


Scott committed
1204 1205 1206
/**
 * Return string for incoming POST field, or null if it's not defined.
 * While we're at it, trim() surrounding white space and converted to Unix line endings.
Scott committed
1207 1208
 * @param $field
 * @return mixed|null
Scott committed
1209 1210 1211 1212
 */
function qa_post_text($field)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1213

Scott committed
1214 1215
	return isset($_POST[$field]) ? preg_replace('/\r\n?/', "\n", trim(qa_gpc_to_string($_POST[$field]))) : null;
}
Scott committed
1216

Scott committed
1217 1218 1219
/**
 * Return an array for incoming POST field, or null if it's not an array or not defined.
 * While we're at it, trim() surrounding white space for each value and convert them to Unix line endings.
Scott committed
1220 1221
 * @param $field
 * @return array|mixed|null
Scott committed
1222 1223 1224 1225 1226 1227 1228
 */
function qa_post_array($field)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }

	if (!isset($_POST[$field]) || !is_array($_POST[$field])) {
		return null;
Scott committed
1229 1230
	}

Scott committed
1231 1232 1233
	$result = array();
	foreach ($_POST[$field] as $key => $value)
		$result[$key] = preg_replace('/\r\n?/', "\n", trim(qa_gpc_to_string($value)));
Scott committed
1234

Scott committed
1235 1236
	return $result;
}
Scott committed
1237 1238


Scott committed
1239 1240 1241
/**
 * Return true if form button $name was clicked (as type=submit/image) to create this page request, or if a
 * simulated click was sent for the button (via 'qa_click' POST field)
Scott committed
1242 1243
 * @param $name
 * @return bool|mixed
Scott committed
1244 1245 1246 1247
 */
function qa_clicked($name)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1248

Scott committed
1249 1250
	return isset($_POST[$name]) || isset($_POST[$name . '_x']) || (qa_post_text('qa_click') == $name);
}
Scott committed
1251 1252


Scott committed
1253 1254 1255 1256 1257 1258 1259
/**
 * Determine the remote IP address of the user accessing the site.
 * @return mixed  String representing IP if it's available, or null otherwise.
 */
function qa_remote_ip_address()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1260

Scott committed
1261 1262
	return isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null;
}
Scott committed
1263 1264


Scott committed
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
/**
 * Checks whether an HTTP request has exceeded the post_max_size PHP variable. This happens whenever an HTTP request
 * is too big to be properly processed by PHP, usually because there is an attachment in the HTTP request. A warning
 * is added to the server's log displaying the size of the file that triggered this situation. It is important to note
 * that whenever this happens the $_POST and $_FILES superglobals are empty.
 */
function qa_post_limit_exceeded()
{
	if (in_array($_SERVER['REQUEST_METHOD'], array('POST', 'PUT')) && empty($_POST) && empty($_FILES)) {
		$postmaxsize = ini_get('post_max_size');  // Gets the current post_max_size configuration
		$unit = substr($postmaxsize, -1);
		if (!is_numeric($unit)) {
			$postmaxsize = substr($postmaxsize, 0, -1);
Scott committed
1278
		}
Scott committed
1279 1280 1281
		// Gets an integer value that can be compared against the size of the HTTP request
		$postmaxsize = convert_to_bytes($unit, $postmaxsize);
		return $_SERVER['CONTENT_LENGTH'] > $postmaxsize;
Scott committed
1282
	}
Scott committed
1283
}
Scott committed
1284 1285


Scott committed
1286 1287 1288 1289 1290 1291 1292 1293 1294
/**
* Turns a numeric value and a unit (g/m/k) into bytes
* @param string $unit One of 'g', 'm', 'k'. It is case insensitive
* @param int $value The value to turn into bytes
* @return int The amount of bytes the unit and the value represent. If the unit is not one of 'g', 'm' or 'k' then
* the original value is returned
*/
function convert_to_bytes($unit, $value)
{
1295 1296
	$value = (int) $value;

Scott committed
1297 1298
	switch (strtolower($unit)) {
		case 'g':
1299
			return $value * pow(1024, 3);
Scott committed
1300
		case 'm':
1301
			return $value * pow(1024, 2);
Scott committed
1302 1303 1304 1305
		case 'k':
			return $value * 1024;
		default:
			return $value;
1306
	}
Scott committed
1307
}
1308 1309


Scott committed
1310 1311 1312 1313 1314 1315 1316
/**
 * Whether we are responding to an HTTP GET request
 * @return bool True if the request is GET
 */
function qa_is_http_get()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1317

Scott committed
1318 1319
	return $_SERVER['REQUEST_METHOD'] === 'GET';
}
Scott committed
1320

Scott committed
1321 1322 1323 1324 1325 1326
/**
 * Return true if we are responding to an HTTP POST request
 */
function qa_is_http_post()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1327

Scott committed
1328 1329
	return $_SERVER['REQUEST_METHOD'] === 'POST' || !empty($_POST);
}
Scott committed
1330 1331


Scott committed
1332 1333 1334 1335 1336 1337
/**
 * Return true if we appear to be responding to a secure HTTP request (but hard to be sure)
 */
function qa_is_https_probably()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1338

Scott committed
1339 1340
	return (@$_SERVER['HTTPS'] && ($_SERVER['HTTPS'] != 'off')) || (@$_SERVER['SERVER_PORT'] == 443);
}
Scott committed
1341 1342


Scott committed
1343 1344 1345 1346 1347 1348 1349
/**
 * Return true if it appears the page request is coming from a human using a web browser, rather than a search engine
 * or other bot. Based on a whitelist of terms in user agents, this can easily be tricked by a scraper or bad bot.
 */
function qa_is_human_probably()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1350

Scott committed
1351
	require_once QA_INCLUDE_DIR . 'util/string.php';
Scott committed
1352

Scott committed
1353
	$useragent = @$_SERVER['HTTP_USER_AGENT'];
Scott committed
1354

Scott committed
1355 1356 1357 1358 1359
	return (strlen($useragent) == 0) || qa_string_matches_one($useragent, array(
		'MSIE', 'Firefox', 'Chrome', 'Safari', 'Opera', 'Gecko', 'MIDP', 'PLAYSTATION', 'Teleca',
		'BlackBerry', 'UP.Browser', 'Polaris', 'MAUI_WAP_Browser', 'iPad', 'iPhone', 'iPod',
	));
}
Scott committed
1360 1361


Scott committed
1362 1363 1364 1365 1366 1367
/**
 * Return true if it appears that the page request is coming from a mobile client rather than a desktop/laptop web browser
 */
function qa_is_mobile_probably()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1368

Scott committed
1369
	require_once QA_INCLUDE_DIR . 'util/string.php';
Scott committed
1370

Scott committed
1371
	// inspired by: http://dangerousprototypes.com/docs/PhpBB3_MOD:_Replacement_mobile_browser_detection_for_mobile_themes
Scott committed
1372

Scott committed
1373
	$loweragent = strtolower(@$_SERVER['HTTP_USER_AGENT']);
Scott committed
1374

Scott committed
1375 1376
	if (strpos($loweragent, 'ipad') !== false) // consider iPad as desktop
		return false;
Scott committed
1377

Scott committed
1378
	$mobileheaders = array('HTTP_X_OPERAMINI_PHONE', 'HTTP_X_WAP_PROFILE', 'HTTP_PROFILE');
Scott committed
1379

Scott committed
1380 1381
	foreach ($mobileheaders as $header)
		if (isset($_SERVER[$header]))
Scott committed
1382 1383
			return true;

Scott committed
1384 1385 1386 1387 1388 1389
	if (qa_string_matches_one($loweragent, array(
		'android', 'phone', 'mobile', 'windows ce', 'palm', ' mobi', 'wireless', 'blackberry', 'opera mini', 'symbian',
		'nokia', 'samsung', 'ericsson,', 'vodafone/', 'kindle', 'ipod', 'wap1.', 'wap2.', 'sony', 'sanyo', 'sharp',
		'panasonic', 'philips', 'pocketpc', 'avantgo', 'blazer', 'ipaq', 'up.browser', 'up.link', 'mmp', 'smartphone', 'midp',
	)))
		return true;
Scott committed
1390

Scott committed
1391 1392 1393 1394
	return qa_string_matches_one(strtolower(@$_SERVER['HTTP_ACCEPT']), array(
		'application/vnd.wap.xhtml+xml', 'text/vnd.wap.wml',
	));
}
Scott committed
1395 1396


Scott committed
1397
// Language phrase support
Scott committed
1398

Scott committed
1399 1400 1401 1402 1403 1404
/**
 * Return the translated string for $identifier, unless we're using external translation logic.
 * This will retrieve the 'site_language' option so make sure you've already loaded/set that if
 * loading an option now will cause a problem (see issue in qa_default_option()). The part of
 * $identifier before the slash (/) replaces the * in the qa-lang-*.php file references, and the
 * part after the / is the key of the array element to be taken from that file's returned result.
Scott committed
1405 1406
 * @param $identifier
 * @return string
Scott committed
1407 1408 1409 1410
 */
function qa_lang($identifier)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1411

Scott committed
1412
	global $qa_lang_file_pattern, $qa_phrases_full;
Scott committed
1413

Scott committed
1414
	list($group, $label) = explode('/', $identifier, 2);
Scott committed
1415

Scott committed
1416 1417
	if (isset($qa_phrases_full[$group][$label]))
		return $qa_phrases_full[$group][$label];
Scott committed
1418

Scott committed
1419 1420 1421 1422 1423 1424
	if (!isset($qa_phrases_full[$group])) {
		// load the default language files
		if (isset($qa_lang_file_pattern[$group]))
			$include = str_replace('*', 'default', $qa_lang_file_pattern[$group]);
		else
			$include = QA_INCLUDE_DIR . 'lang/qa-lang-' . $group . '.php';
Scott committed
1425

Scott committed
1426
		$qa_phrases_full[$group] = is_file($include) ? (array)(include_once $include) : array();
Scott committed
1427

Scott committed
1428 1429 1430 1431 1432 1433 1434
		// look for a localized file in qa-lang/<lang>/
		$languagecode = qa_opt('site_language');
		if (strlen($languagecode)) {
			if (isset($qa_lang_file_pattern[$group]))
				$include = str_replace('*', $languagecode, $qa_lang_file_pattern[$group]);
			else
				$include = QA_LANG_DIR . $languagecode . '/qa-lang-' . $group . '.php';
Scott committed
1435

Scott committed
1436 1437
			$phrases = is_file($include) ? (array)(include $include) : array();
			$qa_phrases_full[$group] = array_merge($qa_phrases_full[$group], $phrases);
Scott committed
1438 1439
		}

Scott committed
1440 1441 1442 1443
		// add any custom phrases from qa-lang/custom/
		$include = QA_LANG_DIR . 'custom/qa-lang-' . $group . '.php';
		$phrases = is_file($include) ? (array)(include $include) : array();
		$qa_phrases_full[$group] = array_merge($qa_phrases_full[$group], $phrases);
Scott committed
1444

Scott committed
1445 1446
		if (isset($qa_phrases_full[$group][$label]))
			return $qa_phrases_full[$group][$label];
Scott committed
1447 1448
	}

Scott committed
1449 1450
	return '[' . $identifier . ']'; // as a last resort, return the identifier to help in development
}
Scott committed
1451 1452


Scott committed
1453 1454
/**
 * Return the translated string for $identifier, with $symbol substituted for $textparam
Scott committed
1455 1456 1457 1458
 * @param $identifier
 * @param $textparam
 * @param string $symbol
 * @return mixed
Scott committed
1459 1460 1461 1462 1463
 */
function qa_lang_sub($identifier, $textparam, $symbol = '^')
{
	return str_replace($symbol, $textparam, qa_lang($identifier));
}
Scott committed
1464 1465


Scott committed
1466 1467
/**
 * Return the translated string for $identifier, converted to HTML
Scott committed
1468 1469
 * @param $identifier
 * @return mixed|string
Scott committed
1470 1471 1472 1473 1474
 */
function qa_lang_html($identifier)
{
	return qa_html(qa_lang($identifier));
}
Scott committed
1475 1476


Scott committed
1477 1478
/**
 * Return the translated string for $identifier converted to HTML, with $symbol *then* substituted for $htmlparam
Scott committed
1479 1480 1481 1482
 * @param $identifier
 * @param $htmlparam
 * @param string $symbol
 * @return mixed
Scott committed
1483 1484 1485 1486 1487
 */
function qa_lang_html_sub($identifier, $htmlparam, $symbol = '^')
{
	return str_replace($symbol, $htmlparam, qa_lang_html($identifier));
}
Scott committed
1488 1489


Scott committed
1490 1491 1492
/**
 * Return an array containing the translated string for $identifier converted to HTML, then split into three,
 * with $symbol substituted for $htmlparam in the 'data' element, and obvious 'prefix' and 'suffix' elements
Scott committed
1493 1494 1495 1496
 * @param $identifier
 * @param $htmlparam
 * @param string $symbol
 * @return array
Scott committed
1497 1498 1499 1500
 */
function qa_lang_html_sub_split($identifier, $htmlparam, $symbol = '^')
{
	$html = qa_lang_html($identifier);
Scott committed
1501

Scott committed
1502 1503 1504
	$symbolpos = strpos($html, $symbol);
	if (!is_numeric($symbolpos))
		qa_fatal_error('Missing ' . $symbol . ' in language string ' . $identifier);
Scott committed
1505

Scott committed
1506 1507 1508 1509 1510 1511
	return array(
		'prefix' => substr($html, 0, $symbolpos),
		'data' => $htmlparam,
		'suffix' => substr($html, $symbolpos + 1),
	);
}
Scott committed
1512 1513


Scott committed
1514
// Request and path generation
Scott committed
1515

Scott committed
1516 1517 1518 1519 1520 1521
/**
 * Return the relative path to the Q2A root (if it was previously set by qa_set_request())
 */
function qa_path_to_root()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1522

Scott committed
1523 1524 1525
	global $qa_root_url_relative;
	return $qa_root_url_relative;
}
Scott committed
1526 1527


Scott committed
1528 1529 1530 1531 1532 1533
/**
 * Return an array of mappings of Q2A requests, as defined in the qa-config.php file
 */
function qa_get_request_map()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1534

Scott committed
1535 1536 1537
	global $qa_request_map;
	return $qa_request_map;
}
Scott committed
1538 1539


Scott committed
1540 1541 1542 1543 1544
/**
 * Return the relative URI path for $request, with optional parameters $params and $anchor.
 * Slashes in $request will not be urlencoded, but any other characters will.
 * If $neaturls is set, use that, otherwise retrieve the option. If $rooturl is set, take
 * that as the root of the Q2A site, otherwise use path to root which was set elsewhere.
Scott committed
1545 1546 1547 1548 1549 1550
 * @param $request
 * @param array $params
 * @param string $rooturl
 * @param int $neaturls
 * @param string $anchor
 * @return string
Scott committed
1551
 */
Scott committed
1552
function qa_path($request, $params = null, $rooturl = null, $neaturls = null, $anchor = null)
Scott committed
1553 1554
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1555

Scott committed
1556 1557 1558 1559
	if (!isset($neaturls)) {
		require_once QA_INCLUDE_DIR . 'app/options.php';
		$neaturls = qa_opt('neat_urls');
	}
Scott committed
1560

Scott committed
1561 1562
	if (!isset($rooturl))
		$rooturl = qa_path_to_root();
Scott committed
1563

Scott committed
1564 1565
	$url = $rooturl . ((empty($rooturl) || (substr($rooturl, -1) == '/')) ? '' : '/');
	$paramsextra = '';
Scott committed
1566

Scott committed
1567 1568
	$requestparts = explode('/', $request);
	$pathmap = qa_get_request_map();
Scott committed
1569

Scott committed
1570 1571
	if (isset($pathmap[$requestparts[0]])) {
		$newpart = $pathmap[$requestparts[0]];
Scott committed
1572

Scott committed
1573 1574 1575 1576 1577
		if (strlen($newpart))
			$requestparts[0] = $newpart;
		elseif (count($requestparts) == 1)
			array_shift($requestparts);
	}
Scott committed
1578

Scott committed
1579 1580 1581 1582
	foreach ($requestparts as $index => $requestpart) {
		$requestparts[$index] = urlencode($requestpart);
	}
	$requestpath = implode('/', $requestparts);
Scott committed
1583

Scott committed
1584 1585 1586 1587 1588
	switch ($neaturls) {
		case QA_URL_FORMAT_INDEX:
			if (!empty($request))
				$url .= 'index.php/' . $requestpath;
			break;
Scott committed
1589

Scott committed
1590 1591 1592 1593 1594 1595 1596 1597
		case QA_URL_FORMAT_NEAT:
			$url .= $requestpath;
			break;

		case QA_URL_FORMAT_PARAM:
			if (!empty($request))
				$paramsextra = '?qa=' . $requestpath;
			break;
Scott committed
1598

Scott committed
1599 1600
		default:
			$url .= 'index.php';
Scott committed
1601

Scott committed
1602 1603 1604 1605 1606 1607
		case QA_URL_FORMAT_PARAMS:
			if (!empty($request)) {
				foreach ($requestparts as $partindex => $requestpart)
					$paramsextra .= (strlen($paramsextra) ? '&' : '?') . 'qa' . ($partindex ? ('_' . $partindex) : '') . '=' . $requestpart;
			}
			break;
Scott committed
1608 1609
	}

1610 1611 1612 1613 1614 1615
	if (is_array($params)) {
		foreach ($params as $key => $value) {
			$value = is_array($value) ? '' : (string) $value;
			$paramsextra .= (strlen($paramsextra) ? '&' : '?') . urlencode($key) . '=' . urlencode($value);
		}
	}
Scott committed
1616

Scott committed
1617 1618
	return $url . $paramsextra . (empty($anchor) ? '' : '#' . urlencode($anchor));
}
Scott committed
1619 1620


Scott committed
1621 1622
/**
 * Return HTML representation of relative URI path for $request - see qa_path() for other parameters
Scott committed
1623 1624 1625 1626 1627 1628
 * @param $request
 * @param array $params
 * @param string $rooturl
 * @param int $neaturls
 * @param string $anchor
 * @return mixed|string
Scott committed
1629 1630 1631 1632 1633
 */
function qa_path_html($request, $params = null, $rooturl = null, $neaturls = null, $anchor = null)
{
	return qa_html(qa_path($request, $params, $rooturl, $neaturls, $anchor));
}
Scott committed
1634 1635


Scott committed
1636 1637
/**
 * Return the absolute URI for $request - see qa_path() for other parameters
Scott committed
1638 1639 1640 1641
 * @param $request
 * @param array $params
 * @param string $anchor
 * @return string
Scott committed
1642 1643 1644 1645 1646
 */
function qa_path_absolute($request, $params = null, $anchor = null)
{
	return qa_path($request, $params, qa_opt('site_url'), null, $anchor);
}
Scott committed
1647 1648


Scott committed
1649 1650 1651
/**
 * Get Q2A request for a question, and make it search-engine friendly, shortening it if necessary
 * by removing shorter words which are generally less meaningful.
Scott committed
1652
 * @param int $questionid The question ID
Scott committed
1653
 * @param string $title The question title
Scott committed
1654
 * @return string
Scott committed
1655 1656 1657 1658
 */
function qa_q_request($questionid, $title)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1659

Scott committed
1660 1661
	require_once QA_INCLUDE_DIR . 'app/options.php';
	require_once QA_INCLUDE_DIR . 'util/string.php';
Scott committed
1662

Scott committed
1663 1664
	$title = qa_block_words_replace($title, qa_get_block_words_preg());
	$slug = qa_slugify($title, qa_opt('q_urls_remove_accents'), qa_opt('q_urls_title_length'));
Scott committed
1665

Scott committed
1666 1667
	return (int)$questionid . '/' . $slug;
}
Scott committed
1668 1669


Scott committed
1670 1671
/**
 * Return the HTML anchor that should be used for post $postid with $basetype (Q/A/C)
Scott committed
1672 1673 1674
 * @param $basetype
 * @param $postid
 * @return mixed|string
Scott committed
1675 1676 1677 1678
 */
function qa_anchor($basetype, $postid)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1679

Scott committed
1680 1681
	return strtolower($basetype) . $postid; // used to be $postid only but this violated HTML spec
}
Scott committed
1682 1683


Scott committed
1684 1685 1686
/**
 * Return the URL for question $questionid with $title, possibly using $absolute URLs.
 * To link to a specific answer or comment in a question, set $showtype and $showid accordingly.
Scott committed
1687 1688 1689 1690 1691 1692
 * @param $questionid
 * @param $title
 * @param bool $absolute
 * @param string $showtype
 * @param int $showid
 * @return mixed|string
Scott committed
1693 1694 1695 1696 1697
 */
function qa_q_path($questionid, $title, $absolute = false, $showtype = null, $showid = null)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }

Scott committed
1698
	if (($showtype == 'Q' || $showtype == 'A' || $showtype == 'C') && isset($showid)) {
Scott committed
1699 1700
		$params = array('show' => $showid); // due to pagination
		$anchor = qa_anchor($showtype, $showid);
Scott committed
1701

Scott committed
1702 1703 1704
	} else {
		$params = null;
		$anchor = null;
Scott committed
1705 1706
	}

Scott committed
1707 1708
	return qa_path(qa_q_request($questionid, $title), $params, $absolute ? qa_opt('site_url') : null, null, $anchor);
}
Scott committed
1709 1710


Scott committed
1711 1712
/**
 * Return the HTML representation of the URL for $questionid - other parameters as for qa_q_path()
Scott committed
1713 1714 1715 1716 1717 1718
 * @param $questionid
 * @param $title
 * @param bool $absolute
 * @param string $showtype
 * @param int $showid
 * @return mixed|string
Scott committed
1719 1720 1721 1722 1723
 */
function qa_q_path_html($questionid, $title, $absolute = false, $showtype = null, $showid = null)
{
	return qa_html(qa_q_path($questionid, $title, $absolute, $showtype, $showid));
}
Scott committed
1724 1725


Scott committed
1726 1727
/**
 * Return the request for the specified $feed
Scott committed
1728 1729
 * @param $feed
 * @return mixed|string
Scott committed
1730 1731 1732 1733
 */
function qa_feed_request($feed)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1734

Scott committed
1735 1736
	return 'feed/' . $feed . '.rss';
}
Scott committed
1737 1738


Scott committed
1739 1740 1741 1742 1743 1744
/**
 * Return an HTML-ready relative URL for the current page, preserving GET parameters - this is useful for action="..." in HTML forms
 */
function qa_self_html()
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1745

Scott committed
1746
	global $qa_used_url_format;
Scott committed
1747

Scott committed
1748 1749
	return qa_path_html(qa_request(), $_GET, null, $qa_used_url_format);
}
Scott committed
1750 1751


Scott committed
1752 1753 1754
/**
 * Return HTML for hidden fields to insert into a <form method="get"...> on the page.
 * This is needed because any parameters on the URL will be lost when the form is submitted.
Scott committed
1755 1756 1757 1758 1759 1760
 * @param $request
 * @param array $params
 * @param string $rooturl
 * @param int $neaturls
 * @param string $anchor
 * @return mixed|string
Scott committed
1761
 */
Scott committed
1762
function qa_path_form_html($request, $params = null, $rooturl = null, $neaturls = null, $anchor = null)
Scott committed
1763 1764
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1765

Scott committed
1766 1767
	$path = qa_path($request, $params, $rooturl, $neaturls, $anchor);
	$formhtml = '';
Scott committed
1768

Scott committed
1769 1770 1771
	$questionpos = strpos($path, '?');
	if (is_numeric($questionpos)) {
		$params = explode('&', substr($path, $questionpos + 1));
Scott committed
1772

Scott committed
1773 1774 1775
		foreach ($params as $param)
			if (preg_match('/^([^\=]*)(\=(.*))?$/', $param, $matches))
				$formhtml .= '<input type="hidden" name="' . qa_html(urldecode($matches[1])) . '" value="' . qa_html(urldecode(@$matches[3])) . '"/>';
Scott committed
1776 1777
	}

Scott committed
1778 1779
	return $formhtml;
}
Scott committed
1780 1781


Scott committed
1782 1783
/**
 * Redirect the user's web browser to $request and then we're done - see qa_path() for other parameters
Scott committed
1784 1785 1786 1787 1788 1789
 * @param $request
 * @param array $params
 * @param string $rooturl
 * @param int $neaturls
 * @param string $anchor
 * @return mixed
Scott committed
1790
 */
Scott committed
1791
function qa_redirect($request, $params = null, $rooturl = null, $neaturls = null, $anchor = null)
Scott committed
1792 1793
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1794

Scott committed
1795 1796
	qa_redirect_raw(qa_path($request, $params, $rooturl, $neaturls, $anchor));
}
Scott committed
1797 1798


Scott committed
1799 1800
/**
 * Redirect the user's web browser to page $path which is already a URL
Scott committed
1801 1802
 * @param $url
 * @return mixed
Scott committed
1803 1804 1805 1806
 */
function qa_redirect_raw($url)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1807

Scott committed
1808 1809 1810
	header('Location: ' . $url);
	qa_exit('redirect');
}
Scott committed
1811 1812


Scott committed
1813
// General utilities
Scott committed
1814

Scott committed
1815 1816
/**
 * Return the contents of remote $url, using file_get_contents() if possible, otherwise curl functions
Scott committed
1817 1818
 * @param $url
 * @return mixed|string
Scott committed
1819 1820 1821 1822
 */
function qa_retrieve_url($url)
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
1823

Scott committed
1824 1825 1826 1827
	// ensure we're fetching a remote URL
	if (!preg_match('#^https?://#', $url)) {
		return '';
	}
Scott committed
1828

Scott committed
1829
	$contents = @file_get_contents($url);
Scott committed
1830

Scott committed
1831
	if (!strlen($contents) && function_exists('curl_exec')) { // try curl as a backup (if allow_url_fopen not set)
Scott committed
1832 1833 1834 1835 1836
		$curl = curl_init($url);
		curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
		$contents = @curl_exec($curl);
		curl_close($curl);
Scott committed
1837 1838
	}

Scott committed
1839 1840
	return $contents;
}
Scott committed
1841 1842


1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
/**
 * Helper function to access the Application object.
 * @return Application
 */
function qa_app()
{
	return Application::getInstance();
}


/**
 * Helper function to access services in the Container.
 * If the $key parameter is set and the $object parameter is null the container is called to resolve the $key.
 * If the $key and the $object parameters are null the container is called to bind the $object to the $key.
 * @param mixed $key Identifier for the object to get/set.
 * @param mixed $object Object to set in the $key (if null, a stored object is returned)
 * @return mixed
 */
function qa_service($key, $object = null)
{
	$app = Application::getInstance();

	if ($object === null) {
		return $app->getContainer()->get($key);
	}

	$app->getContainer()->set($key, $object);
}


Scott committed
1873 1874
/**
 * Shortcut to get or set an option value without specifying database
Scott committed
1875 1876 1877
 * @param $name
 * @param mixed $value
 * @return
Scott committed
1878 1879 1880 1881
 */
function qa_opt($name, $value = null)
{
	global $qa_options_cache;
Scott committed
1882

Scott committed
1883
	if (!isset($value) && isset($qa_options_cache[$name]))
Scott committed
1884
		return $qa_options_cache[$name]; // quick shortcut to reduce calls to qa_get_options()
Scott committed
1885

Scott committed
1886
	require_once QA_INCLUDE_DIR . 'app/options.php';
Scott committed
1887

Scott committed
1888 1889
	if (isset($value))
		qa_set_option($name, $value);
Scott committed
1890

Scott committed
1891
	$options = qa_get_options(array($name));
Scott committed
1892

Scott committed
1893 1894
	return $options[$name];
}
Scott committed
1895

Scott committed
1896 1897
/**
 * Simple method to output a preformatted variable
Scott committed
1898
 * @param $var
Scott committed
1899 1900 1901 1902
 */
function qa_debug($var)
{
	echo "\n" . '<pre style="padding: 10px; background-color: #eee; color: #444; font-size: 11px; text-align: left">';
Scott committed
1903
	echo $var === null ? 'NULL' : htmlspecialchars(print_r($var, true), ENT_COMPAT|ENT_SUBSTITUTE);
Scott committed
1904 1905
	echo '</pre>' . "\n";
}
Scott committed
1906 1907


Scott committed
1908
// Event and process stage reporting
Scott committed
1909

Scott committed
1910 1911 1912
/**
 * Suspend the reporting of events to event modules via qa_report_event(...) if $suspend is
 * true, otherwise reinstate it. A counter is kept to allow multiple calls.
Scott committed
1913
 * @param bool $suspend
Scott committed
1914 1915 1916 1917
 */
function qa_suspend_event_reports($suspend = true)
{
	global $qa_event_reports_suspended;
Scott committed
1918

Scott committed
1919 1920
	$qa_event_reports_suspended += ($suspend ? 1 : -1);
}
Scott committed
1921 1922


Scott committed
1923 1924
/**
 * Send a notification of event $event by $userid, $handle and $cookieid to all event modules, with extra $params
Scott committed
1925 1926 1927 1928 1929 1930
 * @param $event
 * @param $userid
 * @param $handle
 * @param $cookieid
 * @param array $params
 * @return mixed|void
Scott committed
1931
 */
Scott committed
1932
function qa_report_event($event, $userid, $handle, $cookieid, $params = array())
Scott committed
1933 1934
{
	if (qa_to_override(__FUNCTION__)) { $args=func_get_args(); return qa_call_override(__FUNCTION__, $args); }
Scott committed
1935

Scott committed
1936
	global $qa_event_reports_suspended;
Scott committed
1937

Scott committed
1938 1939
	if ($qa_event_reports_suspended > 0)
		return;
Scott committed
1940

Scott committed
1941 1942 1943 1944
	$eventmodules = qa_load_modules_with('event', 'process_event');
	foreach ($eventmodules as $eventmodule)
		$eventmodule->process_event($event, $userid, $handle, $cookieid, $params);
}
Scott committed
1945 1946


Scott committed
1947 1948 1949
function qa_report_process_stage($method) // can have extra params
{
	global $qa_process_reports_suspended;
Scott committed
1950

Scott committed
1951 1952
	if (@$qa_process_reports_suspended)
		return;
Scott committed
1953

Scott committed
1954
	$qa_process_reports_suspended = true; // prevent loop, e.g. because of an error
Scott committed
1955

Scott committed
1956 1957
	$args = func_get_args();
	$args = array_slice($args, 1);
Scott committed
1958

Scott committed
1959 1960 1961
	$processmodules = qa_load_modules_with('process', $method);
	foreach ($processmodules as $processmodule) {
		call_user_func_array(array($processmodule, $method), $args);
Scott committed
1962
	}
Scott committed
1963 1964 1965

	$qa_process_reports_suspended = null;
}