]> git.mxchange.org Git - mailer.git/blobdiff - inc/wrapper-functions.php
Major rewrite of template system:
[mailer.git] / inc / wrapper-functions.php
index ba56fb2c8e3e9d5bab2e12f2020d764694fc292a..36d0bb2fe9f5fc7cf4e56c7fd328b2272c0b1d66 100644 (file)
@@ -326,7 +326,7 @@ function isInstalling () {
        // Determine whether we are installing
        if (!isset($GLOBALS['__mailer_installing'])) {
                // Check URL (css.php/js.php need this)
-               $GLOBALS['__mailer_installing'] = isGetRequestElementSet('installing');
+               $GLOBALS['__mailer_installing'] = (isGetRequestElementSet('installing') || ((isGetRequestElementSet('level')) && (getRequestElement('level') == 'install')));
        } // END - if
 
        // Return result
@@ -343,9 +343,9 @@ function isInstalled () {
                        // First is config
                        (
                                (
-                                       isConfigEntrySet('MXCHANGE_INSTALLED')
+                                       isConfigEntrySet('MAILER_INSTALLED')
                                ) && (
-                                       getConfig('MXCHANGE_INSTALLED') == 'Y'
+                                       getConfig('MAILER_INSTALLED') == 'Y'
                                )
                        )
                ) || (
@@ -443,6 +443,18 @@ function isDebugRegularExpressionEnabled () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Checks whether debugging of build mails is enabled
+function isDebugBuildMailsEnabled () {
+       // Is cache set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Simply check it
+               $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_BUILD_MAILS')) && (getConfig('DEBUG_BUILD_MAILS') == 'Y'));
+       } // END - if
+
+       // Return it
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Checks whether the cache instance is valid
 function isCacheInstanceValid () {
        // Is there cache?
@@ -591,7 +603,7 @@ function setWhatFromConfig ($configEntry) {
 }
 
 // Checks whether what is set and optionally aborts on miss
-function isWhatSet ($strict =  false) {
+function isWhatSet ($strict = FALSE) {
        // Check for it
        $isset = (isset($GLOBALS['__what']) && (!empty($GLOBALS['__what'])));
 
@@ -626,7 +638,7 @@ function setAction ($newAction) {
 }
 
 // Checks whether action is set and optionally aborts on miss
-function isActionSet ($strict =  false) {
+function isActionSet ($strict = FALSE) {
        // Check for it
        $isset = ((isset($GLOBALS['__action'])) && (!empty($GLOBALS['__action'])));
 
@@ -661,8 +673,29 @@ function setModule ($newModule) {
        $GLOBALS['__module'] = strtolower($newModule);
 }
 
+// Wrapper to get extra module names
+function getExtraModule () {
+       // Default is 'NULL'
+       $extra = 'NULL';
+
+       // Is 'tab/step' set?
+       if (isPostRequestElementSet('tab')) {
+               // Use this
+               $extra = 'tab=' . postRequestElement('tab');
+       } elseif (isPostRequestElementSet('step')) {
+               // Use this
+               $extra = 'step=' . postRequestElement('step');
+       } elseif ((isActionSet()) && (isWhatSet())) {
+               // Use 'action/what'
+               $extra = 'action=' . getAction() . ':what=' . getWhat();
+       }
+
+       // Return it
+       return $extra;
+}
+
 // Checks whether module is set and optionally aborts on miss
-function isModuleSet ($strict =  false) {
+function isModuleSet ($strict = FALSE) {
        // Check for it
        $isset = ((isset($GLOBALS['__module'])) && (!empty($GLOBALS['__module'])));
 
@@ -695,13 +728,13 @@ function getScriptOutputMode () {
 }
 
 // Setter for 'output_mode' value
-function setOutputMode ($newOutputMode) {
+function setScriptOutputMode ($newOutputMode) {
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'output_mode=' . $newOutputMode);
        $GLOBALS['__output_mode'] = (int) $newOutputMode;
 }
 
 // Checks whether output_mode is set and optionally aborts on miss
-function isOutputModeSet ($strict =  false) {
+function isOutputModeSet ($strict = FALSE) {
        // Check for it
        $isset = (isset($GLOBALS['__output_mode']));
 
@@ -1067,7 +1100,7 @@ function unsetCurrentUserId () {
 }
 
 // Checks whether we are debugging template cache
-function isDebuggingTemplateCache () {
+function isDebugTemplateCacheEnabled () {
        // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
@@ -1164,7 +1197,7 @@ function sendRawRedirect ($url) {
        $GLOBALS['__output'] = '';
 
        // To make redirects working (no content type), output mode must be raw
-       setOutputMode(-1);
+       setScriptOutputMode(-1);
 
        // Send helping header
        setHttpStatus('302 Found');
@@ -1291,7 +1324,7 @@ function isValidUserId ($userid) {
        // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__][$userid])) {
                // Check it out
-               $GLOBALS[__FUNCTION__][$userid] = ((!is_null($userid)) && (!empty($userid)) && ($userid > 0));
+               $GLOBALS[__FUNCTION__][$userid] = ((!is_null($userid)) && (!empty($userid)) && ($userid != 'NULL') && ($userid > 0));
        } // END - if
 
        // Return cache
@@ -1339,7 +1372,7 @@ function getDateTimeFromRepository () {
 function getYear ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
-               // null is time()
+               // If NULL is set, use time()
                if (is_null($timestamp)) {
                        $timestamp = time();
                } // END - if
@@ -1356,7 +1389,7 @@ function getYear ($timestamp = NULL) {
 function getMonth ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
-               // If null is set, use time()
+               // If NULL is set, use time()
                if (is_null($timestamp)) {
                        // Use time() which is current timestamp
                        $timestamp = time();
@@ -1592,7 +1625,7 @@ function isRandomReferralIdEnabled () {
        // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
-               $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getConfig('select_user_zero_refid') == 'Y'));
+               $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getSelectUserZeroRefid() == 'Y'));
        } // END - if
 
        // Return cache
@@ -1659,6 +1692,18 @@ function getCachePath () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// "Getter" for WRITE_FOOTER
+function getWriteFooter () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('WRITE_FOOTER');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // "Getter" for secret_key
 function getSecretKey () {
        // Is there cache?
@@ -1946,79 +1991,6 @@ function getUserMinConfirmed () {
        // Return cache
        return $GLOBALS[__FUNCTION__];
 }
-
-// "Getter" for auto_purge
-function getAutoPurge () {
-       // Is there cache?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // Determine it
-               $GLOBALS[__FUNCTION__] = getConfig('auto_purge');
-       } // END - if
-
-       // Return cache
-       return $GLOBALS[__FUNCTION__];
-}
-
-// "Getter" for bonus_userid
-function getBonusUserid () {
-       // Is there cache?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // Determine it
-               $GLOBALS[__FUNCTION__] = getConfig('bonus_userid');
-       } // END - if
-
-       // Return cache
-       return $GLOBALS[__FUNCTION__];
-}
-
-// "Getter" for ap_inactive_time
-function getApInactiveTime () {
-       // Is there cache?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // Determine it
-               $GLOBALS[__FUNCTION__] = getConfig('ap_inactive_time');
-       } // END - if
-
-       // Return cache
-       return $GLOBALS[__FUNCTION__];
-}
-
-// "Getter" for ap_dm_timeout
-function getApDmTimeout () {
-       // Is there cache?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // Determine it
-               $GLOBALS[__FUNCTION__] = getConfig('ap_dm_timeout');
-       } // END - if
-
-       // Return cache
-       return $GLOBALS[__FUNCTION__];
-}
-
-// "Getter" for ap_tasks_time
-function getApTasksTime () {
-       // Is there cache?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // Determine it
-               $GLOBALS[__FUNCTION__] = getConfig('ap_tasks_time');
-       } // END - if
-
-       // Return cache
-       return $GLOBALS[__FUNCTION__];
-}
-
-// "Getter" for ap_unconfirmed_time
-function getApUnconfirmedTime () {
-       // Is there cache?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // Determine it
-               $GLOBALS[__FUNCTION__] = getConfig('ap_unconfirmed_time');
-       } // END - if
-
-       // Return cache
-       return $GLOBALS[__FUNCTION__];
-}
-
 // "Getter" for points
 function getPoints () {
        // Is there cache?
@@ -2535,6 +2507,126 @@ function isDisplayHomeInIndexEnabled () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Getter for 'show_points_unconfirmed'
+function getShowPointsUnconfirmed () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('show_points_unconfirmed');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether 'show_points_unconfirmed' is 'Y'
+function isShowPointsUnconfirmedEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getShowPointsUnconfirmed() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'youre_here'
+function getYoureHere () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('youre_here');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether 'show_timings' is 'Y'
+function isYoureHereEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getYoureHere() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'show_timings'
+function getShowTimings () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('show_timings');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether 'show_timings' is 'Y'
+function isShowTimingsEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getShowTimings() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'ap_server_name_since'
+function getApServerNameSince () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('ap_server_name_since');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'ap_server_name'
+function getApServerName () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('ap_server_name');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'index_delay'
+function getIndexDelay () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('index_delay');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether 'ap_server_name' is 'Y'
+function isApServerNameEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getApServerName() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Getter for 'admin_menu_javascript'
 function getAdminMenuJavascript () {
        // Is the cache entry set?
@@ -2559,6 +2651,90 @@ function getPointsRemoveAccount () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Getter for 'css_php'
+function getCssPhp () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('css_php');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'guest_menu'
+function getGuestMenu () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('guest_menu');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks if guest menu is enabled
+function isGuestMenuEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getGuestMenu() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'member_menu'
+function getMemberMenu () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('member_menu');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks if member menu is enabled
+function isMemberMenuEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getMemberMenu() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'word_wrap'
+function getWordWrap () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Construct config entry name
+               $configEntry = getMenuModeFromModule() . '_word_wrap_' . getWhat();
+
+               // Is a special config entry found or ext-sql_patches updated?
+               if (isConfigEntrySet($configEntry)) {
+                       // A special config entry has been found, then use it
+                       $GLOBALS[__FUNCTION__] = getConfig($configEntry);
+               } elseif (isExtensionInstalledAndNewer('other', '0.2.9')) {
+                       // No special config entry found, then use it as "fall-back"
+                       $GLOBALS[__FUNCTION__] = getConfig('word_wrap');
+               } else {
+                       // No, use default (15 characters)
+                       $GLOBALS[__FUNCTION__] = 15;
+               }
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Checks whether proxy configuration is used
 function isProxyUsed () {
        // Is there cache?
@@ -2676,18 +2852,6 @@ function isExtensionTask ($content) {
        return $GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']];
 }
 
-// Getter for 'mt_start'
-function getMtStart () {
-       // Is the cache entry set?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // No, so determine it
-               $GLOBALS[__FUNCTION__] = getConfig('mt_start');
-       } // END - if
-
-       // Return cached entry
-       return $GLOBALS[__FUNCTION__];
-}
-
 // Checks whether ALLOW_TESTER_ACCOUNTS is set
 function ifTesterAccountsAllowed () {
        // Is the cache entry set?
@@ -2890,18 +3054,20 @@ function search_array ($array, $key, $value, $parentIndex = NULL) {
        if (is_array($array)) {
                // Search for whole array
                foreach ($array as $idx => $dummy) {
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',value=' . $value . ',idx=' . $idx);
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',value=' . $value . ',idx=' . $idx . ',parentIndex[' . gettype($parentIndex) . ']=' . $parentIndex);
+                       //* DEBUG: */ print 'idx=' . $idx . ',parentIndex[' . gettype($parentIndex) . ']=' . $parentIndex . ',key=' . $key . ',value=' . $value . ',array=<pre>'.print_r($array, TRUE).'</pre>';
                        // Is dummy an array?
-                       if (is_array($dummy)) {
+                       if ((is_array($dummy)) && ((is_null($parentIndex)) || ($parentIndex === $value))) {
                                // Then search again
                                $subResult = search_array($dummy, $key, $value, $idx);
                                //* DEBUG: */ print 'subResult=<pre>' . print_r($subResult, TRUE).'</pre>';
 
                                // And merge both
                                $results = merge_array($results, $subResult, TRUE);
-                       } elseif ((isset($array[$key])) && ($array[$key] == $value)) {
+                       } elseif (($key == $idx) && (isset($array[$key])) && ($array[$key] === $value)) {
                                // Is found, so add it
                                $results[$parentIndex] = $array;
+                               //* DEBUG: */ print 'ARRAY: key=' . $key . ',idx=' . $idx . ',value=' . $value . ',parentIndex[' . gettype($parentIndex) . ']=' . $parentIndex . ',array=<pre>' . print_r($array, TRUE).'</pre>';
                        }
                } // END - foreach
        } // END - if
@@ -3194,5 +3360,38 @@ function SQL_DEBUG_ENABLED () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Wrapper function to wrap call of wordwrap()
+function wrapWords ($text) {
+       // Wrap words
+       $wrapped = wordwrap($test, getWordWrap());
+
+       // Return it
+       return $wrapped;
+}
+
+// Encodes given data into a JSON object
+function encodeJson ($data) {
+       // Encode it
+       return json_encode($data, JSON_FORCE_OBJECT);
+}
+
+// Get all extension files
+function loadAllExtensionsByTemplate () {
+       // Get all
+       $extensions = getArrayFromDirectory(
+               'templates/' . getLanguage() . '/html/ext/',
+               'ext_',
+               false,
+               false,
+               array(),
+               '.tpl',
+               '@(\.|\.\.)$@',
+               false
+       );
+
+       // Return them
+       return $extensions;
+}
+
 // [EOF]
 ?>