Extension ext-coupon continued, a lot improvements applied:
[mailer.git] / inc / libs / bonus_functions.php
index dd4959a..bd39484 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 11/10/2004 *
- * ===============                              Last change: 03/18/2005 *
+ * Mailer v0.2.1-FINAL                                Start: 11/10/2004 *
+ * ===================                          Last change: 03/18/2005 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : bonus_functions.php                              *
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Spezielle Funktion fuer bonus-Erweiterung        *
  * -------------------------------------------------------------------- *
- * $Revision:: 856                                                    $ *
- * $Date:: 2009-03-06 20:24:32 +0100 (Fr, 06. Mär 2009)              $ *
+ * $Revision::                                                        $ *
+ * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
- * $Author:: stelzi                                                   $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
+ * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
- * Copyright (c) 2003 - 2008 by Roland Haeder                           *
+ * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * 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 *
 
 // Some security stuff...
 if (!defined('__SECURITY')) {
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
-       require($INC);
-}
+       die();
+} // END - if
 
-// This function must be run *BEFORE* a link is removed from table 'mxchange_user_links' !
-function BONUS_ADD_TURBO_POINTS ($mid, $uid, $type) {
+// 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 = ""; $bonys = 0; $mail = 0; $column = "";
+       $sql = ''; $bonus = '0'; $mail = '0'; $column = '';
 
        // Select SQL command
-       switch ($type)
-       {
-       case "bonusid":
-               $column = "bonus_id";
-               $bonus = $mid;
-               break;
-
-       case "mailid" :
-               $column = "mail_id";
-               $mail = $mid;
-               break;
-
-       default:
-               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Invalid type %s detected.", $type));
-               break;
-       }
+       switch ($type) {
+               case 'bonusid':
+                       $column = 'bonus_id';
+                       $bonus = $mid;
+                       break;
+
+               case 'mailid' :
+                       $column = 'mail_id';
+                       $mail = $mid;
+                       break;
+
+               default:
+                       logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid type %s detected.", $type));
+                       break;
+       } // END - switch
 
        // Is a column name set?
        if (empty($column)) {
@@ -75,17 +74,7 @@ function BONUS_ADD_TURBO_POINTS ($mid, $uid, $type) {
        } // END - if
 
        // Check for entry
-       $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt FROM  `{!_MYSQL_PREFIX!}_bonus_turbo` WHERE userid=%s AND %s=%s LIMIT 1",
-               array($uid, $column, $mid), __FUNCTION__, __LINE__);
-
-       // Load clicks from table as current rank
-       list($rank) = SQL_FETCHROW($result);
-
-       // Add one line
-       $rank++;
-
-       // Free result
-       SQL_FREERESULT($result);
+       $rank = countSumTotalData($mid, 'bonus_turbo', 'id', $column, true) + 1;
 
        // Which rank?
        if ($rank == 1) {
@@ -93,156 +82,263 @@ function BONUS_ADD_TURBO_POINTS ($mid, $uid, $type) {
                $points = getConfig('turbo_bonus');
        } else {
                // Anything else so let's explode all entered rank points
-               $test = explode(";", getConfig('turbo_rates'));
+               $test = explode(';', getConfig('turbo_rates'));
                if (!empty($test[$rank - 2])) {
                        // Level found
                        $points = $test[$rank - 2];
                } else {
-                       // Level not found!
-                       $points = "0.00000";
+                       // Level not found
+                       $points = '0.00000';
                }
        }
 
        // Add points to his account directly
-       SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET turbo_bonus=turbo_bonus+".$points." WHERE userid=%s LIMIT 1",
-               array(bigintval($uid)), __FUNCTION__, __LINE__);
+       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `turbo_bonus`=`turbo_bonus`+%s WHERE `userid`=%s LIMIT 1",
+               array(
+                       bigintval($userid),
+                       $points
+               ), __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($uid), bigintval($mail), bigintval($bonus), $rank, $points), __FUNCTION__, __LINE__);
-
-       if ((GET_EXT_VERSION("bonus") >= "0.3.5") && (getConfig('bonus_mode') != "ADD") && ($points > 0)) BONUS_POINTS_HANDLER($points);
+       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),
+                       $rank,
+                       $points
+               ), __FUNCTION__, __LINE__);
+
+       if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getBonusMode() != 'ADD') && ($points > 0)) {
+               handleBonusPoints($points);
+       } // END - if
 }
+
 //
-function BONUS_MAKE_RANK_ROWS ($data, $type, $uid) {
-       $self = false; $OUT = "";
+function addBonusRanks ($data, $type, $userid) {
+       // Init variables
+       $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(';', getConfig('turbo_rates'))) + 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",
-               array($type, $data, $uid), __FUNCTION__, __LINE__);
+       $result = SQL_QUERY_ESC("SELECT `level`, `points`, `timemark` FROM `{?_MYSQL_PREFIX?}_bonus_turbo` WHERE `%s`=%s AND `userid`=%s LIMIT 1",
+               array(
+                       $type,
+                       $data,
+                       bigintval($userid)
+               ), __FUNCTION__, __LINE__);
+
+       // Entry found?
        if (SQL_NUMROWS($result) == 1) {
                // Load data
-               list($rank, $points, $mark) = SQL_FETCHROW($result);
+               $GLOBALS['ranking_content'] = merge_array($GLOBALS['ranking_content'], SQL_FETCHARRAY($result));
 
                // Remember all values for later use
-               $self  = true; $points = TRANSLATE_COMMA($points);
+               $self  = true;
 
                // Transfer data to template
-               define('__YR_LEVEL' , $rank);
-               define('__YR_POINTS', $points);
-               define('__YR_TMARK' , MAKE_DATETIME($mark, "1"));
+               $GLOBALS['ranking_content']['timemark'] = generateDateTime($GLOBALS['ranking_content']['timemark'], 1);
 
                // Load template
-               define('__YOUR_RANKING_LINE', LOAD_TEMPLATE("show_bonus_yr", true));
+               $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 LIMIT %s",
-               array($type, $data, getConfig('bonus_lines')), __FUNCTION__, __LINE__);
-       if (SQL_NUMROWS($result) > 0) {
-               // Start generating the ranking list
-               $max = SQL_NUMROWS($result);
-
-               $SW = 2;
-               for ($rank = 1; $rank <= $max; $rank++) {
+       $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_HASZERONUMS($result)) {
+               // Output all ranks (levels)
+               for ($rank = 1; $rank <= SQL_NUMROWS($result); $rank++) {
                        // Load data
-                       $result_users = SQL_QUERY_ESC("SELECT userid, points, timemark FROM `{!_MYSQL_PREFIX!}_bonus_turbo` WHERE %s=%s AND level=%s LIMIT 1",
+                       $result_users = SQL_QUERY_ESC("SELECT
+       `userid`, `points`
+FROM
+       `{?_MYSQL_PREFIX?}_bonus_turbo`
+WHERE
+       `%s`=%s AND
+       `level`=%s
+LIMIT 1",
                                array($type, $data, $rank), __FUNCTION__, __LINE__);
 
                        // Nothing found by default
-                       $userid = "---"; $points = "---";
+                       $rows['userid'] = '---';
+                       $rows['points'] = '---';
 
                        // Are you one of them?
                        if (SQL_NUMROWS($result_users) == 1) {
                                // Load data
-                               list($userid, $points, $mark) = SQL_FETCHROW($result_users);
+                               $rows = merge_array($rows, SQL_FETCHARRAY($result_users));
+
+                               // Is ext-nickname active?
+                               if (isExtensionActive('nickname')) {
+                                       // Then get the nickname
+                                       $nick = getNickname($rows['userid']);
 
-                               // Translate comma
-                               $points = TRANSLATE_COMMA($points);
+                                       // Is it not empty? Then use it
+                                       if (!empty($nick)) $rows['userid'] = $nick;
+                               } // END - if
                        } // END - if
 
-                       // Output row
-                       $OUT .= "<tr>
-  <td class=\"bonus_rank_".$rank." bottom2 switch_sw".$SW."\">&nbsp;".$rank.".</td>
-  <td class=\"bonus_rank_".$rank." bottom2 switch_sw".$SW."\" align=\"center\">".$userid."</td>
-  <td class=\"bonus_rank_".$rank." bottom2 switch_sw".$SW."\" align=\"center\">".$points."</td>
-</tr>\n";
-                       $SW = 3 - $SW;
+                       // Free result
+                       SQL_FREERESULT($result_users);
+
+                       // Add more
+                       $rows['rank'] = $rank;
+
+                       // Load row template
+                       $OUT .= loadTemplate('member_bonus_turbo_row', true, $rows);
                } // END - for
 
-               if (!$self) {
+               if ($self === false) {
                        // If current user was not found set constant
-                       define('__YOUR_RANKING_LINE', BONUS_RANK_YOU_ARE_NOT_FOUND);
+                       $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=\"bottom2\">
-    <div class=\"guest_failed\">".BONUS_NO_RANKS_1.$data.BONUS_NO_RANKS_2."</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";
-               define('__YOUR_RANKING_LINE', "");
+</tr>';
        }
+
+       // Retutn content
        return $OUT;
 }
+
 //
-function BONUS_POINTS_HANDLER ($MODE) {
+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_uid') == "0")) {
+       if ((getBonusMode() == 'UID') && (getBonusUserId() == '0') && (isExtensionActive('jackpot'))) {
                // Update database & config
-               UPDATE_CONFIG('bonus_mode', "JACKPOT");
+               updateConfiguration('bonus_mode', 'JACKPOT');
        } // END - if
 
-       if ($MODE == "login_bonus") {
+       if ($mode == 'login_bonus') {
                // Login bonus detected
                $points = getConfig('login_bonus');
        } else {
                // Direct points supplied
-               $points = $MODE;
+               $points = $mode;
        }
 
+       // Check his amount first
+       $total = getTotalPoints(getBonusUserId());
+
        // Subtract points from...
-       switch (getConfig('bonus_mode'))
-       {
-       case "JACKPOT": // ... jackpot
-               if ((SUB_JACKPOT($points) == -1) && (getConfig('bonus_uid') > 0)) {
-                       // Check points amount first...
-                       $TOTAL = GET_TOTAL_DATA(getConfig('bonus_uid'), "user_points", "points") - GET_TOTAL_DATA(getConfig('bonus_uid'), "user_data", "used_points");
-                       if ($TOTAL >= $points) {
-                               // Subtract points from userid's account
-                               SUB_POINTS("bonus_payout_jackpot", getConfig('bonus_uid'), $points);
+       switch (getBonusMode()) {
+               case 'ADD': // Only add them (no subtraction)
+                       // Ignored
+                       break;
+
+               case 'JACKPOT': // ... jackpot
+                       if ((isExtensionActive('jackpot')) && (subtractPointsFromJackpot($points) == -1) && (isValidUserId(getBonusUserId()))) {
+                               if ($total >= $points) {
+                                       // Subtract points from userid's account
+                                       subtractPointsFromJackpot('bonus_payout_jackpot', getBonusUserId(), $points);
+                               } // END - if
                        } // END - if
-               } // END - if
-               break;
-
-       case "UID": // ... userid's account
-               // Check his amount first
-               $TOTAL = GET_TOTAL_DATA(getConfig('bonus_uid'), "user_points", "points") - GET_TOTAL_DATA(getConfig('bonus_uid'), "user_data", "used_points");
-               if ($TOTAL >= $points) {
-                       // Subtract points from userid's account
-                       SUB_POINTS("bonus_payout_uid", getConfig('bonus_uid'), $points);
-               } else {
-                       // Try to subtract from jackpot
-                       $dummy = SUB_JACKPOT($points);
-               }
-               break;
-       }
+                       break;
+
+               case 'UID': // ... userid's account
+                       if ($total >= $points) {
+                               // Subtract points from userid's account
+                               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
 }
 
-//
-function BONUS_PURGE_EXPIRED_TURBO_BONUS() {
+// 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() - ".getConfig('bonus_timeout').")", __FUNCTION__, __LINE__);
-       if (SQL_AFFECTEDROWS() > 0) {
+       $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
-               SEND_ADMIN_NOTIFICATION(AUTOPURGE_ADMIN_TURBO_SUBJECT, "admin_autopurge_turbo", SQL_AFFECTEDROWS(), "");
-       }
+               sendAdminNotification('{--ADMIN_AUTOPURGE_TURBO_SUBJECT--}', 'admin_autopurge_turbo', SQL_AFFECTEDROWS());
+       } // END - if
 }
-//
+
+//-----------------------------------------------------------------------------
+//                             Wrapper Functions
+//-----------------------------------------------------------------------------
+
+// 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
+
+       // Return cache
+       return $GLOBALS['bonus_rallye_active'];
+}
+
+// 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
+
+       // 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]
 ?>