<?php
/************************************************************************
 * Mailer v0.2.1-FINAL                                Start: 12/16/2008 *
 * ===================                          Last change: 12/16/2008 *
 *                                                                      *
 * -------------------------------------------------------------------- *
 * File              : filters.php                                      *
 * -------------------------------------------------------------------- *
 * Short description : Generic filters                                  *
 * -------------------------------------------------------------------- *
 * Kurzbeschreibung  : Allgemeine Filter                                *
 * -------------------------------------------------------------------- *
 * $Revision::                                                        $ *
 * $Date::                                                            $ *
 * $Tag:: 0.2.1-FINAL                                                 $ *
 * $Author::                                                          $ *
 * -------------------------------------------------------------------- *
 * Copyright (c) 2003 - 2009 by Roland Haeder                           *
 * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
 * For more information visit: http://www.mxchange.org                  *
 *                                                                      *
 * 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.                         *
 *                                                                      *
 * You should have received a copy of the GNU General Public License    *
 * along with this program; if not, write to the Free Software          *
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
 * MA  02110-1301  USA                                                  *
 ************************************************************************/

// Some security stuff...
if (!defined('__SECURITY')) {
	die();
} // END - if

// Filter for flushing all new filters to the database
function FILTER_FLUSH_FILTERS () {
	// Clear all previous SQL queries
	initSqls();

	// Are we installing?
	if ((isInstallationPhase())) {
		// Then silently skip this filter
		return true;
	} // END - if

	// Is a database link here and not in installation mode?
	if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
		// Abort here
		debug_report_bug(__FUNCTION__, __LINE__, 'No database link is up. Cannot flush filters.');
		return false;
	} // END - if

	// Is the extension ext-sql_patches updated?
	if ((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9'))) {
		// Abort silently here
		logDebugMessage(__FUNCTION__, __LINE__, 'Cannot flush filters, sql_patches might be missing. isExtensionInstalled()=' . isExtensionInstalled('sql_patches') . ',isExtensionInstalledAndOlder()=' . isExtensionInstalledAndOlder('sql_patches', '0.5.9'));
		return false;
	} // END - if

	// Nothing is added/remove by default
	$inserted = '0';
	$removed = '0';

	// Prepare SQL queries
	$insertSQL = 'INSERT INTO `{?_MYSQL_PREFIX?}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES';
	$removeSQL = 'DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_filters` WHERE';

	// Write all filters to database
	foreach ($GLOBALS['cache_array']['filter']['chains'] as $filterName => $filterArray) {
		// Walk through all filters
		foreach ($filterArray as $filterFunction => $active) {
			// Is this filter loaded?
			//* DEBUG: */ debugOutput('FOUND:'.$filterName.'/'.$filterFunction.'='.$active);
			if (((!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) && ($active != 'R')) || ($active == 'A')) {
				// Add this filter (all filters are active by default)
				//* DEBUG: */ debugOutput('ADD:'.$filterName.'/'.$filterFunction);
				$insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
				$inserted++;
			} elseif ($active == 'R') {
				// Remove this filter
				//* DEBUG: */ debugOutput('REMOVE:'.$filterName.'/'.$filterFunction);
				$removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
				$removed++;
			}
		} // END - foreach
	} // END - foreach

	// Something has been added?
	if ($inserted > 0) {
		// Finish SQL command and add it
		addSql(substr($insertSQL, 0, -1));
	} // END - if

	// Something has been removed?
	if ($removed > 0) {
		// Finish SQL command and add it
		addSql(substr($removeSQL, 0, -2) . 'LIMIT ' . $removed);
	} // END - if

	// Shall we update usage counters (ONLY FOR DEBUGGING!)
	if (isFilterUsageUpdateEnabled()) {
		// Update all counters
		foreach ($GLOBALS['cache_array']['filter']['counter'] as $filterName => $filterArray) {
			// Walk through all filters
			foreach ($filterArray as $filterFunction => $count) {
				// Construct and add the query
				addSql(sprintf("UPDATE `{?_MYSQL_PREFIX?}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
					bigintval($count),
					$filterName,
					$filterFunction
				));
			} // END - foreach
		} // END - foreach
	} // END - if

	// Run the run_sqls filter in non-dry mode
	runFilterChain('run_sqls');

	// Should we rebuild cache?
	if (($inserted > 0) || ($removed > 0)) {
		// Destroy cache
		rebuildCache('filter', 'filter');
	} // END - if
}

// Filter for calling the handler for login failures
function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($filterData) {
	// Init content
	$content = $filterData;

	// Handle failed logins here if not in guest
	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'type=' . $filterData['type'] . ',action=' . getAction() . ',what=' . getWhat() . ',level=' . $filterData['access_level']);
	if ((($filterData['type'] == 'what') || ($filterData['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getIndexHome()))) && ($filterData['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.6')))) {
		// Handle failure
		$content['content'] .= handleLoginFailures($filterData['access_level']);
	} // END - if

	// Return the content
	return $content;
}

// Filter for redirecting to logout if sql_patches has been installed
function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
	// Remove this filter
	unregisterFilter(__FUNCTION__, __LINE__, 'shutdown', __FUNCTION__);

	// Is the element set?
	if (isset($GLOBALS['ext_load_mode'])) {
		// Redirect here
		redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $GLOBALS['ext_load_mode'] . '=sql_patches');
	} // END - if

	// This should not happen!
	logDebugMessage(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
}

// Filter for auto-activation of a extension
function FILTER_AUTO_ACTIVATE_EXTENSION ($filterData) {
	// Debug message
	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $filterData['ext_name'] . ',isThisExtensionAlwaysActive()=' . intval(isThisExtensionAlwaysActive()));

	// Is this extension always activated?
	if (isThisExtensionAlwaysActive()) {
		// Then activate the extension
		doActivateExtension($filterData['ext_name']);
	} // END - if

	// Return the data
	return $filterData;
}

// Filter for solving task given task
function FILTER_SOLVE_TASK ($filterData) {
	// Don't solve anything if no admin!
	if (!isAdmin()) {
		return $filterData;
	} // END - if

	// Is this a direct task id or array element task_id is found?
	if (is_int($filterData)) {
		// Then solve it...
		adminSolveTask($filterData);
	} elseif ((is_array($filterData)) && (isset($filterData['task_id']))) {
		// Solve it...
		adminSolveTask($filterData['task_id']);
	} else {
		// Not detectable!
		debug_report_bug(__FUNCTION__, __LINE__, sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($filterData), print_r($filterData, true)));
	}

	// Return the data
	return $filterData;
}

// Filter to load include files
function FILTER_LOAD_INCLUDES ($filterData) {
	// Is it null?
	if (is_null($filterData)) {
		// This should not happen!
		debug_report_bug(__FUNCTION__, __LINE__, 'pool is null.');
	} // END - if

	// Is the pool an array and 'pool' set?
	if ((is_array($filterData)) && (isset($filterData['pool']))) {
		// Then use it as pool
		$realPool = $filterData['pool'];
	} else {
		// Default is $data as inclusion list
		$realPool = $filterData;
	}

	// Get inc pool
	$data = getIncludePool($realPool);

	// Is it an array?
	if ((!isset($data)) || (!is_array($data))) {
		// Then abort here
		debug_report_bug(__FUNCTION__, __LINE__, sprintf("INC_POOL is no array! Type: %s", gettype($data)));
	} elseif (isset($data['inc_pool'])) {
		// Use this as new inclusion pool!
		setIncludePool($realPool, $data['inc_pool']);
	}

	// Check for added include files
	if (countIncludePool($realPool) > 0) {
		// Loads every include file
		loadIncludePool($realPool);

		// Reset array
		initIncludePool($realPool);
	} // END - if

	// Continue with processing
	return $filterData;
}

// Filter for running SQL commands
function FILTER_RUN_SQLS ($filterData) {
	// Debug message
	//* DEBUG: */ die('getSqls()=<pre>'.print_r(getSqls(), true).'</pre>ext_update_depends=<pre>'.print_r($GLOBALS['ext_update_depends'], true).'</pre>');
	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Entered!');

	// Is the array there?
	if ((isSqlsValid()) && ((!isset($filterData['dry_run'])) || ($filterData['dry_run'] == false))) {
		// Run SQL commands
		//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Found ' . countSqls() . ' queries to run.');
		foreach (getSqls() as $mode=>$sqls) {
			// Debug message
			//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mode=' . $mode . ',count()=' . count($sqls));

			// New cache format...
			foreach ($sqls as $sql) {
				// Trim spaces away
				$sql = trim($sql);

				// Is 'enable_codes' not set? Then set it to true
				if (!isset($filterData['enable_codes'])) {
					$filterData['enable_codes'] = true;
				} // END - if

				// Is there still a query left?
				if (!empty($sql)) {
					// Do we have an "ALTER TABLE" command?
					if (substr(strtolower($sql), 0, 11) == 'alter table') {
						// Analyse the alteration command
						//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Alterting table: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
						SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
					} else {
						// Run regular SQL command
						//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running regular query: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
						SQL_QUERY($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
					}
				} // END - if
			} // END - foreach
		} // END - foreach
	} // END - if

	// Debug message
	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
}

// Filter for updating/validating login data
function FILTER_UPDATE_LOGIN_DATA () {
	// Add missing array
	if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) {
		$GLOBALS['last_online'] = array();
	} // END - if

	// Recheck if logged in
	if ((!isMember()) || ((isAdmin()) && (!isDebugModeEnabled()))) {
		return false;
	} // END - if

	// Secure user id
	setMemberId(getSession('userid'));

	// Found a userid?
	if (fetchUserData(getMemberId())) {
		// Load last module and online time
		$content = getUserDataArray();

		// Maybe first login time?
		if (empty($content['last_module'])) {
			$content['last_module'] = 'login';
		} // END - if

		// This will be displayed on welcome page! :-)
		if (empty($GLOBALS['last_online']['module'])) {
			$GLOBALS['last_online']['module'] = $content['last_module'];
			$GLOBALS['last_online']['online'] = $content['last_online'];
		} // END - if

		// 'what' not set?
		if (!isWhatSet()) {
			// Fix it to default
			setWhat('welcome');
			if (getIndexHome() != '') {
				setWhatFromConfig('index_home');
			} // END - if
		} // END - if

		// Update last module / online time
		updateLastActivity(getMemberId());
	}  else {
		// Destroy session, we cannot update!
		destroyMemberSession();
	}
}

// Filter for initializing randomizer
function FILTER_INIT_RANDOMIZER () {
	// Take a prime number which is long (if you know a longer one please try it out!)
	setConfigEntry('_PRIME', 591623);

	// Only execute this filter if installed
	if ((!isInstalled()) || (!isExtensionInstalledAndNewer('other', '0.2.5'))) {
		// Set missing entry
		setConfigEntry('_ADD', 0);
		return;
	} // END - if

	// Calculate "entropy" with the prime number (for code generation)
	setConfigEntry('_ADD', (getPrime() * getPrime() / (pi() * getCodeLength() + 1)));

	// Simply init the randomizer with seed and _ADD value
	mt_srand(generateSeed() + getConfig('_ADD'));
}

// Filter for removing updates
function FILTER_REMOVE_UPDATES ($filterData) {
	// Init removal list
	initExtensionRemovalList();

	// Add the current extension to it
	addCurrentExtensionToRemovalList();

	// Simply remove it
	unsetExtensionSqls();

	// Do we need to remove update depency?
	if (countExtensionUpdateDependencies() > 0) {
		// Then find all updates we shall no longer execute
		foreach (getExtensionUpdateDependencies() as $id => $ext_name) {
			// Shall we remove this update?
			if (in_array($ext_name, getExtensionRemovalList())) {
				// Then remove this extension!
				removeExtensionDependency($ext_name);
			} // END - if
		} // END - foreach
	} // END - if

	// Return data
	return $filterData;
}

// Determines username for current user state
function FILTER_DETERMINE_USERNAME () {
	// Check if logged in
	if (isMember()) {
		// Is still logged in so we welcome him with his name
		if (fetchUserData(getMemberId())) {
			// Load surname and family's name and build the username
			$content = getUserDataArray();

			// Prepare username
			setUsername($content['surname'] . ' ' . $content['family']);

			// Additionally admin?
			if (isAdmin()) {
				// Add it
				setUsername(getUsername() . ' ({--USERNAME_ADMIN_SHORT--})');
			} // END - if
		} else {
			// Hmmm, logged in and no valid userid?
			setUsername('<em>{--USERNAME_UNKNOWN--}</em>');

			// Destroy session
			destroyMemberSession();
		}
	} elseif (isAdmin()) {
		// Admin is there
		setUsername('{--USERNAME_ADMIN--}');
	} else {
		// He's a guest, hello there... ;-)
		setUsername('{--USERNAME_GUEST--}');
	}
}

// Filter for compiling config entries
function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
	// Save the uncompiled code
	$uncompiled = $code;

	// Do we have cache?
	if (!isset($GLOBALS['compiled_config'][$code])) {
		// Compile {?some_var?} to getConfig('some_var')
		preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);

		// Some entries found?
		if ((count($matches) > 0) && (count($matches[0]) > 0)) {
			// Replace all matches
			foreach ($matches[0] as $key => $match) {
				// Do we have cache?
				if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
					// Is the config valid?
					if (isConfigEntrySet($matches[1][$key])) {
						// Set it for caching
						$GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . $matches[1][$key] . '%}';
					} elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
						// Use default value
						$GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . 'DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
					} elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
						// No config, try the language system
						$GLOBALS['compile_config'][$matches[1][$key]] = '{%message,DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
					} else {
						// Unhandled!
						$GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
					}
				} // END - if

				// Use this for replacing
				$code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
				//* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die(__FUNCTION__.'['.__LINE__.']:<pre>'.secureString($code).'</pre>');
			} // END - foreach
		} // END - if

		// Add it to cache
		$GLOBALS['compiled_config'][$uncompiled] = $code;
	} // END - if

	// Should we compile it?
	if ($compiled === true) {
		// Run the code
		$eval = "\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . '";';
		//* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>' . encodeEntities($eval) . '</pre>');
		eval($eval);
	} // END - if

	// Return compiled code
	return $GLOBALS['compiled_config'][$uncompiled];
}

// Filter for compiling expression code
function FILTER_COMPILE_EXPRESSION_CODE ($filterData) {
	// Compile {%cmd,callback,extraFunction=some_value%} to get expression code snippets
	// See switch() command below for supported commands
	preg_match_all('/\{%(([a-zA-Z0-9-_,]+)(=([^\}]+)){0,1})*%\}/', $filterData, $matches);
	//* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.print_r($matches, true).'</pre>');

	// Default is from outputHtml()
	$outputMode = getScriptOutputMode();

	// Some entries found?
	if ((count($matches) > 0) && (count($matches[3]) > 0)) {
		// Replace all matches
		foreach ($matches[2] as $key => $cmd) {
			// Init replacer/call-back variable
			$replacer       = '';
			$callback       = '';
			$extraFunction  = '';
			$extraFunction2 = '';
			$value          = NULL;

			// Extract command and call-back
			$cmdArray = explode(',', $cmd);
			$cmd = $cmdArray[0];

			// Detect call-back function
			if (isset($cmdArray[1])) {
				// Call-back function detected
				$callback = $cmdArray[1];
			} // END - if

			// Detect extra function
			if (isset($cmdArray[2])) {
				// Also detected
				$extraFunction = $cmdArray[2];
			} // END - if

			// Detect extra function 2
			if (isset($cmdArray[3])) {
				// Also detected
				$extraFunction2 = $cmdArray[3];
			} // END - if

			// And value
			if (isset($matches[4][$key])) {
				// Use this as value
				$value = $matches[4][$key];
			} // END - if

			// Construct call-back function name for the command
			$commandFunction = 'doExpression' . capitalizeUnderscoreString($cmd);

			// Is this function there?
			if (function_exists($commandFunction)) {
				// Prepare $matches, $key, $outputMode, etc.
				$data = array(
					'matches'     => $matches,
					'key'         => $key,
					'mode'        => getScriptOutputMode(),
					'code'        => $filterData,
					'callback'    => $callback,
					'extra_func'  => $extraFunction,
					'extra_func2' => $extraFunction2,
					'value'       => $value
				);

				// Call it
				//* DEBUG: */ debugOutput(__FUNCTION__ . '[' . __LINE__ . ']: function=' . $commandFunction);
				$filterData = call_user_func($commandFunction, $data);
			} else {
				// Unsupported command detected
				logDebugMessage(__FUNCTION__, __LINE__, 'Command cmd=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
			}
		} // END - foreach
	} // END - if

	// Do we have non-HTML mode?
	if (!isHtmlOutputMode()) {
		$filterData = decodeEntities($filterData);
	} // END - if

	// Return compiled code
	//* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.($filterData).'</pre>');
	return $filterData;
}

// Runs some generic filter update steps
function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
	// Create task (we ignore the task id here)
	createExtensionUpdateTask(getCurrentAdminId(), $ext_name, $GLOBALS['update_ver'][$ext_name], SQL_ESCAPE(getExtensionNotes(getExtensionNotes())));

	// Update extension's version
	SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_version`='%s' WHERE `ext_name`='%s' LIMIT 1",
		array($GLOBALS['update_ver'][$ext_name], $ext_name), __FUNCTION__, __LINE__);

	// Remove arrays
	unsetSqls();
	unset($GLOBALS['update_ver'][$ext_name]);
}

// Load more hourly reset scripts
function FILTER_RUN_HOURLY_INCLUDES () {
	// Is the reset set or old sql_patches?
	if (((!isHourlyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) && (isHtmlOutputMode())) {
		// Then abort here
		debug_report_bug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isHourlyResetEnabled()).',ext_newer[sql_patches:0.7.5]='.intval(isExtensionInstalledAndNewer('sql_patches', '0.7.5')).' Please report this bug. Thanks');
	} // END - if

	// Get more hourly reset scripts
	setIncludePool('hourly', getArrayFromDirectory('inc/hourly/', 'hourly_'));

	// Update database
	if ((!isConfigEntrySet('DEBUG_RESET')) || (!isDebugResetEnabled())) {
		updateConfiguration('last_hour', getHour());
	} // END - if

	// Run the filter
	runFilterChain('load_includes', 'hourly');
}

// Load more reset scripts
function FILTER_RUN_RESET_INCLUDES () {
	// Is the reset set or old sql_patches?
	if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (isHtmlOutputMode())) {
		// Then abort here
		debug_report_bug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
	} // END - if

	// Get more daily reset scripts
	setIncludePool('reset', getArrayFromDirectory('inc/daily/', 'daily_'));

	// Update database
	if ((!isConfigEntrySet('DEBUG_RESET')) || (!isDebugResetEnabled())) {
		updateConfiguration('last_update', 'UNIX_TIMESTAMP()');
	} // END - if

	// Is the config entry set?
	if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
		// Has it changed?
		if (((isConfigEntrySet('last_week')) && (getConfig('last_week') != getWeek())) || (isWeeklyResetDebugEnabled())) {
			// Include weekly reset scripts
			mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));

			// Update config if not in debug mode
			if (!isWeeklyResetDebugEnabled()) {
				updateConfiguration('last_week', getWeek());
			} // END - if
		} // END - if

		// Create current month mark
		$currMonth = getMonth();

		// Has it changed?
		if ((getLastMonth() != $currMonth) || (isMonthlyResetDebugEnabled())) {
			// Include monthly reset scripts
			mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));

			// Update config
			if (!isMonthlyResetDebugEnabled()) {
				updateConfiguration('last_month', $currMonth);
			} // END - if
		} // END - if
	} // END - if

	// Run the filter
	runFilterChain('load_includes', 'reset');
}

// Filter for removing the given extension
function FILTER_REMOVE_EXTENSION () {
	// Delete this extension (remember to remove it from your server *before* you click on welcome!
	SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
		array(getCurrentExtensionName()), __FUNCTION__, __LINE__);

	// Remove the extension from cache array as well
	removeExtensionFromArray();

	// Remove the cache
	rebuildCache('extension', 'extension');
}

// Filter for flushing the output
function FILTER_FLUSH_OUTPUT () {
	// Simple, he?
	outputHtml('');
}

// Prepares an SQL statement part for HTML mail and/or holiday depency
function FILTER_HTML_INCLUDE_USERS ($mode) {
	// Exclude no users by default
	$MORE = '';

	// HTML mail?
	if ($mode == 'html') $MORE = " AND `html`='Y'";
	if (isExtensionInstalledAndNewer('holiday', '0.1.3')) {
		// Add something for the holiday extension
		$MORE .= " AND `holiday_active`='N'";
	} // END - if

	// Return result
	return $MORE;
}

// Filter for determining what/action/module
function FILTER_DETERMINE_WHAT_ACTION () {
	// In installation phase we don't have what/action
	if (isInstallationPhase()) {
		// Set both to empty
		setAction('');
		setWhat('');

		// Abort here
		return;
	} // END - if

	// Get all values
	if ((!isCssOutputMode()) && (!isRawOutputMode())) {
		// Fix module
		if (!isModuleSet()) {
			// Is the request element set?
			if (isGetRequestElementSet('module')) {
				// Set module from request
				setModule(getRequestElement('module'));
			} elseif (isHtmlOutputMode()) {
				// Set default module 'index'
				setModule('index');
			} else {
				// Unknown module
				setModule('unknown');
			}
		} // END - if

		// Fix 'what' if not yet set
		if (!isWhatSet()) {
			setWhat(getWhatFromModule(getModule()));
		} // END - if

		// Fix 'action' if not yet set
		if (!isActionSet()) {
			setAction(getActionFromModuleWhat(getModule(), getWhat()));
		} // END - if
	} else {
		// Set action/what to empty
		setAction('');
		setWhat('');
	}

	// Set default 'what' value
	//* DEBUG: */ debugOutput('-' . getModule() . '/' . getWhat() . '-');
	if ((!isWhatSet()) && (!isActionSet()) && (!isCssOutputMode()) && (!isRawOutputMode())) {
		if (getModule() == 'admin') {
			// Set 'action' value to 'login' in admin menu
			setAction(getActionFromModuleWhat(getModule(), getWhat()));
		} elseif ((getModule() == 'index') || (getModule() == 'login')) {
			// Set 'what' value to 'welcome' in guest and member menu
			setWhatFromConfig('index_home');
		} else {
			// Anything else like begging link
			setWhat('');
		}
	} // END - if
}

// Sends out pooled mails
function FILTER_TRIGGER_SENDING_POOL () {
	// Are we in normal output mode?
	if (!isHtmlOutputMode()) {
		// Only in normal output mode to prevent race-conditons!
	} // END - if

	// Init counter
	$GLOBALS['pool_cnt'] = '0';

	// Init & set the include pool
	initIncludePool('pool');
	setIncludePool('pool', getArrayFromDirectory('inc/pool/', 'pool-'));

	// Run the filter
	runFilterChain('load_includes', 'pool');

	// Remove the counter
	unset($GLOBALS['pool_cnt']);
}

// Filter for checking and updating SVN revision
function FILTER_CHECK_REPOSITORY_REVISION () {
	// Only execute this filter if installed and all config entries are there
	if ((!isInstalled()) || (!isConfigEntrySet('patch_level'))) return;

	// Check for patch level differences between database and current hard-coded
	if ((getCurrentRepositoryRevision() > getConfig('patch_level')) || (getConfig('patch_level') == 'CURRENT_REPOSITORY_REVISION') || (getConfig('patch_ctime') == 'UNIX_TIMES')) {
		// Update database and CONFIG array
		updateConfiguration(array('patch_level', 'patch_ctime'), array(getCurrentRepositoryRevision(), 'UNIX_TIMESTAMP()'));
		setConfigEntry('patch_level', getCurrentRepositoryRevision());
		setConfigEntry('patch_ctime', time());
	} // END - if
}

// Filter for running daily reset
function FILTER_RUN_DAILY_RESET () {
	// Only execute this filter if installed
	if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalled('sql_patches'))) {
		return;
	} // END - if

	// Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
	if (((getDay(getConfig('last_update')) != getDay()) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (!isCssOutputMode())) {
		// Tell every module we are in reset-mode!
		doReset();
	} // END - if
}

// Filter for running hourly reset
function FILTER_RUN_HOURLY_RESET () {
	// Only execute this filter if installed
	if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) {
		return;
	} // END - if

	// Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
	if ((((isConfigEntrySet('last_hour')) && (getConfig('last_hour') != getHour())) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (!isCssOutputMode())) {
		// Tell every module we are in reset-mode!
		doHourly();
	} // END - if
}

// Filter for loading more runtime includes (not for installation)
function FILTER_LOAD_RUNTIME_INCLUDES () {
	// Load more includes
	foreach (array('databases', 'session', 'versions') as $inc) {
		// Load the include
		loadIncludeOnce('inc/' . $inc . '.php');
	} // END - foreach
}

// Filter for checking admin ACL
function FILTER_CHECK_ADMIN_ACL () {
	// Extension not installed so it's always allowed to access everywhere!
	$ret = true;

	// Ok, Cookie-Update done
	if ((isExtensionInstalledAndNewer('admins', '0.3.0')) && (isExtensionActive('admins'))) {
		// Check if action GET variable was set
		$action = getAction();
		if (isWhatSet()) {
			// Get action value by what-value
			$action = getActionFromModuleWhat('admin', getWhat());
		} // END - if

		// Check for access control line of current menu entry
		$ret = isAdminsAllowedByAcl($action, getWhat());
	} // END - if

	// Set it here
	$GLOBALS['acl_allow'] = $ret;
}

// Init random number/cache buster
function FILTER_INIT_RANDOM_NUMBER () {
	// Is the extension ext-sql_patches installed and at least 0.3.6?
	if ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
		// Generate random number
		setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 99999), getMemberId(), ''));
	} else {
		// Generate *WEAK* code
		setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
	}

	// Copy it to CACHE_BUSTER
	setConfigEntry('CACHE_BUSTER', getConfig('RAND_NUMBER'));
}

// Update module counter
function FILTER_COUNT_MODULE () {
	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ' - ENTERED!');
	// Do count all other modules but not accesses on CSS file css.php!
	SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `clicks`=`clicks`+1 WHERE `module`='%s' LIMIT 1",
		array(getModule()), __FUNCTION__, __LINE__);
	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - EXIT!');
}

// Handles fatal errors
function FILTER_HANDLE_FATAL_ERRORS () {
	// Do we have errors to handle and right output mode?
	if ((!ifFatalErrorsDetected()) || (!isHtmlOutputMode())) {
		// Abort executing here
		return false;
	} // END - if

	// Set content type
	setContentType('text/html');

	// Load config here
	loadIncludeOnce('inc/load_config.php');

	// Default content is none
	$content = '';

	// Installation phase or regular mode?
	if ((isInstallationPhase())) {
		// While we are installing ouput other header than while it is installed... :-)
		$OUT = '';
		foreach (getFatalArray() as $key => $value) {
			// Prepare content for the template
			$content = array(
				'key'   => ($key + 1),
				'value' => $value
			);

			// Load row template
			$OUT .= loadTemplate('install_fatal_row', true, $content);
		}

		// Load main template
		$content = loadTemplate('install_fatal_table', true, $OUT);
	} elseif (isInstalled()) {
		// Display all runtime fatal errors
		$OUT = '';
		foreach (getFatalArray() as $key => $value) {
			// Prepare content for the template
			$content = array(
				'key'   => ($key + 1),
				'value' => $value
			);

			// Load row template
			$OUT .= loadTemplate('runtime_fatal_row', true, $content);
		}

		// Load main template
		$content = loadTemplate('runtime_fatal_table', true, $OUT);
	}

	// Message to regular users (non-admin)
	$CORR = '{--FATAL_REPORT_ERRORS--}';

	// Maybe the admin wants to take a look?
	if (isAdmin()) {
		$CORR = '{--FATAL_CORRECT_ERRORS--}';
	} // END - if

	// Remember all in array
	$content = array(
		'rows' => $content,
		'corr' => $CORR
	);

	// Load footer
	loadIncludeOnce('inc/header.php');

	// Load main template
	loadTemplate('fatal_errors', false, $content);

	// Delete all to prevent double-display
	initFatalMessages();

	// Load footer
	loadIncludeOnce('inc/footer.php');

	// Abort here
	shutdown();
}

// Filter for displaying copyright line
function FILTER_DISPLAY_COPYRIGHT () {
	// Shall we display the copyright notice?
	if ((!isGetRequestElementSet('frame')) && (basename($_SERVER['PHP_SELF']) != 'mailid_top.php') && ((getConfig('WRITE_FOOTER') == 'Y') || (isInstalling())) && ($GLOBALS['header_sent'] == 2)) {
		// Backlink enabled?
		if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
			// Copyright with backlink, thanks! :-)
			$GLOBALS['page_footer'] .= loadTemplate('copyright_backlink', true);
		} else {
			// No backlink in Copyright note
			$GLOBALS['page_footer'] .= loadTemplate('copyright', true);
		}
	} // END - if
}

// Filter for displaying parsing time
function FILTER_DISPLAY_PARSING_TIME () {
	// Shall we display the parsing time and number of queries?
	// 1234                            5                      54    4         5              5       4    4                       5       543    3                   4432    2             33     2    2                              21
	if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (!isGetRequestElementSet('frame'))) || (isInstallationPhase())) && (isHtmlOutputMode()) && ($GLOBALS['header_sent'] == 2)) {
		// Then display it here
		displayParsingTime();
	} // END - if
}

// Filter for flushing template cache
function FILTER_FLUSH_TEMPLATE_CACHE () {
	// Do not flush when debugging the template cache
	if (isDebuggingTemplateCache()) return;

	// Do we have cached eval() data?
	if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
		// Now flush all
		foreach ($GLOBALS['template_eval'] as $template => $eval) {
			// Flush the cache (if not yet found)
			flushTemplateCache($template, $eval);
		} // END - if
	} // END - if
}

// Filter for loading user data
function FILTER_FETCH_USER_DATA ($userid = NULL) {
	// Is the userid not set? Then use member id
	if (!isValidUserId($userid)) {
		$userid = getMemberId();
	} // END - if

	// Get user data
	if (!fetchUserData($userid)) {
		// Userid is not valid
		debug_report_bug(__FUNCTION__, __LINE__, 'User id '.$userid . ' is invalid.');
	} // END - if

	// Set member id
	setMemberId($userid);
}

// Filter for reseting users' last login failure, only available with latest ext-sql_patches
function FILTER_RESET_USER_LOGIN_FAILURE () {
	// Is the user data valid?
	if (!isMember()) {
		// Do only run for logged in members
		debug_report_bug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
	} // END - if

	// Remmeber login failures if available
	if (isExtensionInstalledAndNewer('user', '0.3.7')) {
		// Reset login failures
		SQL_QUERY_ESC("UPDATE
	`{?_MYSQL_PREFIX?}_user_data`
SET
	`login_failures`=0,
	`last_failure`=NULL
WHERE
	`userid`=%s
LIMIT 1",
			array(getMemberId()), __FUNCTION__, __LINE__);

		// Store it in session
		setSession('mailer_member_failures' , getUserData('login_failures'));
		setSession('mailer_member_last_failure', getUserData('last_failure'));
	} // END - if
}

// Try to login the admin by setting some session/cookie variables
function FILTER_DO_LOGIN_ADMIN ($filterData) {
	// Now set all session variables and store the result for later processing
	$GLOBALS['admin_login_success'] = ((
		setAdminMd5(encodeHashForCookie($filterData['pass_hash']))
	) && (
		setAdminId($filterData['id'])
	) && (
		setAdminLast(time())
	));

	// Return the data for further processing
	return $filterData;
}

// Filter for loading page header, this should be ran first!
function FILTER_LOAD_PAGE_HEADER () {
	// Output page header code
	$GLOBALS['page_header'] = loadTemplate('page_header', true);

	// Include meta data in 'guest' module
	if (getModule() == 'index') {
		// Load meta data template
		$GLOBALS['page_header'] .= loadTemplate('metadata', true);

		// Add meta description to header
		if ((isInstalled()) && (isAdminRegistered()) && (SQL_IS_LINK_UP())) {
			// Add meta description not in admin and login module and when the script is installed
			generateMetaDescriptionCode();
		} // END - if
	} // END - if
}

// Filter for adding style sheet, closing page header
function FILTER_FINISH_PAGE_HEADER () {
	// Include stylesheet
	loadIncludeOnce('inc/stylesheet.php');

	// Closing HEAD tag
	$GLOBALS['page_header'] .= '</head>';
}

// Cleans up the DNS cache if sql_patches is at least 0.7.0
function FILTER_CLEANUP_DNS_CACHE () {
	// Is the latest version installed?
	if (isExtensionInstalledAndNewer('sql_patches', '0.7.0')) {
		// Load class file
		loadIncludeOnce('inc/classes/resolver.class.php');

		// Instance the resolver
		$resolver = new HostnameResolver();

		// Purge entries
		$resolver->purgeEntries();

		// Cute, isn't it? ;-)
	} // END - if
}

// Filter for setting CURRENT_DATE, this is required after initialization of extensions
function FILTER_SET_CURRENT_DATE () {
	// Set current date
	setConfigEntry('CURRENT_DATE', generateDateTime(time(), '3'));

	// Epoche time for yesterday, today ... all at 00:00 am
	setConfigEntry('START_YDAY', makeTime(0, 0, 0, time() - getOneDay()));
	setConfigEntry('START_TDAY', makeTime(0, 0, 0, time()));
}

// Filter for marking extension as installed
function FILTER_EXTENSION_MARK_INSTALLED ($filterData) {
	// Mark it as installed
	$GLOBALS['ext_is_installed'][$filterData['ext_name']] = true;
}

// Filter for generating mails links for 'pool' mails
function FILTER_GENERATE_POOL_MAIL_LINKS ($filterData) {
	// Is type 'mid'?
	if ($filterData['type'] == 'mid') {
		// Load template
		$filterData['__output'] .= loadTemplate('admin_links_' . strtolower($filterData['mail_status']) . '_pool_mail', true, $filterData);
	} // END - if

	// Return data
	return $filterData;
}

// Filter to activate exchange
function FILTER_ACTIVATE_EXCHANGE () {
	// Is the extension 'user' there?
	if ((!isExtensionActive('user')) || (getActivateXchange() == '0')) {
		// Silently abort here
		return false;
	} // END - if

	// Check total amount of users
	if (getTotalConfirmedUser() >= getActivateXchange()) {
		// Activate System
		addSql("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `locked`='N', `hidden`='N', `mem_only`='Y' WHERE `module`='order' LIMIT 1");
		addSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `visible`='Y', `locked`='N' WHERE `what`='order' OR `what`='unconfirmed' LIMIT 2");

		// Run SQLs
		runFilterChain('run_sqls');

		// Update configuration
		updateConfiguration('activate_xchange' ,0);

		// Rebuild cache
		rebuildCache('modules', 'modules');
	} // END - if
}

// Filter to handle configuration
function FILTER_HANDLE_HOME_IN_INDEX_SETTING ($filterData) {
	// Is ext-sql_patches up-to-date?
	if ((isExtensionInstalledAndNewer('sql_patches', '0.8.3')) && (isDisplayHomeInIndexEnabled())) {
		// Is 'search' as same as 'index_home'?
		if ($filterData['search'] == getIndexHome()) {
			// Then set 'content' to link to index.php
			$filterData['content'] = $filterData['prefix'] . '<strong><a class="you_are_here" href="{%url=index.php' . $filterData['link_add'] . '%}">' . getTitleFromMenu($filterData['access_level'], $filterData['search'], $filterData['type'], $filterData['add']) . '</a></strong>';
		} // END - if
	} // END - if

	// Return data
	return $filterData;
}

// Filter to add history entry
function FILTER_ADD_HISTORY_ENTRY ($filterData) {
	// Add the entry
	SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_history` (`history_subject`,`history_userid`,`history_value`) VALUES ('%s',%s,'%s')",
		$filterData,
		__FUNCTION__, __LINE__);

	// Remember insert id for other filters
	$filterData['history_id'] = SQL_INSERTID();

	// Return data
	return $filterData;
}

// [EOF]
?>