Fixes for referal system, shell scripts overworked:
[mailer.git] / inc / libs / refback_functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 09/28/2008 *
4  * ===================                          Last change: 09/28/2008 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : refback_functions.php                            *
8  * -------------------------------------------------------------------- *
9  * Short description : Functions for refback extension                  *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Funktionen fuer Refback-Erweiterung              *
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 - 2011 by Mailer Developer Team                   *
20  * For more information visit: http://www.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 }
42
43 // Payback refback for refid and reduce it for current user
44 function addRefbackPoints ($userid, $ref, $points, $ref_points) {
45         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ',points=' . $points . ',ref_points=' . $ref_points . ' - ENTERED!');
46         // Back ref depths
47         $GLOBALS['refback_depth'][$userid][$ref] = $GLOBALS['ref_level'];
48
49         // Init points
50         $return = $ref_points;
51
52         // Get all ref levels
53         $result_refs = SQL_QUERY('SELECT `level`, `percents` FROM `{?_MYSQL_PREFIX?}_refdepths` WHERE `level` > 0 ORDER BY `level` ASC',
54                 __FUNCTION__, __LINE__);
55
56         // "Walk" through all level
57         while ($content = SQL_FETCHARRAY($result_refs)) {
58                 // Reset ref depths
59                 initReferalSystem();
60
61                 // "Walk" through all refids
62                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ',level=' . $content['level'] . ',percents=' . $content['percents'] . ',points=' . $points . ' - LOOP START!');
63                 foreach (getArrayFromRefbackLevel($userid, $content['level']) as $refid) {
64                         // Skip level zero or if both are the same
65                         if ($userid == $refid) {
66                                 continue;
67                         } // END - if
68
69                         // Get refback percents
70                         $percents = getRefbackPercents($userid, $refid);
71                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ',refid=' . $refid . ',points=' . $points . ',percents=' . $percents);
72
73                         // Some percents given?
74                         if ($percents > 0) {
75                                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'points=' . $points . ',[percents]=' . $content['percents'] . ',percents=' . $percents . ',level=' . $content['level']);
76                                 // Calculate points for refback
77                                 $refback = $points * ($content['percents'] / 100) * ($percents / 100);
78
79                                 // Update refback table ('refid' and 'userid' must be exchanged!)
80                                 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_refs` SET `points`=`points`+%s WHERE `userid`=%s AND `refid`=%s LIMIT 1",
81                                         array(
82                                                 $refback,
83                                                 $refid,
84                                                 $userid
85                                         ), __FUNCTION__, __LINE__);
86
87                                 // Something must have been updated
88                                 if (SQL_HASZEROAFFECTED()) {
89                                         // Please report this bug
90                                         debug_report_bug(__FUNCTION__, __LINE__, 'Nothing has been updated in user_refs,userid=' . $userid . ',refid=' . $refid . ',refback=' . $refback);
91                                 } // END - if
92
93                                 // Add points again, but only directly
94                                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refback=' . $refback . ',userid=' . $userid . ',ref=' . $ref . ',refid=' . $refid . ' - UPDATE! (' . SQL_AFFECTEDROWS() . ')');
95                                 addPointsDirectly(sprintf("refback:%s", $refid), $userid, $refback);
96
97                                 // Reduce points if refid is found
98                                 if ($refid == $ref) {
99                                         // Reduce points here!
100                                         $return = $points * ($content['percents'] / 100) - $refback;
101                                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'return=' . $return . ' - REDUCED!');
102                                 } // END - if
103                         } // END - if
104                 } // END foreach
105         } // END - while
106
107         // Free result
108         SQL_FREERESULT($result_refs);
109
110         // Restore ref depth
111         $GLOBALS['ref_level'] = $GLOBALS['refback_depth'][$userid][$ref];
112
113         // Return them
114         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ',points=' . $points . ',ref_points=' . $ref_points . ',return=' . $return . ' - EXIT!');
115         return $return;
116 }
117
118 // "Getter" for refback percents
119 function getRefbackPercents ($userid, $ref) {
120         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ' - ENTERED!');
121         // Skip identical ids
122         if ($userid == $ref) {
123                 return 0;
124         } // END - if
125
126         // Is it cached?
127         if (!isset($GLOBALS['refback_percents'][$userid][$ref])) {
128                 // Default is zero
129                 $GLOBALS['refback_percents'][$userid][$ref] = '0';
130
131                 // Get percents from database
132                 $result = SQL_QUERY_ESC("SELECT `refback` FROM `{?_MYSQL_PREFIX?}_user_refs` WHERE `userid`=%s AND `refid`=%s LIMIT 1",
133                         array($ref, $userid), __FUNCTION__, __LINE__);
134
135                 // Entry found? (Should be!)
136                 if (SQL_NUMROWS($result) == 1) {
137                         // Fetch percents
138                         list($GLOBALS['refback_percents'][$userid][$ref]) = SQL_FETCHROW($result);
139                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ',percents=' . $GLOBALS['refback_percents'][$userid][$ref]);
140                 } else {
141                         // Debug log
142                         logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ' - No entry found. :-(');
143                 }
144
145                 // Free result
146                 SQL_FREERESULT($result);
147         } // END - if
148
149         // Return percents
150         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $ref . ',refback_percents=' . $GLOBALS['refback_percents'][$userid][$ref] . ' - EXIT!');
151         return $GLOBALS['refback_percents'][$userid][$ref];
152 }
153
154 // "Getter" for userid array which will return only one entry
155 function getArrayFromRefbackLevel ($refid, $level) {
156         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refid=' . $refid . ',level=' . $level);
157         // Init userids
158         $userIds = array();
159
160         // Look for all
161         $result = SQL_QUERY_ESC("SELECT
162         `userid`
163 FROM
164         `{?_MYSQL_PREFIX?}_user_refs`
165 WHERE
166         `refid`=%s AND `level`=%s
167 ORDER BY
168         `userid` ASC",
169                 array($refid, $level), __FUNCTION__, __LINE__);
170
171         // Entries found?
172         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'numRows=' . SQL_NUMROWS($result));
173         if (!SQL_HASZERONUMS($result)) {
174                 // Add all
175                 while ($content = SQL_FETCHARRAY($result)) {
176                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refid=' . $refid . ',level=' . $level . ',userid=' . $content['userid']);
177                         $userIds[] = $content['userid'];
178                 } // END - while
179         } // END - if
180
181         // Free result
182         SQL_FREERESULT($result);
183
184         // Return array
185         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refid=' . $refid . ',userIds()=' . count($userIds) . ' - EXIT!');
186         return $userIds;
187 }
188
189 // Update "refback table"
190 function updateRefbackTable ($userid) {
191         // Make it sure referal level zero (member him-/herself) is at least selected
192         if (empty($GLOBALS['refback_level'])) {
193                 $GLOBALS['refback_level'] = NULL;
194         } // END - if
195         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $GLOBALS['refback_level'] . ' - ENTERED!');
196
197         // Init refid and variables
198         $GLOBALS['refback_refid'][$GLOBALS['refback_level']] = '0';
199         $old = '0';
200         $minus = '0';
201
202         // Check for his referal
203         $result_refid = SQL_QUERY_ESC("SELECT `userid` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `refid`=%s ORDER BY `userid` ASC",
204                 array(bigintval($userid)), __FUNCTION__, __LINE__);
205
206         // When no entry was updated then we have to create it here
207         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQL_NUMROWS()=' . SQL_NUMROWS($result_refid));
208         if (!SQL_HASZERONUMS($result_refid)) {
209                 // Load all refids
210                 while (list($GLOBALS['refback_refid'][$GLOBALS['refback_level']]) = SQL_FETCHROW($result_refid)) {
211                         // Remmber userid
212                         $GLOBALS['refback_userid'][$GLOBALS['refback_refid'][$GLOBALS['refback_level']]] = $userid;
213
214                         // Refid set?
215                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']]);
216                         if (($GLOBALS['refback_refid'][$GLOBALS['refback_level']] > 0) && ($GLOBALS['refback_refid'][$GLOBALS['refback_level']] != $userid) && (isset($GLOBALS['refback_refid'][$GLOBALS['refback_level']]))) {
217                                 // New userid?
218                                 if ((isset($GLOBALS['refback_refid'][$GLOBALS['refback_level']-1])) && (isset($GLOBALS['refback_userid'][$GLOBALS['refback_refid'][$GLOBALS['refback_level']-1]]))) {
219                                         // New userid!
220                                         $old = $userid;
221                                         $userid = $GLOBALS['refback_userid'][$GLOBALS['refback_refid'][$GLOBALS['refback_level']-1]];
222                                         $minus = 1;
223                                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',old=' . $old . ',level=' . $GLOBALS['refback_level'] . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']] . ' - NEW UID!');
224                                 } // END - if
225
226                                 // Check existence
227                                 if (is_null($GLOBALS['refback_level'])) {
228                                         // Level is NULL
229                                         $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_user_refs` WHERE `userid`=%s AND `level` IS NULL AND `refid`=%s LIMIT 1",
230                                                 array(
231                                                         bigintval($userid),
232                                                         bigintval($GLOBALS['refback_refid'][$GLOBALS['refback_level']])
233                                                 ), __FUNCTION__, __LINE__);
234                                 } else {
235                                         // Level is > 0
236                                         $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_user_refs` WHERE `userid`=%s AND `level`=%s AND `refid`=%s LIMIT 1",
237                                                 array(
238                                                         bigintval($userid),
239                                                         bigintval($GLOBALS['refback_level']),
240                                                         bigintval($GLOBALS['refback_refid'][$GLOBALS['refback_level']])
241                                                 ), __FUNCTION__, __LINE__);
242                                 }
243
244                                 // Do we have no entry?
245                                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $GLOBALS['refback_level'] . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']] . ',minus=' . $minus . ',numRows=' . SQL_NUMROWS($result) . ' - FOUND!');
246                                 if (SQL_HASZERONUMS($result)) {
247                                         // Insert this level
248                                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $GLOBALS['refback_level'] . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']] . ' - ADD!');
249                                         SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_refs` (`userid`,`level`,`refid`) VALUES (%s,%s,%s)",
250                                                 array(
251                                                         bigintval($userid),
252                                                         $GLOBALS['refback_level'],
253                                                         bigintval($GLOBALS['refback_refid'][$GLOBALS['refback_level']])
254                                                 ), __FUNCTION__, __LINE__);
255
256                                         // Move to next referal level and count his counter one up!
257                                         $GLOBALS['refback_level']++;
258                                         updateRefbackTable($GLOBALS['refback_refid'][($GLOBALS['refback_level'] - 1)]);
259                                 } // END - if
260
261                                 // Do we have another level here?
262                                 if ((($GLOBALS['refback_level']-$minus) > 0) && ($old > 0)) {
263                                         // Restore old one
264                                         $userid = $old;
265
266                                         // Shall we add this as well?
267                                         $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_user_refs` WHERE `userid`=%s AND `level`=%s AND `refid`=%s LIMIT 1",
268                                                 array(
269                                                         bigintval($userid),
270                                                         (bigintval($GLOBALS['refback_level']) - $minus),
271                                                         bigintval($GLOBALS['refback_refid'][$GLOBALS['refback_level']])
272                                                 ), __FUNCTION__, __LINE__);
273
274                                         // Do we have no entry?
275                                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . ($GLOBALS['refback_level'] - $minus) . ',minus=' . $minus . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']] . ',numRows=' . SQL_NUMROWS($result) . ' - BACK!');
276                                         if (SQL_HASZERONUMS($result)) {
277                                                 // Insert this level
278                                                 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_refs` (`userid`,`level`,`refid`) VALUES (%s,%s,%s)",
279                                                         array(
280                                                                 bigintval($userid),
281                                                                 ($GLOBALS['refback_level'] - $minus),
282                                                                 bigintval($GLOBALS['refback_refid'][$GLOBALS['refback_level']])
283                                                         ), __FUNCTION__, __LINE__);
284                                                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . ($GLOBALS['refback_level'] - $minus) . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']] . ' - RETURNED!');
285                                         } // END - if
286                                 } // END - if
287                         } // END - if
288                 } // END - while
289
290                 // Free memory
291                 SQL_FREERESULT($result_refid);
292         } // END - if
293
294         // When he has a referal...
295         if ((($GLOBALS['refback_refid'][$GLOBALS['refback_level']] == $userid) || ($GLOBALS['refback_refid'][$GLOBALS['refback_level']] == '0')) && (isExtensionInstalledAndNewer('cache', '0.1.2')) && (!isset($GLOBALS['refback_cached']))) {
296                 // Remove cache here
297                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']] . ' - CACHE!');
298                 if ($GLOBALS['cache_instance']->loadCacheFile('refback')) $GLOBALS['cache_instance']->removeCacheFile();
299                 $GLOBALS['refback_cached'] = 1;
300         } // END - if
301
302         // "Walk" back here
303         $GLOBALS['refback_level']--;
304         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',refback_level=' . $GLOBALS['refback_level'] .' - LEVEL!');
305
306         // Fix empty refid
307         if (!isset($GLOBALS['refback_refid'][$GLOBALS['refback_level']-1])) {
308                 $GLOBALS['refback_refid'][$GLOBALS['refback_level']-1] = '0';
309         } // END - if
310         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',refback_level=' . $GLOBALS['refback_level'] . ',ref=' . $GLOBALS['refback_refid'][$GLOBALS['refback_level']-1] . ' - EXIT!');
311 }
312
313 // "Getter" for array for user refs in given level
314 function getArrayFromRefbackUserRefs ($userid, $level) {
315         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ' - ENTERED!');
316         // Default is no refs and no nickname
317         $refs = array();
318
319         // Get refs from database
320         $result = SQL_QUERY_ESC("SELECT
321         r.`id`,
322         r.`refid`,
323         r.`refback`,
324         r.`points`,
325         d.`status`,
326         d.`joined`,
327         d.`refid` AS `level_refid`
328 FROM
329         `{?_MYSQL_PREFIX?}_user_refs` AS r
330 LEFT JOIN
331         `{?_MYSQL_PREFIX?}_user_data` AS d
332 ON
333         r.`refid`=d.`userid`
334 WHERE
335         r.`userid`=%s AND
336         r.`level`=%s
337 ORDER BY
338         r.`refid` ASC",
339                 array(bigintval($userid), bigintval($level)), __FUNCTION__, __LINE__);
340
341         // Are there some entries?
342         if (!SQL_HASZERONUMS($result)) {
343                 // Fetch all entries
344                 while ($row = SQL_FETCHARRAY($result)) {
345                         // Add row
346                         $refs[$row['id']] = $row;
347                 } // END - while
348         } // END - if
349
350         // Free result
351         SQL_FREERESULT($result);
352
353         // Return result
354         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',level=' . $level . ',refs()=' . count($refs) . ' - EXIT!');
355         return $refs;
356 }
357
358 // "Getter" for refback entry
359 function getArrayFromUserRefbackData ($id) {
360         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $id . ' - ENTERED!');
361         // Default data is nothing
362         $data = array();
363
364         // Secure id number
365         $id = bigintval($id);
366
367         // Get entry from database
368         $result = SQL_QUERY_ESC("SELECT `id`, `userid`, `refid`, `refback`, `level`, `points` FROM `{?_MYSQL_PREFIX?}_user_refs` WHERE `id`=%s AND `userid`=%s LIMIT 1",
369                 array($id, getMemberId()), __FUNCTION__, __LINE__);
370
371         // Is there an entry?
372         if (SQL_NUMROWS($result) == 1) {
373                 // Fetch data
374                 $data = SQL_FETCHARRAY($result);
375         } // END - if
376
377         // Free result
378         SQL_FREERESULT($result);
379
380         // Return entry
381         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $id . ',data()=' . count($data) . ' - EXIT!');
382         return $data;
383 }
384
385 // Update refback percents (but with some sanity-checks!
386 function updateMemberRefbackPercents ($id, $percents) {
387         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $id . ',percents=' . $percents . ' - ENTERED!');
388         // Default status is failed
389         $status['message'] = '{--MEMBER_REFBACK_ERROR_GENERAL--}';
390
391         // Do some sanity-checks
392         if (!isMember()) {
393                 // No member!
394                 $status['message'] = '{--MEMBER_REFBACK_ERROR_NO_MEMBER--}';
395                 return $status;
396         } elseif (''.$id.'' != ''.($id + 0).'') {
397                 // No number!
398                 $status['message'] = '{--MEMBER_REFBACK_ERROR_INVALID_ID_NUMBER--}';
399                 return $status;
400         } elseif (($percents < 0) || ($percents > 100)) {
401                 // Percentage is not valid!
402                 $status['message'] = '{--MEMBER_REFBACK_ERROR_INVALID_PERCENTAGE--}';
403                 return $status;
404         }
405
406         // Get ref entry
407         $dummy = getArrayFromUserRefbackData($id);
408
409         // Is this valid?
410         if (count($dummy) == 0) {
411                 // id does not belong to user!
412                 $status['message'] = '{--MEMBER_REFBACK_ERROR_ID_MISMATCH--}';
413                 return $status;
414         } // END - if
415
416         // Revert german commata
417         $percents = convertCommaToDot($percents);
418
419         // Update entry
420         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_refs` SET `refback`='%s' WHERE `id`=%s AND `userid`=%s LIMIT 1",
421                 array($percents, $id, getMemberId()), __FUNCTION__, __LINE__);
422
423         // Entry updated?
424         if (SQL_HASZEROAFFECTED()) {
425                 // Entry not updated!
426                 $status['message'] = '{--MEMBER_REFBACK_ERROR_NOT_UPDATED--}';
427                 return $status;
428         } // END - if
429
430         // Prepare email content
431         $dummy['percents'] = $percents;
432
433         // Load member email template
434         $mail = loadEmailTemplate('member_refback', $dummy, $dummy['refid']);
435
436         // Send email to user
437         sendEmail($dummy['refid'], '{--MEMBER_REFBACK_SUBJECT--}', $mail);
438
439         // Send admin notification
440         sendAdminNotification('{--ADMIN_REFBACK_SUBJECT--}', 'admin_refback', $dummy, getMemberId());
441
442         // All fine!
443         $status['ok'] = true;
444
445         // Return status array
446         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $id . ',percents=' . $percents . ' - EXIT!');
447         return $status;
448 }
449
450 // Checks wether refback is enabled
451 function isRefbackEnabled () {
452         // Do we have cache?
453         if (!isset($GLOBALS[__FUNCTION__])) {
454                 // Determine it
455                 $GLOBALS[__FUNCTION__] = (getConfig('refback_enabled') == 'Y');
456         } // END - if
457
458         // Return cache
459         return $GLOBALS[__FUNCTION__];
460 }
461
462 // [EOF]
463 ?>