+<?php
+/************************************************************************
+ * Mailer v0.2.1-FINAL Start: 07/12/2011 *
+ * =================== Last change: 07/12/2011 *
+ * *
+ * -------------------------------------------------------------------- *
+ * File : referal-functions.php *
+ * -------------------------------------------------------------------- *
+ * Short description : All referal system functions *
+ * -------------------------------------------------------------------- *
+ * Kurzbeschreibung : Alle zum Referal-System gehoerenden Funktionen *
+ * -------------------------------------------------------------------- *
+ * $Revision:: $ *
+ * $Date:: $ *
+ * $Tag:: 0.2.1-FINAL $ *
+ * $Author:: $ *
+ * -------------------------------------------------------------------- *
+ * 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 *
+ * it under the terms of the GNU General Public License as published by *
+ * the Free Software Foundation; either version 2 of the License, or *
+ * (at your option) any later version. *
+ * *
+ * This program is distributed in the hope that it will be useful, *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
+ * GNU General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU General Public License *
+ * along with this program; if not, write to the Free Software *
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
+ * MA 02110-1301 USA *
+ ************************************************************************/
+
+// Some security stuff...
+if (!defined('__SECURITY')) {
+ die();
+} // END - if
+
+// Initializes the referal system
+function initReferalSystem () {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ' Referal system initialized!');
+ $GLOBALS['ref_level'] = NULL;
+ $GLOBALS['ref_system'] = true;
+}
+
+// Getter fro ref level percents
+function getReferalLevelPercents ($level) {
+ // Default is zero
+ $data['percents'] = '0';
+
+ // Do we have cache?
+ if ((isset($GLOBALS['cache_array']['refdepths']['level'])) && (isExtensionActive('cache'))) {
+ // First look for level
+ $key = array_search($level, $GLOBALS['cache_array']['refdepths']['level']);
+ if ($key !== false) {
+ // Entry found
+ $data['percents'] = $GLOBALS['cache_array']['refdepths']['percents'][$key];
+
+ // Count cache hit
+ incrementStatsEntry('cache_hits');
+ } // END - if
+ } elseif (!isExtensionActive('cache')) {
+ // Get referal data
+ $result_level = SQL_QUERY_ESC("SELECT `percents` FROM `{?_MYSQL_PREFIX?}_refdepths` WHERE `level`=%s LIMIT 1",
+ array(bigintval($level)), __FUNCTION__, __LINE__);
+
+ // Entry found?
+ if (SQL_NUMROWS($result_level) == 1) {
+ // Get percents
+ $data = SQL_FETCHARRAY($result_level);
+ } // END - if
+
+ // Free result
+ SQL_FREERESULT($result_level);
+ }
+
+ // Return percent
+ return $data['percents'];
+}
+
+/**
+ *
+ * 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...
+ * points = ... xxx points
+ * refid = inc/modules/guest/what-confirm.php need this
+ * locked = Shall I pay it to normal (false) or locked (true) points ammount?
+ */
+function addPointsThroughReferalSystem ($subject, $userid, $points, $refid = '0') {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',points=' . $points . ',refid=' . $refid . ' - ENTERED!');
+ // By default nothing has been added
+ $added = false;
+
+ // Determine payment method and notification
+ $paymentMethod = strtoupper(getPaymentMethodFromSubject($subject));
+ $sendNotify = isPaymentRecipientNotificationEnabled($subject);
+
+ // When $userid = '0' add points to jackpot
+ if (($userid == '0') && ($paymentMethod == 'DIRECT') && (isExtensionActive('jackpot'))) {
+ // Add points to jackpot only in DIRECT mode
+ return addPointsToJackpot($points);
+ } // END - if
+
+ // Check user account
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',points=' . $points);
+ if (fetchUserData($userid)) {
+ // Determine wether the user has some mails to click before he/she gets the points
+ $locked = ifUserPointsLocked($userid);
+
+ // 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: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.$userid.',points='.$points.',depth='.$GLOBALS['ref_level'].',per='.$per.',mode='.$paymentMethod);
+
+ // Some percents found?
+ if ($per > 0) {
+ // Calculate new points
+ $ref_points = $points * $per / 100;
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.$userid.',points='.$points.',per='.$per.',depth='.$GLOBALS['ref_level'].',ref_points='.$ref_points);
+
+ // Pay refback here if level > 0 and in ref-mode
+ if ((isExtensionActive('refback')) && ($GLOBALS['ref_level'] > 0) && ($per < 100) && ($paymentMethod == 'REFERAL') && (isset($GLOBALS['cache_array']['add_userid'][$userid]))) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '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: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.$userid.',data='.$GLOBALS['cache_array']['add_userid'][$userid].',ref_points='.$ref_points.',depth='.$GLOBALS['ref_level'].' - AFTER!');
+ } // END - if
+
+ // Update points...
+ if (is_null($GLOBALS['ref_level'])) {
+ // Level NULL (self)
+ SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_points` SET `%s`=`%s`+%s WHERE `userid`=%s AND `ref_depth` IS NULL LIMIT 1",
+ array(
+ $pointsColumn,
+ $pointsColumn,
+ $ref_points,
+ bigintval($userid)
+ ), __FUNCTION__, __LINE__);
+ } else {
+ // Level 1+
+ SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_points` SET `%s`=`%s`+%s WHERE `userid`=%s AND `ref_depth`=%s LIMIT 1",
+ array(
+ $pointsColumn,
+ $pointsColumn,
+ $ref_points,
+ bigintval($userid),
+ bigintval($GLOBALS['ref_level'])
+ ), __FUNCTION__, __LINE__);
+ }
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'pointsColumn='.$pointsColumn.',ref_points='.$ref_points.',userid='.$userid.',depth='.$GLOBALS['ref_level'].',mode='.$paymentMethod.' - 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(
+ $pointsColumn,
+ bigintval($userid),
+ makeZeroToNull($GLOBALS['ref_level']),
+ $ref_points
+ ), __FUNCTION__, __LINE__);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'data='.$pointsColumn.',ref_points='.$ref_points.',userid='.$userid.',depth='.$GLOBALS['ref_level'].',mode='.$paymentMethod.' - INSERTED! ('.SQL_AFFECTEDROWS().')');
+ } // END - if
+
+ // Check affected rows
+ $added = SQL_AFFECTEDROWS();
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'added='.intval($added));
+
+ // Prepare data for the filter
+ $filterData = array(
+ 'subject' => $subject,
+ 'userid' => $userid,
+ 'points' => $points,
+ 'ref_points' => $ref_points,
+ 'column' => $pointsColumn,
+ 'notify' => $sendNotify,
+ 'refid' => $refid,
+ 'locked' => $locked,
+ 'mode' => 'add',
+ 'add_mode' => $paymentMethod,
+ 'added' => $added
+ );
+
+ // Filter it now
+ $filterData = runFilterChain('post_add_points', $filterData);
+
+ // Extract $added
+ $added = $filterData['added'];
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'added='.intval($added));
+
+ // Points updated, maybe I shall send him an email?
+ if (($sendNotify === true) && (isValidUserId(getUserData('refid'))) && ($locked === false)) {
+ // Prepare content
+ $content = array(
+ 'percents' => $per,
+ 'level' => bigintval($GLOBALS['ref_level']),
+ 'points' => $ref_points,
+ );
+
+ // Load email template
+ $message = loadEmailTemplate('guest_user_confirmed_referal', $content, bigintval($userid));
+
+ // Send email
+ sendEmail($userid, '{--THANX_REFERAL_ONE_SUBJECT--}', $message);
+ } elseif (($sendNotify === true) && (!isValidUserId(getUserData('refid'))) && ($locked === false) && ($paymentMethod == 'DIRECT')) {
+ // Prepare content
+ $content = array(
+ 'reason' => '{--REASON_DIRECT_PAYMENT--}',
+ 'subject' => $subject,
+ 'points' => $ref_points
+ );
+
+ // Load message
+ $message = loadEmailTemplate('member_add_points', $content, $userid);
+
+ // And sent it away
+ sendEmail($userid, '{--DIRECT_PAYMENT_SUBJECT--}', $message);
+ if (!isGetRequestParameterSet('mid')) {
+ // Output message to admin
+ displayMessage('{--ADMIN_POINTS_ADDED--}');
+ } // END - if
+ }
+
+ // Increase referal level
+ $GLOBALS['ref_level']++;
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ' Referal level increased, ref_level=' . $GLOBALS['ref_level']);
+
+ // Maybe there's another ref?
+ if ((isValidUserId(getUserData('refid'))) && ($points > 0) && (getUserData('refid') != $userid) && ($paymentMethod == 'REFERAL')) {
+ // Then let's credit him here...
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',refid=' . getUserData('refid') . ',points=' . $points . ',ref_points=' . $ref_points . ' - ADVANCE!');
+ $added = ($added && addPointsThroughReferalSystem(sprintf("%s_ref:%s", $subject, $GLOBALS['ref_level']), getUserData('refid'), $points, getUserData('refid')));
+ } // END - if
+ } // END - if
+ } // END - if
+
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',points=' . $points . ',sendNotify=' . intval($sendNotify) . ',refid=' . $refid . ',paymentMethod=' . $paymentMethod . ' - EXIT!');
+ return $added;
+}
+
+// Updates the referal counter
+function updateReferalCounter ($userid) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
+ // Init referal id
+ $ref = NULL;
+
+ // Check for his referal
+ if (fetchUserData($userid)) {
+ // Get it
+ $ref = getUserData('refid');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . makeZeroToNull($ref) . ' - FETCHED!');
+ } // END - if
+
+ // Init entries
+ if (empty($GLOBALS['cache_array']['ref_level'][$userid])) {
+ $GLOBALS['cache_array']['ref_level'][$userid] = NULL;
+ } // END - if
+ if (empty($GLOBALS['cache_array']['ref_level'][$ref])) {
+ $GLOBALS['cache_array']['ref_level'][$ref] = NULL;
+ } // END - if
+
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . makeZeroToNull($ref));
+
+ // When he has a referal...
+ if (($ref > 0) && ($ref != $userid)) {
+ // Move to next referal level and count his counter one up
+ $GLOBALS['cache_array']['ref_level'][$ref] = $GLOBALS['cache_array']['ref_level'][$userid] + 1;
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref(' . $ref . ')=' . $GLOBALS['cache_array']['ref_level'][$ref] . ' - ADVANCED!');
+
+ // Update counter
+ SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_refsystem` SET `counter`=`counter`+1 WHERE `userid`=%s AND `level`=%s LIMIT 1",
+ array(
+ bigintval($ref),
+ bigintval($GLOBALS['cache_array']['ref_level'][$ref])
+ ), __FUNCTION__, __LINE__);
+
+ // When no entry was updated then we have to create it here
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ref=' . $ref . ',level=' . $GLOBALS['cache_array']['ref_level'][$ref] . ',updated=' . SQL_AFFECTEDROWS());
+ if (SQL_HASZEROAFFECTED()) {
+ // First count!
+ SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_refsystem` (`userid`, `level`, `counter`) VALUES (%s,%s,1)",
+ array(
+ bigintval($ref),
+ makeZeroToNull($GLOBALS['cache_array']['ref_level'][$ref])
+ ), __FUNCTION__, __LINE__);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ref=' . $ref . ',level=' . $GLOBALS['cache_array']['ref_level'][$ref] . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS());
+ } // END - if
+
+ // Advance to next level
+ updateReferalCounter($ref);
+ } elseif ((($ref == $userid) || ($ref == '0')) && (isExtensionInstalledAndNewer('cache', '0.1.2'))) {
+ // Remove cache here
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ref=' . makeZeroToNull($ref) . ' - CACHE!');
+ rebuildCache('refsystem', 'refsystem');
+ }
+
+ // Handle refback here if extension is installed
+ // @TODO Rewrite this to a filter
+ if (isExtensionActive('refback')) {
+ updateRefbackTable($userid);
+ } // END - if
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . makeZeroToNull($ref) . ',level=' . makeZeroToNull($GLOBALS['cache_array']['ref_level'][$ref]) . ' - EXIT!');
+}
+
+// Subtract points from database and mediadata cache
+function subtractPoints ($subject, $userid, $points) {
+ // Add points to used points
+ SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `used_points`=`used_points`+%s WHERE `userid`=%s LIMIT 1",
+ array(
+ $points,
+ bigintval($userid)
+ ), __FUNCTION__, __LINE__);
+
+ // Prepare filter data
+ $filterData = array(
+ 'subject' => $subject,
+ 'userid' => $userid,
+ 'points' => $points,
+ 'mode' => 'sub',
+ 'added' => (!SQL_HASZEROAFFECTED())
+ );
+
+ // Insert booking record
+ $filterData = runFilterChain('post_sub_points', $filterData);
+
+ // Return result
+ return $filterData['added'];
+}
+// "Getter" for array for user refs and points in given level
+function getUserReferalPoints ($userid, $level) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ' - ENTERED!');
+ // Default is no refs and no nickname
+ $refs = array();
+
+ // Get refs from database
+ $result = SQL_QUERY_ESC("SELECT
+ ur.`id`, ur.`refid`, ud.`status`, ud.`last_online`, ud.`mails_confirmed`, ud.`emails_received`
+FROM
+ `{?_MYSQL_PREFIX?}_user_refs` AS ur
+LEFT JOIN
+ `{?_MYSQL_PREFIX?}_user_points` AS up
+ON
+ ur.refid=up.userid AND
+ (ur.level=0 OR ur.level IS NULL)
+LEFT JOIN
+ `{?_MYSQL_PREFIX?}_user_data` AS ud
+ON
+ ur.`refid`=ud.`userid`
+WHERE
+ ur.`userid`=%s AND
+ ur.`level`=%s
+ORDER BY
+ ur.`refid` ASC",
+ array(
+ bigintval($userid),
+ bigintval($level)
+ ), __FUNCTION__, __LINE__);
+
+ // Are there some entries?
+ if (!SQL_HASZERONUMS($result)) {
+ // Fetch all entries
+ while ($row = SQL_FETCHARRAY($result)) {
+ // Get total points of this user
+ $row['points'] = getTotalPoints($row['refid']);
+
+ // Get unconfirmed mails
+ $row['unconfirmed'] = countSumTotalData($row['refid'], 'user_links', 'id', 'userid', true);
+
+ // Init click rate with zero
+ $row['click_rate'] = '0';
+
+ // Is at least one mail received?
+ if ($row['emails_received'] > 0) {
+ // Calculate click rate
+ $row['click_rate'] = ($row['mails_confirmed'] / $row['emails_received'] * 100);
+ } // END - if
+
+ // Activity is 'active' by default because if autopurge is not installed
+ $row['activity'] = '{--MEMBER_ACTIVITY_ACTIVE--}';
+
+ // Is autopurge installed and the user inactive?
+ if ((isExtensionActive('autopurge')) && ((time() - getApInactiveSince()) >= $row['last_online'])) {
+ // Inactive user!
+ $row['activity'] = '{--MEMBER_ACTIVITY_INACTIVE--}';
+ } // END - if
+
+ // Remove some entries
+ unset($row['mails_confirmed']);
+ unset($row['emails_received']);
+ unset($row['last_online']);
+
+ // Add row
+ $refs[$row['id']] = $row;
+ } // END - while
+ } // END - if
+
+ // Free result
+ SQL_FREERESULT($result);
+
+ // Return result
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ' - EXIT!');
+ return $refs;
+}
+
+// Get points data for given subject
+function getPointsDataArrayFromSubject ($subject) {
+ // Extension sql_patches must be up-to-date
+ if (isExtensionInstalledAndOlder('sql_patches', '0.8.2')) {
+ // Please update ext-sql_patches
+ debug_report_bug(__FUNCTION__, __LINE__, 'sql_patches is out-dated. Please update to at least 0.8.2 to continue. subject=' . $subject);
+ } // END - if
+
+ // Remove any double-dot from it
+ $subjectArray = explode(':', $subject);
+ $subject = $subjectArray[0];
+ unset($subjectArray);
+
+ // If we have cache, shortcut it here
+ if (isset($GLOBALS['cache_array']['points_data'][$subject])) {
+ // Return it
+ return $GLOBALS['cache_array']['points_data'][$subject];
+ } // END - if
+
+ // Now checkout the entry in database table
+ $result = SQL_QUERY_ESC("SELECT `id`, `subject`, `column_name`, `locked_mode`, `payment_method`, `notify_recipient` FROM `{?_MYSQL_PREFIX?}_points_data` WHERE `subject`='%s' LIMIT 1",
+ array($subject), __FUNCTION__, __LINE__);
+
+ // Do we have an entry?
+ if (SQL_NUMROWS($result) == 1) {
+ // Then load it
+ $pointsData = SQL_FETCHARRAY($result);
+
+ // Add all entries to our cache array
+ foreach ($pointsData as $key=>$value) {
+ $GLOBALS['cache_array']['points_data'][$subject][$key] = $value;
+ } // END - foreach
+ } else {
+ // Register this automatically
+ SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_points_data` (`subject`, `column_name`, `locked_mode`, `payment_method`, `notify_recipient`) VALUES ('%s','points','LOCKED','REFERAL','N')",
+ array($subject), __FUNCTION__, __LINE__);
+
+ // Re-request it
+ return getPointsDataArrayFromSubject($subject);
+ }
+
+ // Free result
+ SQL_FREERESULT($result);
+
+ // Return it
+ return $GLOBALS['cache_array']['points_data'][$subject];
+}
+
+// Determines the right points column name for given subject and 'locked'
+function getPointsColumnNameFromSubjectLocked ($subject, $isLocked) {
+ // Get the points_data entry
+ $pointsData = getPointsDataArrayFromSubject($subject);
+
+ // Regular points by default
+ $columnName = $pointsData['column_name'];
+
+ // Are the points locked?
+ if (($isLocked === true) && ($pointsData['locked_mode'] == 'LOCKED')) {
+ // Locked points, so prefix it
+ $columnName = 'locked_' . $pointsData['column_name'];
+ } // END - if
+
+ // Return the result
+ return $columnName;
+}
+
+// Determines the payment method for given extension and 'locked'
+function getPaymentMethodFromSubject ($subject) {
+ // Get the points_data entry
+ $pointsData = getPointsDataArrayFromSubject($subject);
+
+ // Regular points by default
+ $paymentMethod = $pointsData['payment_method'];
+
+ // Return the result
+ return $paymentMethod;
+}
+
+// Checks wether notification of points recipient is enabled
+function isPaymentRecipientNotificationEnabled ($subject) {
+ // Get the points_data entry
+ $pointsData = getPointsDataArrayFromSubject($subject);
+
+ // Is it enabled?
+ $isEnabled = ($pointsData['notify_recipient'] == 'Y');
+
+ // Return the result
+ return $isEnabled;
+}
+
+// [EOF]
+?>