* $Date:: $ *
* $Tag:: 0.2.1-FINAL $ *
* $Author:: $ *
- * Needs to be in all Files and every File needs "svn propset *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
- * Copyright (c) 2009, 2010 by Mailer Developer Team *
- * For more information visit: http://www.mxchange.org *
+ * Copyright (c) 2009 - 2012 by Mailer Developer Team *
+ * For more information visit: http://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 *
// Is the filter already initialized?
if (isset($GLOBALS['filter_init'])) {
// Then abort here
- debug_report_bug('Filter system already initialized.');
+ reportBug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
} // END - if
// Load all saved filers if sql_patches is updated
} elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
// Init add
$add = '';
- if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) $add = ", `filter_counter`";
+ if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) {
+ $add = ',`filter_counter`';
+ } // END - if
- // Load all active filers
- $result = SQL_QUERY("SELECT
- `filter_name`,`filter_function`,`filter_active`".$add."
+ // Load all filters
+ $result = SQL_QUERY('SELECT
+ `filter_name`,
+ `filter_function`,
+ `filter_active`
+ ' . $add . '
FROM
`{?_MYSQL_PREFIX?}_filters`
ORDER BY
- `filter_id` ASC", __FUNCTION__, __LINE__);
+ `filter_id` ASC', __FUNCTION__, __LINE__);
// Are there entries?
- if (SQL_NUMROWS($result) > 0) {
+ if (!SQL_HASZERONUMS($result)) {
// Load all filters
while ($filterArray = SQL_FETCHARRAY($result)) {
// Get filter name and function
}
// Init filters
- registerFilter('init', 'LOAD_CONFIGURATION');
- registerFilter('init', 'INIT_RANDOMIZER');
- registerFilter('init', 'LOAD_RUNTIME_INCLUDES');
- registerFilter('init', 'INIT_EXTENSIONS');
- registerFilter('init', 'INIT_RANDOM_NUMBER');
- registerFilter('init', 'CHECK_SVN_REVISION');
- registerFilter('init', 'RUN_DAILY_RESET');
- registerFilter('init', 'TRIGGER_SENDING_POOL');
- registerFilter('init', 'DETERMINE_USERNAME');
- registerFilter('init', 'DETERMINE_WHAT_ACTION');
- registerFilter('init', 'COUNT_MODULE');
- registerFilter('init', 'UPDATE_LOGIN_DATA');
- registerFilter('init', 'ACTIVATE_EXCHANGE');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'LOAD_CONFIGURATION');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOMIZER');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'LOAD_RUNTIME_INCLUDES');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_EXTENSIONS');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_SESSION');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'SET_CURRENT_DATE');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOM_NUMBER');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'CHECK_REPOSITORY_REVISION');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_HOURLY_RESET');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_DAILY_RESET');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'TRIGGER_SENDING_POOL');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
+ registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
// Page headers - pre-filter (normally, you want to register here)
- registerFilter('pre_page_header', 'LOAD_PAGE_HEADER');
+ registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
// Page headers - post-filter (normally, you don't want to register here)
- // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
- registerFilter('post_page_header', 'FINISH_PAGE_HEADER');
- // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
+ //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
+ registerFilter(__FUNCTION__, __LINE__, 'post_page_header', 'FINISH_PAGE_HEADER');
+ //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
- // Login failures handler
- registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
+ // 'You are here' navigation - post filter
+ registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
+ registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
// Filters for pre-extension-registration
- registerFilter('pre_extension_installed', 'RUN_SQLS');
+ registerFilter(__FUNCTION__, __LINE__, 'pre_extension_installed', 'RUN_SQLS');
// Filters for post-extension-registration
- registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
- registerFilter('post_extension_installed', 'SOLVE_TASK');
- registerFilter('post_extension_installed', 'LOAD_INCLUDES');
- registerFilter('post_extension_installed', 'REMOVE_UPDATES');
+ registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
+ registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'SOLVE_TASK');
+ registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'LOAD_INCLUDES');
+ registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'REMOVE_UPDATES');
+ registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'EXTENSION_MARK_INSTALLED');
// Solving tasks
- registerFilter('solve_task', 'SOLVE_TASK');
+ registerFilter(__FUNCTION__, __LINE__, 'solve_task', 'SOLVE_TASK');
// Loading includes in general
- registerFilter('load_includes', 'LOAD_INCLUDES');
+ registerFilter(__FUNCTION__, __LINE__, 'load_includes', 'LOAD_INCLUDES');
// Run SQLs
- registerFilter('run_sqls', 'RUN_SQLS');
+ registerFilter(__FUNCTION__, __LINE__, 'run_sqls', 'RUN_SQLS');
// Admin ACL check
- registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
+ registerFilter(__FUNCTION__, __LINE__, 'check_admin_acl', 'CHECK_ADMIN_ACL');
// Register shutdown filters
- registerFilter('shutdown', 'FLUSH_FILTERS');
- registerFilter('shutdown', 'FLUSH_STATS');
- registerFilter('shutdown', 'FLUSH_TEMPLATE_CACHE');
- registerFilter('shutdown', 'FLUSH_OUTPUT');
+ registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_FILTERS');
+ registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_STATS');
+ registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_TEMPLATE_CACHE');
+ registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_OUTPUT');
// Compiling code
- registerFilter('compile_code', 'COMPILE_CONFIG');
- registerFilter('compile_code', 'COMPILE_EXPRESSION_CODE');
+ registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_CONFIG');
+ registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_EXPRESSION_CODE');
// Generic extension update filters
- registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
+ registerFilter(__FUNCTION__, __LINE__, 'extension_update', 'UPDATE_EXTENSION_DATA');
+
+ // Do hourly reset stuff, keep this entry first in this chain:
+ registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
// Do reset stuff, keep this entry first in this chain:
- registerFilter('reset', 'RUN_RESET_INCLUDES');
+ registerFilter(__FUNCTION__, __LINE__, 'reset', 'RUN_RESET_INCLUDES');
// Remove extension
- registerFilter('extension_remove', 'REMOVE_EXTENSION');
+ registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
// Exclude some users
- registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
+ registerFilter(__FUNCTION__, __LINE__, 'exclude_users', 'HTML_INCLUDE_USERS');
// Handling of fatal errors
- registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
+ registerFilter(__FUNCTION__, __LINE__, 'handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
// Page footer filters
- registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
- registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
- registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
+ registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'HANDLE_FATAL_ERRORS');
+ registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_COPYRIGHT');
+ registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_PARSING_TIME');
// Member login check. Always keep FETCH_USER_DATA as first entry!
- registerFilter('member_login_check', 'FETCH_USER_DATA');
+ registerFilter(__FUNCTION__, __LINE__, 'member_login_check', 'FETCH_USER_DATA');
// Admin login
- registerFilter('do_admin_login_done', 'DO_LOGIN_ADMIN');
+ registerFilter(__FUNCTION__, __LINE__, 'do_admin_login_done', 'DO_LOGIN_ADMIN');
+
+ // Admin mail links
+ registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
+
+ // Build mails
+ registerFilter(__FUNCTION__, __LINE__, 'send_build_mail', 'SEND_BUILD_MAIL');
}
// "Registers" a new filter function
-function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
-
+function registerFilter ($F, $L, $filterName, $filterFunction, $silentAbort = true, $force = false, $isDryRun = false) {
// Extend the filter function name
- $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
+ $filterFunction = 'FILTER_' . strtoupper($filterFunction);
+
+ // Debug message with FILTER_ prefix
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - ENTERED!');
// Is that filter already there?
if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
- // Then abort here
- if ($silentAbort === false) {
+ // In installation phase we always want to abort
+ if (($silentAbort === false) || (isInstallationPhase())) {
// Add fatal message
- addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
+ reportBug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered! F=%s,L=%s,force=%d", $filterName, $filterFunction, basename($F), $L, intval($force)));
} // END - if
// Abort here
} // END - if
// Shall we add it?
- if ($dry_run === false) {
+ if ($isDryRun === false) {
// Is the function there?
if (!function_exists($filterFunction)) {
// Then abort here
- addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s.", $filterFunction, $filterName));
+ addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s. F=%s,L=%s,force=%d", $filterFunction, $filterName, basename($F), $L, intval($force)));
return false;
} // END - if
// Simply add it to the array
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L);
$GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
$GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
} // END - if
+
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - EXIT!');
}
// "Unregisters" a filter from the given chain
-function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run));
+function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $isDryRun = false) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
// Extend the filter function name only if not loaded from database
if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
- $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
+ $filterFunction = 'FILTER_' . strtoupper($filterFunction);
} // END - if
// Is that filter there?
} // END - if
// Shall we remove? (default, not while just showing an extension removal)
- if ($dry_run === false) {
+ if ($isDryRun === false) {
// Mark for filter removal
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REMOVE: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
$GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
} // END - if
+
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
}
-// "Runs" the given filters, data is optional and can be any type of data
-function runFilterChain ($filterName, $data = null) {
+// "Runs" the given filters, filterData is optional and can be any type of data
+function runFilterChain ($filterName, $filterData = NULL) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
+
// Is that filter chain there?
if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
// Log not found filters in debug-mode
if (isDebugModeEnabled()) {
// Log it away...
- logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
+ logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' does not exist.');
} // END - if
// Abort here and return content
- return $data;
+ return $filterData;
} // END - if
// Default return value
- $returnValue = $data;
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
+ $returnValue = $filterData;
// Then run all filters
foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
// Debug message
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
- // Is the filter active?
- if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
+ // Is the filter active or newly added??
+ if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown', 'extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
// Is this filter there?
if (!function_exists($filterFunction)) {
- // Unregister it
- unregisterFilter($filterName, $filterFunction);
-
- // Skip this entry
- continue;
+ // Should be fixed
+ reportBug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - AUTO-UNREGISTERED!');
} // END - if
// Call the filter chain
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName.'/'.$filterFunction.',[]='.gettype($returnValue));
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
$returnValue = call_user_func_array($filterFunction, array($returnValue));
// Update usage counter
countFilterUsage($filterName, $filterFunction);
} elseif (isDebugModeEnabled()) {
// Debug message
- logDebugMessage(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
+ logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
}
} // END - foreach
// Return the filtered content
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
return $returnValue;
}
$GLOBALS['cache_array']['filter'] = $filterArray;
}
+/**
+ * Loads filter for given extension if present. This function will silently
+ * ignore absent filter files.
+ *
+ * @param $ext_name Name of extension
+ * @return void
+ */
+function loadExtensionFilters ($ext_name) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
+
+ // Is there a cache entry?
+ if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
+ // Default is not found
+ $GLOBALS[__FUNCTION__][$ext_name] = false;
+
+ // Construct include file name
+ $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
+
+ // Is the include file readable?
+ if (isIncludeReadable($incFileName)) {
+ // Load the include file
+ loadIncludeOnce($incFileName);
+
+ // Mark the file as loaded
+ $GLOBALS[__FUNCTION__][$ext_name] = true;
+ } elseif (isDebugModeEnabled()) {
+ // Log missing file
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
+ }
+ } // END - if
+
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',result=' . intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');
+}
+
// [EOF]
?>
projects / mailer.git / blobdiff