]> git.mxchange.org Git - mailer.git/blobdiff - inc/libs/user_functions.php
Referal system refactured (and some parts fixed), wrapper function introduced:
[mailer.git] / inc / libs / user_functions.php
index 187afc76159406e3dc21e957e8c2829adf7f696e..827ee9c2c6c6218ae71f8479e59016be4eeb36c8 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                    *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -45,8 +43,8 @@ if (!defined('__SECURITY')) {
 // Add links for selecting some users
 function alpha ($sortby, $colspan, $return=false) {
        if (!isGetRequestParameterSet('offset')) setGetRequestParameter('offset', 0);
-       $add = '&page='.getRequestParameter('page').'&offset='.getRequestParameter('offset');
-       if (isGetRequestParameterSet('mode')) $add .= '&mode='.getRequestParameter('mode');
+       $add = '&page=' . getRequestParameter('page').'&offset=' . getRequestParameter('offset');
+       if (isGetRequestParameterSet('mode')) $add .= '&mode=' . getRequestParameter('mode');
 
        /* Creates the list of letters and makes them a link. */
        $alphabet = explode(',', 'A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,');
@@ -101,11 +99,13 @@ function addSortLinks ($letter, $sortby, $colspan, $return=false) {
        elseif (isGetRequestParameterSet('mode')) $add .= '&mode=' . getRequestParameter('mode');
 
        // Makes order by links..
-       if ($letter == 'front') $letter = '';
+       if ($letter == 'front') {
+               $letter = '';
+       } // END - if
 
        // Prepare array with all possible sorters
        $list = array(
-               'userid'      => '{--_UID--}',
+               'userid'      => '{--_USERID--}',
                'family'      => '{--FAMILY--}',
                'email'       => '{--EMAIL--}',
                'REMOTE_ADDR' => '{--REMOTE_IP--}'
@@ -125,7 +125,7 @@ function addSortLinks ($letter, $sortby, $colspan, $return=false) {
        } // END - foreach
 
        // Add list and colspan
-       $content['list'] = substr($OUT, 0, -13);
+       $content['list'] = substr($OUT, 0, -1);
        $content['colspan2'] = $colspan;
 
        // Load template
@@ -200,7 +200,7 @@ function addPageNavigation ($numPages, $offset, $showForm, $colspan, $return=fal
 }
 
 // Create email link to user's account
-function generateUserEmailLink($email, $mod = 'admin') {
+function generateUserEmailLink ($email, $mod = 'admin') {
        // Show contact link only if user is confirmed by default
        $locked = " AND `status`='CONFIRMED'";
 
@@ -234,7 +234,7 @@ LIMIT 1",
 // @TODO Double-check configuration entry here
 function determineRandomReferalId () {
        // Default is zero refid
-       $refid = '0';
+       $refid = null;
 
        // Is the extension version fine?
        if (isExtensionInstalledAndNewer('user', '0.3.4')) {
@@ -255,8 +255,8 @@ function determineRandomReferalId () {
                                // Use that userid as new referal id
                                list($refid) = SQL_FETCHROW($result);
 
-                               // Reset this user's counter
-                               SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `rand_confirmed`=0 WHERE `userid`=%s LIMIT 1",
+                               // Reset all users, this makes this random referal id more challenging
+                               SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `rand_confirmed`=0",
                                        array($refid), __FUNCTION__, __LINE__);
                        } // END - if
 
@@ -304,11 +304,13 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
        if (($errorCode == '0') && ($isFound === true)) {
                // Get user data array and set userid (e.g. important if we login with nickname)
                $content = getUserDataArray();
-               if (!empty($content['userid'])) $userid = bigintval($content['userid']);
+               if (!empty($content['userid'])) {
+                       $userid = bigintval($content['userid']);
+               } // END - if
        } // END - if
 
        // Is there an entry?
-       if ((isUserDataValid()) && (getUserData('status') == 'CONFIRMED') && (!empty($content['userid']))) {
+       if (($errorCode == '0') && (isUserDataValid()) && (getUserData('status') == 'CONFIRMED') && (!empty($content['userid']))) {
                // Check for old MD5 passwords
                if ((strlen(getUserData('password')) == 32) && (md5($passwd) == getUserData('password'))) {
                        // Just set the hash to the password from DB... :)
@@ -331,17 +333,26 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                        // No login bonus by default
                        $GLOBALS['bonus_payed'] = false;
 
-                       // Probe for last online timemark
-                       $probe = time() -  getUserData('last_online');
-                       if (getUserData('last_login') > 0) $probe = time() - getUserData('last_login');
+                       // Is bonus up-to-date?
+                       if (isExtensionInstalledAndNewer('bonus', '0.2.2')) {
+                               // Probe for last online timemark
+                               $probe = time() -  getUserData('last_online');
+                               if (getUserData('last_login') > 0) {
+                                       // Use timestamp from last login
+                                       $probe = time() - getUserData('last_login');
+                               } // END - if
 
-                       if ((isExtensionInstalledAndNewer('bonus', '0.2.2')) && ($probe >= getConfig('login_timeout'))) {
-                               // Add login bonus to user's account
-                               $add = ', `login_bonus`=`login_bonus`+{?login_bonus?}';
-                               $GLOBALS['bonus_payed'] = true;
+                               // Is the timeout reached?
+                               if ($probe >= getConfig('login_timeout')) {
+                                       // Add login bonus to user's account
+                                       $add = ', `login_bonus`=`login_bonus`+{?login_bonus?}';
+                                       $GLOBALS['bonus_payed'] = true;
 
-                               // Subtract login bonus from userid's account or jackpot
-                               if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getConfig('bonus_mode') != 'ADD')) handleBonusPoints('login_bonus');
+                                       // Subtract login bonus from userid's account or jackpot
+                                       if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getBonusMode() != 'ADD')) {
+                                               handleBonusPoints('login_bonus');
+                                       } // END - if
+                               } // END - if
                        } // END - if
 
                        // @TODO Make this filter working: $url = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
@@ -355,7 +366,7 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                                // Update database records
                                SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `total_logins`=`total_logins`+1" . $add . " WHERE `userid`=%s LIMIT 1",
                                        array($userid), __FUNCTION__, __LINE__);
-                               if (SQL_AFFECTEDROWS() == 1) {
+                               if (!SQL_HASZEROAFFECTED()) {
                                        // Is a success URL set?
                                        if (empty($successUrl)) {
                                                // Procedure to checking for login data
@@ -379,7 +390,7 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                                $errorCode = getCode('COOKIES_DISABLED');
                        }
                } elseif (isExtensionInstalledAndNewer('sql_patches', '0.6.1')) {
-                       // Update failture counter
+                       // Update failure counter
                        SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `login_failures`=`login_failures`+1,`last_failure`=NOW() WHERE `userid`=%s LIMIT 1",
                                array($userid), __FUNCTION__, __LINE__);
 
@@ -393,7 +404,7 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                // Set userid in session
                setSession('current_userid', getUserData('userid'));
        } elseif (!isUserDataValid()) {
-               // User id not found!
+               // User id not found
                $errorCode = getCode('WRONG_ID');
        } else {
                // Unknown error
@@ -406,7 +417,9 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                $url = $errorUrl . $errorCode;
 
                // Extension set? Then add it as well.
-               if (!empty($ext)) $url .= '&ext=' . $ext;
+               if (!empty($ext)) {
+                       $url .= '&ext=' . $ext;
+               } // END - if
        } // END - if
 
        // Return URL
@@ -415,67 +428,68 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
 
 // Try to send a new password for the given user account
 function doNewUserPassword ($email, $userid) {
-       // Init result and error
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'email=' . $email . ',userid=' . $userid . ' - ENTERED!');
+       // Init found-status and error
        $errorCode = '';
-       $result = false;
+       $accountFound = false;
 
        // Probe userid/nickname
-       // @TODO We should try to rewrite this to fetchUserData() somehow
        if (!empty($email)) {
                // Email entered
-               $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `email`='%s' OR `email`='%s' LIMIT 1",
-                       array($email, str_replace('.', '{DOT}', $email)), __FUNCTION__, __LINE__);
+               $accountFound = fetchUserData($email, 'email');
        } elseif ((isExtensionActive('nickname')) && (isNicknameOrUserid($userid))) {
                // Nickname entered
-               $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `nickname`='%s' OR `userid`='%s' OR `email`='%s' LIMIT 1",
-                       array($userid, $userid, $email), __FUNCTION__, __LINE__);
+               $accountFound = fetchUserData($userid, 'nickname');
        } elseif ((isValidUserId($userid)) && (empty($email))) {
                // Direct userid entered
-               $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `userid`=%s LIMIT 1",
-                       array(bigintval($userid)), __FUNCTION__, __LINE__);
+               $accountFound = fetchUserData($userid);
        } else {
                // Userid not set!
-               logDebugMessage(__FUNCTION__, __LINE__, 'Userid is not set! BUG!');
-               $errorCode = getCode('WRONG_ID');
+               logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',email=' . $email . ': Important variables are empty.');
        }
 
        // Any entry found?
-       if (SQL_NUMROWS($result) == 1) {
-               // This data is valid, so we create a new pass... :-)
-               list($userid, $status) = SQL_FETCHROW($result);
-
-               if ($status == 'CONFIRMED') {
-                       // Ooppps, this was missing! ;-) We should update the database...
+       if ($accountFound === true) {
+               // Is the account confirmed
+               if (getUserData('status') == 'CONFIRMED') {
+                       // Generate new password
                        $NEW_PASS = generatePassword();
+
+                       // Update database
                        SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `password`='%s' WHERE `userid`=%s LIMIT 1",
-                               array(generateHash($NEW_PASS), $userid), __FUNCTION__, __LINE__);
+                               array(generateHash($NEW_PASS), getUserData('userid')), __FUNCTION__, __LINE__);
 
                        // Prepare data and message for email
-                       $message = loadEmailTemplate('new-pass', array('new_pass' => $NEW_PASS, 'nickname' => $userid), $userid);
+                       $message = loadEmailTemplate('guest_new_password',
+                               array(
+                                       'new_pass' => $NEW_PASS,
+                                       'nickname' => $userid
+                               ), bigintval(getUserData('userid')));
 
                        // ... and send it away
-                       sendEmail($userid, '{--GUEST_NEW_PASSWORD--}', $message);
+                       sendEmail(bigintval(getUserData('userid')), '{--GUEST_NEW_PASSWORD--}', $message);
 
                        // Output note to user
-                       loadTemplate('admin_settings_saved', false, '{--GUEST_NEW_PASSWORD_SEND--}');
+                       displayMessage('{--GUEST_NEW_PASSWORD_SEND--}');
                } else {
                        // Account is locked or unconfirmed
-                       $errorCode = generateErrorCodeFromUserStatus($status);
+                       $errorCode = generateErrorCodeFromUserStatus(getUserData('status'));
 
                        // Load URL
-                       redirectToUrl('modules.php?module=index&what=login&login='.$errorCode);
+                       redirectToUrl('modules.php?module=index&what=login&login=' . $errorCode);
                }
        } else {
                // id or email is wrong
-               loadTemplate('admin_settings_saved', false, '<span class="guest_failed">{--GUEST_WRONG_ID_EMAIL--}</span>');
+               displayMessage('<span class="notice">{--GUEST_WRONG_ID_EMAIL--}</span>');
        }
 
        // Return the error code
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'email=' . $email . ',userid=' . $userid . ',errorCode=' . $errorCode . ' - EXIT!');
        return $errorCode;
 }
 
 // Get timestamp for given stats type and data
-function getTimestampFromUserStats ($statsType, $statsData, $userid = '0') {
+function getEpocheTimeFromUserStats ($statsType, $statsData, $userid = '0') {
        // Default timestamp is zero
        $data['inserted'] = '0';
 
@@ -485,7 +499,7 @@ function getTimestampFromUserStats ($statsType, $statsData, $userid = '0') {
        } // END - if
 
        // Is the extension installed and updated?
-       if ((!isExtensionActive('sql_patches')) || (isExtensionOlder('sql_patches', '0.5.6'))) {
+       if ((!isExtensionActive('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.6'))) {
                // Return zero here
                return $data['inserted'];
        } // END - if
@@ -522,15 +536,15 @@ LIMIT 1",
 // Inserts user stats
 function insertUserStatsRecord ($userid, $statsType, $statsData) {
        // Is the extension installed and updated?
-       if ((!isExtensionActive('sql_patches')) || (isExtensionOlder('sql_patches', '0.5.6'))) {
+       if ((!isExtensionActive('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.6'))) {
                // Return zero here
                return false;
        } // END - if
 
        // Does it exist?
-       if ((!getTimestampFromUserStats($statsType, $statsData, $userid)) && (!is_array($statsData))) {
+       if ((!getEpocheTimeFromUserStats($statsType, $statsData, $userid)) && (!is_array($statsData))) {
                // Then insert it!
-               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_stats_data` (`userid`,`stats_type`,`stats_data`) VALUES (%s,'%s','%s')",
+               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_stats_data` (`userid`, `stats_type`, `stats_data`) VALUES (%s,'%s','%s')",
                        array(
                                bigintval($userid),
                                $statsType,
@@ -543,7 +557,7 @@ function insertUserStatsRecord ($userid, $statsType, $statsData) {
 }
 
 // Confirms a user account
-function doConfirmUserAccount () {
+function doConfirmUserAccount ($hash) {
        // Init content
        $content = array(
                'message' => '{--GUEST_CONFIRMED_FAILED--}',
@@ -554,11 +568,11 @@ function doConfirmUserAccount () {
        $userid = '0';
 
        // Search for an unconfirmed or confirmed account
-       $result = SQL_QUERY_ESC("SELECT `userid`, `email`, `refid` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `user_hash`='%s' AND (`status`='UNCONFIRMED' OR `status`='CONFIRMED') LIMIT 1",
-               array(getRequestParameter('hash')), __FILE__, __LINE__);
+       $result = SQL_QUERY_ESC("SELECT `userid`, `refid` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `user_hash`='%s' AND (`status`='UNCONFIRMED' OR `status`='CONFIRMED') LIMIT 1",
+               array($hash), __FILE__, __LINE__);
        if (SQL_NUMROWS($result) == 1) {
                // Ok, he want's to confirm now so we load some data
-               list($userid, $email, $refid) = SQL_FETCHROW($result);
+               list($userid, $refid) = SQL_FETCHROW($result);
 
                // Fetch user data
                if (!fetchUserData($userid)) {
@@ -574,19 +588,20 @@ function doConfirmUserAccount () {
        `{?_MYSQL_PREFIX?}_user_data`
 SET
        `status`='CONFIRMED',
-       `ref_payout`={?ref_payout?},
        `user_hash`=NULL
 WHERE
        `user_hash`='%s' AND
        `status`='UNCONFIRMED'
 LIMIT 1",
-                       array(getRequestParameter('hash')), __FILE__, __LINE__);
-               if (SQL_AFFECTEDROWS() == 1) {
+                       array($hash), __FILE__, __LINE__);
+
+               // Was it updated?
+               if (!SQL_HASZEROAFFECTED()) {
                        // Send email if updated
-                       $message = loadEmailTemplate('confirm-member', $content, bigintval($userid));
+                       $message = loadEmailTemplate('guest_user_confirmed', $content, bigintval($userid));
 
                        // And send him right away the confirmation mail
-                       sendEmail($email, '{--GUEST_THANX_CONFIRM--}', $message);
+                       sendEmail($userid, '{--GUEST_THANX_CONFIRM--}', $message);
 
                        // Maybe he got "referaled"?
                        if (($refid > 0) && ($refid != $userid)) {
@@ -606,9 +621,8 @@ LIMIT 1",
                                        } // END - if
 
                                        // Add one-time referal bonus over referal system or directly
-                                       // @TODO Try to rewrite the following unset()
-                                       unset($GLOBALS['ref_level']);
-                                       addPointsThroughReferalSystem('referal_bonus', $refid, getPointsRef(), true, bigintval($userid), getConfig('reg_points_mode'));
+                                       initReferalSystem();
+                                       addPointsThroughReferalSystem('referal_bonus', $refid, getPointsRef(), bigintval($userid));
                                } // END - if
                        } // END - if
 
@@ -644,7 +658,64 @@ LIMIT 1",
        }
 
        // Load template
-       loadTemplate('admin_settings_saved', false, $content['message']);
+       displayMessage($content['message']);
+}
+
+// Does resend the user's confirmation link for given email address
+function doResendUserConfirmationLink ($email) {
+       // Email address not registered is default message
+       $message = '{--EMAIL_404--}';
+
+       // Confirmation link requested
+       if (fetchUserData($email, 'email')) {
+               // Email address found
+               $content = getUserDataArray();
+
+               // Is the account unconfirmed?
+               if ($content['status'] == 'UNCONFIRMED') {
+                       // Load email template
+                       $message = loadEmailTemplate('guest_request_confirm', array(), $content['userid']);
+
+                       // Send email
+                       sendEmail($content['userid'], '{--GUEST_REQUEST_CONFIRM_LINK_SUBJECT--}', $message);
+               } // END - if
+
+               // Create message based on the status
+               $message = getConfirmationMessageFromUserStatus($content['status']);
+       } // END - if
+
+       // Output message
+       displayMessage($message);
+}
+
+// Get a message (somewhat translation) from user status for confirmation link.
+// This is different to translateUserStatus() in text messages.
+function getConfirmationMessageFromUserStatus ($status) {
+       // Default is 'UNKNOWN'
+       $message = '{%message,GUEST_LOGIN_ID_UNKNOWN_STATUS=' . $status . '%}';
+
+       // Which status is it?
+       switch ($status) {
+               case 'UNCONFIRMED': // Account is unconfirmed
+                       // And set message
+                       $message = '{--GUEST_CONFIRM_LINK_SENT--}';
+                       break;
+
+               case 'CONFIRMED': // Account already confirmed
+                       $message = '{--GUEST_LOGIN_ID_CONFIRMED--}';
+                       break;
+
+               case 'LOCKED': // Account is locked
+                       $message = '{--GUEST_LOGIN_ID_LOCKED--}';
+                       break;
+
+               default: // This should not happen
+                       debug_report_bug(__FUNCTION__, __LINE__, 'Unknown user status ' . $status . ' detected.');
+                       break;
+       } // END - switch
+
+       // Return message
+       return $message;
 }
 
 // Expression call-back function for fetching user data
@@ -683,5 +754,23 @@ function doExpressionUser ($data) {
        return $code;
 }
 
+// Template call-back function for list_user admin function
+function doTemplateAdminListUserTitle ($template, $dummy = false) {
+       // Init title with "all accounts"
+       $code = '{--ADMIN_LIST_ALL_ACCOUNTS--}';
+
+       // Do we have a 'status' or 'mode' set?
+       if (isGetRequestParameterSet('status')) {
+               // Set title according to the 'status'
+               $code = sprintf("{--ADMIN_LIST_STATUS_%s_ACCOUNTS--}", strtoupper(getRequestParameter('status')));
+       } elseif (isGetRequestParameterSet('mode')) {
+               // Set title according to the "mode"
+               $code = sprintf("{--ADMIN_LIST_MODE_%s_ACCOUNTS--}", strtoupper(getRequestParameter('mode')));
+       }
+
+       // Return the code
+       return $code;
+}
+
 // [EOF]
 ?>