]> git.mxchange.org Git - mailer.git/blobdiff - inc/libs/bonus_functions.php
Updated copyright notice as there are changes in this year
[mailer.git] / inc / libs / bonus_functions.php
index fe9d30de02272a2a14ea232f3875f5d08478cc20..bb118906a0236de3714c53e885b94cc2404a512f 100644 (file)
@@ -16,8 +16,8 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2009 - 2013 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 *
@@ -41,25 +41,28 @@ if (!defined('__SECURITY')) {
 } // END - if
 
 // This function must be run *BEFORE* a link is removed from table 'mailer_user_links' !
-function addTurboBonus ($mid, $userid, $type) {
+function addTurboBonus ($id, $userid, $type) {
        // Shall we add bonus points?
        if (!isBonusRallyeActive()) {
-               return false;
+               return FALSE;
        } // END - if
 
        // Init variables
-       $sql = ''; $bonus = '0'; $mail = '0'; $column = '';
+       $sql     = '';
+       $bonusId = 'NULL';
+       $mailId  = 'NULL';
+       $column  = '';
 
        // Select SQL command
        switch ($type) {
                case 'bonusid':
                        $column = 'bonus_id';
-                       $bonus = $mid;
+                       $bonusId = $id;
                        break;
 
                case 'mailid' :
                        $column = 'mail_id';
-                       $mail = $mid;
+                       $mailId = $id;
                        break;
 
                default:
@@ -70,19 +73,19 @@ function addTurboBonus ($mid, $userid, $type) {
        // Is a column name set?
        if (empty($column)) {
                // No, then abort here
-               return false;
+               return FALSE;
        } // END - if
 
        // Check for entry
-       $rank = countSumTotalData($mid, 'bonus_turbo', 'id', $column, true) + 1;
+       $rank = countSumTotalData($id, 'bonus_turbo', 'id', $column, TRUE) + 1;
 
        // Which rank?
        if ($rank == 1) {
                // First rank!
-               $points = getConfig('turbo_bonus');
+               $points = getTurboBonus();
        } else {
                // Anything else so let's explode all entered rank points
-               $test = explode(';', getConfig('turbo_rates'));
+               $test = explode(';', getTurboRates());
                if (!empty($test[$rank - 2])) {
                        // Level found
                        $points = $test[$rank - 2];
@@ -95,35 +98,38 @@ function addTurboBonus ($mid, $userid, $type) {
        // Add points to his account directly
        SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `turbo_bonus`=`turbo_bonus`+%s WHERE `userid`=%s LIMIT 1",
                array(
-                       bigintval($userid),
-                       $points
+                       $points,
+                       bigintval($userid)
                ), __FUNCTION__, __LINE__);
 
        // Rember this whole data for displaying ranking list
        SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_bonus_turbo` (`userid`, `mail_id`, `bonus_id`, `level`, `points`, `timemark`) VALUES (%s, %s, %s, %s, %s, UNIX_TIMESTAMP())",
                array(
                        bigintval($userid),
-                       bigintval($mail),
-                       bigintval($bonus),
+                       $mailId,
+                       $bonusId,
                        $rank,
                        $points
                ), __FUNCTION__, __LINE__);
 
+       // @TODO Rewrite this to a filter
        if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getBonusMode() != 'ADD') && ($points > 0)) {
-               handleBonusPoints($points);
+               handleBonusPoints($points, $userid);
        } // END - if
 }
 
 //
 function addBonusRanks ($data, $type, $userid) {
        // Init variables
-       $self = false; $OUT = ''; $GLOBALS['ranking_content'] = array();
+       $self = FALSE;
+       $OUT = '';
+       $GLOBALS['ranking_content'] = array();
 
        // Clear rankings by default
        $GLOBALS['ranking_content']['rankings'] = '';
 
        // How many ranks do we have?
-       $ranks = count(explode(';', getConfig('turbo_rates'))) + 1;
+       $ranks = count(explode(';', getTurboRates())) + 1;
 
        // Load current user's data
        $result = SQL_QUERY_ESC("SELECT `level`, `points`, `timemark` FROM `{?_MYSQL_PREFIX?}_bonus_turbo` WHERE `%s`=%s AND `userid`=%s LIMIT 1",
@@ -139,13 +145,13 @@ function addBonusRanks ($data, $type, $userid) {
                $GLOBALS['ranking_content'] = merge_array($GLOBALS['ranking_content'], SQL_FETCHARRAY($result));
 
                // Remember all values for later use
-               $self  = true;
+               $self = TRUE;
 
                // Transfer data to template
                $GLOBALS['ranking_content']['timemark'] = generateDateTime($GLOBALS['ranking_content']['timemark'], 1);
 
                // Load template
-               $GLOBALS['ranking_content']['own'] = loadTemplate('show_bonus_yr', true, $GLOBALS['ranking_content']);
+               $GLOBALS['ranking_content']['own'] = loadTemplate('show_bonus_yr', TRUE, $GLOBALS['ranking_content']);
        } // END - if
 
        // Load rankings
@@ -156,7 +162,8 @@ function addBonusRanks ($data, $type, $userid) {
                for ($rank = 1; $rank <= SQL_NUMROWS($result); $rank++) {
                        // Load data
                        $result_users = SQL_QUERY_ESC("SELECT
-       `userid`, `points`
+       `userid`,
+       `points`
 FROM
        `{?_MYSQL_PREFIX?}_bonus_turbo`
 WHERE
@@ -182,10 +189,10 @@ LIMIT 1",
                        $rows['rank'] = $rank;
 
                        // Load row template
-                       $OUT .= loadTemplate('member_bonus_turbo_row', true, $rows);
+                       $OUT .= loadTemplate('member_bonus_turbo_row', TRUE, $rows);
                } // END - for
 
-               if ($self === false) {
+               if ($self === FALSE) {
                        // If current user was not found set constant
                        $GLOBALS['ranking_content']['rankings'] = '{--MEMBER_BONUS_RANK_YOU_ARE_404--}';
                } // END - if
@@ -194,7 +201,7 @@ LIMIT 1",
                // @TODO Move this HTML to a template
                $OUT = '<tr>
   <td colspan="3" align="center" height="30" class="bottom">
-    <div class="notice">{%message,MEMBER_BONUS_NO_RANKS=' . $data . '%}</div>
+    <div class="bad">{%message,MEMBER_BONUS_NO_RANKS=' . $data . '%}</div>
   </td>
 </tr>';
        }
@@ -203,27 +210,32 @@ LIMIT 1",
        return $OUT;
 }
 
-//
-function handleBonusPoints ($mode) {
+// Hanle any bonus points the given user shall become
+function handleBonusPoints ($mode, $userid) {
        // Shall we add bonus points?
-       if (!isBonusRallyeActive()) return;
+       if (!isBonusRallyeActive()) {
+               return;
+       } // END - if
+
+       // Default is not working
+       $return = FALSE;
 
        // Switch to jackpot-mode when no UID is supplied but userid-mode is selected
-       if ((getBonusMode() == 'UID') && (getBonusUserid() == '0') && (isExtensionActive('jackpot'))) {
+       if ((getBonusMode() == 'UID') && (!isValidId($userid)) && (isExtensionActive('jackpot'))) {
                // Update database & config
                updateConfiguration('bonus_mode', 'JACKPOT');
        } // END - if
 
        if ($mode == 'login_bonus') {
                // Login bonus detected
-               $points = getConfig('login_bonus');
+               $points = getLoginBonus();
        } else {
                // Direct points supplied
                $points = $mode;
        }
 
        // Check his amount first
-       $total = getTotalPoints(getBonusUserid());
+       $total = getTotalPoints($userid);
 
        // Subtract points from...
        switch (getBonusMode()) {
@@ -232,10 +244,10 @@ function handleBonusPoints ($mode) {
                        break;
 
                case 'JACKPOT': // ... jackpot
-                       if ((isExtensionActive('jackpot')) && (subtractPointsFromJackpot($points) == -1) && (isValidUserId(getBonusUserid()))) {
+                       if ((isExtensionActive('jackpot')) && (subtractPointsFromJackpot($points) === FALSE) && (isValidId($userid))) {
                                if ($total >= $points) {
                                        // Subtract points from userid's account
-                                       subtractPointsFromJackpot('bonus_payout_jackpot', getBonusUserid(), $points);
+                                       $return = subtractPointsFromJackpot('bonus_payout_jackpot', $userid, $points);
                                } // END - if
                        } // END - if
                        break;
@@ -243,27 +255,30 @@ function handleBonusPoints ($mode) {
                case 'UID': // ... userid's account
                        if ($total >= $points) {
                                // Subtract points from userid's account
-                               subtractPoints('bonus_payout_userid', getBonusUserid(), $points);
+                               $return = subtractPoints('bonus_payout_userid', $userid, $points);
                        } elseif (isExtensionActive('jackpot')) {
                                // Try to subtract from jackpot
-                               $dummy = subtractPointsFromJackpot($points);
+                               $return = subtractPointsFromJackpot($points);
                        }
                        break;
 
                default: // This should not happen
-                       debug_report_bug(__FUNCTION__, __LINE__, 'Invalid bonus-mode ' . getBonusMode() . ' detected.');
+                       reportBug(__FUNCTION__, __LINE__, 'Invalid bonus-mode ' . getBonusMode() . ' detected.');
                        break;
        } // END - switch
+
+       // Return status
+       return $return;
 }
 
 // Purges expired fast-click bonus entries
-function purgeExpiredTurboBonus() {
+function purgeExpiredTurboBonus () {
        // Remove entries
        $result = SQL_QUERY('DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_bonus_turbo` WHERE (UNIX_TIMESTAMP() - `timemark`) >= {?bonus_timeout?}', __FUNCTION__, __LINE__);
 
        if (!SQL_HASZEROAFFECTED()) {
                // Send out email to admin
-               sendAdminNotification('{--ADMIN_AUTOPURGE_TURBO_SUBJECT--}', 'admin_autopurge_turbo', SQL_AFFECTEDROWS());
+               sendAdminNotification('{--ADMIN_AUTOPURGE_TURBO_SUBJECT--}', 'admin_purge_turbo', SQL_AFFECTEDROWS());
        } // END - if
 }
 
@@ -271,24 +286,24 @@ function purgeExpiredTurboBonus() {
 //                             Wrapper Functions
 //-----------------------------------------------------------------------------
 
-// Determines wether the "bonus rallye" is active
+// Determines whether the "bonus rallye" is active
 function isBonusRallyeActive () {
-       // Do we have cache?
+       // Is there cache?
        if (!isset($GLOBALS['bonus_rallye_active'])) {
                // Just determine it
-               $GLOBALS['bonus_rallye_active'] = (getConfig('bonus_active') == 'Y');
+               $GLOBALS['bonus_rallye_active'] = (getBonusActive() == 'Y');
        } // END - if
 
        // Return cache
        return $GLOBALS['bonus_rallye_active'];
 }
 
-// Determines wether the "bonus new_member_notify" is active
+// Determines whether the "bonus new_member_notify" is active
 function isBonusNewMemberNotifyEnabled () {
-       // Do we have cache?
+       // Is there cache?
        if (!isset($GLOBALS['bonus_new_member_notify_active'])) {
                // Just determine it
-               $GLOBALS['bonus_new_member_notify_active'] = (getConfig('bonus_new_member_notify') == 'Y');
+               $GLOBALS['bonus_new_member_notify_active'] = (getBonusNewMemberNotify() == 'Y');
        } // END - if
 
        // Return cache
@@ -297,7 +312,7 @@ function isBonusNewMemberNotifyEnabled () {
 
 // Getter for bonus_timeout
 function getBonusTimeout () {
-       // Do we have cache?
+       // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
                $GLOBALS[__FUNCTION__] = getConfig('bonus_timeout');
@@ -309,7 +324,7 @@ function getBonusTimeout () {
 
 // Getter for bonus_mode
 function getBonusMode () {
-       // Do we have cache?
+       // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
                $GLOBALS[__FUNCTION__] = getConfig('bonus_mode');
@@ -321,7 +336,7 @@ function getBonusMode () {
 
 // Getter for bonus_ranks
 function getBonusRanks () {
-       // Do we have cache?
+       // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
                $GLOBALS[__FUNCTION__] = getConfig('bonus_ranks');
@@ -331,5 +346,317 @@ function getBonusRanks () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Getter for turbo_rates
+function getTurboRates () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('turbo_rates');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for login_timeout
+function getLoginTimeout () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('login_timeout');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for login_bonus
+function getLoginBonus () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('login_bonus');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for turbo_bonus
+function getTurboBonus () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('turbo_bonus');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_ref
+function getBonusRef () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_ref');
+       } // 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 bonus_active
+function getBonusActive () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_active');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_notify_points
+function getBonusNotifyPoints () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_notify_points');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_new_member_notify
+function getBonusNewMemberNotify () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_new_member_notify');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_stats
+function getBonusStats () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_stats');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_order
+function getBonusOrder () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_order');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_lines
+function getBonusLines () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_lines');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_include_own
+function getBonusIncludeOwn () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_include_own');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether bonus_include_own is set to 'Y'
+function isBonusIncludeOwnEnabled () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = (getBonusIncludeOwn() == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_disable_notify
+function getBonusDisableNotify () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_disable_notify');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_enable_notify
+function getBonusEnableNotify () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_enable_notify');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for include_bonus_click
+function getIncludeBonusClick () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('include_bonus_click');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether include_bonus_click is set to 'Y'
+function isIncludeBonusClickEnabled () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = (getIncludeBonusClick() == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for include_bonus_login
+function getIncludeBonusLogin () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('include_bonus_login');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether include_bonus_login is set to 'Y'
+function isIncludeBonusLoginEnabled () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = (getIncludeBonusLogin() == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for include_bonus_order
+function getIncludeBonusOrder () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('include_bonus_order');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether include_bonus_order is set to 'Y'
+function isIncludeBonusOrderEnabled () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = (getIncludeBonusOrder() == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for include_bonus_Ref
+function getIncludeBonusRef () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('include_bonus_ref');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether include_bonus_ref is set to 'Y'
+function isIncludeBonusRefEnabled () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = (getIncludeBonusRef() == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for include_bonus_stats
+function getIncludeBonusStats () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('include_bonus_stats');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether include_bonus_stats is set to 'Y'
+function isIncludeBonusStatsEnabled () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = (getIncludeBonusStats() == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // [EOF]
 ?>