2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 12/16/2008 *
4 * =================== Last change: 12/16/2008 *
6 * -------------------------------------------------------------------- *
8 * -------------------------------------------------------------------- *
9 * Short description : Generic filters *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Allgemeine Filter *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2012 by Mailer Developer Team *
20 * For more information visit: http://mxchange.org *
22 * This program is free software; you can redistribute it and/or modify *
23 * it under the terms of the GNU General Public License as published by *
24 * the Free Software Foundation; either version 2 of the License, or *
25 * (at your option) any later version. *
27 * This program is distributed in the hope that it will be useful, *
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
30 * GNU General Public License for more details. *
32 * You should have received a copy of the GNU General Public License *
33 * along with this program; if not, write to the Free Software *
34 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
43 // Filter for flushing all new filters to the database
44 function FILTER_FLUSH_FILTERS () {
45 // Clear all previous SQL queries
48 // Is a database link here and not in installation mode?
49 if ((!SQL_IS_LINK_UP()) && (!isInstallationPhase())) {
51 reportBug(__FUNCTION__, __LINE__, 'No database link is up. Cannot flush filters.');
52 } elseif ((isInstallationPhase()) && (!SQL_IS_LINK_UP())) {
53 // If the link is not up in installation phase, skip flushing filters
57 // Is the extension ext-sql_patches updated and not in installation phase?
58 if ((!isInstallationPhase()) && ((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9')))) {
59 // Log only in debug mode
60 if (isDebugModeEnabled()) {
61 logDebugMessage(__FUNCTION__, __LINE__, 'Cannot flush filters, ext-sql_patches might be missing. isExtensionInstalled()=' . intval(isExtensionInstalled('sql_patches')) . ',isExtensionInstalledAndOlder()=' . intval(isExtensionInstalledAndOlder('sql_patches', '0.5.9')));
64 // Abort silently here
68 // Nothing is added/remove by default
72 // Prepare SQL queries
73 $insertSQL = 'INSERT INTO `{?_MYSQL_PREFIX?}_filters` (`filter_name`, `filter_function`, `filter_active`) VALUES';
74 $removeSQL = 'DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_filters` WHERE';
76 // Write all filters to database
77 foreach ($GLOBALS['cache_array']['filter']['chains'] as $filterName => $filterArray) {
78 // Walk through all filters
79 foreach ($filterArray as $filterFunction => $active) {
80 // Is this filter loaded?
81 //* DEBUG: */ debugOutput('FOUND:'.$filterName.'/'.$filterFunction.'='.$active);
82 if (((!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) && ($active != 'R')) || ($active == 'A')) {
83 // Is this filter already in database?
84 if (countSumTotalData($filterFunction, 'filters', 'filter_name', 'filter_function', TRUE, sprintf(" AND `filter_name`='%s'", SQL_ESCAPE($filterName))) == 0) {
85 // Add this filter (all filters are active by default)
86 //* DEBUG: */ debugOutput('ADD:'.$filterName.'/'.$filterFunction);
87 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
89 } elseif (isDebugModeEnabled()) {
90 // Log already registered filters
91 logDebugMessage(__FUNCTION__, __LINE__, 'Already registered: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',active=' . $active);
93 } elseif ($active == 'R') {
95 //* DEBUG: */ debugOutput('REMOVE:'.$filterName.'/'.$filterFunction);
96 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
102 // Something has been added?
104 // Finish SQL command and add it
105 addSql(substr($insertSQL, 0, -1));
108 // Something has been removed?
110 // Finish SQL command and add it
111 addSql(substr($removeSQL, 0, -2) . 'LIMIT ' . $removed);
114 // Shall we update usage counters (ONLY FOR DEBUGGING!)
115 if (isFilterUsageUpdateEnabled()) {
116 // Update all counters
117 foreach ($GLOBALS['cache_array']['filter']['counter'] as $filterName => $filterArray) {
118 // Walk through all filters
119 foreach ($filterArray as $filterFunction => $count) {
120 // Construct and add the query
121 addSql(sprintf("UPDATE `{?_MYSQL_PREFIX?}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
130 // Run the run_sqls filter in non-dry mode
131 runFilterChain('run_sqls');
133 // Should we rebuild cache?
134 if (($inserted > 0) || ($removed > 0)) {
136 rebuildCache('filter', 'filter');
140 // Filter for calling the handler for login failures
141 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($filterData) {
143 $content = $filterData;
145 // Handle failed logins here if not in guest
146 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'type=' . $filterData['type'] . ',action=' . getAction() . ',what=' . getWhat() . ',level=' . $filterData['access_level']);
147 if ((($filterData['type'] == 'what') || ($filterData['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'welcome') || (getWhat() == getIndexHome()))) && ($filterData['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.6')))) {
149 $content['content'] .= handleLoginFailures($filterData['access_level']);
152 // Return the content
156 // Filter for redirecting to logout if ext-sql_patches has been installed
157 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
158 // Remove this filter
159 unregisterFilter(__FUNCTION__, __LINE__, 'shutdown', __FUNCTION__);
161 // Is the element set?
162 if (isset($GLOBALS['ext_load_mode'])) {
164 redirectToUrl('modules.php?module=admin&logout=1&' . $GLOBALS['ext_load_mode'] . '=sql_patches');
167 // This should not happen!
168 logDebugMessage(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
171 // Filter for auto-activation of a extension
172 function FILTER_AUTO_ACTIVATE_EXTENSION ($filterData) {
174 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $filterData['ext_name'] . ',isThisExtensionAlwaysActive()=' . intval(isThisExtensionAlwaysActive()));
176 // Is this extension always activated?
177 if (isThisExtensionAlwaysActive()) {
178 // Then activate the extension
179 doActivateExtension($filterData['ext_name']);
186 // Filter for solving task given task
187 function FILTER_SOLVE_TASK ($filterData) {
188 // Don't solve anything if no admin!
193 // Is this a direct task id or array element task_id is found?
194 if (is_int($filterData)) {
196 adminSolveTask($filterData);
197 } elseif ((is_array($filterData)) && (isset($filterData['task_id']))) {
199 adminSolveTask($filterData['task_id']);
202 reportBug(__FUNCTION__, __LINE__, sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($filterData), print_r($filterData, TRUE)));
209 // Filter to load include files
210 function FILTER_LOAD_INCLUDES ($filterData) {
212 if (is_null($filterData)) {
213 // This should not happen!
214 reportBug(__FUNCTION__, __LINE__, 'pool is null.');
217 // Is the pool an array and 'pool' set?
218 if ((is_array($filterData)) && (isset($filterData['pool']))) {
219 // Then use it as pool
220 $realPool = $filterData['pool'];
222 // Default is $data as inclusion list
223 $realPool = $filterData;
227 $data = getIncludePool($realPool);
230 if ((!isset($data)) || (!is_array($data))) {
232 reportBug(__FUNCTION__, __LINE__, sprintf("INC_POOL is no array! Type: %s", gettype($data)));
233 } elseif (isset($data['inc_pool'])) {
234 // Use this as new inclusion pool!
235 setIncludePool($realPool, $data['inc_pool']);
238 // Check for added include files
239 if (countIncludePool($realPool) > 0) {
240 // Loads every include file
241 loadIncludePool($realPool);
244 initIncludePool($realPool);
247 // Continue with processing
251 // Filter for running SQL commands
252 function FILTER_RUN_SQLS ($filterData) {
257 //* DEBUG: */ die('getSqls()=<pre>'.print_r(getSqls(), TRUE).'</pre>ext_update_depends=<pre>'.print_r($GLOBALS['ext_update_depends'], TRUE).'</pre>');
258 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Entered!');
260 // Is the array there?
261 if ((isSqlsValid()) && ((!isset($filterData['dry_run'])) || ($filterData['dry_run'] == FALSE))) {
263 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Found ' . countSqls() . ' queries to run.');
264 foreach (getSqls() as $mode => $sqls) {
266 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mode=' . $mode . ',count()=' . count($sqls));
268 // New cache format...
269 foreach ($sqls as $sql) {
273 // Is 'enable_codes' not set? Then set it to true
274 if (!isset($filterData['enable_codes'])) {
275 $filterData['enable_codes'] = TRUE;
278 // Is there still a query left?
280 // Is there an "ALTER TABLE" command? Exclude installation phase here as it would cause this query to fail
281 if ((substr(strtolower($sql), 0, 11) == 'alter table') && (!isset($filterData['ext_installing']))) {
282 // Analyse the alteration command
283 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Alterting table: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
284 SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
286 // Run regular SQL command
287 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running regular query: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
288 SQL_QUERY($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
291 // Has a line changed?
292 if (!SQL_HASZEROAFFECTED()) {
293 // Add it to total account
294 $count += SQL_AFFECTEDROWS();
302 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
308 // Filter for updating/validating login data
309 function FILTER_UPDATE_LOGIN_DATA () {
311 if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) {
312 $GLOBALS['last_online'] = array();
315 // Recheck if logged in
316 if ((!isMember()) || ((isAdmin()) && (!isDebugModeEnabled()))) {
321 setMemberId(getSession('userid'));
324 if (fetchUserData(getMemberId())) {
325 // Load last module and online time
326 $content = getUserDataArray();
328 // Maybe first login time?
329 if (empty($content[getUserLastWhatName()])) {
330 $content[getUserLastWhatName()] = 'login';
333 // This will be displayed on welcome page! :-)
334 if (empty($GLOBALS['last_online']['module'])) {
335 $GLOBALS['last_online']['module'] = $content[getUserLastWhatName()];
336 $GLOBALS['last_online']['online'] = $content['last_online'];
343 if (getIndexHome() != '') {
344 setWhatFromConfig('index_home');
348 // Update last module / online time
349 updateLastActivity(getMemberId());
351 // Destroy session, we cannot update!
352 destroyMemberSession();
356 // Filter for initializing randomizer
357 function FILTER_INIT_RANDOMIZER () {
358 // Take a prime number which is long (if you know a longer one please try it out!)
359 setConfigEntry('_PRIME', 591623);
361 // Initialize array with all allowed chars
362 $GLOBALS['_abc'] = explode(',', 'a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,1,2,3,4,6,7,8,9,-,+,_,/,.');
364 // Only execute this filter if installed
365 if ((!isInstalled()) || (!isExtensionInstalledAndNewer('other', '0.2.5'))) {
367 setConfigEntry('_ADD', 0);
371 // Calculate "entropy" with the prime number (for code generation)
372 setConfigEntry('_ADD', (getPrime() * getPrime() / (pi() * getCodeLength() + 1)));
374 // Simply init the randomizer with seed and _ADD value
375 mt_srand(generateSeed() + getConfig('_ADD'));
378 // Filter for removing updates
379 function FILTER_REMOVE_UPDATES ($filterData) {
381 initExtensionRemovalList();
383 // Add the current extension to it
384 addCurrentExtensionToRemovalList();
387 unsetExtensionSqls();
389 // Are there update dependencies to remove?
390 if (countExtensionUpdateDependencies() > 0) {
391 // Then find all updates we shall no longer execute
392 foreach (getExtensionUpdateDependencies() as $id => $ext_name) {
393 // Shall we remove this update?
394 if (in_array($ext_name, getExtensionRemovalList())) {
395 // Then remove this extension!
396 removeExtensionDependency($ext_name);
405 // Determines username for current user state
406 function FILTER_DETERMINE_USERNAME () {
407 // Check if logged in
409 // Is still logged in so we welcome him with his name
410 if (fetchUserData(getMemberId())) {
411 // Load surname and family's name and build the username
412 $content = getUserDataArray();
415 setUsername($content['surname'] . ' ' . $content['family']);
417 // Additionally admin?
420 setUsername(getUsername() . ' ({--USERNAME_ADMIN_SHORT--})');
423 // Hmmm, logged in and no valid userid?
424 setUsername('<span class="bad">{--USERNAME_UNKNOWN--}</span>');
427 destroyMemberSession();
429 } elseif (isAdmin()) {
431 setUsername('{--USERNAME_ADMIN--}');
433 // He's a guest, hello there... ;-)
434 setUsername('{--USERNAME_GUEST--}');
438 // Filter for compiling config entries
439 function FILTER_COMPILE_CONFIG ($code, $compiled = FALSE) {
440 // Save the uncompiled code
444 if (!isset($GLOBALS['compiled_config'][$code])) {
445 // Compile {?some_var?} to getConfig('some_var')
446 preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
448 // Some entries found?
449 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
450 // Replace all matches
451 foreach ($matches[0] as $key => $match) {
453 if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
454 // Is the config valid?
455 if (isConfigEntrySet($matches[1][$key])) {
456 // Set it for caching
457 $GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . $matches[1][$key] . '%}';
458 } elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
460 $GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . 'DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
461 } elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
462 // No config, try the language system
463 $GLOBALS['compile_config'][$matches[1][$key]] = '{%message,DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
466 $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
470 // Use this for replacing
471 $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
472 //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die(__FUNCTION__.'['.__LINE__.']:<pre>'.secureString($code).'</pre>');
477 $GLOBALS['compiled_config'][$uncompiled] = $code;
480 // Should we compile it?
481 if ($compiled === TRUE) {
483 $eval = "\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . '";';
484 //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>' . encodeEntities($eval) . '</pre>');
488 // Return compiled code
489 return $GLOBALS['compiled_config'][$uncompiled];
492 // Filter for compiling expression code
493 function FILTER_COMPILE_EXPRESSION_CODE ($filterData) {
494 // Compile {%cmd,callback,extraFunction=some_value%} to get expression code snippets
495 // See switch() command below for supported commands
496 preg_match_all('/\{%(([a-zA-Z0-9-_,]+)(=([^\}]+)){0,1})*%\}/', $filterData, $matches);
497 //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.print_r($matches, TRUE).'</pre>');
499 // Default is from outputHtml()
500 $outputMode = getScriptOutputMode();
502 // Some entries found?
503 if ((count($matches) > 0) && (count($matches[3]) > 0)) {
504 // Replace all matches
505 foreach ($matches[2] as $key => $eti) {
506 // Init replacer/call-back variable
510 $extraFunction2 = '';
513 // Extract command and call-back
514 $etiArray = explode(',', $eti);
517 // Detect call-back function
518 if (isset($etiArray[1])) {
519 // Call-back function detected
520 $callback = $etiArray[1];
523 // Detect extra function
524 if (isset($etiArray[2])) {
526 $extraFunction = $etiArray[2];
529 // Detect extra function 2
530 if (isset($etiArray[3])) {
532 $extraFunction2 = $etiArray[3];
536 if (isset($matches[4][$key])) {
538 $value = $matches[4][$key];
541 // Construct call-back function name for the command
542 $etiFunction = 'doExpression' . capitalizeUnderscoreString($eti);
544 // Is this function there?
545 if (function_exists($etiFunction)) {
546 // Prepare $matches, $key, $outputMode, etc.
548 'matches' => $matches,
550 'output_mode' => getScriptOutputMode(),
551 'code' => $filterData,
552 'callback' => $callback,
553 'extra_func' => $extraFunction,
554 'extra_func2' => $extraFunction2,
559 //* DEBUG: */ debugOutput(__FUNCTION__ . '[' . __LINE__ . ']: etiFunction=' . $etiFunction);
560 $filterData = call_user_func($etiFunction, $data);
562 // Unsupported command detected
563 logDebugMessage(__FUNCTION__, __LINE__, 'eti=' . $eti . ',etiFunction=' . $etiFunction . ',callback=' . $callback . ',extraFunction=' . $extraFunction . ',extraFunction2=' . $extraFunction2 . ' - UNSUPPORTED');
568 // Is there non-HTML mode?
569 if (!isHtmlOutputMode()) {
570 $filterData = decodeEntities($filterData);
573 // Return compiled code
574 //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.($filterData).'</pre>');
578 // Runs some generic filter update steps
579 function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
580 // Create task (we ignore the task id here)
581 createExtensionUpdateTask(getCurrentAdminId(), $ext_name, $GLOBALS['update_ver'][$ext_name], SQL_ESCAPE(getExtensionNotes(getExtensionNotes())));
583 // Update extension's version
584 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_version`='%s' WHERE `ext_name`='%s' LIMIT 1",
585 array($GLOBALS['update_ver'][$ext_name], $ext_name), __FUNCTION__, __LINE__);
589 unset($GLOBALS['update_ver'][$ext_name]);
592 // Load more hourly reset scripts
593 function FILTER_RUN_HOURLY_INCLUDES () {
594 // Is the reset set or old sql_patches?
595 if (((!isHourlyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) && (isHtmlOutputMode())) {
597 reportBug(__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');
600 // Get more hourly reset scripts
601 setIncludePool('hourly', getArrayFromDirectory('inc/hourly/', 'hourly_'));
604 if ((!isConfigEntrySet('DEBUG_RESET')) || (!isDebugResetEnabled())) {
605 updateConfiguration('last_hour', getHour());
609 runFilterChain('load_includes', 'hourly');
612 // Load more reset scripts
613 function FILTER_RUN_RESET_INCLUDES () {
614 // Is the reset set or old sql_patches?
615 if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (isHtmlOutputMode())) {
617 reportBug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
620 // Get more daily reset scripts
621 setIncludePool('reset', getArrayFromDirectory('inc/daily/', 'daily_'));
623 // Update configuration if this reset is not being debugged
624 if (!isDebugResetEnabled()) {
625 updateConfiguration('last_update', 'UNIX_TIMESTAMP()');
628 // Is the config entry set?
629 if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
631 if (((isConfigEntrySet('last_week')) && (getConfig('last_week') != getWeek())) || (isWeeklyResetDebugEnabled())) {
632 // Include weekly reset scripts
633 mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
635 // Update configuration if this reset is not being debugged
636 if (!isWeeklyResetDebugEnabled()) {
637 updateConfiguration('last_week', getWeek());
641 // Create current month mark
642 $currMonth = getMonth();
645 if ((getLastMonth() != $currMonth) || (isMonthlyResetDebugEnabled())) {
646 // Include monthly reset scripts
647 mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
649 // Update configuration if this reset is not being debugged
650 if (!isMonthlyResetDebugEnabled()) {
651 updateConfiguration('last_month', $currMonth);
657 runFilterChain('load_includes', 'reset');
660 // Filter for removing the given extension
661 function FILTER_REMOVE_EXTENSION () {
662 // Delete this extension (remember to remove it from your server *before* you click on welcome!
663 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
664 array(getCurrentExtensionName()), __FUNCTION__, __LINE__);
666 // Remove the extension from cache array as well
667 removeExtensionFromArray();
670 rebuildCache('extension', 'extension');
673 // Filter for flushing the output
674 function FILTER_FLUSH_OUTPUT () {
679 // Prepares an SQL statement part for HTML mail and/or holiday dependency
680 function FILTER_HTML_INCLUDE_USERS ($mode) {
681 // Exclude no users by default
685 if ($mode == 'html') {
686 $MORE = " AND `html`='Y'";
689 if (isExtensionInstalledAndNewer('holiday', '0.1.3')) {
690 // Add something for the holiday extension
691 $MORE .= " AND `holiday_active`='N'";
698 // Filter for determining what/action/module
699 function FILTER_DETERMINE_WHAT_ACTION () {
700 // In installation phase we don't have what/action
701 if (isInstallationPhase()) {
711 if ((!isCssOutputMode()) && (!isRawOutputMode())) {
713 if (!isModuleSet()) {
714 // Is the module registered?
715 if (!isModuleRegistered(getRequestElement('module'))) {
716 // Is not a valid module
717 redirectToUrl('modules.php?module=index');
720 // Is the request element set?
721 if (isGetRequestElementSet('module')) {
722 // Set module from request
723 setModule(getRequestElement('module'));
724 } elseif (isHtmlOutputMode()) {
725 // Set default module 'index'
729 setModule('unknown');
733 // Fix 'what' if not yet set
735 setWhat(getWhatFromModule(getModule()));
738 // Fix 'action' if not yet set
739 if (!isActionSet()) {
743 setAction(getActionFromModuleWhat(getModule(), getWhat()));
745 // Set action/what to empty
751 // Set action/what to empty
756 // Set default 'what' value
757 //* DEBUG: */ debugOutput('-' . getModule() . '/' . getWhat() . '-');
758 if ((!isWhatSet()) && (!isActionSet()) && (!isCssOutputMode()) && (!isRawOutputMode())) {
759 if (getModule() == 'admin') {
760 // Set 'action' value to 'login' in admin menu
761 setAction(getActionFromModuleWhat(getModule(), getWhat()));
762 } elseif ((getModule() == 'index') || (getModule() == 'login')) {
763 // Set 'what' value to 'welcome' in guest and member menu
764 setWhatFromConfig('index_home');
766 // Anything else like begging link
772 // Sends out pooled mails
773 function FILTER_TRIGGER_SENDING_POOL () {
774 // Are we in normal output mode?
775 if (!isHtmlOutputMode()) {
776 // Only in normal output mode to prevent race-conditons!
780 $GLOBALS['pool_cnt'] = '0';
782 // Init & set the include pool
783 initIncludePool('pool');
784 setIncludePool('pool', getArrayFromDirectory('inc/pool/', 'pool-'));
787 runFilterChain('load_includes', 'pool');
789 // Remove the counter
790 unset($GLOBALS['pool_cnt']);
793 // Filter for checking and updating SVN revision
794 function FILTER_CHECK_REPOSITORY_REVISION () {
795 // Only execute this filter if installed and all config entries are there
796 if ((!isInstalled()) || (!isConfigEntrySet('patch_level'))) return;
798 // Check for patch level differences between database and current hard-coded
799 if ((getCurrentRepositoryRevision() > getConfig('patch_level')) || (getConfig('patch_level') == 'CURRENT_REPOSITORY_REVISION') || (getConfig('patch_ctime') == 'UNIX_TIMES')) {
800 // Update database and CONFIG array
801 updateConfiguration(array('patch_level', 'patch_ctime'), array(getCurrentRepositoryRevision(), 'UNIX_TIMESTAMP()'));
802 setConfigEntry('patch_level', getCurrentRepositoryRevision());
803 setConfigEntry('patch_ctime', time());
807 // Filter for running daily reset
808 function FILTER_RUN_DAILY_RESET () {
809 // Only execute this filter if installed
810 if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalled('sql_patches'))) {
814 // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
815 if (((getDay(getConfig('last_update')) != getDay()) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (!isCssOutputMode())) {
816 // Tell every module we are in reset-mode!
821 // Filter for running hourly reset
822 function FILTER_RUN_HOURLY_RESET () {
823 // Only execute this filter if installed
824 if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) {
828 // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
829 if ((((isConfigEntrySet('last_hour')) && (getConfig('last_hour') != getHour())) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (!isCssOutputMode())) {
830 // Tell every module we are in reset-mode!
835 // Filter for loading more runtime includes (not for installation)
836 function FILTER_LOAD_RUNTIME_INCLUDES () {
837 // Load more includes
838 foreach (array('databases', 'session', 'versions') as $inc) {
840 loadIncludeOnce('inc/' . $inc . '.php');
844 // Filter for checking admin ACL
845 function FILTER_CHECK_ADMIN_ACL () {
846 // Extension not installed so it's always allowed to access everywhere!
849 // Ok, Cookie-Update done
850 if ((isExtensionInstalledAndNewer('admins', '0.3.0')) && (isExtensionActive('admins'))) {
851 // Check if action GET variable was set
852 $action = getAction();
854 // Get action value by what-value
855 $action = getActionFromModuleWhat('admin', getWhat());
858 // Check for access control line of current menu entry
859 $ret = isAdminsAllowedByAcl($action, getWhat());
863 $GLOBALS['acl_allow'] = $ret;
866 // Init random number/cache buster
867 function FILTER_INIT_RANDOM_NUMBER () {
868 // Is the extension ext-sql_patches installed and at least 0.3.6?
869 if (isSessionVariableSet('random_number')) {
871 setConfigEntry('RAND_NUMBER', getSession('random_number'));
872 } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
873 // Generate random number
874 setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 99999), getMemberId(), ''));
876 // Generate *WEAK* code
877 setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
880 // Set it in session for faster script execusion
881 setSession('random_number', getConfig('RAND_NUMBER'));
883 // Copy it to CACHE_BUSTER
884 setConfigEntry('CACHE_BUSTER', getConfig('RAND_NUMBER'));
887 // Update module counter
888 function FILTER_COUNT_MODULE () {
889 // Is installation phase?
890 if (isInstallationPhase()) {
891 // Then don't count any modules
895 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ' - ENTERED!');
896 // Do count all other modules but not accesses on CSS file css.php!
897 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `clicks`=`clicks`+1 WHERE `module`='%s' LIMIT 1",
898 array(getModule()), __FUNCTION__, __LINE__);
899 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - EXIT!');
902 // Handles fatal errors
903 function FILTER_HANDLE_FATAL_ERRORS () {
904 // Is there errors to handle and right output mode?
905 if ((!ifFatalErrorsDetected()) || (!isHtmlOutputMode())) {
906 // Abort executing here
911 setContentType('text/html');
914 loadIncludeOnce('inc/load_config.php');
916 // Default content is none
919 // Installation phase or regular mode?
920 if ((isInstallationPhase())) {
921 // While we are installing ouput other header than while it is installed... :-)
923 foreach (getFatalArray() as $key => $value) {
924 // Prepare content for the template
931 $OUT .= loadTemplate('install_fatal_row', TRUE, $content);
934 // Load main template
935 $content = loadTemplate('install_fatal_table', TRUE, $OUT);
936 } elseif (isInstalled()) {
937 // Display all runtime fatal errors
939 foreach (getFatalArray() as $key => $value) {
940 // Prepare content for the template
947 $OUT .= loadTemplate('runtime_fatal_row', TRUE, $content);
950 // Load main template
951 $content = loadTemplate('runtime_fatal_table', TRUE, $OUT);
954 // Message to regular users (non-admin)
955 $CORR = '{--FATAL_REPORT_ERRORS--}';
957 // Maybe the admin wants to take a look?
959 $CORR = '{--FATAL_CORRECT_ERRORS--}';
962 // Remember all in array
969 loadIncludeOnce('inc/header.php');
971 // Load main template
972 loadTemplate('fatal_errors', FALSE, $content);
974 // Delete all to prevent double-display
978 loadIncludeOnce('inc/footer.php');
984 // Filter for displaying copyright line
985 function FILTER_DISPLAY_COPYRIGHT () {
986 // Shall we display the copyright notice?
987 if ((isFullPage()) && ((getWriteFooter() == 'Y') || (isInstalling())) && ($GLOBALS['__header_sent'] == 2) && (ifCopyrightFooterEnabled())) {
989 if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
990 // Copyright with backlink, thanks! :-)
991 $GLOBALS['__page_footer'] .= loadTemplate('copyright_backlink', TRUE);
993 // No backlink in Copyright note
994 $GLOBALS['__page_footer'] .= loadTemplate('copyright', TRUE);
999 // Filter for displaying parsing time
1000 function FILTER_DISPLAY_PARSING_TIME () {
1001 // Shall we display the parsing time and number of queries?
1002 // 1234 5 54 4 554 4 5543 3 4432 2 332 2 21
1003 if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (isShowTimingsEnabled()) && (isFullPage())) && (!isInstallationPhase())) && (isHtmlOutputMode()) && ($GLOBALS['__header_sent'] == 2)) {
1004 // Then display it here
1005 displayParsingTime();
1009 // Filter for flushing template cache
1010 function FILTER_FLUSH_TEMPLATE_CACHE () {
1011 // Do not flush when debugging the template cache
1012 if (isDebuggingTemplateCache()) {
1013 // Do not flush templates in debug-mode
1017 // Is there cached eval() data?
1018 if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
1020 foreach ($GLOBALS['template_eval'] as $prefix => $templateArray) {
1021 foreach ($templateArray as $template => $eval) {
1022 // Flush the cache (if not yet found)
1023 flushTemplateCache($prefix, $template, $eval);
1029 // Filter for loading user data
1030 function FILTER_FETCH_USER_DATA ($userid = NULL) {
1031 // Is the userid not set? Then use member id
1032 if (!isValidUserId($userid)) {
1033 $userid = getMemberId();
1037 if (!fetchUserData($userid)) {
1038 // Userid is not valid
1039 reportBug(__FUNCTION__, __LINE__, 'User id '.$userid . ' is invalid.');
1043 setMemberId($userid);
1046 // Filter for reseting users' last login failure, only available with latest ext-sql_patches
1047 function FILTER_RESET_USER_LOGIN_FAILURE () {
1048 // Is the user data valid?
1050 // Do only run for logged in members
1051 reportBug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
1054 // Remmeber login failures if available
1055 if (isExtensionInstalledAndNewer('user', '0.3.7')) {
1056 // Reset login failures
1057 SQL_QUERY_ESC("UPDATE
1058 `{?_MYSQL_PREFIX?}_user_data`
1065 array(getMemberId()), __FUNCTION__, __LINE__);
1067 // Store it in session
1068 setSession('mailer_member_failures' , getUserData('login_failures'));
1069 setSession('mailer_member_last_failure', getUserData('last_failure'));
1073 // Try to login the admin by setting some session/cookie variables
1074 function FILTER_DO_LOGIN_ADMIN ($filterData) {
1075 // Now set all session variables and store the result for later processing
1076 $GLOBALS['admin_login_success'] = ((
1077 setAdminMd5(encodeHashForCookie($filterData['pass_hash']))
1079 setAdminId($filterData['id'])
1081 setAdminLast(time())
1084 // Return the data for further processing
1088 // Filter for loading page header, this should be ran first!
1089 function FILTER_LOAD_PAGE_HEADER () {
1090 // Output page header code
1091 $GLOBALS['__page_header'] = loadTemplate('page_header', TRUE);
1093 // Include meta data in 'guest' module
1094 if (isModuleSet()) {
1095 // Load meta data template
1096 $GLOBALS['__page_header'] .= loadTemplate(getMenuModeFromModule() . '_metadata', TRUE);
1098 // Add meta description to header
1099 if ((isInstalled()) && (isAdminRegistered()) && (SQL_IS_LINK_UP()) && (getModule() == 'index')) {
1100 // Add meta description not in admin and login module and when the script is installed
1101 generateMetaDescriptionCode();
1106 // Filter for adding style sheet, closing page header
1107 function FILTER_FINISH_PAGE_HEADER () {
1108 // Include stylesheet
1109 loadIncludeOnce('inc/stylesheet.php');
1112 $GLOBALS['__page_header'] .= '</head>';
1115 // Cleans up the DNS cache if ext-sql_patches is at least 0.7.0
1116 function FILTER_CLEANUP_DNS_CACHE () {
1117 // Is the latest version installed?
1118 if (isExtensionInstalledAndNewer('sql_patches', '0.7.0')) {
1120 loadIncludeOnce('inc/classes/resolver.class.php');
1122 // Instance the resolver
1123 $resolver = new HostnameResolver();
1126 $resolver->purgeEntries();
1128 // Cute, isn't it? ;-)
1132 // Filter for setting CURRENT_DATE, this is required after initialization of extensions
1133 function FILTER_SET_CURRENT_DATE () {
1135 setConfigEntry('CURRENT_DATE', generateDateTime(time(), '3'));
1137 // Epoche time for yesterday, today ... all at 00:00 am
1138 setConfigEntry('START_YDAY', makeTime(0, 0, 0, time() - getOneDay()));
1139 setConfigEntry('START_TDAY', makeTime(0, 0, 0, time()));
1142 // Filter for marking extension as installed
1143 function FILTER_EXTENSION_MARK_INSTALLED ($filterData) {
1144 // Mark it as installed
1145 $GLOBALS['ext_is_installed'][$filterData['ext_name']] = TRUE;
1148 // Filter for generating mails links for 'pool' mails
1149 function FILTER_GENERATE_POOL_MAIL_LINKS ($filterData) {
1151 if ($filterData['type'] == 'mid') {
1153 $filterData['__output'] .= loadTemplate('admin_links_' . strtolower($filterData['mail_status']) . '_pool_mail', TRUE, $filterData);
1160 // Filter to activate exchange
1161 function FILTER_ACTIVATE_EXCHANGE () {
1162 // Is the extension 'user' there?
1163 if ((!isExtensionActive('user')) || (getActivateXchange() == '0')) {
1164 // Silently abort here
1168 // Check total amount of users
1169 if (getTotalConfirmedUser() >= getActivateXchange()) {
1171 addSql("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `locked`='N',`hidden`='N',`mem_only`='Y' WHERE `module`='order' LIMIT 1");
1172 addSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `visible`='Y',`locked`='N' WHERE `what`='order' OR `what`='unconfirmed' LIMIT 2");
1175 runFilterChain('run_sqls');
1177 // Update configuration
1178 updateConfiguration('activate_xchange' ,0);
1181 rebuildCache('modules', 'modules');
1185 // Filter to handle configuration
1186 function FILTER_HANDLE_HOME_IN_INDEX_SETTING ($filterData) {
1187 // Is ext-sql_patches up-to-date?
1188 if ((isExtensionInstalledAndNewer('sql_patches', '0.8.3')) && (isDisplayHomeInIndexEnabled())) {
1189 // Is 'search' as same as 'index_home'?
1190 if ($filterData['search'] == getIndexHome()) {
1191 // Then set 'content' to link to index.php
1192 $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>';
1200 // Filter to add history entry
1201 function FILTER_ADD_HISTORY_ENTRY ($filterData) {
1203 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_history` (`history_subject`, `history_userid`, `history_value`) VALUES ('%s',%s,'%s')",
1205 __FUNCTION__, __LINE__);
1207 // Remember insert id for other filters
1208 $filterData['history_id'] = SQL_INSERTID();
1214 // Filter for initializing ext-sql_patches
1215 function FILTER_GENERATE_FILE_SECRET_HASH ($filterData) {
1216 // Transfer POINTS word
1217 if (isExtensionInstalledAndNewer('sql_patches', '0.0.3')) {
1218 // Okay, recent enough, so transfer the word for POINTS
1219 setConfigEntry('POINTS', getPointsWord());
1223 setConfigEntry('secret_key', '');
1225 // Read key from secret file
1226 if ((getFileHash() == '') || (getMasterSalt() == '') || (getPassScramble() == '')) {
1227 // Maybe need setup of secret key!
1228 loadIncludeOnce('inc/gen_sql_patches.php');
1232 if ((getFileHash() != '') && (getMasterSalt() != '') && (getPassScramble() != '')) {
1233 // File hash fas generated so we can also file the secret file... hopefully.
1234 $hashFile = sprintf("%s%s.%s.cache", getPath(), getCachePath(), getFileHash());
1236 // Is the secret key file readable?
1237 if (isFileReadable($hashFile)) {
1239 setConfigEntry('secret_key', readFromFile($hashFile));
1241 // Remove it from database
1242 updateConfiguration('file_hash', '');
1244 // Cannot read secret file!
1245 reportBug(__FILE__, __LINE__, 'Cannot read secret file! Please try to reload.');
1253 // Filter to initialize session
1254 function FILTER_INIT_SESSION ($filterData) {
1255 // Determine and set referral id
1256 determineReferralId();
1262 // Filter for sending "build mail" to admin
1263 function FILTER_SEND_BUILD_MAIL ($filterData) {
1264 // Was one line updated?
1265 if (($filterData['affected'] > 0) || (isDebugBuildMailsEnabled())) {
1266 // Then call the proper function
1267 call_user_func_array('sendGenericBuildMails', $filterData);
1274 // Handles click on referral banner
1275 function FILTER_HANDLE_REFERRER_BANNER_CLICK ($filterData) {
1276 // Check required parameters
1277 if ((isGetRequestElementSet('user')) && (isGetRequestElementSet('banner'))) {
1278 // Update clicks counter...
1279 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_refbanner` SET `clicks`=`clicks`+1 WHERE `id`=%s LIMIT 1",
1280 array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1282 // A line has been updated?
1283 if ((!SQL_HASZEROAFFECTED()) && (isGetRequestElementSet('user'))) {
1284 // Redirect to the user's referral link
1285 redirectToUrl('ref.php?refid=' . bigintval(getRequestElement('user')));
1289 // Return filter data
1293 // Filter for handling viewing of a referral banner
1294 function FILTER_HANDLE_REFERRER_BANNER_VIEW ($filterData) {
1295 // Are all required parameters set
1296 if ((isGetRequestElementSet('user')) && (isGetRequestElementSet('banner'))) {
1297 // For later things... ;-)
1298 $result = SQL_QUERY_ESC("SELECT `url` FROM `{?_MYSQL_PREFIX?}_refbanner` WHERE `id`=%s LIMIT 1",
1299 array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1301 // Is there the banner?
1302 if (SQL_NUMROWS($result) == 1) {
1304 $data = SQL_FETCHARRAY($result);
1307 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_refbanner` SET `counter`=`counter`+1 WHERE `id`=%s LIMIT 1",
1308 array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1310 // Set header and ...
1311 setContentType('image/' . substr($data['url'], -3, 3));
1314 redirectToUrl($data['url'], FALSE);
1317 // @TODO No banner found, output some default banner
1318 logDebugMessage(__FUNCTION__, __LINE__, 'Banner ' . bigintval(getRequestElement('banner')) . ' not found.');
1321 SQL_FREERESULT($result);
1324 // Do nothing for now
1325 redirectToUrl('modules.php?module=index');
1328 // Filter for redirecting on wrong server name (e.g. bad.your-server.tld will be redirected to your-server.tld)
1329 function FILTER_REDIRECT_WRONG_SERVER_NAME ($filterData) {
1333 // Is the configured URL same as SERVER_NAME?
1334 if (extractHostnameFromUrl($url) != detectServerName()) {
1336 logWrongServerNameRedirect();
1338 // Then redirect to configured URL
1339 redirectToRequestUri();
1342 // Return filter data
1346 // Filter for adding hidden session id
1347 function FILTER_ADD_INPUT_HIDDEN_SESSION_ID ($filterData) {
1348 // Is a spider detected?
1349 if ((!isSpider()) && (!isSessionValid()) && ($filterData['__form_method'] == 'get')) {
1350 // No, then add the hidden field
1351 $filterData['__replacer'] .= '<input type="hidden" name="' . session_name() . '" value="' . session_id() . '" />';
1354 // Return filter data
1358 // Filter for purging old SERVER_NAME entries
1359 function FILTER_SERVER_NAME_EXTRA_AUTOPURGE ($filterData) {
1360 // Is purging configured?
1361 if ((isApServerNameEnabled()) && (getApServerNameSince() > 0)) {
1362 // Then start purging
1363 SQL_QUERY('DELETE LOW_PRIORITY FROM
1364 `{?_MYSQL_PREFIX?}_server_name_log`
1366 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`server_name_added`)) >= {?ap_server_name_since?}',
1367 __FILE__, __LINE__);
1369 // Are some entries deleted?
1370 if (SQL_AFFECTEDROWS() > 0) {
1371 // Okay, then send an email to the admin
1372 sendAdminNotification('{--ADMIN_PURGE_USER_SERVER_NAME_LOG_SUBJECT--}', 'admin_purge_user_server_name_log', SQL_AFFECTEDROWS());
1376 // Return filter data
1380 // Filter for detecting menu mode
1381 function FILTER_DETERMINE_MENU_MODE_GENERIC ($filterData) {
1383 switch (getModule()) {
1384 case 'confirm': // Login script is 'member'
1385 $filterData = 'member';
1389 // Return filter data