]> git.mxchange.org Git - mailer.git/blob - inc/libs/sponsor_functions.php
Call-back function names shortened, __FUNCTION__ used:
[mailer.git] / inc / libs / sponsor_functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 04/23/2005 *
4  * ===================                          Last change: 05/18/2008 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : sponsor_functions.php                            *
8  * -------------------------------------------------------------------- *
9  * Short description : Functions for the sponsor area                   *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Funktionen fuer den Sponsorenbereich             *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * Needs to be in all Files and every File needs "svn propset           *
18  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
19  * -------------------------------------------------------------------- *
20  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
21  * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
22  * For more information visit: http://www.mxchange.org                  *
23  *                                                                      *
24  * This program is free software; you can redistribute it and/or modify *
25  * it under the terms of the GNU General Public License as published by *
26  * the Free Software Foundation; either version 2 of the License, or    *
27  * (at your option) any later version.                                  *
28  *                                                                      *
29  * This program is distributed in the hope that it will be useful,      *
30  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
32  * GNU General Public License for more details.                         *
33  *                                                                      *
34  * You should have received a copy of the GNU General Public License    *
35  * along with this program; if not, write to the Free Software          *
36  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
37  * MA  02110-1301  USA                                                  *
38  ************************************************************************/
39
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
42         die();
43 } // END - if
44
45 //
46 function handleSponsorRequest ($postData, $update=false, $messageArray=array(), $RET_STATUS=false) {
47         // Init a lot variables
48         $SAVE = true;
49         $UPDATE = false;
50         $skip = false;
51         $ALREADY = false;
52         $ret = 'unused';
53
54         // Skip these entries
55         $SKIPPED = array(
56                 'ok', 'edit', 'terms', 'pay_type'
57         );
58
59         // Save sponsor data
60         $DATA = array(
61                 'keys'   => array(),
62                 'values' => array()
63         );
64
65                 // Check if sponsor already exists
66                 foreach ($postData as $k => $v) {
67                         if (!(array_search($k, $SKIPPED) > -1)) {
68                                 // Check only posted input entries not the submit button
69                                 switch ($k)
70                                 {
71                                         case 'email':
72                                                 $ALREADY = false;
73                                                 if (!isEmailValid($v)) {
74                                                         // Email address is not valid
75                                                         $SAVE = false;
76                                                 } else {
77                                                         // Do we want to add a new sponsor or update his data?
78                                                         $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_sponsor_data` WHERE email='%s' LIMIT 1",
79                                                         array($postData['email']), __FUNCTION__, __LINE__);
80
81                                                         // Is a sponsor alread in the db?
82                                                         if (SQL_NUMROWS($result) == 1) {
83                                                                 // Yes, he is!
84                                                                 if ((getWhat() == 'add_sponsor') || ($update)) {
85                                                                         // Already found!
86                                                                         $ALREADY = true;
87                                                                 } else {
88                                                                         // Update his data
89                                                                         $UPDATE = true;
90                                                                 }
91                                                         }
92
93                                                         // Free memory
94                                                         SQL_FREERESULT($result);
95                                                 }
96                                                 break;
97
98                                         case 'pass1':
99                                                 $k = ''; $v = '';
100                                                 break;
101
102                                         case 'pass2':
103                                                 $k = 'password'; $v = md5($v);
104                                                 break;
105
106                                         case 'url':
107                                                 if (!isUrlValid($v)) $SAVE = false;
108                                                 break;
109
110                                         default:
111                                                 // Test if there is are time selections
112                                                 convertSelectionsToTimestamp($postData, $DATA, $k, $skip);
113                                                 break;
114                                 }
115
116                                 if ((!empty($k)) && ($skip == false)) {
117                                         // Add data
118                                         $DATA['keys'][] = $k; $DATA['values'][] = $v;
119                                 }
120                         }
121                 }
122
123                 // Save sponsor?
124                 if ($SAVE === true) {
125                         // Default is no force even when a guest want to abuse this force switch
126                         if ((empty($postData['force'])) || (!isAdmin())) $postData['force'] = '0';
127
128                         // SQL and message string is empty by default
129                         $sql = ''; $message = '';
130
131                         // Update?
132                         if ($UPDATE) {
133                                 // Update his data
134                                 $sql = "UPDATE `{?_MYSQL_PREFIX?}_sponsor_data` SET ";
135                                 foreach ($DATA['keys'] as $k => $v) {
136                                         $sql .= $v."='%s', ";
137                                 } // END - foreach
138
139                                 // Remove last ", " from SQL string
140                                 $sql = substr($sql, 0, -2)." WHERE `id`=%s LIMIT 1";
141                                 $DATA['values'][] = bigintval(getRequestParameter('id'));
142
143                                 // Generate message
144                                 $message = getMessageFromIndexedArray('{--ADMIN_SPONSOR_UPDATED--}', 'updated', $messageArray);
145                                 $ret = 'updated';
146                         } elseif (($ALREADY === false) || (($postData['force'] == 1) && (isAdmin()))) {
147                                 // Add new sponsor, first add more data
148                                 $DATA['keys'][] = 'status';
149                                 if (($update === true) && (isAdmin()) && (getWhat() == 'add_sponsor')) {
150                                         // Only allowed for admin
151                                         $DATA['values'][] = 'PENDING';
152
153                                         // Add remote IP address as well
154                                         $DATA['keys'][] = 'remote_addr';
155                                         $DATA['values'][] = detectRemoteAddr();
156                                 } else {
157                                         // Guest area
158                                         $DATA['values'][] = 'UNCONFIRMED';
159
160                                         // Generate hash code
161                                         $DATA['keys'][] = 'hash';
162                                         // @TODO Rewrite this to API function
163                                         $DATA['values'][] = md5(session_id().':'.$postData['email'].':'.detectRemoteAddr().':'.detectUserAgent().':'.time());
164                                         $DATA['keys'][] = 'remote_addr';
165                                         $DATA['values'][] = detectRemoteAddr();
166                                 }
167
168                                 // Search the entry
169                                 $key = array_search('force', $DATA['keys']);
170
171                                 // Remove force from both arrays
172                                 unset($DATA['keys'][$key]);
173                                 unset($DATA['values'][$key]);
174
175                                 // Implode all data into strings
176                                 $keyArray   = implode('`, `'  , $DATA['keys']);
177                                 $valueArray = str_repeat("%s', '", count($DATA['values']) - 1);
178
179                                 // Generate string
180                                 $sql = 'INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_data` (`' . $keyArray . "`) VALUES ('" . $valueArray . "%s')";
181
182                                 // Generate message
183                                 $message = getMessageFromIndexedArray('{--ADMIN_SPONSOR_ADDED--}', 'added', $messageArray);
184                                 $ret = 'added';
185                         } elseif (($update === true) && (isAdmin())) {
186                                 // Add all data as hidden data
187                                 $OUT = '';
188                                 foreach ($postData as $k => $v) {
189                                         // Do not add 'force' !
190                                         if ($k != 'force') {
191                                                 $OUT .= '<input type="hidden" name="' . secureString($k) . '" value="' . SQL_ESCAPE($v) . '" />';
192                                         } // END - if
193                                 } // END - foreach
194
195                                 // Remember data
196                                 $content['hidden'] = $OUT;
197                                 $content['email']  = $postData['email'];
198
199                                 // Ask for adding a sponsor with same email address
200                                 loadTemplate('admin_add_sponsor_already', false, $content);
201                                 return;
202                         } else {
203                                 // Already added!
204                                 $message = getMaskedMessage('SPONSOR_ALREADY_FOUND', $postData['email']);
205                                 $ret = 'already';
206                         }
207
208                         if (!empty($sql)) {
209                                 // Run SQL command
210                                 $result = SQL_QUERY_ESC($sql, $DATA['values'], __FUNCTION__, __LINE__);
211                         } // END - if
212                 } else {
213                         // Error found!
214                         $message = getMessageFromIndexedArray('{--SPONSOR_DATA_NOT_SAVED--}', 'failed', $messageArray);
215                         loadTemplate('admin_settings_saved', false, $message);
216                 }
217
218         // Always return the status
219         return $ret;
220 }
221
222 //
223 function sponsorTranslateUserStatus ($status) {
224         // Construct constant name
225         $constantName = sprintf("ACCOUNT_STATUS_%s", $status);
226
227         // Is the constant there?
228         if (isMessageIdValid($constantName)) {
229                 // Then use it
230                 $ret = getMessage($constantName);
231         } else {
232                 // Not found!
233                 /* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
234                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
235                 $ret = getMaskedMessage('ACCOUNT_STATUS_UNKNOWN_STATUS', $status);
236         }
237
238         // Return status
239         return $ret;
240 }
241
242 // Search for an email address in the database
243 function isSponsorRegisteredWithEmail ($email) {
244         // Do we already have the provided email address in our DB?
245         $ret = (countSumTotalData($email, 'sponsor_data', 'id', 'email', true) == 1);
246
247         // Return result
248         return $ret;
249 }
250
251 // Wether the current user is a sponsor
252 function isSponsor () {
253         // Failed is default
254         $ret = false;
255
256         // Determine it
257         $ret = (
258                 (isSessionVariableSet('sponsor_id')) &&
259                 (isSessionVariableSet('sponsor_pass')) &&
260                 (fetchSponsorData(getSession('sponsor_id')))
261         );
262
263         // Return status
264         return $ret;
265 }
266
267 //
268 function addSponsorMenu ($current) {
269         $OUT = '';
270         $WHERE = " AND `active`='Y'";
271         if (isAdmin()) $WHERE = '';
272
273         // Load main menu entries
274         $result_main = SQL_QUERY("SELECT
275         `action` AS `main_action`, `title` AS `main_title`
276 FROM
277         `{?_MYSQL_PREFIX?}_sponsor_menu`
278 WHERE
279         (`what`='' OR `what` IS NULL)
280         " . $WHERE . "
281 ORDER BY
282         `sort` ASC", __FUNCTION__, __LINE__);
283         if (!SQL_HASZERONUMS($result_main)) {
284                 // Load every menu and it's sub menus
285                 while ($content = SQL_FETCHARRAY($result_main)) {
286                         // Load sub menus
287                         $result_sub = SQL_QUERY_ESC("SELECT
288         `what` AS `sub_what`, `title` AS `sub_title`
289 FROM
290         `{?_MYSQL_PREFIX?}_sponsor_menu`
291 WHERE
292         `action`='%s' AND
293         `what` != '' AND
294         `what` IS NOT NULL
295         " . $WHERE . "
296 ORDER BY
297         `sort` ASC",
298                         array($content['main_action']), __FUNCTION__, __LINE__);
299                         if (!SQL_HASZERONUMS($result_sub)) {
300                                 // Load sub menus
301                                 $SUB = '';
302                                 while ($content2 = SQL_FETCHARRAY($result_sub)) {
303                                         // Check if current selected menu is matching the loaded one
304                                         if ($current == $content2['sub_what']) $content2['sub_title'] = '<strong>' . $content2['sub_title'] . '</strong>';
305
306                                         // Load row template
307                                         $SUB .= loadTemplate('sponsor_what', true, $content2);
308                                 } // END - while
309
310                                 // Prepare data for the main template
311                                 $content['menu'] = $SUB;
312
313                                 // Load menu template
314                                 $OUT .= loadTemplate('sponsor_action', true, $content);
315                         } else {
316                                 // No sub menus active
317                                 $OUT .= loadTemplate('admin_settings_saved', true, '{--SPONSOR_NO_SUB_MENUS_ACTIVE--}');
318                         }
319
320                         // Free memory
321                         SQL_FREERESULT($result_sub);
322                 } // END - while
323         } else {
324                 // No main menus active
325                 $OUT .= loadTemplate('admin_settings_saved', true, '{--SPONSOR_NO_MAIN_MENUS_ACTIVE--}');
326         }
327
328         // Free memory
329         SQL_FREERESULT($result_main);
330
331         // Return content
332         return $OUT;
333 }
334
335 //
336 function addSponsorContent ($what) {
337         // Init sponsor content
338         $GLOBALS['sponsor_output'] = '';
339
340         // Generate IFN (Include FileName)
341         $INC = sprintf("inc/modules/sponsor/%s.php", $what);
342         if (isIncludeReadable($INC)) {
343                 // Every sponsor action will output nothing directly. It will be written into $GLOBALS['sponsor_output']!
344                 loadIncludeOnce($INC);
345         } else {
346                 // File not found!
347                 $GLOBALS['sponsor_output'] .= loadTemplate('admin_settings_saved', true, getMaskedMessage('SPONSOR_CONTENT_404', $what));
348         }
349
350         // Return content
351         return $GLOBALS['sponsor_output'];
352 }
353
354 //
355 function updateSponsorLogin () {
356         // Failed by default
357         $login = false;
358
359         // Is sponsor?
360         if (isSponsor()) {
361                 // Update last online timestamp
362                 SQL_QUERY_ESC("UPDATE
363         `{?_MYSQL_PREFIX?}_sponsor_data`
364 SET
365         `last_online`=NOW()
366 WHERE
367         `id`=%s AND
368         `password`='%s'
369 LIMIT 1",
370                         array(
371                                 bigintval(getSession('sponsor_id')),
372                                 getSession('sponsor_pass')
373                         ), __FUNCTION__, __LINE__);
374
375                 // This update went fine?
376                 $login = (SQL_AFFECTEDROWS() == 1);
377         } // END - if
378
379         // Return status
380         return $login;
381 }
382
383 // Saves sponsor's data
384 function saveSponsorData ($postData, $content) {
385         $EMAIL = false;
386
387         // Unsecure data which we don't want
388         $UNSAFE = array('password', 'id', 'remote_addr', 'sponsor_created', 'last_online', 'status', 'ref_count',
389                         'points_amount', 'points_used', 'refid', 'hash', 'last_pay', 'last_curr', 'pass_old',
390                         'ok', 'pass1', 'pass2');
391
392         // Set default message ("not saved")
393         $message = '{--SPONSOR_ACCOUNT_DATA_NOT_SAVED--}';
394
395         // Check for submitted passwords
396         if ((!empty($postData['pass1'])) && (!empty($postData['pass2']))) {
397                 // Are both passwords the same?
398                 if ($postData['pass1'] == $postData['pass2']) {
399                         // Okay, then set password and remove pass1 and pass2
400                         $postData['password'] = md5($postData['pass1']);
401                 } // END - if
402         } // END - if
403
404         // Remove all (maybe spoofed) unsafe data from array
405         foreach ($UNSAFE as $remove) {
406                 unset($postData[$remove]);
407         } // END - foreach
408
409         // This array is for the submitted data which we will use with the SQL_QUERY_ESC() function to
410         // secure the data
411         $DATA = array();
412
413         // Prepare SQL string
414         $sql = "UPDATE `{?_MYSQL_PREFIX?}_sponsor_data` SET";
415         foreach ($postData as $key => $value) {
416                 // Mmmmm, too less security here???
417                 $sql   .= " `" . secureString($key) . "`='%s',";
418
419                 // We will secure this later inside the SQL_QUERY_ESC() function
420                 $DATA[] = secureString($value);
421         } // END - foreach
422
423         // Check if email has changed
424         if ((!empty($content['email'])) && (!empty($postData['email']))) {
425                 if ($content['email'] != $postData['email']) {
426                         // Change email address
427                         $EMAIL = true;
428
429                         // Okay, has changed then add status with UNCONFIRMED and new hash code
430                         $sql .= " `status`='EMAIL', `hash`='%s',";
431
432                         // Generate hash code
433                         // @TODO Rewrite this to API function
434                         $HASH = md5(session_id() . ':' . $postData['email'] . ':' . detectRemoteAddr() . ':' . detectUserAgent() . ':' . time());
435                         $DATA[] = $HASH;
436                 } // END - if
437         } // END - if
438         // Remove last commata
439         $sql = substr($sql, 0, -1);
440
441         // Add last_change
442         $sql .= ', `last_change`=NOW()';
443
444         // Add SQL tail data
445         $sql .= " WHERE `id`=%s AND `password`='%s' LIMIT 1";
446         $DATA[] = bigintval(getSession('sponsor_id'));
447         $DATA[] = getSession('sponsor_pass');
448
449         // Saving data was completed... ufff...
450         switch (getWhat()) {
451                 case 'account': // Change account data
452                         if ($EMAIL === true) {
453                                 $message = '{--SPONSOR_ACCOUNT_EMAIL_CHANGED--}';
454                                 $templ   = 'admin_sponsor_change_email';
455                                 $subj    = '{--ADMIN_SPONSOR_ACC_EMAIL_SUBJECT--}';
456                         } else {
457                                 $message = '{--SPONSOR_ACCOUNT_DATA_SAVED--}';
458                                 $templ   = 'admin_sponsor_change_data';
459                                 $subj    = '{--ADMIN_SPONSOR_ACC_DATA_SUBJECT--}';
460                         }
461                         break;
462
463                 case 'settings': // Change settings
464                         // Set message template and subject for admin
465                         $message = '{--SPONSOR_SETTINGS_SAVED--}';
466                         $templ   = 'admin_sponsor_settings';
467                         $subj    = '{--ADMIN_SPONSOR_SETTINGS_SUBJECT--}';
468                         break;
469
470                 default: // Unknown sponsor what value!
471                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown sponsor module (what) %s detected.", getWhat()));
472                         $message = getMaskedMessage('SPONSOR_UNKNOWN_WHAT', getWhat());
473                         $templ   = '';
474                         $subj    = '';
475                         break;
476         } // END - switch
477
478         // Has an entry updated?
479         if (SQL_AFFECTEDROWS() == 1) {
480                 // Template and subject are set?
481                 if (!empty($templ) && !empty($subj)) {
482                         // Run SQL command and check for success
483                         $result = SQL_QUERY_ESC($sql, $DATA, __FUNCTION__, __LINE__);
484
485                         // Add all data to content
486                         $content['new_data'] = $postData;
487
488                         // Send email to admins
489                         sendAdminNotification($subj, $templ, $content);
490
491                         // Shall we send mail to the sponsor's new email address?
492                         if ($content['receive_warnings'] == 'Y') {
493                                 /*
494                                  * Okay send email with confirmation link to new address and with no confirmation link
495                                  * to the old address.
496                                  */
497
498                                 // First to old address
499                                 switch (getWhat()) {
500                                         case 'account': // Change account data
501                                                 $email_msg = loadEmailTemplate('sponsor_change_data', $content);
502                                                 sendEmail($content['email'], '{--SPONSOR_ACC_DATA_SUBJECT--}', $email_msg);
503
504                                                 if ($EMAIL === true) {
505                                                         // Add hash code to content array
506                                                         $content['hash'] = $HASH;
507
508                                                         // Second mail goes to the new address
509                                                         $email_msg = loadEmailTemplate('sponsor_change_email', $content);
510                                                         sendEmail($content['email'], '{--SPONSOR_ACC_EMAIL_SUBJECT--}', $email_msg);
511                                                 } // END - if
512                                                 break;
513
514                                         case 'settings': // Change settings
515                                                 // Send email
516                                                 $email_msg = loadEmailTemplate('sponsor_settings', $content);
517                                                 sendEmail($content['email'], '{--SPONSOR_SETTINGS_SUBJECT--}', $email_msg);
518                                                 break;
519                                 } // END - switch
520                         } // END - if
521                 } // END - if
522         } // END - if
523
524         // Return final message
525         return $message;
526 }
527
528 // Create email link to sponsor's account
529 function generateSponsorEmailLink ($email, $mod = 'admin') {
530         // Show contact link only if sponsor is confirmed by default
531         $locked = " AND `status`='CONFIRMED'";
532
533         // But admins shall always see it
534         if (isAdmin()) $locked = '';
535
536         $result = SQL_QUERY_ESC("SELECT
537         `id`
538 FROM
539         `{?_MYSQL_PREFIX?}_sponsor_data`
540 WHERE
541         `email`='%s'" . $locked."
542 LIMIT 1",
543                 array($email), __FUNCTION__, __LINE__);
544         if (SQL_NUMROWS($result) == 1) {
545                 // Load sponsor_id
546                 list($sponsor_id) = SQL_FETCHROW($result);
547
548                 // Rewrite email address to contact link
549                 $email = '{%url=modules.php?module=' . $mod . '&amp;what=sponsor_contct&amp;sponsor_id=' . bigintval($sponsor_id) . '%}';
550         } // END - if
551
552         // Free memory
553         SQL_FREERESULT($result);
554
555         // Return rewritten (?) email address
556         return $email;
557 }
558
559 // Processes a sponsor request and handles it
560 function doProcessSponsorFormRequest ($messageArray = array()) {
561         // Default message
562         $message = '';
563
564         // Handle the request
565         $status = handleSponsorRequest(postRequestArray(), true, $messageArray, true);
566
567         // Check the status of the registration process
568         switch ($status) {
569                 case 'added': // Sponsor successfully added with account status = UNCONFIRMED!
570                         // Check for his id number
571                         $result = SQL_QUERY_ESC("SELECT `id`, `hash` FROM `{?_MYSQL_PREFIX?}_sponsor_data` WHERE `email`='%s' LIMIT 1",
572                                 array(postRequestParameter('email')), __FUNCTION__, __LINE__);
573                         if (SQL_NUMROWS($result) == 1) {
574                                 // id found so let's load it for the confirmation email
575                                 list($id, $hash) = SQL_FETCHROW($result);
576
577                                 // Prepare data for the email template
578                                 $content['id']        = $id;
579                                 $content['hash']      = $hash;
580                                 $content['email']     = secureString(postRequestParameter('email'));
581                                 $content['surname']   = secureString(postRequestParameter('surname'));
582                                 $content['family']    = secureString(postRequestParameter('family'));
583                                 $content['timestamp'] = generateDateTime(time(), 0);
584                                 $content['password']  = secureString(postRequestParameter('pass1'));
585
586                                 // Generate email and send it to the new sponsor
587                                 $message = loadEmailTemplate('sponsor_confirm', $content, $id);
588                                 sendEmail(postRequestParameter('email'), '{--SPONSOR_PLEASE_CONFIRM_SUBJECT--}', $message);
589
590                                 // Send mail to admin
591                                 sendAdminNotification('{--ADMIN_NEW_SPONSOR--}', 'admin_sponsor_reg', $content);
592
593                                 // Output message: DONE
594                                 $message = $messageArray['added'];
595                         } else {
596                                 // Sponsor account not found???
597                                 $message = getMaskedMessage('SPONSOR_EMAIL_404', postRequestParameter('email'));
598                         }
599
600                         // Free memory
601                         SQL_FREERESULT($result);
602                         break;
603
604                 default:
605                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
606                         if (!isAdmin()) {
607                                 // Message for testing admin
608                                 $message = getMaskedMessage('ADMIN_SPONSOR_UNKNOWN_STATUS', $status);
609                         } else {
610                                 // Message for the guest
611                                 $message = getMaskedMessage('SPONSOR_UNKNOWN_STATUS', $status);
612                         }
613                         break;
614         }
615
616         // Return message
617         return $message;
618 }
619
620 // Expression call-back function for fetching sponsor data
621 function doExpressionSponsor ($data) {
622         // Use current sponsor_id by default
623         $functionName = 'getSponsorId()';
624
625         // Sponsor-related data, so is there a sponsor_id?
626         if (!empty($data['matches'][4][$data['key']])) {
627                 // Do we have a sponsor_id or $sponsor_id?
628                 if ($data['matches'][4][$data['key']] == '$userid') {
629                         // Use dynamic call
630                         $functionName = "getFetchedSponsorData('id', \$userid, '" . $data['callback'] . "')";
631                 } elseif (!empty($data['matches'][4][$data['key']])) {
632                         // Sponsor data found
633                         $functionName = "getFetchedSponsorData('id', " . $data['matches'][4][$data['key']] . ", '" . $data['callback'] . "')";
634                 }
635         } elseif ((!empty($data['callback'])) && (isSponsorDataValid())) {
636                 // "Call-back" alias column for current logged in sponsor's data
637                 $functionName = "getSponsorData('" . $data['callback'] . "')";
638         }
639
640         // Do we have another function to run (e.g. translations)
641         if (!empty($data['extra_func'])) {
642                 // Surround the original function call with it
643                 $functionName = $data['extra_func'] . '(' . $functionName . ')';
644         } // END - if
645
646         // Generate replacer
647         $replacer = '{DQUOTE} . ' . $functionName . ' . {DQUOTE}';
648
649         // Now replace the code
650         $code = replaceExpressionCode($data, $replacer);
651
652         // Return replaced code
653         return $code;
654 }
655
656 // Fetch sponsor data for given sponsor id
657 function fetchSponsorData ($sponsor_id, $column = 'id') {
658         // If we should look for sponsor_id secure&set it here
659         if ($column == 'id') {
660                 // Secure sponsor_id
661                 $sponsor_id = bigintval($sponsor_id);
662
663                 // Set it here
664                 setCurrentSponsorId($sponsor_id);
665
666                 // Don't look for invalid sponsor_ids...
667                 if (!isValidUserId($sponsor_id)) {
668                         // Invalid, so abort here
669                         debug_report_bug(__FUNCTION__, __LINE__, 'Sponsor id ' . $sponsor_id . ' is invalid.');
670                 } elseif (isSponsorDataValid()) {
671                         // Use cache, so it is fine
672                         return true;
673                 }
674         } elseif (isSponsorDataValid()) {
675                 // Use cache, so it is fine
676                 return true;
677         }
678
679         // By default none was found
680         $found = false;
681
682         // Extra statements
683         $ADD = '';
684
685         // Query for the sponsor
686         $result = SQL_QUERY_ESC("SELECT *".$ADD." FROM `{?_MYSQL_PREFIX?}_sponsor_data` WHERE `%s`='%s' LIMIT 1",
687                 array($column, $sponsor_id), __FUNCTION__, __LINE__);
688
689         // Do we have a record?
690         if (SQL_NUMROWS($result) == 1) {
691                 // Load data from cookies
692                 $data = SQL_FETCHARRAY($result);
693
694                 // Set the sponsor_id for later use
695                 setCurrentSponsorId($data['id']);
696                 $GLOBALS['sponsor_data'][getCurrentSponsorId()] = $data;
697
698                 // Rewrite 'last_failure' if found
699                 if (isset($GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'])) {
700                         // Backup the raw one and zero it
701                         $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure_raw'] = $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'];
702                         $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'] = '0';
703
704                         // Is it not zero?
705                         if ($GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure_raw'] != '0000-00-00 00:00:00') {
706                                 // Seperate data/time
707                                 $array = explode(' ', $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure_raw']);
708
709                                 // Seperate data and time again
710                                 $array['date'] = explode('-', $array[0]);
711                                 $array['time'] = explode(':', $array[1]);
712
713                                 // Now pass it to mktime()
714                                 $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'] = mktime(
715                                         $array['time'][0],
716                                         $array['time'][1],
717                                         $array['time'][2],
718                                         $array['date'][1],
719                                         $array['date'][2],
720                                         $array['date'][0]
721                                 );
722                         } // END - if
723                 } // END - if
724
725                 // Found, but valid?
726                 $found = isSponsorDataValid();
727         } // END - if
728
729         // Free memory
730         SQL_FREERESULT($result);
731
732         // Return result
733         return $found;
734 }
735
736 // Wrapper for fetchSponsorData() and getSponsorData() calls
737 function getFetchedSponsorData ($keyColumn, $sponsor_id, $valueColumn) {
738         // Zero ids are not valid
739         if ($sponsor_id == 0) {
740                 // Abort here
741                 debug_report_bug(__FUNCTION__, __LINE__, 'Zero sponsor_id provided');
742         } // END - if
743
744         // Is it cached?
745         if (!isset($GLOBALS['sponsor_data_cache'][$sponsor_id][$keyColumn][$valueColumn])) {
746                 // Default is empty
747                 $data = '';
748
749                 // Can we fetch the sponsor data?
750                 if ((isValidSponsorId($sponsor_id)) && (fetchSponsorData($sponsor_id, $keyColumn))) {
751                         // Now get the data back
752                         $data = getSponsorData($valueColumn);
753                 } // END - if
754
755                 // Cache it
756                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cached:id=' . $sponsor_id . ',keyColumn=' . $keyColumn . ',valueColumn=' . $valueColumn . ',data=' . $data);
757                 $GLOBALS['sponsor_data_cache'][$sponsor_id][$keyColumn][$valueColumn] = $data;
758         } // END - if
759
760         // Return it
761         return $GLOBALS['sponsor_data_cache'][$sponsor_id][$keyColumn][$valueColumn];
762 }
763
764 // Checks if the sponsor data is valid, this may indicate that the sponsor has logged
765 // in, but you should use isMember() if you want to find that out.
766 function isSponsorDataValid () {
767         // Sponsor id should not be zero so abort here
768         if (!isCurrentSponsorIdSet()) return false;
769
770         // Is it cached?
771         if (!isset($GLOBALS['is_sponsor_data_valid'][getCurrentSponsorId()])) {
772                 // Determine it
773                 $GLOBALS['is_sponsor_data_valid'][getCurrentSponsorId()] = ((isset($GLOBALS['sponsor_data'][getCurrentSponsorId()])) && (count($GLOBALS['sponsor_data'][getCurrentSponsorId()]) > 1));
774         } // END - if
775
776         // Return the result
777         return $GLOBALS['is_sponsor_data_valid'][getCurrentSponsorId()];
778 }
779
780 // Setter for current sponsor_id
781 function setCurrentSponsorId ($sponsor_id) {
782         // Set sponsor_id
783         $GLOBALS['current_sponsor_id'] = bigintval($sponsor_id);
784
785         // Unset it to re-determine the actual state
786         unset($GLOBALS['is_sponsor_data_valid'][$sponsor_id]);
787 }
788
789 // Getter for current sponsor_id
790 function getCurrentSponsorId () {
791         // Sponsorid must be set before it can be used
792         if (!isCurrentSponsorIdSet()) {
793                 // Not set
794                 debug_report_bug(__FUNCTION__, __LINE__, 'Sponsor id is not set.');
795         } // END - if
796
797         // Return the sponsor_id
798         return $GLOBALS['current_sponsor_id'];
799 }
800
801 // Checks if current sponsor_id is set
802 function isCurrentSponsorIdSet () {
803         return ((isset($GLOBALS['current_sponsor_id'])) && (isValidSponsorId($GLOBALS['current_sponsor_id'])));
804 }
805
806 // Is given sponsor_id valid?
807 function isValidSponsorId ($sponsor_id) {
808         // Do we have cache?
809         if (!isset($GLOBALS['is_valid_sponsor_id'][$sponsor_id])) {
810                 // Check it out
811                 $GLOBALS['is_valid_sponsor_id'][$sponsor_id] = ((!is_null($sponsor_id)) && (!empty($sponsor_id)) && ($sponsor_id > 0));
812         } // END - if
813
814         // Return cache
815         return $GLOBALS['is_valid_sponsor_id'][$sponsor_id];
816 }
817
818 // Getter for sponsor data
819 function getSponsorData ($column) {
820         // Sponsor id should not be zero
821         if (!isValidUserId(getCurrentSponsorId())) {
822                 debug_report_bug(__FUNCTION__, __LINE__, 'Sponsor id is zero.');
823         } // END - if
824
825         // Return the value
826         return $GLOBALS['sponsor_data'][getCurrentSponsorId()][$column];
827 }
828
829 // Determines the country of the given sponsor id
830 function determineSponsorCountry ($sponsor_id) {
831         // Then handle it over
832         $country = getSponsorData('country');
833
834         // Return it
835         return $country;
836 }
837
838 // Destroy sponsor session
839 function destroySponsorSession () {
840         // Remove all user data from session
841         return ((setSession('sponsor_id', '')) && (setSession('sponsor_pass', '')));
842 }
843
844 // [EOF]
845 ?>