]> git.mxchange.org Git - mailer.git/blobdiff - inc/filters.php
Rewrites/fixes in extension registration
[mailer.git] / inc / filters.php
index 018e8b6fd4b658b5319f2da337f86fbadc94f01c..4551d1d80c1e95b7c7c32e6178ead81e26f58785 100644 (file)
@@ -18,6 +18,7 @@
  * 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                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -55,7 +56,7 @@ function FILTER_FLUSH_FILTERS () {
        // Is a database link here and not in installation mode?
        if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
                // Abort here
-               addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
+               addFatalMessage(__FUNCTION__, __LINE__, '{--FILTER_FLUSH_FAILED_NO_DATABASE--}');
                return false;
        } // END - if
 
@@ -70,23 +71,23 @@ function FILTER_FLUSH_FILTERS () {
        $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";
+       $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: */ print 'FOUND:'.$filterName.'/'.$filterFunction.'='.$active.'<br />';
+                       //* 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: */ print 'ADD:'.$filterName.'/'.$filterFunction.'<br />';
+                               //* DEBUG: */ debugOutput('ADD:'.$filterName.'/'.$filterFunction);
                                $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
                                $inserted++;
                        } elseif ($active == 'R') {
                                // Remove this filter
-                               //* DEBUG: */ print 'REMOVE:'.$filterName.'/'.$filterFunction.'<br />';
+                               //* DEBUG: */ debugOutput('REMOVE:'.$filterName.'/'.$filterFunction);
                                $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
                                $removed++;
                        }
@@ -106,7 +107,7 @@ function FILTER_FLUSH_FILTERS () {
        } // END - if
 
        // Shall we update usage counters (ONLY FOR DEBUGGING!)
-       if (getConfig('update_filter_usage') == 'Y') {
+       if ((isExtensionInstalledAndNewer('sql_patches', '0.6.0')) && (isConfigEntrySet('update_filter_usage')) && (getConfig('update_filter_usage') == 'Y')) {
                // Update all counters
                foreach ($GLOBALS['cache_array']['filter']['counter'] as $filterName => $filterArray) {
                        // Walk through all filters
@@ -150,7 +151,7 @@ function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
 // Filter for redirecting to logout if sql_patches has been installed
 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
        // Remove this filter
-       unregisterFilter('shutdown', __FUNCTION__);
+       unregisterFilter(__FUNCTION__, __LINE__, 'shutdown', __FUNCTION__);
 
        // Is the element set?
        if (isset($GLOBALS['ext_load_mode'])) {
@@ -165,7 +166,7 @@ function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
 // Filter for auto-activation of a extension
 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
        // Is this extension always activated?
-       if (getExtensionAlwaysActive() == 'Y') {
+       if (isExtensionAlwaysActive()) {
                // Then activate the extension
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name={$data['ext_name']}<br />");
                doActivateExtension($data['ext_name']);
@@ -189,7 +190,7 @@ function FILTER_SOLVE_TASK ($data) {
                adminSolveTask($data['task_id']);
        } else {
                // Not detectable!
-               debug_report_bug(sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($data), print_r($data, true)));
+               debug_report_bug(__FUNCTION__, __LINE__, sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($data), print_r($data, true)));
        }
 
        // Return the data
@@ -201,7 +202,7 @@ function FILTER_LOAD_INCLUDES ($pool) {
        // Is it null?
        if (is_null($pool)) {
                // This should not happen!
-               debug_report_bug('pool is null.');
+               debug_report_bug(__FUNCTION__, __LINE__, 'pool is null.');
        } // END - if
 
        // Is the pool an array and 'pool' set?
@@ -219,7 +220,7 @@ function FILTER_LOAD_INCLUDES ($pool) {
        // Is it an array?
        if ((!isset($data)) || (!is_array($data))) {
                // Then abort here
-               debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
+               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']);
@@ -408,13 +409,13 @@ function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
                                        // Is the config valid?
                                        if (isConfigEntrySet($matches[1][$key])) {
                                                // Set it for caching
-                                               $GLOBALS['compile_config'][$matches[1][$key]] = "\" . getConfig('" . $matches[1][$key] . "') . \"";
+                                               $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]] = "\" . getConfig('" . 'DEFAULT_' . strtoupper($matches[1][$key]) . "') . \"";
+                                               $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]] = "\" . getMessage('". 'DEFAULT_' . strtoupper($matches[1][$key]) . "') . \"";
+                                               $GLOBALS['compile_config'][$matches[1][$key]] = '{%message,DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
                                        } else {
                                                // Unhandled!
                                                $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
@@ -423,7 +424,7 @@ function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
 
                                // Use this for replacing
                                $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
-                               //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die('<pre>'.secureString($code).'</pre>');
+                               //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die(__FUNCTION__.'['.__LINE__.']:<pre>'.secureString($code).'</pre>');
                        } // END - foreach
                } // END - if
 
@@ -434,8 +435,8 @@ function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
        // Should we compile it?
        if ($compiled === true) {
                // Run the code
-               $eval = "\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . "\";";
-               //* DEBUG: */ print('<pre>' . str_replace('$', '&#36;', htmlentities($eval)) . '</pre>');
+               $eval = "\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . '";';
+               //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>' . encodeEntities($eval) . '</pre>');
                eval($eval);
        } // END - if
 
@@ -448,9 +449,9 @@ function FILTER_COMPILE_EXPRESSION_CODE ($code) {
        // 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})*%\}/', $code, $matches);
-       //* DEBUG: */ print('<pre>'.print_r($matches, true).'</pre>');
+       //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.print_r($matches, true).'</pre>');
 
-       // Default is from OUTPUT_HTML
+       // Default is from outputHtml()
        $outputMode = getOutputMode();
 
        // Some entries found?
@@ -458,15 +459,29 @@ function FILTER_COMPILE_EXPRESSION_CODE ($code) {
                // Replace all matches
                foreach ($matches[2] as $key => $cmd) {
                        // Init replacer/call-back variable
-                       $replacer = '';
-                       $callback = '';
+                       $replacer      = '';
+                       $callback      = '';
                        $extraFunction = '';
+                       $value         = '';
 
                        // Extract command and call-back
                        $cmdArray = explode(',', $cmd);
                        $cmd = $cmdArray[0];
-                       if (isset($cmdArray[1])) $callback      = $cmdArray[1];
-                       if (isset($cmdArray[2])) $extraFunction = $cmdArray[2];
+
+                       // 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];
+                       } elseif (isset($matches[4][$key])) {
+                               // Use this as value
+                               $value = $matches[4][$key];
+                       }
 
                        // Construct call-back function name for the command
                        $commandFunction = 'doExpression' . ucfirst(strtolower($cmd));
@@ -475,18 +490,21 @@ function FILTER_COMPILE_EXPRESSION_CODE ($code) {
                        if (function_exists($commandFunction)) {
                                // Prepare $matches, $key, $outputMode, etc.
                                $data = array(
-                                       'matches'  => $matches,
-                                       'key'      => $key,
-                                       'mode'     => $outputMode,
-                                       'code'     => $code,
-                                       'callback' => $callback
+                                       'matches'    => $matches,
+                                       'key'        => $key,
+                                       'mode'       => $outputMode,
+                                       'code'       => $code,
+                                       'callback'   => $callback,
+                                       'extra_func' => $extraFunction,
+                                       'value'      => $value
                                );
 
                                // Call it
+                               //* DEBUG: */ debugOutput(__FUNCTION__ . '[' . __LINE__ . ']: function=' . $commandFunction);
                                $code = call_user_func($commandFunction, $data);
                        } else {
                                // Unsupported command detected
-                               debug_report_bug('Command=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
+                               debug_report_bug(__FUNCTION__, __LINE__, 'Command=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
                        }
                } // END - foreach
        } // END - if
@@ -495,13 +513,13 @@ function FILTER_COMPILE_EXPRESSION_CODE ($code) {
        if ((getOutputMode() != '0') || ($outputMode != '0')) $code = decodeEntities($code);
 
        // Return compiled code
-       //* DEBUG: */ die('<pre>'.htmlentities($code).'</pre>');
+       //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.($code).'</pre>');
        return $code;
 }
 
 // Runs some generic filter update steps
 function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
-       // Create task
+       // 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
@@ -518,7 +536,7 @@ function FILTER_RUN_RESET_INCLUDES () {
        // Is the reset set or old sql_patches?
        if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (getOutputMode() == '0')) {
                // Then abort here
-               debug_report_bug('Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
+               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
@@ -530,27 +548,27 @@ function FILTER_RUN_RESET_INCLUDES () {
        // Is the config entry set?
        if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
                // Create current week mark
-               $currWeek = date('W', time());
+               $currWeek = getWeek();
 
                // Has it changed?
-               if ((getConfig('last_week') != $currWeek) || (getConfig('DEBUG_WEEKLY') == 'Y')) {
+               if ((getConfig('last_week') != $currWeek) || ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') == 'Y'))) {
                        // Include weekly reset scripts
                        mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
 
                        // Update config
-                       if ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') != 'Y')) updateConfiguration('last_week', $currWeek);
+                       if ((!isConfigEntrySet('DEBUG_WEEKLY')) || (getConfig('DEBUG_WEEKLY') != 'Y')) updateConfiguration('last_week', $currWeek);
                } // END - if
 
                // Create current month mark
-               $currMonth = date('m', time());
+               $currMonth = getMonth();
 
                // Has it changed?
-               if ((getConfig('last_month') != $currMonth) || (getConfig('DEBUG_MONTHLY') == 'Y')) {
+               if ((getConfig('last_month') != $currMonth) || ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') == 'Y'))) {
                        // Include monthly reset scripts
                        mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
 
                        // Update config
-                       if ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') != 'Y')) updateConfiguration('last_month', $currMonth);
+                       if ((!isConfigEntrySet('DEBUG_MONTHLY')) || (getConfig('DEBUG_MONTHLY') != 'Y')) updateConfiguration('last_month', $currMonth);
                } // END - if
        } // END - if
 
@@ -584,7 +602,7 @@ function FILTER_HTML_INCLUDE_USERS ($mode) {
 
        // HTML mail?
        if ($mode == 'html') $MORE = " AND `html`='Y'";
-       if ((isExtensionActive('holiday')) && (getExtensionVersion('holiday') >= '0.1.3')) {
+       if (isExtensionInstalledAndNewer('holiday', '0.1.3')) {
                // Add something for the holiday extension
                $MORE .= " AND `holiday_active`='N'";
        } // END - if
@@ -634,7 +652,7 @@ function FILTER_DETERMINE_WHAT_ACTION () {
        }
 
        // Set default 'what' value
-       //* DEBUG: */ outputHtml('-'.getModule().'/'.getWhat()."-<br />");
+       //* DEBUG: */ debugOutput('-' . getModule() . '/' . getWhat() . '-');
        if ((!isWhatSet()) && (!isActionSet()) && (getOutputMode() != 1) && (getOutputMode() != -1)) {
                if (getModule() == 'admin') {
                        // Set 'action' value to 'login' in admin menu
@@ -690,7 +708,7 @@ function FILTER_RUN_DAILY_RESET () {
        if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalled('sql_patches'))) return;
 
        // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
-       if (((date('d', getConfig('last_update')) != date('d', time())) || ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y'))) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestParameterSet('register')) && (getOutputMode() != 1)) {
+       if (((getDay(getConfig('last_update')) != getDay()) || ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y'))) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestParameterSet('register')) && (getOutputMode() != 1)) {
                // Tell every module we are in reset-mode!
                doReset();
        } // END - if
@@ -703,14 +721,6 @@ function FILTER_LOAD_RUNTIME_INCLUDES () {
                // Load the include
                loadIncludeOnce($inc);
        } // END - foreach
-
-       // Load admin include file if he is admin
-       if (isAdmin()) {
-               // Administrative functions
-               loadIncludeOnce('inc/modules/admin/admin-inc.php');
-       } // END - if
-       //* DEBUG: */ addPointsThroughReferalSystem('test', 36, 1000);
-       //* DEBUG: */ die();
 }
 
 // Filter for checking admin ACL
@@ -760,7 +770,7 @@ function FILTER_COUNT_MODULE () {
 // Handles fatal errors
 function FILTER_HANDLE_FATAL_ERRORS () {
        // Do we have errors to handle and right output mode?
-       if ((getTotalFatalErrors() == '0') || (getOutputMode() != 0)) {
+       if ((!ifFatalErrorsDetected()) || (getOutputMode() != '0')) {
                // Abort executing here
                return false;
        } // END - if
@@ -813,11 +823,11 @@ function FILTER_HANDLE_FATAL_ERRORS () {
        }
 
        // Message to regular users (non-admin)
-       $CORR = getMessage('FATAL_REPORT_ERRORS');
+       $CORR = '{--FATAL_REPORT_ERRORS--}';
 
        // PHP warnings fixed
        if ($check == 'done') {
-               if (isAdmin()) $CORR = getMessage('FATAL_CORRECT_ERRORS');
+               if (isAdmin()) $CORR = '{--FATAL_CORRECT_ERRORS--}';
        } // END - if
 
        // Remember all in array
@@ -890,7 +900,7 @@ function FILTER_FETCH_USER_DATA ($userid = 0) {
        // Get user data
        if (!fetchUserData($userid)) {
                // Userid is not valid
-               debug_report_bug('User id '.$userid . ' is invalid.');
+               debug_report_bug(__FUNCTION__, __LINE__, 'User id '.$userid . ' is invalid.');
        } // END - if
 
        // Set member id
@@ -902,7 +912,7 @@ function FILTER_RESET_USER_LOGIN_FAILURE () {
        // Is the user data valid?
        if (!isMember()) {
                // Do only run for logged in members
-               debug_report_bug('Please only run this filter for logged in users.');
+               debug_report_bug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
        } // END - if
 
        // Remmeber login failures if available
@@ -916,11 +926,11 @@ SET
 WHERE
        `userid`=%s
 LIMIT 1",
-                       array(getMemberId()), __FILE__, __LINE__);
+                       array(getMemberId()), __FUNCTION__, __LINE__);
 
                // Store it in session
-               setSession('mxchange_member_failures' , getUserData('login_failures'));
-               setSession('mxchange_member_last_failure', getUserData('last_failure'));
+               setSession('mailer_member_failures' , getUserData('login_failures'));
+               setSession('mailer_member_last_failure', getUserData('last_failure'));
        } // END - if
 }
 
@@ -930,7 +940,7 @@ function FILTER_DO_LOGIN_ADMIN ($data) {
        $GLOBALS['admin_login_success'] = ((
                setSession('admin_md5', encodeHashForCookie($data['pass_hash']))
        ) && (
-               setSession('admin_login', $data['login'])
+               setSession('admin_id', $data['id'])
        ) && (
                setSession('admin_last', time())
        ));
@@ -939,5 +949,52 @@ function FILTER_DO_LOGIN_ADMIN ($data) {
        return $data;
 }
 
+// Filter for loading page header, this should be ran first!
+function FILTER_LOAD_PAGE_HEADER () {
+       // Determine the page title
+       $content['header_title'] = determinePageTitle();
+
+       // Output page header code
+       $GLOBALS['page_header'] = loadTemplate('page_header', true, $content);
+
+       // 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
+}
+
 // [EOF]
 ?>