A lot has been rewritten, ext-teams added, ext-forced continued:
[mailer.git] / inc / wrapper-functions.php
index 79de7cc685243746d32e20e3c09d934255e066b7..cf55c4e282b027f5046bc884212c9988bcbd10e2 100644 (file)
@@ -571,7 +571,7 @@ function isNicknameUsed ($userid) {
 // Getter for 'what' value
 function getWhat () {
        // Default is null
-       $what = null;
+       $what = NULL;
 
        // Is the value set?
        if (isWhatSet(true)) {
@@ -615,7 +615,7 @@ function isWhatSet ($strict =  false) {
 // Getter for 'action' value
 function getAction ($strict = true) {
        // Default is null
-       $action = null;
+       $action = NULL;
 
        // Is the value set?
        if (isActionSet(($strict) && (isHtmlOutputMode()))) {
@@ -650,7 +650,7 @@ function isActionSet ($strict =  false) {
 // Getter for 'module' value
 function getModule ($strict = true) {
        // Default is null
-       $module = null;
+       $module = NULL;
 
        // Is the value set?
        if (isModuleSet($strict)) {
@@ -688,7 +688,7 @@ function getScriptOutputMode () {
        // Do we have cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Default is null
-               $output_mode = null;
+               $output_mode = NULL;
 
                // Is the value set?
                if (isOutputModeSet(true)) {
@@ -741,10 +741,19 @@ function isBlockModeEnabled () {
        return $GLOBALS['block_mode'];
 }
 
-// Wrapper function for addPointsThroughReferalSystem()
+/**
+ * Wrapper function for addPointsThroughReferalSystem(), you should generally
+ * avoid this function and use addPointsThroughReferalSystem() directly and add
+ * your special payment method entry to points_data instead.
+ *
+ * @param      $subject        A string-encoded subject for this add
+ * @param      $userid         The recipient (member) for given points
+ * @param      $points         Points to be added to member's account
+ * @return     $added          Wether the points has been added to the user's account
+ */
 function addPointsDirectly ($subject, $userid, $points) {
        // Reset level here
-       unset($GLOBALS['ref_level']);
+       initReferalSystem();
 
        // Call more complicated method (due to more parameters)
        return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, 'DIRECT');
@@ -940,6 +949,7 @@ function initUserData () {
        } // END - if
 
        // Init the user
+       unset($GLOBALS['is_userdata_valid'][getCurrentUserId()]);
        $GLOBALS['user_data'][getCurrentUserId()] = array();
 }
 
@@ -952,7 +962,7 @@ function getUserData ($column) {
        } // END - if
 
        // Default is empty
-       $data = null;
+       $data = NULL;
 
        if (isset($GLOBALS['user_data'][getCurrentUserId()][$column])) {
                // Return the value
@@ -1000,7 +1010,9 @@ function getUserDataArray () {
 // in, but you should use isMember() if you want to find that out.
 function isUserDataValid () {
        // User id should not be zero so abort here
-       if (!isCurrentUserIdSet()) return false;
+       if (!isCurrentUserIdSet()) {
+               return false;
+       } // END - if
 
        // Is it cached?
        if (!isset($GLOBALS['is_userdata_valid'][getCurrentUserId()])) {
@@ -1052,10 +1064,11 @@ function isDebuggingTemplateCache () {
 
 // Wrapper for fetchUserData() and getUserData() calls
 function getFetchedUserData ($keyColumn, $userid, $valueColumn) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyColumn=' . $keyColumn . ',userid=' . $userid . ',valueColumn=' . $valueColumn . ' - ENTERED!');
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn])) {
-               // Default is 'guest'
-               $data = '{--USERNAME_GUEST--}';
+               // Default is NULL
+               $data = NULL;
 
                // Can we fetch the user data?
                if ((isValidUserId($userid)) && (fetchUserData($userid, $keyColumn))) {
@@ -1068,6 +1081,7 @@ function getFetchedUserData ($keyColumn, $userid, $valueColumn) {
        } // END - if
 
        // Return it
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyColumn=' . $keyColumn . ',userid=' . $userid . ',valueColumn=' . $valueColumn . ',value=' . $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn] . ' - EXIT!');
        return $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn];
 }
 
@@ -1218,6 +1232,22 @@ function getTotalLockedUser () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// "Getter" for total locked user accounts
+function getTotalRandomRefidUser () {
+       // Is it cached?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Then do it
+               if (isExtensionInstalledAndNewer('user', '0.3.4')) {
+                       $GLOBALS[__FUNCTION__] = countSumTotalData('{?user_min_confirmed?}', 'user_data', 'userid', 'rand_confirmed', true, '', '>=');
+               } else {
+                       $GLOBALS[__FUNCTION__] = 0;
+               }
+       } // END - if
+
+       // Return cached value
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Is given userid valid?
 function isValidUserId ($userid) {
        // Do we have cache?
@@ -1243,11 +1273,23 @@ function encodeEntities ($str) {
 }
 
 // "Getter" for date from patch_ctime
-function getDateFromPatchTime () {
+function getDateFromRepository () {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Then set it
-               $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('patch_ctime'), '5');
+               $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('CURRENT_REPOSITORY_DATE'), '5');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for date/time from patch_ctime
+function getDateTimeFromRepository () {
+       // Is it cached?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Then set it
+               $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('CURRENT_REPOSITORY_DATE'), '2');
        } // END - if
 
        // Return cache
@@ -1255,7 +1297,7 @@ function getDateFromPatchTime () {
 }
 
 // Getter for current year (default)
-function getYear ($timestamp = null) {
+function getYear ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -1272,7 +1314,7 @@ function getYear ($timestamp = null) {
 }
 
 // Getter for current month (default)
-function getMonth ($timestamp = null) {
+function getMonth ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // If null is set, use time()
@@ -1290,7 +1332,7 @@ function getMonth ($timestamp = null) {
 }
 
 // Getter for current hour (default)
-function getHour ($timestamp = null) {
+function getHour ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -1307,7 +1349,7 @@ function getHour ($timestamp = null) {
 }
 
 // Getter for current day (default)
-function getDay ($timestamp = null) {
+function getDay ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -1324,7 +1366,7 @@ function getDay ($timestamp = null) {
 }
 
 // Getter for current week (default)
-function getWeek ($timestamp = null) {
+function getWeek ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -1339,7 +1381,7 @@ function getWeek ($timestamp = null) {
 }
 
 // Getter for current short_hour (default)
-function getShortHour ($timestamp = null) {
+function getShortHour ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -1354,7 +1396,7 @@ function getShortHour ($timestamp = null) {
 }
 
 // Getter for current long_hour (default)
-function getLongHour ($timestamp = null) {
+function getLongHour ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -1369,7 +1411,7 @@ function getLongHour ($timestamp = null) {
 }
 
 // Getter for current second (default)
-function getSecond ($timestamp = null) {
+function getSecond ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -1384,7 +1426,7 @@ function getSecond ($timestamp = null) {
 }
 
 // Getter for current minute (default)
-function getMinute ($timestamp = null) {
+function getMinute ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
                // null is time()
@@ -2334,6 +2376,54 @@ function getUrlTlock () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Getter for 'check_double_email'
+function getCheckDoubleEmail () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('check_double_email');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks wether 'check_double_email' is 'Y'
+function isCheckDoubleEmailEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getCheckDoubleEmail() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'display_home_in_index'
+function getDisplayHomeInIndex () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('display_home_in_index');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks wether 'display_home_in_index' is 'Y'
+function isDisplayHomeInIndexEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getDisplayHomeInIndex() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Checks wether proxy configuration is used
 function isProxyUsed () {
        // Do we have cache?
@@ -2453,6 +2543,7 @@ function generateWrappedUserEmailLink ($email) {
 
 // Wrapper to check if user points are locked
 function ifUserPointsLocked ($userid) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
        // Do we have cache?
        if (!isset($GLOBALS[__FUNCTION__][$userid])) {
                // Determine it
@@ -2460,6 +2551,7 @@ function ifUserPointsLocked ($userid) {
        } // END - if
 
        // Return cache
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',locked=' . intval($GLOBALS[__FUNCTION__][$userid]) . ' - EXIT!');
        return $GLOBALS[__FUNCTION__][$userid];
 }
 
@@ -2472,18 +2564,18 @@ function appendLineToFile ($file, $line) {
 }
 
 // Wrapper for changeDataInFile() but with full path added
-function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
+function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $inserted, $seek=0) {
        // Add full path
        $FQFN = getPath() . $FQFN;
 
        // Call inner function
-       return changeDataInFile($FQFN, $comment, $prefix, $suffix, $DATA, $seek);
+       return changeDataInFile($FQFN, $comment, $prefix, $suffix, $inserted, $seek);
 }
 
 // Wrapper for changing entries in config-local.php
-function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $DATA, $seek = 0) {
+function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $inserted, $seek = 0) {
        // Call the inner function
-       return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $DATA, $seek);
+       return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $inserted, $seek);
 }
 
 // Shortens ucfirst(strtolower()) calls
@@ -2497,7 +2589,7 @@ function createConfigurationTimeSelections ($configEntry, $stamps, $align = 'cen
        $configValue = getConfig($configEntry);
 
        // Call inner method
-       return createTimeSelections($configValue, $configEntry, $stamps, $align);
+       return createTimeSelections($configValue, $configEntry, $stamps, $align, true);
 }
 
 // Shortens converting of German comma to Computer's version in POST data
@@ -2521,28 +2613,47 @@ function convertCommaToDotInPostDataArray ($postEntries) {
        } // END - foreach
 }
 
-// Getter for 'check_double_email'
-function getCheckDoubleEmail () {
-       // Is the cache entry set?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // No, so determine it
-               $GLOBALS[__FUNCTION__] = getConfig('check_double_email');
-       } // END - if
+/**
+ * Parses a string into a US formated float variable, taken from user comments
+ * from PHP documentation website.
+ *
+ * @param      $floatString    A string holding a float expression
+ * @return     $float                  Corresponding float variable
+ * @author     chris<at>georgakopoulos<dot>com
+ * @link       http://de.php.net/manual/en/function.floatval.php#92563
+ */
+function parseFloat ($floatString){
+    $LocaleInfo = localeconv();
+    $floatString = str_replace($LocaleInfo['mon_thousands_sep'] , '', $floatString);
+    $floatString = str_replace($LocaleInfo['mon_decimal_point'] , '.', $floatString);
+    return floatval($floatString);
+}
 
-       // Return cached entry
-       return $GLOBALS[__FUNCTION__];
+// Generates a YES/NO option list from given default
+function generateYesNoOptionList ($configValue = '') {
+       // Generate it
+       return generateOptionList('/ARRAY/', array('Y', 'N'), array('{--YES--}', '{--NO--}'), $configValue);
 }
 
-// Checks wether 'check_double_email' is "YES"
-function isCheckDoubleEmailEnabled () {
-       // Is the cache entry set?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // No, so determine it
-               $GLOBALS[__FUNCTION__] = (getCheckDoubleEmail() == 'Y');
+// "Getter" for total available receivers
+function getTotalReceivers ($mode = 'normal') {
+       // Get num rows
+       $numRows = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true, ' AND `receive_mails` > 0' . runFilterChain('exclude_users', $mode));
+
+       // Return value
+       return $numRows;
+}
+
+// Wrapper "getter" to get total unconfirmed mails for given userid
+function getTotalUnconfirmedMails ($userid) {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__][$userid])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__][$userid] = countSumTotalData($userid, 'user_links', 'id', 'userid', true);
        } // END - if
 
-       // Return cached entry
-       return $GLOBALS[__FUNCTION__];
+       // Return cache
+       return $GLOBALS[__FUNCTION__][$userid];
 }
 
 // [EOF]