Extension ext-coupon continued, a lot improvements applied:
[mailer.git] / inc / libs / bonus_functions.php
index 08a4d61..bd39484 100644 (file)
  * $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                    *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -42,10 +40,12 @@ if (!defined('__SECURITY')) {
        die();
 } // END - if
 
-// This function must be run *BEFORE* a link is removed from table 'mxchange_user_links' !
+// This function must be run *BEFORE* a link is removed from table 'mailer_user_links' !
 function addTurboBonus ($mid, $userid, $type) {
        // Shall we add bonus points?
-       if (getConfig('bonus_active') != 'Y') return false;
+       if (!isBonusRallyeActive()) {
+               return false;
+       } // END - if
 
        // Init variables
        $sql = ''; $bonus = '0'; $mail = '0'; $column = '';
@@ -65,7 +65,7 @@ function addTurboBonus ($mid, $userid, $type) {
                default:
                        logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid type %s detected.", $type));
                        break;
-       }
+       } // END - switch
 
        // Is a column name set?
        if (empty($column)) {
@@ -87,7 +87,7 @@ function addTurboBonus ($mid, $userid, $type) {
                        // Level found
                        $points = $test[$rank - 2];
                } else {
-                       // Level not found!
+                       // Level not found
                        $points = '0.00000';
                }
        }
@@ -109,7 +109,9 @@ function addTurboBonus ($mid, $userid, $type) {
                        $points
                ), __FUNCTION__, __LINE__);
 
-       if ((getExtensionVersion('bonus') >= '0.3.5') && (getConfig('bonus_mode') != "ADD") && ($points > 0)) handleBonusPoints($points);
+       if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getBonusMode() != 'ADD') && ($points > 0)) {
+               handleBonusPoints($points);
+       } // END - if
 }
 
 //
@@ -128,7 +130,7 @@ function addBonusRanks ($data, $type, $userid) {
                array(
                        $type,
                        $data,
-                       $userid
+                       bigintval($userid)
                ), __FUNCTION__, __LINE__);
 
        // Entry found?
@@ -140,26 +142,18 @@ function addBonusRanks ($data, $type, $userid) {
                $self  = true;
 
                // Transfer data to template
-               $GLOBALS['ranking_content']['yr_level']  = $GLOBALS['ranking_content']['level'];
-               $GLOBALS['ranking_content']['yr_points'] = translateComma($GLOBALS['ranking_content']['points']);
-               $GLOBALS['ranking_content']['yr_tmark']  = generateDateTime($GLOBALS['ranking_content']['timemark'], 1);
+               $GLOBALS['ranking_content']['timemark'] = generateDateTime($GLOBALS['ranking_content']['timemark'], 1);
 
                // Load template
                $GLOBALS['ranking_content']['own'] = loadTemplate('show_bonus_yr', true, $GLOBALS['ranking_content']);
        } // END - if
 
        // Load rankings
-       $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_bonus_turbo` WHERE %s=%s ORDER BY `level` ASC LIMIT {?bonus_lines?}",
+       $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_bonus_turbo` WHERE `%s`=%s ORDER BY `level` ASC LIMIT {?bonus_lines?}",
                array($type, $data), __FUNCTION__, __LINE__);
-       if (SQL_NUMROWS($result) > 0) {
-               // Start generating the ranking list
-               $max = SQL_NUMROWS($result);
-
-               // Init variables
-               $SW = 2;
-
+       if (!SQL_HASZERONUMS($result)) {
                // Output all ranks (levels)
-               for ($rank = 1; $rank <= $max; $rank++) {
+               for ($rank = 1; $rank <= SQL_NUMROWS($result); $rank++) {
                        // Load data
                        $result_users = SQL_QUERY_ESC("SELECT
        `userid`, `points`
@@ -188,9 +182,6 @@ LIMIT 1",
                                        // Is it not empty? Then use it
                                        if (!empty($nick)) $rows['userid'] = $nick;
                                } // END - if
-
-                               // Translate comma
-                               $rows['points'] = translateComma($rows['points']);
                        } // END - if
 
                        // Free result
@@ -198,31 +189,23 @@ LIMIT 1",
 
                        // Add more
                        $rows['rank'] = $rank;
-                       $rows['sw']   = $SW;
 
-                       // Output row
-                       $OUT .= "<tr>
-  <td class=\"bonus_rank_".$rows['rank']." bottom switch_sw".$rows['sw']."\">".$rows['rank'].".</td>
-  <td class=\"bonus_rank_".$rows['rank']." bottom switch_sw".$rows['sw']."\" align=\"center\">".$rows['userid']."</td>
-  <td class=\"bonus_rank_".$rows['rank']." bottom switch_sw".$rows['sw']."\" align=\"center\">".$rows['points']."</td>
-</tr>\n";
-
-                       // Switch color
-                       $SW = 3 - $SW;
+                       // Load row template
+                       $OUT .= loadTemplate('member_bonus_turbo_row', true, $rows);
                } // END - for
 
                if ($self === false) {
                        // If current user was not found set constant
-                       // @TODO Try to find a way for rewriting this constant
-                       $GLOBALS['ranking_content']['rankings'] = getMessage('BONUS_RANK_YOU_ARE_404');
+                       $GLOBALS['ranking_content']['rankings'] = '{--MEMBER_BONUS_RANK_YOU_ARE_404--}';
                } // END - if
        } else {
-               // No entries found!
-               $OUT = "<tr>
-  <td colspan=\"3\" align=\"center\" height=\"30\" class=\"bottom\">
-    <div class=\"guest_failed\">".getMaskedMessage('BONUS_NO_RANKS', $data)."</div>
+               // No entries found
+               // @TODO Move this HTML to a template
+               $OUT = '<tr>
+  <td colspan="3" align="center" height="30" class="bottom">
+    <div class="notice">' . getMaskedMessage('MEMBER_BONUS_NO_RANKS', $data) . '</div>
   </td>
-</tr>\n";
+</tr>';
        }
 
        // Retutn content
@@ -232,10 +215,10 @@ LIMIT 1",
 //
 function handleBonusPoints ($mode) {
        // Shall we add bonus points?
-       if (getConfig('bonus_active') != 'Y') return;
+       if (!isBonusRallyeActive()) return;
 
        // Switch to jackpot-mode when no UID is supplied but userid-mode is selected
-       if ((getConfig('bonus_mode') == 'UID') && (getConfig('bonus_userid') == '0') && (isExtensionActive('jackpot'))) {
+       if ((getBonusMode() == 'UID') && (getBonusUserId() == '0') && (isExtensionActive('jackpot'))) {
                // Update database & config
                updateConfiguration('bonus_mode', 'JACKPOT');
        } // END - if
@@ -249,15 +232,19 @@ function handleBonusPoints ($mode) {
        }
 
        // Check his amount first
-       $total = countSumTotalData(getConfig('bonus_userid'), 'user_points', 'points') - countSumTotalData(getConfig('bonus_userid'), 'user_data', 'used_points');
+       $total = getTotalPoints(getBonusUserId());
 
        // Subtract points from...
-       switch (getConfig('bonus_mode')) {
+       switch (getBonusMode()) {
+               case 'ADD': // Only add them (no subtraction)
+                       // Ignored
+                       break;
+
                case 'JACKPOT': // ... jackpot
-                       if ((isExtensionActive('jackpot')) && (subtractPointsFromJackpot($points) == -1) && (getConfig('bonus_userid') > 0)) {
+                       if ((isExtensionActive('jackpot')) && (subtractPointsFromJackpot($points) == -1) && (isValidUserId(getBonusUserId()))) {
                                if ($total >= $points) {
                                        // Subtract points from userid's account
-                                       subtractPointsFromJackpot('bonus_payout_jackpot', getConfig('bonus_userid'), $points);
+                                       subtractPointsFromJackpot('bonus_payout_jackpot', getBonusUserId(), $points);
                                } // END - if
                        } // END - if
                        break;
@@ -265,67 +252,92 @@ function handleBonusPoints ($mode) {
                case 'UID': // ... userid's account
                        if ($total >= $points) {
                                // Subtract points from userid's account
-                               subtractPoints('bonus_payout_userid', getConfig('bonus_userid'), $points);
+                               subtractPoints('bonus_payout_userid', getBonusUserId(), $points);
                        } elseif (isExtensionActive('jackpot')) {
                                // Try to subtract from jackpot
                                $dummy = subtractPointsFromJackpot($points);
                        }
                        break;
+
+               default: // This should not happen
+                       debug_report_bug(__FUNCTION__, __LINE__, 'Invalid bonus-mode ' . getBonusMode() . ' detected.');
+                       break;
        } // END - switch
 }
 
 // Purges expired fast-click bonus entries
 function purgeExpiredTurboBonus() {
        // Remove entries
-       $result = SQL_QUERY("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_bonus_turbo` WHERE `timemark` < (UNIX_TIMESTAMP() - {?bonus_timeout?})", __FUNCTION__, __LINE__);
+       $result = SQL_QUERY('DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_bonus_turbo` WHERE (UNIX_TIMESTAMP() - `timemark`) >= {?bonus_timeout?}', __FUNCTION__, __LINE__);
 
-       if (SQL_AFFECTEDROWS() > 0) {
+       if (!SQL_HASZEROAFFECTED()) {
                // Send out email to admin
-               sendAdminNotification(getMessage('AUTOPURGE_ADMIN_TURBO_SUBJECT'), 'admin_autopurge_turbo', SQL_AFFECTEDROWS());
+               sendAdminNotification('{--ADMIN_AUTOPURGE_TURBO_SUBJECT--}', 'admin_autopurge_turbo', SQL_AFFECTEDROWS());
        } // END - if
 }
 
-///////////////////////////////////////////////////////////////////////////////
-//                              Only filter functions
-///////////////////////////////////////////////////////////////////////////////
+//-----------------------------------------------------------------------------
+//                             Wrapper Functions
+//-----------------------------------------------------------------------------
 
-// Filter for adding login bonus to the user's account
-function FILTER_ADD_LOGIN_BONUS () {
-       // 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.');
+// Determines wether the "bonus rallye" is active
+function isBonusRallyeActive () {
+       // Do we have cache?
+       if (!isset($GLOBALS['bonus_rallye_active'])) {
+               // Just determine it
+               $GLOBALS['bonus_rallye_active'] = (getConfig('bonus_active') == 'Y');
        } // END - if
 
-       // Bonus is not given by default ;-)
-       $bonus = false;
-       if ((isExtensionInstalledAndNewer('sql_patches', '0.2.8')) && (getConfig('bonus_active') == 'Y') && (getConfig('bonus_login_yn') == 'Y')) {
-               // Update last login if far enougth away
-               // @TODO This query isn't right, it will only update if the user was for a longer time away!
-               SQL_QUERY_ESC("UPDATE
-       `{?_MYSQL_PREFIX?}_user_data`
-SET
-       `last_login`=UNIX_TIMESTAMP()
-WHERE
-       `userid`=%s AND
-       `last_login` < (UNIX_TIMESTAMP() - {?login_timeout?})
-LIMIT 1",
-                       array(
-                               getMemberId()
-                       ), __FILE__, __LINE__
-               );
+       // Return cache
+       return $GLOBALS['bonus_rallye_active'];
+}
 
-               // Updated entry?
-               $bonus = (SQL_AFFECTEDROWS() == 1);
+// Determines wether the "bonus new_member_notify" is active
+function isBonusNewMemberNotifyEnabled () {
+       // Do we have cache?
+       if (!isset($GLOBALS['bonus_new_member_notify_active'])) {
+               // Just determine it
+               $GLOBALS['bonus_new_member_notify_active'] = (getConfig('bonus_new_member_notify') == 'Y');
        } // END - if
 
-       if (($bonus === true) && (getRequestParameter('mode') == 'bonus')) {
-               // Output message with added points
-               $GLOBALS['message'] .= '<div class="tiny">' . getMessage('BONUS_LOGIN_BONUS_ADDED') . '</div>';
-       } elseif (isExtensionActive('bonus')) {
-               // No login bonus added!
-               $GLOBALS['message'] .= '<div class="member_failed">{--BONUS_LOGIN_BONUS_NOT_ADDED--}</div>';
-       }
+       // Return cache
+       return $GLOBALS['bonus_new_member_notify_active'];
+}
+
+// Getter for bonus_timeout
+function getBonusTimeout () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_timeout');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_mode
+function getBonusMode () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_mode');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for bonus_ranks
+function getBonusRanks () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('bonus_ranks');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
 }
 
 // [EOF]