Fixes + asserts
[mailer.git] / inc / referral-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 07/12/2011 *
4  * ===================                          Last change: 07/12/2011 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : referral-functions.php                           *
8  * -------------------------------------------------------------------- *
9  * Short description : All referral system functions                    *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Alle zum Referral-System gehoerenden Funktionen  *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
20  * For more information visit: http://mxchange.org                      *
21  *                                                                      *
22  * This program is free software; you can redistribute it and/or modify *
23  * it under the terms of the GNU General Public License as published by *
24  * the Free Software Foundation; either version 2 of the License, or    *
25  * (at your option) any later version.                                  *
26  *                                                                      *
27  * This program is distributed in the hope that it will be useful,      *
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
30  * GNU General Public License for more details.                         *
31  *                                                                      *
32  * You should have received a copy of the GNU General Public License    *
33  * along with this program; if not, write to the Free Software          *
34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Initializes the referral system
44 function initReferralSystem () {
45         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ' Referral system initialized!');
46         $GLOBALS['ref_level']  = NULL;
47         $GLOBALS['ref_system'] = TRUE;
48 }
49
50 // Getter fro ref level percents
51 function getReferralLevelPercents ($level) {
52         // Default is zero
53         $data['percents'] = '0';
54
55         // Is there cache?
56         if ((isset($GLOBALS['cache_array']['refdepths']['level'])) && (isExtensionActive('cache'))) {
57                 // First look for level
58                 $key = array_search($level, $GLOBALS['cache_array']['refdepths']['level']);
59                 if ($key !== FALSE) {
60                         // Entry found
61                         $data['percents'] = $GLOBALS['cache_array']['refdepths']['percents'][$key];
62
63                         // Count cache hit
64                         incrementStatsEntry('cache_hits');
65                 } // END - if
66         } elseif (!isExtensionActive('cache')) {
67                 // Get referral data
68                 $result_level = sqlQueryEscaped("SELECT `percents` FROM `{?_MYSQL_PREFIX?}_refdepths` WHERE `level`=%s LIMIT 1",
69                         array(bigintval($level)), __FUNCTION__, __LINE__);
70
71                 // Entry found?
72                 if (sqlNumRows($result_level) == 1) {
73                         // Get percents
74                         $data = sqlFetchArray($result_level);
75                 } // END - if
76
77                 // Free result
78                 sqlFreeResult($result_level);
79         }
80
81         // Return percent
82         return $data['percents'];
83 }
84
85 /**
86  * Dynamic Referral and points system, can also send mails!
87  *
88  * subject       = Subject line, write in lower-case letters and underscore is allowed
89  * userid        = Referral id wich should receive...
90  * points        = ... xxx points
91  * refid         = inc/modules/guest/what-confirm.php need this
92  */
93 function addPointsThroughReferralSystem ($subject, $userid, $points, $refid = NULL) {
94         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',points=' . $points . ',refid=' . convertNullToZero($refid) . ' - ENTERED!');
95         // By default nothing has been added
96         $added = FALSE;
97
98         // Determine payment method and notification
99         $paymentMethod = strtoupper(getPaymentMethodFromSubject($subject));
100         $sendNotify    = isPaymentRecipientNotificationEnabled($subject);
101
102         // When $userid is NULL add points to jackpot
103         if ((!isValidId($userid)) && ($paymentMethod == 'DIRECT') && (isExtensionActive('jackpot'))) {
104                 // Add points to jackpot only in DIRECT mode
105                 return addPointsToJackpot($points);
106         } // END - if
107
108         // Set userid as current
109         setCurrentUserId($userid);
110
111         // Check user account
112         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',points=' . $points . ',paymentMethod=' . $paymentMethod . ',sendNotify=' . intval($sendNotify));
113         if (fetchUserData($userid)) {
114                 // Determine whether the user has some mails to click before he/she gets the points
115                 $isLocked = ifUserPointsLocked($userid);
116
117                 // Detect database column
118                 $pointsColumn = determinePointsColumnFromSubjectLocked($subject, $isLocked);
119
120                 // Get percents
121                 $percents = getReferralLevelPercents($GLOBALS['ref_level']);
122                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',points=' . $points . ',depth=' . convertNullToZero($GLOBALS['ref_level']) . ',percents=' . $percents . ',mode=' . $paymentMethod . ',pointsColumn=' . $pointsColumn . ',isLocked=' . intval($isLocked) . ',refid=' . getUserData('refid'));
123
124                 // Some percents found?
125                 if ($percents > 0) {
126                         // Calculate new points
127                         $ref_points = $points * $percents / 100;
128
129                         // Pay refback here if level > 0 and in ref-mode
130                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',refid=' . convertNullToZero(getUserData('refid')) . ',points=' . $points . ',paymentMethod=' . $paymentMethod);
131                         if (($userid != $refid) && (substr($subject, 0, 8) != 'refback:') &&($paymentMethod == 'REFERRAL') && (isValidId(getUserData('refid'))) && (isExtensionActive('refback'))) {
132                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',refid=' . convertNullToZero(getUserData('refid')) . ',ref_points=' . $ref_points . ',depth=' . convertNullToZero($GLOBALS['ref_level']) . ' - BEFORE!');
133                                 $ref_points = addRefbackPoints($userid, getUserData('refid'), $points, $ref_points);
134                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',refid=' . convertNullToZero(getUserData('refid')) . ',ref_points=' . $ref_points . ',depth=' . convertNullToZero($GLOBALS['ref_level']) . ' - AFTER!');
135                         } // END - if
136
137                         // Update points...
138                         if (is_null($GLOBALS['ref_level'])) {
139                                 // Level NULL (self)
140                                 sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_points` SET `%s`=`%s`+%s WHERE `userid`=%s AND `ref_depth` IS NULL LIMIT 1",
141                                         array(
142                                                 $pointsColumn,
143                                                 $pointsColumn,
144                                                 $ref_points,
145                                                 bigintval($userid)
146                                         ), __FUNCTION__, __LINE__);
147                         } else {
148                                 // Level 1+
149                                 sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_points` SET `%s`=`%s`+%s WHERE `userid`=%s AND `ref_depth`=%s LIMIT 1",
150                                         array(
151                                                 $pointsColumn,
152                                                 $pointsColumn,
153                                                 $ref_points,
154                                                 bigintval($userid),
155                                                 bigintval($GLOBALS['ref_level'])
156                                         ), __FUNCTION__, __LINE__);
157                         }
158                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'pointsColumn='.$pointsColumn.',ref_points='.$ref_points.',userid='.$userid.',depth='.convertNullToZero($GLOBALS['ref_level']).',mode='.$paymentMethod.' - UPDATE! ('.sqlAffectedRows().')');
159
160                         // No entry updated?
161                         if (ifSqlHasZeroAffectedRows()) {
162                                 // First ref in this level! :-)
163                                 sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_user_points` (`userid`, `ref_depth`, `%s`) VALUES (%s, %s, %s)",
164                                         array(
165                                                 $pointsColumn,
166                                                 bigintval($userid),
167                                                 convertZeroToNull($GLOBALS['ref_level']),
168                                                 $ref_points
169                                         ), __FUNCTION__, __LINE__);
170                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'data='.$pointsColumn.',ref_points='.$ref_points.',userid='.$userid.',depth='.convertNullToZero($GLOBALS['ref_level']).',mode='.$paymentMethod.' - INSERTED! ('.sqlAffectedRows().')');
171                         } // END - if
172
173                         // Check affected rows
174                         $added = (sqlAffectedRows() == 1);
175                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'added=' . intval($added) . ' - BEFORE FILTER');
176
177                         // Prepare data for the filter
178                         $filterData = array(
179                                 'subject'     => $subject,
180                                 'userid'      => $userid,
181                                 'points'      => $points,
182                                 'ref_points'  => $ref_points,
183                                 'column'      => $pointsColumn,
184                                 'notify'      => $sendNotify,
185                                 'refid'       => $refid,
186                                 'locked'      => $isLocked,
187                                 'points_mode' => 'add',
188                                 'add_mode'    => $paymentMethod,
189                                 'added'       => $added
190                         );
191
192                         // Filter it now
193                         $filterData = runFilterChain('post_add_points', $filterData);
194
195                         // Extract $added
196                         $added = $filterData['added'];
197                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'added=' . intval($added) . ' - AFTER FILTER');
198
199                         // Debug message
200                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',refid=' . $refid . ',paymentMethod=' . $paymentMethod . ',sendNotify=' . intval($sendNotify) . ',isLocked=' . intval($isLocked));
201
202                         // Send "referral confirmed" mails out?
203                         if ((isValidId($refid)) && ($refid != $userid) && ($sendNotify === TRUE)) {
204                                 // Calculate the referral's points and percents
205                                 $percentsReferral = getReferralLevelPercents($GLOBALS['ref_level'] + 1);
206
207                                 // Calculate new points
208                                 $ref_points = $ref_points * $percentsReferral / 100;
209
210                                 // Prepare content
211                                 $content = array(
212                                         'userid'         => bigintval($userid),
213                                         'refid'          => $refid,
214                                         'level'          => bigintval($GLOBALS['ref_level'] + 1),
215                                         'percents'       => $percentsReferral,
216                                         'points'         => ($paymentMethod == 'REFERRAL' ? $ref_points : '0'),
217                                         'payment_method' => $paymentMethod,
218                                         'subject'        => $subject,
219                                 );
220
221                                 // Load email template
222                                 $message = loadEmailTemplate('guest_user_confirmed_referral', $content, bigintval($userid));
223
224                                 // Send email
225                                 sendEmail($userid, '{--THANKS_REFERRAL_ONE_SUBJECT--}', $message);
226                         } // END - if
227
228                         // Points updated, maybe I shall send him an email?
229                         if (($sendNotify === TRUE) && ($isLocked === FALSE)) {
230                                 // "Explode" subject
231                                 $subjectArray = explode(':', $subject);
232                                 $subjectUserid = (isset($subjectArray[1])) ? $subjectArray[1] : '0';
233
234                                 // Generic delivery of mails, so prepare data
235                                 $content = array(
236                                         'userid'         => $userid,
237                                         'percents'       => $percents,
238                                         'level'          => bigintval($GLOBALS['ref_level']),
239                                         'points'         => $ref_points,
240                                         'column'         => $pointsColumn,
241                                         'subject'        => $subjectArray[0],
242                                         'subject_userid' => $subjectUserid,
243                                         'payment_method' => $paymentMethod,
244                                 );
245
246                                 // Load email template
247                                 $message = loadEmailTemplate('member_' . $subjectArray[0] . '_' . strtolower($paymentMethod), $content, $userid);
248
249                                 // Send email
250                                 sendEmail($userid, '{%message,MEMBER_' . $paymentMethod . '_' . strtoupper($subjectArray[0]) . '_SUBJECT=' . $subjectUserid . '%}', $message);
251
252                                 // Also send admin notification
253                                 sendAdminNotification(
254                                         // Subject
255                                         '{%message,ADMIN_' . $paymentMethod . '_' . strtoupper($subjectArray[0]) . '_SUBJECT=' . $subjectUserid . '%}',
256                                         // Template name
257                                         'admin_' . $subjectArray[0] . '_' . strtolower($paymentMethod),
258                                         // Template content (data array)
259                                         $content,
260                                         // User id
261                                         $userid
262                                 );
263                         } // END - if
264
265                         // Increase referral level, if payment method is 'REFERRAL'
266                         if ($paymentMethod == 'REFERRAL') {
267                                 // Increase it
268                                 $GLOBALS['ref_level']++;
269                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Referral level increased, ref_level=' . convertNullToZero($GLOBALS['ref_level']) . ',points=' . $points . ',refid=' . convertNullToZero(getUserData('refid')) . ',userid=' . $userid . ',paymentMethod=' . $paymentMethod);
270                         } elseif (isDebugModeEnabled()) {
271                                 // Not increasing referral level, DIRECT payment method
272                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Referral level *NOT* increased, ref_level=' . convertNullToZero($GLOBALS['ref_level']) . ',points=' . $points . ',refid=' . convertNullToZero(getUserData('refid')) . ',userid=' . $userid . ',paymentMethod=' . $paymentMethod);
273                         }
274
275                         // Remove any :x
276                         $subject = removeDoubleDotFromSubject($subject);
277
278                         // Maybe there's another ref?
279                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'points=' . $points . ',refid(var|data)=' . convertNullToZero($refid) . '|' . convertNullToZero(getUserData('refid')) . ',userid=' . $userid . ',paymentMethod=' . $paymentMethod . ',subject=' . $subject . ',ref_level=' . $GLOBALS['ref_level']);
280                         if (($paymentMethod == 'REFERRAL') && (isValidId(getUserData('refid'))) && ($points > 0) && (getUserData('refid') != $userid)) {
281                                 // Is _ref there?
282                                 if (ifSubjectHasReferralSuffix($subject)) {
283                                         // Then remove it, no double _ref suffix!
284                                         $subject = substr($subject, 0, -4);
285                                 } // END - if
286
287                                 // Then let's credit him here...
288                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',refid=' . convertNullToZero(getUserData('refid')) . ',points=' . $points . ',ref_points=' . $ref_points . ',added[' . gettype($added) . ']=' . intval($added) . ',ref_level=' . $GLOBALS['ref_level'] . ' - ADVANCE!');
289                                 $added = ($added && addPointsThroughReferralSystem(sprintf('%s_ref:%s', $subject, $GLOBALS['ref_level']), getUserData('refid'), $points, getFetchedUserData('userid', getUserData('refid'), 'refid')));
290                         } // END - if
291                 } // END - if
292         } // END - if
293
294         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',userid=' . $userid . ',points=' . $points . ',sendNotify=' . intval($sendNotify) . ',refid=' . convertNullToZero($refid) . ',paymentMethod=' . $paymentMethod . ' - EXIT!');
295         return $added;
296 }
297
298 // Updates the referral counter
299 function updateReferralCounter ($userid) {
300         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
301         // Init referral id
302         $refid = NULL;
303
304         // Check for his referral
305         if (fetchUserData($userid)) {
306                 // Get it
307                 $refid = getUserData('refid');
308                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',refid=' . convertZeroToNull($refid) . ' - FETCHED!');
309         } // END - if
310
311         // Init entries
312         if (empty($GLOBALS['cache_array']['ref_level'][$userid])) {
313                 $GLOBALS['cache_array']['ref_level'][$userid] = NULL;
314         } // END - if
315         if (empty($GLOBALS['cache_array']['ref_level'][$refid])) {
316                 $GLOBALS['cache_array']['ref_level'][$refid] = NULL;
317         } // END - if
318
319         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',refid=' . convertZeroToNull($refid));
320
321         // When he has a referral...
322         if ((isValidId($refid)) && ($refid != $userid)) {
323                 // Move to next referral level and count his counter one up
324                 $GLOBALS['cache_array']['ref_level'][$refid] = $GLOBALS['cache_array']['ref_level'][$userid] + 1;
325                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',refid(' . $refid . ')=' . $GLOBALS['cache_array']['ref_level'][$refid] . ' - ADVANCED!');
326
327                 // Update counter
328                 sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_refsystem` SET `counter`=`counter`+1 WHERE `userid`=%s AND `level`=%s LIMIT 1",
329                         array(
330                                 bigintval($refid),
331                                 bigintval($GLOBALS['cache_array']['ref_level'][$refid])
332                         ), __FUNCTION__, __LINE__);
333
334                 // When no entry was updated then we have to create it here
335                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refid=' . $refid . ',level=' . $GLOBALS['cache_array']['ref_level'][$refid] . ',updated=' . sqlAffectedRows());
336                 if (ifSqlHasZeroAffectedRows()) {
337                         // First count!
338                         sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_refsystem` (`userid`, `level`, `counter`) VALUES (%s,%s,1)",
339                                 array(
340                                         bigintval($refid),
341                                         convertZeroToNull($GLOBALS['cache_array']['ref_level'][$refid])
342                                 ), __FUNCTION__, __LINE__);
343                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refid=' . $refid . ',level=' . $GLOBALS['cache_array']['ref_level'][$refid] . ',sqlAffectedRows()=' . sqlAffectedRows());
344                 } // END - if
345
346                 // Advance to next level
347                 updateReferralCounter($refid);
348         } elseif ((($refid == $userid) || (!isValidId($refid))) && (isExtensionInstalledAndNewer('cache', '0.1.2'))) {
349                 // Remove cache here
350                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refid=' . convertZeroToNull($refid) . ' - CACHE!');
351                 rebuildCache('refsystem', 'refsystem');
352         }
353
354         // Update the referral table
355         updateReferralTable($userid);
356
357         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',refid=' . convertZeroToNull($refid) . ',level=' . convertZeroToNull($GLOBALS['cache_array']['ref_level'][$refid]) . ' - EXIT!');
358 }
359
360 // Subtract points from database and mediadata cache
361 function subtractPoints ($subject, $userid, $points) {
362         // Add points to used points
363         sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `used_points`=`used_points`+%s WHERE `userid`=%s LIMIT 1",
364                 array(
365                         $points,
366                         bigintval($userid)
367                 ), __FUNCTION__, __LINE__);
368
369         // Prepare filter data
370         $filterData = array(
371                 'subject'     => $subject,
372                 'userid'      => $userid,
373                 'points'      => $points,
374                 'points_mode' => 'sub',
375                 'column'      => 'used_points',
376                 'added'       => (!ifSqlHasZeroAffectedRows())
377         );
378
379         // Insert booking record
380         $filterData = runFilterChain('post_sub_points', $filterData);
381
382         // Return result
383         return $filterData['added'];
384 }
385 // "Getter" for array for user refs and points in given level
386 function getUserReferralPoints ($userid, $level) {
387         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ' - ENTERED!');
388         // Default is no refs and no nickname
389         $refs = array();
390
391         // Get refs from database
392         $result = sqlQueryEscaped('SELECT
393         `ur`.`id`,
394         `ur`.`refid`,
395         `ud`.`status`,
396         `ud`.`last_online`,
397         `ud`.`mails_confirmed`,
398         `ud`.`emails_received`,
399         `ud`.`subid`
400 FROM
401         `{?_MYSQL_PREFIX?}_user_refs` AS `ur`
402 LEFT JOIN
403         `{?_MYSQL_PREFIX?}_user_points` AS `up`
404 ON
405         `ur`.`refid`=`up`.`userid` AND
406         (`ur`.`level`=0 OR `ur`.`level` IS NULL)
407 LEFT JOIN
408         `{?_MYSQL_PREFIX?}_user_data` AS `ud`
409 ON
410         `ur`.`refid`=`ud`.`userid`
411 WHERE
412         `ur`.`userid`=%s AND
413         `ur`.`level`=%s
414 ORDER BY
415         `ur`.`refid` ASC',
416                 array(
417                         bigintval($userid),
418                         bigintval($level)
419                 ), __FUNCTION__, __LINE__);
420
421         // Are there some entries?
422         if (!ifSqlHasZeroNums($result)) {
423                 // Fetch all entries
424                 while ($row = sqlFetchArray($result)) {
425                         // Init click rate with zero
426                         $row['click_rate'] = calculatePercentageRate($row['mails_confirmed'], $row['emails_received']);
427
428                         // Activity is 'active' by default because if ext-autopurge is not installed
429                         $row['activity'] = '{--MEMBER_ACTIVITY_ACTIVE--}';
430
431                         // Is autopurge installed and the user inactive?
432                         if ((isExtensionActive('autopurge')) && ((time() - getApInactiveSince()) >= $row['last_online']))  {
433                                 // Inactive user!
434                                 $row['activity'] = '{--MEMBER_ACTIVITY_INACTIVE--}';
435                         } // END - if
436
437                         // Remove some entries
438                         unset($row['mails_confirmed']);
439                         unset($row['emails_received']);
440                         unset($row['last_online']);
441
442                         // Add row
443                         $refs[$row['id']] = $row;
444                 } // END - while
445         } // END - if
446
447         // Free result
448         sqlFreeResult($result);
449
450         // Return result
451         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ' - EXIT!');
452         return $refs;
453 }
454
455 // Get points data for given subject
456 function getPointsDataArrayFromSubject ($subject) {
457         // Extension ext-sql_patches must be up-to-date
458         if (isExtensionInstalledAndOlder('sql_patches', '0.8.2')) {
459                 // Please update ext-sql_patches
460                 reportBug(__FUNCTION__, __LINE__, 'sql_patches is out-dated. Please update to at least 0.8.2 to continue. subject=' . $subject);
461         } elseif (substr($subject, -8, 8) == '_ref_ref') {
462                 // Please report ALL finiding
463                 reportBug(__FUNCTION__, __LINE__, 'subject=' . $subject . ' contains invalid double-suffix _ref.');
464         }
465
466         // Remove any double-dot from it
467         $subject = removeDoubleDotFromSubject($subject);
468
469         // If we have cache, shortcut it here
470         if (isset($GLOBALS['cache_array']['points_data'][$subject])) {
471                 // Count cache hit
472                 incrementStatsEntry('cache_hits');
473
474                 // Return it
475                 return $GLOBALS['cache_array']['points_data'][$subject];
476         } // END - if
477
478         // Now checkout the entry in database table
479         $result = sqlQueryEscaped("SELECT
480         `id`,
481         `subject`,
482         `column_name`,
483         `locked_mode`,
484         `payment_method`,
485         `notify_recipient`
486 FROM
487         `{?_MYSQL_PREFIX?}_points_data`
488 WHERE
489         `subject`='%s'
490 LIMIT 1",
491                 array(
492                         $subject
493                 ), __FUNCTION__, __LINE__
494         );
495
496         // Is there an entry?
497         if (sqlNumRows($result) == 1) {
498                 // Then load it
499                 $pointsData = sqlFetchArray($result);
500
501                 // Add all entries to our cache array
502                 foreach ($pointsData as $key => $value) {
503                         $GLOBALS['cache_array']['points_data'][$subject][$key] = $value;
504                 } // END - foreach
505         } else {
506                 // Register this automatically
507                 sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_points_data` (`subject`, `column_name`, `locked_mode`, `payment_method`, `notify_recipient`) VALUES ('%s','points','LOCKED','REFERRAL','N')",
508                         array($subject), __FUNCTION__, __LINE__);
509
510                 // Re-request it
511                 return getPointsDataArrayFromSubject($subject);
512         }
513
514         // Free result
515         sqlFreeResult($result);
516
517         // Return it
518         return $GLOBALS['cache_array']['points_data'][$subject];
519 }
520
521 // Determines the right points column name for given subject and 'locked'
522 function getPointsColumnNameFromSubjectLocked ($subject, $isLocked) {
523         // Get the points_data entry
524         $pointsData = getPointsDataArrayFromSubject($subject);
525
526         // Regular points by default
527         $columnName = $pointsData['column_name'];
528
529         // Are the points locked?
530         if (($isLocked === TRUE) && ($pointsData['locked_mode'] == 'LOCKED')) {
531                 // Locked points, so prefix it
532                 $columnName = 'locked_' . $pointsData['column_name'];
533         } // END - if
534
535         // Return the result
536         return $columnName;
537 }
538
539 // Determines the payment method for given extension and 'locked'
540 function getPaymentMethodFromSubject ($subject) {
541         // Get the points_data entry
542         $pointsData = getPointsDataArrayFromSubject($subject);
543
544         // Regular points by default
545         $paymentMethod = $pointsData['payment_method'];
546
547         // Return the result
548         return $paymentMethod;
549 }
550
551 // Checks whether notification of points recipient is enabled
552 function isPaymentRecipientNotificationEnabled ($subject) {
553         // Get the points_data entry
554         $pointsData = getPointsDataArrayFromSubject($subject);
555
556         // Is it enabled?
557         $isEnabled = ($pointsData['notify_recipient'] == 'Y');
558
559         // Return the result
560         return $isEnabled;
561 }
562
563 // Update "referral table"
564 function updateReferralTable ($userid) {
565         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
566         // Load all referrals
567         loadReferralTable($userid);
568
569         // Add missing level > 1
570         addMissingReferralLevels($userid);
571
572         // The last step is to flush all userid's entries to the database
573         flushReferralTableToDatabase($userid);
574
575         // Rebuild cache
576         rebuildCache('refsystem', 'refsystem');
577
578         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - EXIT!');
579 }
580
581 // Loads all referrals for given userid
582 function loadReferralTable ($userid) {
583         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
584         // Init array
585         $GLOBALS['referral_refid'][$userid] = array();
586
587         // Get all level entries from the refsystem table
588         $GLOBALS['referral_result'][$userid] = sqlQueryEscaped('SELECT `level` FROM `{?_MYSQL_PREFIX?}_refsystem` WHERE `userid`=%s ORDER BY `level` ASC',
589                 array($userid), __FUNCTION__, __LINE__);
590
591         // Are there entries?
592         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',sqlNumRows()=' . sqlNumRows($GLOBALS['referral_result'][$userid]));
593         if (sqlNumRows($GLOBALS['referral_result'][$userid]) > 0) {
594                 // Then walk through all levels
595                 while (list($level) = sqlFetchRow($GLOBALS['referral_result'][$userid])) {
596                         // Init array
597                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level);
598                         $GLOBALS['referral_refid'][$userid][$level] = array();
599
600                         // Level is = 1?
601                         if ($level == 1) {
602                                 // Load all referrals of this user
603                                 $GLOBALS['referral_result_refs'][$userid] = sqlQueryEscaped('SELECT `userid` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `refid`=%s ORDER BY `userid` ASC',
604                                         array($userid), __FUNCTION__, __LINE__);
605
606                                 // Are there entries?
607                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',sqlNumRows()=' . sqlNumRows($GLOBALS['referral_result_refs'][$userid]));
608                                 if (sqlNumRows($GLOBALS['referral_result_refs'][$userid]) > 0) {
609                                         // Then again walk through all
610                                         while (list($refid) = sqlFetchRow($GLOBALS['referral_result_refs'][$userid])) {
611                                                 // Add this refid
612                                                 array_push($GLOBALS['referral_refid'][$userid][$level], $refid);
613                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',refid=' . $refid . ' - ADDED!');
614
615                                                 // Load the refid's array as well
616                                                 loadReferralTable($refid);
617                                         } // END - while
618                                 } // END - if
619
620                                 // Free result
621                                 sqlFreeResult($GLOBALS['referral_result_refs'][$userid]);
622                         } // END - if
623                 } // END - while
624         } // END - if
625
626         // Free result
627         sqlFreeResult($GLOBALS['referral_result'][$userid]);
628         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - EXIT!');
629 }
630
631 // Adds missing referral levels to the array
632 function addMissingReferralLevels ($userid) {
633         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
634         // If the array is gone, you have called this function without calling loadReferralTable()
635         if (!isset($GLOBALS['referral_refid'][$userid])) {
636                 // Please fix your code
637                 reportBug(__FUNCTION__, __LINE__, 'Called without calling loadReferralTable() before! userid=' . $userid);
638         } // END - if
639         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',count()=' . count($GLOBALS['referral_refid'][$userid]));
640
641         // Sort the array reversed
642         krsort($GLOBALS['referral_refid']);
643
644         // Now walk through the array, first levels
645         foreach ($GLOBALS['referral_refid'][$userid] as $level => $levelArray) {
646                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',count()=' . count($levelArray));
647                 // Next are the users
648                 foreach ($levelArray as $refid) {
649                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',refid=' . $refid);
650                         // Does the refid have an array?
651                         if (isset($GLOBALS['referral_refid'][$refid])) {
652                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',refid=' . convertNullToZero($refid) . ',count()=' . count($GLOBALS['referral_refid'][$refid]));
653                                 // Add also this user's (maybe) missing levels
654                                 addMissingReferralLevels($refid);
655
656                                 // Okay, then walk through here, too
657                                 foreach ($GLOBALS['referral_refid'][$refid] as $refLevel => $refArray) {
658                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',refid=' . convertNullToZero($refid) . ',refLevel=' . $refLevel . ',count()=' . count($refArray));
659                                         // Also walk through this one
660                                         foreach ($refArray as $refRefid) {
661                                                 // Calculate new level
662                                                 $newLevel = $level + $refLevel;
663                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',refid=' . convertNullToZero($refid) . ',refLevel=' . $refLevel . ',refRefid=' . $refRefid . ',newLevel=' . $newLevel);
664                                                 // Is the refRefid not in?
665                                                 if ((!isset($GLOBALS['referral_refid'][$userid][$newLevel])) || (!in_array($refRefid, $GLOBALS['referral_refid'][$userid][$newLevel]))) {
666                                                         // Then we must add this ref's refid to the userid's next level
667                                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',newLevel=' . $newLevel . ',refRefid=' . $refRefid . ' - ADDED!');
668                                                         array_push($GLOBALS['referral_refid'][$userid][$newLevel], $refRefid);
669
670                                                         // Add also this user's (maybe) missing levels
671                                                         addMissingReferralLevels($refRefid);
672                                                 } // END - if
673                                         } // END - foreach
674                                 } // END - foreach
675                         } // END - foreach
676                 } // END - foreach
677         } // END - foreach
678         //die('<pre>'.print_r($GLOBALS['referral_refid'][$userid],TRUE).'</pre>');
679         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - EXIT!');
680 }
681
682 // Flush all entries for given userid to database
683 function flushReferralTableToDatabase ($userid) {
684         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
685         // If the array is gone, you have called this function without calling loadReferralTable()
686         if (!isset($GLOBALS['referral_refid'][$userid])) {
687                 // Please fix your code
688                 reportBug(__FUNCTION__, __LINE__, 'Called without calling loadReferralTable() before! userid=' . $userid);
689         } // END - if
690         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',count()=' . count($GLOBALS['referral_refid'][$userid]));
691
692         // If no entries are there, skip this whole step
693         if (!isFilledArray($GLOBALS['referral_refid'][$userid])) {
694                 // No entries found
695                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ABORTING...');
696                 return;
697         } // END - if
698
699         // Prepare SQL
700         $SQL = 'INSERT INTO `{?_MYSQL_PREFIX?}_user_refs` (`userid`, `level`, `refid`) VALUES ';
701         $executeSql = FALSE;
702
703         // Now walk through the array, first levels
704         foreach ($GLOBALS['referral_refid'][$userid] as $level => $levelArray) {
705                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',count()=' . count($levelArray));
706                 // Next are the users
707                 foreach ($levelArray as $refid) {
708                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',refid=' . $refid);
709                         // Query the user_refs table
710                         $count = countSumTotalData(bigintval($userid), 'user_refs', 'id', 'userid', TRUE, ' AND `level`=' . bigintval($level) . ' AND `refid`=' . bigintval($refid));
711
712                         // Is there no entry?
713                         if ($count == 0) {
714                                 // Then add it to the SQL
715                                 $SQL .= '(' . $userid . ',' . $level . ',' . $refid . '),';
716
717                                 // Some has been added, so execute the query
718                                 $executeSql = TRUE;
719                         } // END - if
720                 } // END - foreach
721         } // END - foreach
722
723         // Remove last comma from SQL
724         $SQL = substr($SQL, 0, -1);
725
726         // And run it
727         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',SQL=' . $SQL);
728         if ($executeSql === TRUE) {
729                 sqlQuery($SQL, __FUNCTION__, __LINE__);
730         } // END - if
731
732         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - EXIT!');
733 }
734
735 // Generator (somewhat getter) for points_data, locked_mode
736 function generatePointsLockedModeOptions ($lockedMode = NULL) {
737         // Is this cached?
738         if (!isset($GLOBALS[__FUNCTION__][$lockedMode])) {
739                 // Generate output and cache it
740                 $GLOBALS[__FUNCTION__][$lockedMode] = generateOptions(
741                         '/ARRAY/',
742                         array(
743                                 'LOCKED',
744                                 'UNLOCKED'
745                         ),
746                         array(),
747                         $lockedMode,
748                         '', '',
749                         array(),
750                         'translatePointsLockedMode'
751                 );
752         } // END - if
753
754         // Return content
755         return $GLOBALS[__FUNCTION__][$lockedMode];
756 }
757
758 // Generator (somewhat getter) for points_data, payment_method
759 function generatePointsPaymentMethodOptions ($paymentMethod = NULL) {
760         // Is this cached?
761         if (!isset($GLOBALS[__FUNCTION__][$paymentMethod])) {
762                 // Generate output and cache it
763                 $GLOBALS[__FUNCTION__][$paymentMethod] = generateOptions(
764                         '/ARRAY/',
765                         array(
766                                 'DIRECT',
767                                 'REFERRAL'
768                         ),
769                         array(),
770                         $paymentMethod,
771                         '', '',
772                         array(),
773                         'translatePointsPaymentMethod'
774                 );
775         } // END - if
776
777         // Return content
778         return $GLOBALS[__FUNCTION__][$paymentMethod];
779 }
780
781 // Generator (somewhat getter) for points_data, notify_recipient
782 function generatePointsNotifyRecipientOptions ($notifyRecipient = NULL) {
783         // Is this cached?
784         if (!isset($GLOBALS[__FUNCTION__][$notifyRecipient])) {
785                 // Generate output and cache it
786                 $GLOBALS[__FUNCTION__][$notifyRecipient] = generateOptions(
787                         '/ARRAY/',
788                         array(
789                                 'Y',
790                                 'N'
791                         ),
792                         array(),
793                         $notifyRecipient,
794                         '', '',
795                         array(),
796                         'translatePointsNotifyRecipient'
797                 );
798         } // END - if
799
800         // Return content
801         return $GLOBALS[__FUNCTION__][$notifyRecipient];
802 }
803
804 // Setter for referral id (no bigintval, or nicknames will fail!)
805 function setReferralId ($refid) {
806         $GLOBALS['__refid'] = $refid;
807 }
808
809 // Checks if 'refid' is valid
810 function isValidReferralId () {
811         return ((isset($GLOBALS['__refid'])) && (isValidId(getReferralId())));
812 }
813
814 // Getter for referral id
815 function getReferralId () {
816         return $GLOBALS['__refid'];
817 }
818
819 // Determines referral id and sets it
820 function determineReferralId () {
821         // Is it already detected?
822         if (isValidReferralId()) {
823                 // Do not determine it, just return it
824                 return getReferralId();
825         } elseif ((!isHtmlOutputMode()) && (basename($_SERVER['PHP_SELF']) != 'ref.php')) {
826                 // Skip this in non-html-mode and outside ref.php
827                 return FALSE;
828         }
829
830         // Check if refid is set
831         if (isValidReferralId()) {
832                 // This is fine...
833                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from GLOBALS (' . getReferralId() . ')');
834         } elseif (isPostRequestElementSet('refid')) {
835                 // Get referral id from POST element refid
836                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from POST data (' . postRequestElement('refid') . ')');
837                 setReferralId(secureString(postRequestElement('refid')));
838         } elseif (isGetRequestElementSet('refid')) {
839                 // Get referral id from GET parameter refid
840                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from GET data (' . getRequestElement('refid') . ')');
841                 setReferralId(getRequestElement('refid'));
842         } elseif (isGetRequestElementSet('ref')) {
843                 // Set refid=ref (the referral link uses such variable)
844                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using ref from GET data (' . getRequestElement('ref') . ')');
845                 setReferralId(getRequestElement('ref'));
846         } elseif ((isGetRequestElementSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
847                 // The variable user comes from  click.php
848                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using user from GET data (' . getRequestElement('user') . ')');
849                 setReferralId(bigintval(getRequestElement('user')));
850         } elseif ((isSessionVariableSet('refid')) && (isValidId(getSession('refid')))) {
851                 // Set session refid as global
852                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from SESSION data (' . getSession('refid') . ')');
853                 setReferralId(bigintval(getSession('refid')));
854         } elseif ((isExtensionInstalledAndNewer('user', '0.3.4')) && (isRandomReferralIdEnabled())) {
855                 // Select a random user which has confirmed enougth mails
856                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Checking random referral id');
857                 setReferralId(determineRandomReferralId());
858         } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidId(getDefRefid()))) {
859                 // Set default refid as refid in URL
860                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using default refid (' . getDefRefid() . ')');
861                 setReferralId(getDefRefid());
862         } else {
863                 // No default id when ext-sql_patches is not installed or none set
864                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using NULL as refid');
865                 setReferralId(NULL);
866         }
867
868         // Set cookie when default refid > 0
869         if ((!isSessionVariableSet('refid')) || (!isValidId(getReferralId())) || ((!isValidId(getSession('refid'))) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidId(getDefRefid())))) {
870                 // Default is not found
871                 $found = FALSE;
872
873                 // Is there nickname or userid set?
874                 if ((isExtensionActive('nickname')) && (isNicknameUsed(getReferralId()))) {
875                         // Nickname in URL, so load the id
876                         $found = fetchUserData(getReferralId(), 'nickname');
877
878                         // If we found it, use the userid as referral id
879                         if ($found === TRUE) {
880                                 // Set the userid as 'refid'
881                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from user account by nickname (' . getUserData('userid') . ')');
882                                 setReferralId(getUserData('userid'));
883                         } // END - if
884                 } elseif (isValidId(getReferralId())) {
885                         // Direct userid entered
886                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using direct userid (' . getReferralId() . ')');
887                         $found = fetchUserData(getReferralId());
888                 }
889
890                 // Is the record valid?
891                 if ((($found === FALSE) || (!isUserDataValid())) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2'))) {
892                         // No, then reset referral id
893                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using default refid (' . getDefRefid() . ')');
894                         setReferralId(getDefRefid());
895                 } // END - if
896
897                 // Set cookie
898                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Saving refid to session (' . getReferralId() . ') #1');
899                 setSession('refid', getReferralId());
900         } elseif ((!isValidReferralId()) || (!fetchUserData(getReferralId()))) {
901                 // Not valid!
902                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Not valid referral id (' . getReferralId() . '), setting NULL in session');
903                 setReferralId(NULL);
904                 setSession('refid', NULL);
905         } else {
906                 // Set it from GLOBALS array in session
907                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Saving refid to session (' . getReferralId() . ') #2');
908                 setSession('refid', getReferralId());
909         }
910
911         // Run post validation filter chain
912         runFilterChain('post_refid_validation');
913
914         // Return determined refid
915         return getReferralId();
916 }
917
918 // [EOF]
919 ?>