Rewrote 'we' word a little, rewrote mail order to use SQL_INSERTID() instead of anoth...
[mailer.git] / inc / libs / sponsor_functions.php
index c6cd2e5b346215a95e884d2022ddcd71f62c4bac..3e5909476677b783bf26173550e8b80e698556aa 100644 (file)
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
 // Some security stuff...
 if (!defined('__SECURITY')) {
        die();
-}
+} // END - if
 
 //
-function handlSponsorRequest (&$postData, $update=false, $messageArray=array(), $RET_STATUS=false) {
+function handleSponsorRequest ($postData, $update=false, $messageArray = array(), $RET_STATUS=false) {
        // Init a lot variables
        $SAVE = true;
        $UPDATE = false;
        $skip = false;
        $ALREADY = false;
-       $ret = "unused";
+       $ret = 'unused';
 
        // Skip these entries
        $SKIPPED = array(
@@ -66,23 +64,22 @@ function handlSponsorRequest (&$postData, $update=false, $messageArray=array(),
                foreach ($postData as $k => $v) {
                        if (!(array_search($k, $SKIPPED) > -1)) {
                                // Check only posted input entries not the submit button
-                               switch ($k)
-                               {
+                               switch ($k) {
                                        case 'email':
                                                $ALREADY = false;
                                                if (!isEmailValid($v)) {
                                                        // Email address is not valid
                                                        $SAVE = false;
                                                } else {
-                                                       // Do we want to add a new sponsor or update his data?
+                                                       // Add a new sponsor or update his data?
                                                        $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_sponsor_data` WHERE email='%s' LIMIT 1",
-                                                       array($postData['email']), __FUNCTION__, __LINE__);
+                                                               array($postData['email']), __FUNCTION__, __LINE__);
 
                                                        // Is a sponsor alread in the db?
                                                        if (SQL_NUMROWS($result) == 1) {
                                                                // Yes, he is!
                                                                if ((getWhat() == 'add_sponsor') || ($update)) {
-                                                                       // Already found!
+                                                                       // Already found
                                                                        $ALREADY = true;
                                                                } else {
                                                                        // Update his data
@@ -104,21 +101,25 @@ function handlSponsorRequest (&$postData, $update=false, $messageArray=array(),
                                                break;
 
                                        case 'url':
-                                               if (!isUrlValid($v)) $SAVE = false;
+                                               if (!isUrlValid($v)) {
+                                                       // Don't save the URL
+                                                       $SAVE = false;
+                                               } // END - if
                                                break;
 
                                        default:
                                                // Test if there is are time selections
-                                               convertSelectionsToTimestamp($postData, $DATA, $k, $skip);
+                                               convertSelectionsToEpocheTime($postData, $DATA, $k, $skip);
                                                break;
-                               }
+                               } // END - switch
 
                                if ((!empty($k)) && ($skip == false)) {
                                        // Add data
-                                       $DATA['keys'][] = $k; $DATA['values'][] = $v;
-                               }
-                       }
-               }
+                                       array_push($DATA['keys']  , $k);
+                                       array_push($DATA['values'], $v);
+                               } // END - if
+                       } // END - if
+               } // END - foreach
 
                // Save sponsor?
                if ($SAVE === true) {
@@ -134,35 +135,46 @@ function handlSponsorRequest (&$postData, $update=false, $messageArray=array(),
                                $sql = "UPDATE `{?_MYSQL_PREFIX?}_sponsor_data` SET ";
                                foreach ($DATA['keys'] as $k => $v) {
                                        $sql .= $v."='%s', ";
-                               }
+                               } // END - foreach
 
                                // Remove last ", " from SQL string
-                               $sql = substr($sql, 0, -2)." WHERE `id`='%s' LIMIT 1";
-                               $DATA['values'][] = bigintval(getRequestParameter('id'));
+                               $sql = substr($sql, 0, -2)." WHERE `id`=%s LIMIT 1";
+                               array_push($DATA['values'], bigintval(getRequestElement('id')));
 
                                // Generate message
                                $message = getMessageFromIndexedArray('{--ADMIN_SPONSOR_UPDATED--}', 'updated', $messageArray);
                                $ret = 'updated';
                        } elseif (($ALREADY === false) || (($postData['force'] == 1) && (isAdmin()))) {
                                // Add new sponsor, first add more data
-                               $DATA['keys'][] = 'sponsor_created'; $DATA['values'][] = time();
-                               $DATA['keys'][] = 'status';
+                               array_push($DATA['keys'], 'status');
                                if (($update === true) && (isAdmin()) && (getWhat() == 'add_sponsor')) {
                                        // Only allowed for admin
-                                       $DATA['values'][] = 'PENDING';
+                                       array_push($DATA['values'], 'PENDING');
+
+                                       // Add remote IP address as well
+                                       array_push($DATA['keys'], 'remote_addr');
+                                       array_push($DATA['values'], detectRemoteAddr());
                                } else {
                                        // Guest area
-                                       $DATA['values'][] = 'UNCONFIRMED';
+                                       array_push($DATA['values'], 'UNCONFIRMED');
 
                                        // Generate hash code
-                                       $DATA['keys'][] = 'hash';
-                                       $DATA['values'][] = md5(session_id().':'.$postData['email'].':'.detectRemoteAddr().':'.detectUserAgent().':'.time());
-                                       $DATA['keys'][] = 'remote_addr';
-                                       $DATA['values'][] = detectRemoteAddr();
+                                       array_push($DATA['keys'], 'hash');
+                                       // @TODO Rewrite this to API function
+                                       array_push($DATA['values'], md5(session_id() . getEncryptSeparator() . $postData['email'] . getEncryptSeparator() . detectRemoteAddr() . getEncryptSeparator() . detectUserAgent() . getEncryptSeparator() . time()));
+                                       array_push($DATA['keys'], 'remote_addr');
+                                       array_push($DATA['values'], detectRemoteAddr());
                                }
 
+                               // Search the entry
+                               $key = array_search('force', $DATA['keys']);
+
+                               // Remove force from both arrays
+                               unset($DATA['keys'][$key]);
+                               unset($DATA['values'][$key]);
+
                                // Implode all data into strings
-                               $keyArray   = implode('`, `'  , $DATA['keys']);
+                               $keyArray   = implode('`,`'  , $DATA['keys']);
                                $valueArray = str_repeat("%s', '", count($DATA['values']) - 1);
 
                                // Generate string
@@ -190,7 +202,7 @@ function handlSponsorRequest (&$postData, $update=false, $messageArray=array(),
                                return;
                        } else {
                                // Already added!
-                               $message = getMaskedMessage('SPONSOR_ALREADY_FOUND', $postData['email']);
+                               $message = '{%message,SPONSOR_ALREADY_FOUND=' . $postData['email'] . '%}';
                                $ret = 'already';
                        }
 
@@ -198,41 +210,39 @@ function handlSponsorRequest (&$postData, $update=false, $messageArray=array(),
                                // Run SQL command
                                $result = SQL_QUERY_ESC($sql, $DATA['values'], __FUNCTION__, __LINE__);
                        } // END - if
-
-                       // Output message
-                       if (($update === true) && (isAdmin())) {
-                               loadTemplate('admin_settings_saved', false, $message);
-                       } // END - if
                } else {
-                       // Error found!
+                       // Error detected
                        $message = getMessageFromIndexedArray('{--SPONSOR_DATA_NOT_SAVED--}', 'failed', $messageArray);
-                       loadTemplate('admin_settings_saved', false, $message);
+                       displayMessage($message);
                }
 
-               // Shall we return the status?
-               if ($RET_STATUS === true) return $ret;
+       // Always return the status
+       return $ret;
 }
 
-//
-function sponsorTranslateUserStatus ($status) {
+// Translate the account status
+function translateSponsorStatus ($status) {
        // Construct constant name
-       $constantName = sprintf("ACCOUNT_%s", $status);
+       $constantName = sprintf("ACCOUNT_STATUS_%s", $status);
 
        // Is the constant there?
-       if (defined($constantName)) {
+       if (isMessageIdValid($constantName)) {
                // Then use it
-               $ret = constant($constantName);
+               $ret = getMessage($constantName);
        } else {
-               // Not found!
+               // Not found
+               //* DEBUG: */ reportBug(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
                logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
-               $ret = getMaskedMessage('UNKNOWN_STATUS', $status);
+               $ret = '{%message,ACCOUNT_STATUS_UNKNOWN=' . $status . '%}';
        }
+
+       // Return status
        return $ret;
 }
 
 // Search for an email address in the database
 function isSponsorRegisteredWithEmail ($email) {
-       // Do we already have the provided email address in our DB?
+       // Is there already the provided email address in database?
        $ret = (countSumTotalData($email, 'sponsor_data', 'id', 'email', true) == 1);
 
        // Return result
@@ -241,29 +251,15 @@ function isSponsorRegisteredWithEmail ($email) {
 
 // Wether the current user is a sponsor
 function isSponsor () {
-       // Failed...
+       // Failed is default
        $ret = false;
-       if ((isSessionVariableSet('sponsorid')) && (isSessionVariableSet('sponsorpass'))) {
-               // Check cookies against database records...
-               $result = SQL_QUERY_ESC("SELECT
-       `id`
-FROM
-       `{?_MYSQL_PREFIX?}_sponsor_data`
-WHERE
-       `id`='%s' AND `password`='%s' AND `status`='CONFIRMED'
-LIMIT 1",
-                       array(
-                               bigintval(getSession('sponsorid')),
-                               getSession('sponsorpass')
-                       ), __FUNCTION__, __LINE__);
-               if (SQL_NUMROWS($result) == 1) {
-                       // All is fine
-                       $ret = true;
-               } // END - if
 
-               // Free memory
-               SQL_FREERESULT($result);
-       } // END - if
+       // Determine it
+       $ret = (
+               (isSessionVariableSet('sponsor_id')) &&
+               (isSessionVariableSet('sponsor_pass')) &&
+               (fetchSponsorData(getSession('sponsor_id')))
+       );
 
        // Return status
        return $ret;
@@ -277,7 +273,8 @@ function addSponsorMenu ($current) {
 
        // Load main menu entries
        $result_main = SQL_QUERY("SELECT
-       `action` AS `main_action`, `title` AS `main_title`
+       `action` AS `main_action`,
+       `title` AS `main_title`
 FROM
        `{?_MYSQL_PREFIX?}_sponsor_menu`
 WHERE
@@ -290,7 +287,8 @@ ORDER BY
                while ($content = SQL_FETCHARRAY($result_main)) {
                        // Load sub menus
                        $result_sub = SQL_QUERY_ESC("SELECT
-       `what` AS `sub_what`, `title` AS `sub_title`
+       `what` AS `sub_what`,
+       `title` AS `sub_title`
 FROM
        `{?_MYSQL_PREFIX?}_sponsor_menu`
 WHERE
@@ -305,41 +303,29 @@ ORDER BY
                                // Load sub menus
                                $SUB = '';
                                while ($content2 = SQL_FETCHARRAY($result_sub)) {
-                                       // Merge both arrays
-                                       $content = merge_array($content, $content2);
-
                                        // Check if current selected menu is matching the loaded one
-                                       if ($current == $content['sub_what']) $content['sub_title'] = '<strong>' . $content['sub_title'] . '</strong>';
-
-                                       // Prepare data for the sub template
-                                       $content = array(
-                                               'what'  => $content['sub_what'],
-                                               'title' => $content['sub_title']
-                                       );
+                                       if ($current == $content2['sub_what']) $content2['sub_title'] = '<strong>' . $content2['sub_title'] . '</strong>';
 
                                        // Load row template
-                                       $SUB .= loadTemplate('sponsor_what', true, $content);
-                               }
+                                       $SUB .= loadTemplate('sponsor_what', true, $content2);
+                               } // END - while
 
                                // Prepare data for the main template
-                               $content = array(
-                                       'title' => $content['main_title'],
-                                       'menu'  => $SUB
-                               );
+                               $content['menu'] = $SUB;
 
                                // Load menu template
                                $OUT .= loadTemplate('sponsor_action', true, $content);
                        } else {
                                // No sub menus active
-                               $OUT .= loadTemplate('admin_settings_saved', true, '{--SPONSOR_NO_SUB_MENUS_ACTIVE--}');
+                               $OUT .= displayMessage('{--SPONSOR_NO_SUB_MENUS_ACTIVE--}', true);
                        }
 
                        // Free memory
                        SQL_FREERESULT($result_sub);
-               }
+               } // END - while
        } else {
                // No main menus active
-               $OUT .= loadTemplate('admin_settings_saved', true, '{--SPONSOR_NO_MAIN_MENUS_ACTIVE--}');
+               $OUT .= displayMessage('{--SPONSOR_NO_MAIN_MENUS_ACTIVE--}', true);
        }
 
        // Free memory
@@ -351,18 +337,21 @@ ORDER BY
 
 //
 function addSponsorContent ($what) {
-       $OUT = '';
+       // Init sponsor content
+       $GLOBALS['sponsor_output'] = '';
+
+       // Generate IFN (Include FileName)
        $INC = sprintf("inc/modules/sponsor/%s.php", $what);
        if (isIncludeReadable($INC)) {
-               // Every sponsor action will output nothing directly. It will be written into $OUT!
+               // Every sponsor action will output nothing directly. It will be written into $GLOBALS['sponsor_output']!
                loadIncludeOnce($INC);
        } else {
-               // File not found!
-               $OUT .= loadTemplate('admin_settings_saved', true, getMaskedMessage('SPONSOR_CONTENT_404', $what));
+               // File not found
+               $GLOBALS['sponsor_output'] .= displayMessage('{%message,SPONSOR_CONTENT_404=' . $what . '%}', true);
        }
 
        // Return content
-       return $OUT;
+       return $GLOBALS['sponsor_output'];
 }
 
 //
@@ -373,17 +362,22 @@ function updateSponsorLogin () {
        // Is sponsor?
        if (isSponsor()) {
                // Update last online timestamp
-               SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_sponsor_data`
-SET `last_online`=UNIX_TIMESTAMP()
-WHERE `id`='%s' AND `password`='%s' LIMIT 1",
+               SQL_QUERY_ESC("UPDATE
+       `{?_MYSQL_PREFIX?}_sponsor_data`
+SET
+       `last_online`=NOW()
+WHERE
+       `id`=%s AND
+       `password`='%s'
+LIMIT 1",
                        array(
-                               bigintval(getSession('sponsorid')),
-                               getSession('sponsorpass')
+                               bigintval(getSession('sponsor_id')),
+                               getSession('sponsor_pass')
                        ), __FUNCTION__, __LINE__);
 
                // This update went fine?
-               $login = (SQL_AFFECTEDROWS() == 1);
-       }
+               $login = (!SQL_HASZEROAFFECTED());
+       } // END - if
 
        // Return status
        return $login;
@@ -395,8 +389,8 @@ function saveSponsorData ($postData, $content) {
 
        // Unsecure data which we don't want
        $UNSAFE = array('password', 'id', 'remote_addr', 'sponsor_created', 'last_online', 'status', 'ref_count',
-                       'points_amount', 'points_used', 'refid', 'hash', 'last_pay', 'last_curr', 'pass_old',
-                       'ok', 'pass1', 'pass2');
+                       'points_amount', 'points_used', 'refid', 'hash', 'last_payment', 'last_currency',
+                       'pass_old', 'ok', 'pass1', 'pass2');
 
        // Set default message ("not saved")
        $message = '{--SPONSOR_ACCOUNT_DATA_NOT_SAVED--}';
@@ -426,7 +420,7 @@ function saveSponsorData ($postData, $content) {
                $sql   .= " `" . secureString($key) . "`='%s',";
 
                // We will secure this later inside the SQL_QUERY_ESC() function
-               $DATA[] = secureString($value);
+               array_push($DATA, secureString($value));
        } // END - foreach
 
        // Check if email has changed
@@ -436,21 +430,23 @@ function saveSponsorData ($postData, $content) {
                        $EMAIL = true;
 
                        // Okay, has changed then add status with UNCONFIRMED and new hash code
-                       $sql .= " `status`='EMAIL', `hash`='%s',";
+                       $sql .= " `status`='EMAIL',`hash`='%s',";
 
                        // Generate hash code
-                       $HASH = md5(session_id().':'.$postData['email'].':'.detectRemoteAddr().':'.detectUserAgent().':'.time());
-                       $DATA[] = $HASH;
+                       // @TODO Rewrite this to API function
+                       $HASH = md5(session_id() . getEncryptSeparator() . $postData['email'] . getEncryptSeparator() . detectRemoteAddr() . getEncryptSeparator() . detectUserAgent() . getEncryptSeparator() . time());
+                       array_push($DATA, $HASH);
                } // END - if
        } // END - if
-
        // Remove last commata
        $sql = substr($sql, 0, -1);
 
+       // Add last_change
+       $sql .= ',`last_change`=NOW()';
+
        // Add SQL tail data
        $sql .= " WHERE `id`=%s AND `password`='%s' LIMIT 1";
-       $DATA[] = bigintval(getSession('sponsorid'));
-       $DATA[] = getSession('sponsorpass');
+       array_push($DATA, bigintval(getSession('sponsor_id')), getSession('sponsor_pass'));
 
        // Saving data was completed... ufff...
        switch (getWhat()) {
@@ -458,11 +454,11 @@ function saveSponsorData ($postData, $content) {
                        if ($EMAIL === true) {
                                $message = '{--SPONSOR_ACCOUNT_EMAIL_CHANGED--}';
                                $templ   = 'admin_sponsor_change_email';
-                               $subj    = '{--ADMIN_SPONSOR_ACC_EMAIL_SUBJECT--}';
+                               $subject    = '{--ADMIN_SPONSOR_ACC_EMAIL_SUBJECT--}';
                        } else {
                                $message = '{--SPONSOR_ACCOUNT_DATA_SAVED--}';
                                $templ   = 'admin_sponsor_change_data';
-                               $subj    = '{--ADMIN_SPONSOR_ACC_DATA_SUBJECT--}';
+                               $subject    = '{--ADMIN_SPONSOR_ACC_DATA_SUBJECT--}';
                        }
                        break;
 
@@ -470,21 +466,21 @@ function saveSponsorData ($postData, $content) {
                        // Set message template and subject for admin
                        $message = '{--SPONSOR_SETTINGS_SAVED--}';
                        $templ   = 'admin_sponsor_settings';
-                       $subj    = '{--ADMIN_SPONSOR_SETTINGS_SUBJECT--}';
+                       $subject    = '{--ADMIN_SPONSOR_SETTINGS_SUBJECT--}';
                        break;
 
                default: // Unknown sponsor what value!
                        logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown sponsor module (what) %s detected.", getWhat()));
-                       $message = getMaskedMessage('SPONSOR_UNKNOWN_WHAT', getWhat());
+                       $message = '{--SPONSOR_UNKNOWN_WHAT--}';
                        $templ   = '';
-                       $subj    = '';
+                       $subject    = '';
                        break;
        } // END - switch
 
        // Has an entry updated?
-       if (SQL_AFFECTEDROWS() == 1) {
+       if (!SQL_HASZEROAFFECTED()) {
                // Template and subject are set?
-               if (!empty($templ) && !empty($subj)) {
+               if (!empty($templ) && !empty($subject)) {
                        // Run SQL command and check for success
                        $result = SQL_QUERY_ESC($sql, $DATA, __FUNCTION__, __LINE__);
 
@@ -492,7 +488,7 @@ function saveSponsorData ($postData, $content) {
                        $content['new_data'] = $postData;
 
                        // Send email to admins
-                       sendAdminNotification($subj, $templ, $content);
+                       sendAdminNotification($subject, $templ, $content);
 
                        // Shall we send mail to the sponsor's new email address?
                        if ($content['receive_warnings'] == 'Y') {
@@ -531,5 +527,353 @@ function saveSponsorData ($postData, $content) {
        return $message;
 }
 
+// Create email link to sponsor's account
+function generateSponsorEmailLink ($email, $mod = 'admin') {
+       // Show contact link only if sponsor is confirmed by default
+       $locked = " AND `status`='CONFIRMED'";
+
+       // But admins shall always see it
+       if (isAdmin()) $locked = '';
+
+       $result = SQL_QUERY_ESC("SELECT
+       `id`
+FROM
+       `{?_MYSQL_PREFIX?}_sponsor_data`
+WHERE
+       '%s' REGEXP `email`
+       " . $locked . "
+LIMIT 1",
+               array($email), __FUNCTION__, __LINE__);
+       if (SQL_NUMROWS($result) == 1) {
+               // Load sponsor_id
+               list($sponsor_id) = SQL_FETCHROW($result);
+
+               // Rewrite email address to contact link
+               $email = '{%url=modules.php?module=' . $mod . '&amp;what=sponsor_contct&amp;sponsor_id=' . bigintval($sponsor_id) . '%}';
+       } // END - if
+
+       // Free memory
+       SQL_FREERESULT($result);
+
+       // Return rewritten (?) email address
+       return $email;
+}
+
+// Processes a sponsor request and handles it
+function doProcessSponsorFormRequest ($messageArray = array()) {
+       // Default message
+       $message = '';
+
+       // Handle the request
+       $status = handleSponsorRequest(postRequestArray(), true, $messageArray, true);
+
+       // Check the status of the registration process
+       switch ($status) {
+               case 'added': // Sponsor successfully added with account status = UNCONFIRMED!
+                       // Check for his id number
+                       $result = SQL_QUERY_ESC("SELECT `id`, `hash` FROM `{?_MYSQL_PREFIX?}_sponsor_data` WHERE '%s' REGEXP `email` LIMIT 1",
+                               array(postRequestElement('email')), __FUNCTION__, __LINE__);
+                       if (SQL_NUMROWS($result) == 1) {
+                               // id found so let's load it for the confirmation email
+                               list($id, $hash) = SQL_FETCHROW($result);
+
+                               // Prepare data for the email template
+                               $content['id']        = $id;
+                               $content['hash']      = $hash;
+                               $content['email']     = postRequestElement('email');
+                               $content['surname']   = postRequestElement('surname');
+                               $content['family']    = postRequestElement('family');
+                               $content['timestamp'] = generateDateTime(time(), 0);
+                               $content['password']  = postRequestElement('pass1');
+
+                               // Generate email and send it to the new sponsor
+                               $message = loadEmailTemplate('sponsor_confirm', $content, $id);
+                               sendEmail(postRequestElement('email'), '{--SPONSOR_PLEASE_CONFIRM_SUBJECT--}', $message);
+
+                               // Send mail to admin
+                               sendAdminNotification('{--ADMIN_NEW_SPONSOR--}', 'admin_sponsor_reg', $content);
+
+                               // Output message: DONE
+                               $message = $messageArray['added'];
+                       } else {
+                               // Sponsor account not found???
+                               $message = '{%message,SPONSOR_EMAIL_404=' . postRequestElement('email') . '%}';
+                       }
+
+                       // Free memory
+                       SQL_FREERESULT($result);
+                       break;
+
+               default:
+                       logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
+                       if (!isAdmin()) {
+                               // Message for testing admin
+                               $message = '{%message,ADMIN_SPONSOR_UNKNOWN_STATUS=' . $status . '%}';
+                       } else {
+                               // Message for the guest
+                               $message = '{%message,SPONSOR_UNKNOWN_STATUS=' . $status . '%}';
+                       }
+                       break;
+       } // END - switch
+
+       // Return message
+       return $message;
+}
+
+// Expression call-back function for fetching sponsor data
+function doExpressionSponsor ($data) {
+       // Use current sponsor_id by default
+       $functionName = 'getSponsorId()';
+
+       // Sponsor-related data, so is there a sponsor_id?
+       if (!empty($data['matches'][4][$data['key']])) {
+               // Is there a sponsor_id or $sponsor_id?
+               if ($data['matches'][4][$data['key']] == '$userid') {
+                       // Use dynamic call
+                       $functionName = "getFetchedSponsorData('id', \$userid, '" . $data['callback'] . "')";
+               } elseif (!empty($data['matches'][4][$data['key']])) {
+                       // Sponsor data found
+                       $functionName = "getFetchedSponsorData('id', " . $data['matches'][4][$data['key']] . ", '" . $data['callback'] . "')";
+               }
+       } elseif ((!empty($data['callback'])) && (isSponsorDataValid())) {
+               // "Call-back" alias column for current logged in sponsor's data
+               $functionName = "getSponsorData('" . $data['callback'] . "')";
+       }
+
+       // Is there another function to run (e.g. translations)
+       if (!empty($data['extra_func'])) {
+               // Surround the original function call with it
+               $functionName = $data['extra_func'] . '(' . $functionName . ')';
+       } // END - if
+
+       // Generate replacer
+       $replacer = '{DQUOTE} . ' . $functionName . ' . {DQUOTE}';
+
+       // Now replace the code
+       $code = replaceExpressionCode($data, $replacer);
+
+       // Return replaced code
+       return $code;
+}
+
+// Fetch sponsor data for given sponsor id
+function fetchSponsorData ($sponsor_id, $column = 'id') {
+       // If we should look for sponsor_id secure&set it here
+       if ($column == 'id') {
+               // Secure sponsor_id
+               $sponsor_id = bigintval($sponsor_id);
+
+               // Set it here
+               setCurrentSponsorId($sponsor_id);
+
+               // Don't look for invalid sponsor_ids...
+               if (!isValidUserId($sponsor_id)) {
+                       // Invalid, so abort here
+                       reportBug(__FUNCTION__, __LINE__, 'Sponsor id ' . $sponsor_id . ' is invalid.');
+               } elseif (isSponsorDataValid()) {
+                       // Use cache, so it is fine
+                       return true;
+               }
+       } elseif (isSponsorDataValid()) {
+               // Use cache, so it is fine
+               return true;
+       }
+
+       // By default none was found
+       $found = false;
+
+       // Extra statements
+       $ADD = '';
+
+       // Query for the sponsor
+       $result = SQL_QUERY_ESC("SELECT *".$ADD." FROM `{?_MYSQL_PREFIX?}_sponsor_data` WHERE `%s`='%s' LIMIT 1",
+               array($column, $sponsor_id), __FUNCTION__, __LINE__);
+
+       // Is there a record?
+       if (SQL_NUMROWS($result) == 1) {
+               // Load data from cookies
+               $data = SQL_FETCHARRAY($result);
+
+               // Set the sponsor_id for later use
+               setCurrentSponsorId($data['id']);
+               $GLOBALS['sponsor_data'][getCurrentSponsorId()] = $data;
+
+               // Rewrite 'last_failure' if found
+               if (isset($GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'])) {
+                       // Backup the raw one and zero it
+                       $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure_raw'] = $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'];
+                       $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'] = NULL;
+
+                       // Is it not zero?
+                       if (!is_null($GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure_raw'])) {
+                               // Seperate data/time
+                               $array = explode(' ', $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure_raw']);
+
+                               // Seperate data and time again
+                               $array['date'] = explode('-', $array[0]);
+                               $array['time'] = explode(':', $array[1]);
+
+                               // Now pass it to mktime()
+                               $GLOBALS['sponsor_data'][getCurrentSponsorId()]['last_failure'] = mktime(
+                                       $array['time'][0],
+                                       $array['time'][1],
+                                       $array['time'][2],
+                                       $array['date'][1],
+                                       $array['date'][2],
+                                       $array['date'][0]
+                               );
+                       } // END - if
+               } // END - if
+
+               // Found, but valid?
+               $found = isSponsorDataValid();
+       } // END - if
+
+       // Free memory
+       SQL_FREERESULT($result);
+
+       // Return result
+       return $found;
+}
+
+// Wrapper for fetchSponsorData() and getSponsorData() calls
+function getFetchedSponsorData ($keyColumn, $sponsor_id, $valueColumn) {
+       // Zero ids are not valid
+       if ($sponsor_id == 0) {
+               // Abort here
+               reportBug(__FUNCTION__, __LINE__, 'Zero sponsor_id provided');
+       } // END - if
+
+       // Is it cached?
+       if (!isset($GLOBALS['sponsor_data_cache'][$sponsor_id][$keyColumn][$valueColumn])) {
+               // Default is empty
+               $data = '';
+
+               // Can we fetch the sponsor data?
+               if ((isValidSponsorId($sponsor_id)) && (fetchSponsorData($sponsor_id, $keyColumn))) {
+                       // Now get the data back
+                       $data = getSponsorData($valueColumn);
+               } // END - if
+
+               // Cache it
+               /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cached:id=' . $sponsor_id . ',keyColumn=' . $keyColumn . ',valueColumn=' . $valueColumn . ',data=' . $data);
+               $GLOBALS['sponsor_data_cache'][$sponsor_id][$keyColumn][$valueColumn] = $data;
+       } // END - if
+
+       // Return it
+       return $GLOBALS['sponsor_data_cache'][$sponsor_id][$keyColumn][$valueColumn];
+}
+
+// Checks if the sponsor data is valid, this may indicate that the sponsor has logged
+// in, but you should use isMember() if you want to find that out.
+function isSponsorDataValid () {
+       // Sponsor id should not be zero so abort here
+       if (!isCurrentSponsorIdSet()) return false;
+
+       // Is it cached?
+       if (!isset($GLOBALS['is_sponsor_data_valid'][getCurrentSponsorId()])) {
+               // Determine it
+               $GLOBALS['is_sponsor_data_valid'][getCurrentSponsorId()] = ((isset($GLOBALS['sponsor_data'][getCurrentSponsorId()])) && (count($GLOBALS['sponsor_data'][getCurrentSponsorId()]) > 1));
+       } // END - if
+
+       // Return the result
+       return $GLOBALS['is_sponsor_data_valid'][getCurrentSponsorId()];
+}
+
+// Setter for current sponsor_id
+function setCurrentSponsorId ($sponsor_id) {
+       // Set sponsor_id
+       $GLOBALS['current_sponsor_id'] = bigintval($sponsor_id);
+
+       // Unset it to re-determine the actual state
+       unset($GLOBALS['is_sponsor_data_valid'][$sponsor_id]);
+}
+
+// Getter for current sponsor_id
+function getCurrentSponsorId () {
+       // Sponsorid must be set before it can be used
+       if (!isCurrentSponsorIdSet()) {
+               // Not set
+               reportBug(__FUNCTION__, __LINE__, 'Sponsor id is not set.');
+       } // END - if
+
+       // Return the sponsor_id
+       return $GLOBALS['current_sponsor_id'];
+}
+
+// Checks if current sponsor_id is set
+function isCurrentSponsorIdSet () {
+       return ((isset($GLOBALS['current_sponsor_id'])) && (isValidSponsorId($GLOBALS['current_sponsor_id'])));
+}
+
+// Is given sponsor_id valid?
+function isValidSponsorId ($sponsor_id) {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__][$sponsor_id])) {
+               // Check it out
+               $GLOBALS[__FUNCTION__][$sponsor_id] = ((!is_null($sponsor_id)) && (!empty($sponsor_id)) && ($sponsor_id > 0));
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__][$sponsor_id];
+}
+
+// Getter for sponsor data
+function getSponsorData ($column) {
+       // Sponsor id should not be zero
+       if (!isValidUserId(getCurrentSponsorId())) {
+               reportBug(__FUNCTION__, __LINE__, 'Sponsor id is zero.');
+       } // END - if
+
+       // Return the value
+       return $GLOBALS['sponsor_data'][getCurrentSponsorId()][$column];
+}
+
+// Determines the country of the given sponsor id
+function determineSponsorCountry ($sponsor_id) {
+       // Then handle it over
+       $country = getSponsorData('country');
+
+       // Return it
+       return $country;
+}
+
+// Destroy sponsor session
+function destroySponsorSession () {
+       // Remove all user data from session
+       return (
+               (setSession('sponsor_id', '')) &&
+               (setSession('sponsor_pass', '')) &&
+               (
+                       ((isExtensionActive('theme')) && (setMailerTheme(''))) ||
+                       (!isExtensionActive('theme'))
+               )
+       );
+}
+
+// Getter for sponsor_min_points
+function getSponsorMinPoints () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('sponsor_min_points');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for sponsor_ref_points
+function getSponsorRefPoints () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('sponsor_ref_points');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // [EOF]
 ?>