Introduced function determinePointsColumnFromSubjectLocked(), renamed filter:
[mailer.git] / inc / mysql-manager.php
index bf1a9baec9951c6dd7b5528255c0501bcaa1cf7e..58ea2ccaf1690966fa1eaf0c2ddbe9037fad8ed1 100644 (file)
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * 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 *
@@ -205,7 +205,7 @@ ORDER BY
        `sort` ASC",
                array($mode), __FUNCTION__, __LINE__);
 
-       //* DEBUG: */ debugOutput(__LINE__.'/'.$main_cnt.':'.getWhat().'*');
+       //* DEBUG: */ debugOutput(__LINE__ . '/' . $main_cnt . ':' . getWhat() . '*');
        if (!SQL_HASZERONUMS($result_main)) {
                // There are menus available, so we simply display them... :)
                $GLOBALS['rows'] = '';
@@ -259,8 +259,8 @@ ORDER BY
                                                // Navigation link
                                                $OUT .= '<a name="menu" class="menu_blur" href="{%url=modules.php?module=' . getModule() . '&amp;what=' . $content['sub_what'] . '%}" target="_self">';
                                        } else {
-                                               // Not found! - open
-                                               $OUT .= '<em style="cursor:help" class="notice" title="{%message,MENU_WHAT_404=' . $content['sub_what'] . '%}">';
+                                               // Not found - open
+                                               $OUT .= '<em style="cursor:help" class="notice" title="{%message,ADMIN_MENU_WHAT_404=' . $content['sub_what'] . '%}">';
                                        }
 
                                        // Menu title
@@ -274,7 +274,7 @@ ORDER BY
                                                        $OUT .= '</strong>';
                                                } // END - if
                                        } else {
-                                               // Not found! - close
+                                               // Not found - close
                                                $OUT .= '</em>';
                                        }
 
@@ -305,12 +305,12 @@ ORDER BY
                                if (isFileReadable($INC)) {
                                        // Load include file
                                        if ((!isExtensionActive($content['action'])) || ($content['action'] == 'online')) $GLOBALS['rows'] .= loadTemplate('menu_what_begin', true, $mode);
-                                       //* DEBUG: */ debugOutput(__LINE__.'/'.$main_cnt.'/'.$content['action'].'/'.getWhat().'*');
+                                       //* DEBUG: */ debugOutput(__LINE__ . '/' . $main_cnt . '/' . $content['action'] . '/' . getWhat().'*');
                                        loadInclude($INC);
-                                       //* DEBUG: */ debugOutput(__LINE__.'/'.$main_cnt.'/'.$content['action'].'/'.getWhat().'*');
+                                       //* DEBUG: */ debugOutput(__LINE__ . '/' . $main_cnt . '/' . $content['action'] . '/' . getWhat() . '*');
                                        if ((!isExtensionActive($content['action'])) || ($content['action'] == 'online')) $GLOBALS['rows'] .= loadTemplate('menu_what_end', true, $mode);
                                }
-                               //* DEBUG: */ debugOutput(__LINE__.'/'.$main_cnt.'/'.$content['action'].'/'.$content['sub_what'].':'.getWhat().'*');
+                               //* DEBUG: */ debugOutput(__LINE__ . '/' . $main_cnt . '/' . $content['action'] . '/' . $content['sub_what'] . ':' . getWhat() . '*');
                        }
 
                        // Free result
@@ -319,7 +319,7 @@ ORDER BY
                        // Count one up
                        $main_cnt++;
 
-                       //* DEBUG: */ debugOutput(__LINE__.'/'.$main_cnt.':'.getWhat().'*');
+                       //* DEBUG: */ debugOutput(__LINE__ . '/' . $main_cnt . ':' . getWhat() . '*');
                        if (SQL_NUMROWS($result_main) > $main_cnt) {
                                // Add seperator
                                $GLOBALS['rows'] .= loadTemplate('menu_seperator', true, $mode);
@@ -354,7 +354,7 @@ ORDER BY
                );
 
                // Load main template
-               //* DEBUG: */ debugOutput(__LINE__.'/'.$main_cnt.'/'.$content['action'].'/'.$content['sub_what'].':'.getWhat().'*');
+               //* DEBUG: */ debugOutput(__LINE__ . '/' . $main_cnt . '/' . $content['action'] . '/' . $content['sub_what'] . ':' . getWhat() . '*');
                loadTemplate('menu_table', false, $content);
        } // END - if
 }
@@ -366,7 +366,9 @@ function isMember () {
 
        // Fix missing 'last_online' array, damn stupid code :(((
        // @TODO Try to rewrite this to one or more functions
-       if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) $GLOBALS['last_online'] = array();
+       if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) {
+               $GLOBALS['last_online'] = array();
+       } // END - if
 
        // Is the cache entry there?
        if (isset($GLOBALS[__FUNCTION__])) {
@@ -425,19 +427,19 @@ function isMember () {
 }
 
 // Fetch user data for given user id
-function fetchUserData ($userid, $column = 'userid') {
+function fetchUserData ($value, $column = 'userid') {
        // If we should look for userid secure&set it here
        if (substr($column, -2, 2) == 'id') {
                // Secure userid
-               $userid = bigintval($userid);
+               $value = bigintval($value);
 
                // Set it here
-               setCurrentUserId($userid);
+               setCurrentUserId($value);
 
                // Don't look for invalid userids...
-               if (!isValidUserId($userid)) {
+               if (!isValidUserId($value)) {
                        // Invalid, so abort here
-                       debug_report_bug(__FUNCTION__, __LINE__, 'User id ' . $userid . ' is invalid.');
+                       debug_report_bug(__FUNCTION__, __LINE__, 'User id ' . $value . ' is invalid.');
                } elseif (isUserDataValid()) {
                        // Use cache, so it is fine
                        return true;
@@ -452,11 +454,13 @@ function fetchUserData ($userid, $column = 'userid') {
 
        // Extra statements
        $ADD = '';
-       if (isExtensionInstalledAndNewer('user', '0.3.5')) $ADD = ', UNIX_TIMESTAMP(`lock_timestamp`) AS `lock_timestamp`';
+       if (isExtensionInstalledAndNewer('user', '0.3.5')) {
+               $ADD = ', UNIX_TIMESTAMP(`lock_timestamp`) AS `lock_timestamp`';
+       } // END - if
 
        // Query for the user
        $result = SQL_QUERY_ESC("SELECT *".$ADD." FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `%s`='%s' LIMIT 1",
-               array($column, $userid), __FUNCTION__, __LINE__);
+               array($column, $value), __FUNCTION__, __LINE__);
 
        // Do we have a record?
        if (SQL_NUMROWS($result) == 1) {
@@ -465,6 +469,8 @@ function fetchUserData ($userid, $column = 'userid') {
 
                // Set the userid for later use
                setCurrentUserId($data['userid']);
+
+               // And cache the data for this userid
                $GLOBALS['user_data'][getCurrentUserId()] = $data;
 
                // Rewrite 'last_failure' if found and ext-user has version >= 0.3.7
@@ -656,7 +662,7 @@ function isMenuActionValid ($mode, $action, $what, $updateEntry=false) {
        $add = '';
        if ((!isAdmin()) && ($mode != 'admin')) $add = " AND `locked`='N'";
 
-       //* DEBUG: */ debugOutput(__LINE__.':'.$mode.'/'.$action.'/'.$what.'*');
+       //* DEBUG: */ debugOutput(__LINE__ . ':' . $mode . '/' . $action . '/' . $what . '*');
        if (($mode != 'admin') && ($updateEntry === true)) {
                // Update guest or member menu
                $sql = SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_%s_menu` SET counter=counter+1 WHERE `action`='%s' AND `what`='%s'".$add." LIMIT 1",
@@ -809,6 +815,8 @@ function getPaymentTitlePrice ($pid, $full=false) {
        // Load payment data
        $result = SQL_QUERY_ESC("SELECT `mail_title`, `price` FROM `{?_MYSQL_PREFIX?}_payments` WHERE `id`=%s LIMIT 1",
                array(bigintval($pid)), __FUNCTION__, __LINE__);
+
+       // Do we have an entry?
        if (SQL_NUMROWS($result) == 1) {
                // Payment type found... :-)
                $data = SQL_FETCHARRAY($result);
@@ -819,7 +827,7 @@ function getPaymentTitlePrice ($pid, $full=false) {
                } else {
                        $ret = $data['mail_title'] . ' / {%pipe,translateComma=' . $data['price'] . '%} {?POINTS?}';
                }
-       }
+       } // END - if
 
        // Free result
        SQL_FREERESULT($result);
@@ -851,7 +859,7 @@ function getPaymentPoints ($pid, $lookFor = 'price') {
 }
 
 // Remove a receiver's id from $receivers and add a link for him to confirm
-function removeReceiver (&$receivers, $key, $userid, $pool_id, $stats_id = '', $bonus = false) {
+function removeReceiver (&$receivers, $key, $userid, $pool_id, $stats_id = 0, $isBonusMail = false) {
        // Default is not removed
        $ret = 'failed';
 
@@ -862,9 +870,12 @@ function removeReceiver (&$receivers, $key, $userid, $pool_id, $stats_id = '', $
 
                // Is there already a line for this user available?
                if ($stats_id > 0) {
+                       // Default is 'normal' mail
+                       $type = 'NORMAL';
+                       $rowName = 'stats_id';
+
                        // Only when we got a real stats id continue searching for the entry
-                       $type = 'NORMAL'; $rowName = 'stats_id';
-                       if ($bonus) {
+                       if ($isBonusMail === true) {
                                $type = 'BONUS';
                                $rowName = 'bonus_id';
                        } // END - if
@@ -878,6 +889,13 @@ function removeReceiver (&$receivers, $key, $userid, $pool_id, $stats_id = '', $
                                // So we add one!
                                SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_links` (`%s`, `userid`, `link_type`) VALUES ('%s','%s','%s')",
                                        array($rowName, $stats_id, bigintval($userid), $type), __FUNCTION__, __LINE__);
+
+                               // Update 'mails_sent' if sql_patches is updated
+                               if (isExtensionInstalledAndNewer('sql_patches', '0.7.4')) {
+                                       // Update the pool
+                                       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_pool` SET `mails_sent`=`mails_sent`+1 WHERE `id`=%s LIMIT 1",
+                                               array(bigintval($pool_id)), __FUNCTION__, __LINE__);
+                               } // END - if
                                $ret = 'done';
                        } else {
                                // Already found
@@ -951,7 +969,7 @@ function getReferalLevelPercents ($level) {
                // First look for level
                $key = array_search($level, $GLOBALS['cache_array']['refdepths']['level']);
                if ($key !== false) {
-                       // Entry found!
+                       // Entry found
                        $data['percents'] = $GLOBALS['cache_array']['refdepths']['percents'][$key];
 
                        // Count cache hit
@@ -978,7 +996,7 @@ function getReferalLevelPercents ($level) {
 
 /**
  *
- * Dynamic referal system, can also send mails!
+ * Dynamic referal and points system, can also send mails!
  *
  * subject     = Subject line, write in lower-case letters and underscore is allowed
  * userid      = Referal id wich should receive...
@@ -989,19 +1007,18 @@ function getReferalLevelPercents ($level) {
  * add_mode    = Add points only to $userid or also refs? (WARNING! Changing 'ref' to 'direct'
  *               for default value will cause no referal will get points ever!!!)
  */
-function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify = false, $refid = '0', $add_mode = 'ref') {
+function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify = false, $refid = '0', $addMode = 'ref') {
        // By default nothing has been added
        $added = false;
 
        //* DEBUG: */ debugOutput('----------------------- <font color="#00aa00">' . __FUNCTION__ . ' - ENTRY</font> ------------------------<ul><li>');
        // Convert mode to lower-case
-       $add_mode = strtolower($add_mode);
+       $addMode = strtolower($addMode);
 
        // When $userid = '0' add points to jackpot
        if (($userid == '0') && (isExtensionActive('jackpot'))) {
                // Add points to jackpot
-               addPointsToJackpot($points);
-               return;
+               return addPointsToJackpot($points);
        } // END - if
 
        // Count up referal depth
@@ -1021,20 +1038,15 @@ function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify
                // Determine wether the user has some mails to click before he/she gets the points
                $locked = ifUserPointsLocked($userid);
 
-               // Default is 'normal' points
-               $data = 'points';
-
-               // Which points, locked or normal?
-               if ($locked === true) {
-                       $data = 'locked_points';
-               } // END - if
+               // Detect database column
+               $pointsColumn = determinePointsColumnFromSubjectLocked($subject, $locked);
 
                // This is the user and his ref
                $GLOBALS['cache_array']['add_userid'][getUserData('refid')] = $userid;
 
                // Get percents
                $per = getReferalLevelPercents($GLOBALS['ref_level']);
-               //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):userid='.$userid.',points='.$points.',depth='.$GLOBALS['ref_level'].',per='.$per.',mode='.$add_mode);
+               //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):userid='.$userid.',points='.$points.',depth='.$GLOBALS['ref_level'].',per='.$per.',mode='.$addMode);
 
                // Some percents found?
                if ($per > 0) {
@@ -1043,7 +1055,7 @@ function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify
                        $ref_points = $points * $per / 100;
 
                        // Pay refback here if level > 0 and in ref-mode
-                       if ((isExtensionActive('refback')) && ($GLOBALS['ref_level'] > 0) && ($per < 100) && ($add_mode == 'ref') && (isset($GLOBALS['cache_array']['add_userid'][$userid]))) {
+                       if ((isExtensionActive('refback')) && ($GLOBALS['ref_level'] > 0) && ($per < 100) && ($addMode == 'ref') && (isset($GLOBALS['cache_array']['add_userid'][$userid]))) {
                                //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):userid='.$userid.',data='.$GLOBALS['cache_array']['add_userid'][$userid].',ref_points='.$ref_points.',depth='.$GLOBALS['ref_level'].' - BEFORE!');
                                $ref_points = addRefbackPoints($GLOBALS['cache_array']['add_userid'][$userid], $userid, $points, $ref_points);
                                //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):userid='.$userid.',data='.$GLOBALS['cache_array']['add_userid'][$userid].',ref_points='.$ref_points.',depth='.$GLOBALS['ref_level'].' - AFTER!');
@@ -1051,15 +1063,26 @@ function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify
 
                        // Update points...
                        SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_points` SET `%s`=`%s`+%s WHERE `userid`=%s AND `ref_depth`=%s LIMIT 1",
-                               array($data, $data, $ref_points, bigintval($userid), bigintval($GLOBALS['ref_level'])), __FUNCTION__, __LINE__);
-                       //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):data='.$data.',ref_points='.$ref_points.',userid='.$userid.',depth='.$GLOBALS['ref_level'].',mode='.$add_mode.' - UPDATE! ('.SQL_AFFECTEDROWS().')');
+                               array(
+                                       $pointsColumn,
+                                       $pointsColumn,
+                                       $ref_points,
+                                       bigintval($userid),
+                                       bigintval($GLOBALS['ref_level'])
+                               ), __FUNCTION__, __LINE__);
+                       //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):pointsColumn='.$pointsColumn.',ref_points='.$ref_points.',userid='.$userid.',depth='.$GLOBALS['ref_level'].',mode='.$addMode.' - UPDATE! ('.SQL_AFFECTEDROWS().')');
 
                        // No entry updated?
                        if (SQL_HASZEROAFFECTED()) {
                                // First ref in this level! :-)
-                               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_points` (`userid`,`ref_depth`,`%s`) VALUES (%s,%s,%s)",
-                                       array($data, bigintval($userid), bigintval($GLOBALS['ref_level']), $ref_points), __FUNCTION__, __LINE__);
-                               //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):data='.$data.',ref_points='.$ref_points.',userid='.$userid.',depth='.$GLOBALS['ref_level'].',mode='.$add_mode.' - INSERTED! ('.SQL_AFFECTEDROWS().')');
+                               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_points` (`userid`, `ref_depth`, `%s`) VALUES (%s, %s, %s)",
+                                       array(
+                                               $pointsColumn,
+                                               bigintval($userid),
+                                               bigintval($GLOBALS['ref_level']),
+                                               $ref_points
+                                       ), __FUNCTION__, __LINE__);
+                               //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):data='.$pointsColumn.',ref_points='.$ref_points.',userid='.$userid.',depth='.$GLOBALS['ref_level'].',mode='.$addMode.' - INSERTED! ('.SQL_AFFECTEDROWS().')');
                        } // END - if
 
                        // Check affected rows
@@ -1068,19 +1091,21 @@ function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify
 
                        // Prepare data for the filter
                        $filterData = array(
-                               'subject'  => $subject,
-                               'userid'   => $userid,
-                               'points'   => $points,
-                               'notify'   => $sendNotify,
-                               'refid'    => $refid,
-                               'locked'   => $locked,
-                               'mode'     => 'add',
-                               'sub_mode' => $add_mode,
-                               'added'    => $added
+                               'subject'    => $subject,
+                               'userid'     => $userid,
+                               'points'     => $points,
+                               'ref_points' => $ref_points,
+                               'column'     => $pointsColumn,
+                               'notify'     => $sendNotify,
+                               'refid'      => $refid,
+                               'locked'     => $locked,
+                               'mode'       => 'add',
+                               'add_mode'   => $addMode,
+                               'added'      => $added
                        );
 
                        // Filter it now
-                       $filterData = runFilterChain('add_points', $filterData);
+                       $filterData = runFilterChain('post_add_points', $filterData);
 
                        // Extract $added
                        $added = $filterData['added'];
@@ -1100,7 +1125,7 @@ function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify
 
                                // Send email
                                sendEmail($userid, '{--THANX_REFERAL_ONE_SUBJECT--}', $message);
-                       } elseif (($sendNotify === true) && (!isValidUserId(getUserData('refid'))) && ($locked === false) && ($add_mode == 'direct')) {
+                       } elseif (($sendNotify === true) && (!isValidUserId(getUserData('refid'))) && ($locked === false) && ($addMode == 'direct')) {
                                // Prepare content
                                $content = array(
                                        'reason' => '{--REASON_DIRECT_PAYMENT--}',
@@ -1114,12 +1139,12 @@ function addPointsThroughReferalSystem ($subject, $userid, $points, $sendNotify
                                sendEmail($userid, '{--DIRECT_PAYMENT_SUBJECT--}', $message);
                                if (!isGetRequestParameterSet('mid')) {
                                        // Output message to admin
-                                       loadTemplate('admin_settings_saved', false, '{--ADMIN_POINTS_ADDED--}');
+                                       displayMessage('{--ADMIN_POINTS_ADDED--}');
                                } // END - if
                        }
 
                        // Maybe there's another ref?
-                       if ((isValidUserId(getUserData('refid'))) && ($points > 0) && (getUserData('refid') != $userid) && ($add_mode == 'ref')) {
+                       if ((isValidUserId(getUserData('refid'))) && ($points > 0) && (getUserData('refid') != $userid) && ($addMode == 'ref')) {
                                // Then let's credit him here...
                                //* DEBUG: */ debugOutput(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__ . '</font>):userid='.$userid.',ref='.getUserData('refid').',points='.$points.' - ADVANCE!');
                                $added = ($added && addPointsThroughReferalSystem(sprintf("%s_ref:%s", $subject, $GLOBALS['ref_level']), getUserData('refid'), $points, $sendNotify, getUserData('refid')));
@@ -1719,7 +1744,10 @@ function addBonusMailToQueue ($subject, $text, $receiverList, $points, $seconds,
                $HTML = 'N';
 
                // HTML mode?
-               if ($mode == 'html') $HTML = 'Y';
+               if ($mode == 'html') {
+                       // Yes, please
+                       $HTML = 'Y';
+               } // END - if
 
                // Add HTML mail
                SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_bonus`
@@ -1934,7 +1962,7 @@ function reduceRecipientReceivedMails ($column, $id, $count) {
                                array(implode(',', $userids), count($userids)), __FUNCTION__, __LINE__);
                } else {
                        // Nothing deleted
-                       loadTemplate('admin_settings_saved', false, getMaskedMessage('ADMIN_MAIL_NOTHING_DELETED', $id));
+                       displayMessage(getMaskedMessage('ADMIN_MAIL_NOTHING_DELETED', $id));
                }
        } // END - if
 
@@ -1970,5 +1998,32 @@ function updateLastActivity($userid) {
                ), __FUNCTION__, __LINE__);
 }
 
+// Determines database column name from given subject and locked
+function determinePointsColumnFromSubjectLocked ($subject, $locked) {
+       // Default is 'normal' points
+       $pointsColumn = 'points';
+
+       // Which points, locked or normal?
+       if ($locked === true) {
+               $pointsColumn = 'locked_points';
+       } // END - if
+
+       // Prepare array for filter
+       $filterData = array(
+               'subject' => $subject,
+               'locked'  => $locked,
+               'column'  => $pointsColumn
+       );
+
+       // Run the filter
+       $filterData = runFilterChain('determine_points_column_name', $filterData);
+
+       // Extract column name from array
+       $pointsColumn = $filterData['column'];
+
+       // Return it
+       return $pointsColumn;
+}
+
 // [EOF]
 ?>