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