]> git.mxchange.org Git - mailer.git/blobdiff - inc/libs/user_functions.php
Introduced template call-back function 'doTemplateAdminListUserTitle':
[mailer.git] / inc / libs / user_functions.php
index ca86a9b5f88182e50c2ba16fd2ad19bf97755b92..760bad363d8872d971eedd1cb6257c36e07443e6 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 *
@@ -49,7 +47,7 @@ function alpha ($sortby, $colspan, $return=false) {
        if (isGetRequestParameterSet('mode')) $add .= '&mode='.getRequestParameter('mode');
 
        /* Creates the list of letters and makes them a link. */
-       $alphabet = explode(',', getMessage('_ALL2') . ',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,' . getMessage('_OTHERS'));
+       $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,');
        $num = count($alphabet) - 1;
        $OUT = '';
        while (list($counter, $ltr) = each($alphabet)) {
@@ -64,14 +62,20 @@ function alpha ($sortby, $colspan, $return=false) {
                }
 
                if ((($counter / getConfig('user_alpha')) == round($counter / getConfig('user_alpha'))) && ($counter > 0)) {
-                       $OUT .= '&nbsp;]<br />[&nbsp;';
+                       $OUT .= ']<br />[';
                } elseif ( $counter != $num ) {
-                       $OUT .= '&nbsp;|&nbsp;';
+                       $OUT .= '|';
                }
        } // END - while
 
+       // Prepare content
+       $content = array (
+               'colspan2'        => $colspan,
+               'alpha_selection' => $OUT
+       );
+
        // Load template
-       $OUT = loadTemplate('admin_list_user_alpha', true, $OUT);
+       $OUT = loadTemplate('admin_list_user_alpha', true, $content);
        if ($return === true) {
                // Return generated code
                return $OUT;
@@ -95,30 +99,32 @@ function addSortLinks ($letter, $sortby, $colspan, $return=false) {
        elseif (isGetRequestParameterSet('mode')) $add .= '&amp;mode=' . getRequestParameter('mode');
 
        // Makes order by links..
-       if ($letter == 'front') $letter = getMessage('_ALL2');
+       if ($letter == 'front') $letter = '';
 
        // Prepare array with all possible sorters
        $list = array(
-               'userid'      => getMessage('_UID'),
-               'family'      => getMessage('FAMILY'),
-               'email'       => getMessage('EMAIL'),
-               'REMOTE_ADDR' => getMessage('REMOTE_IP')
+               'userid'      => '{--_UID--}',
+               'family'      => '{--FAMILY--}',
+               'email'       => '{--EMAIL--}',
+               'REMOTE_ADDR' => '{--REMOTE_IP--}'
        );
 
        // Add nickname if extension is installed
        if (isExtensionActive('nickname')) {
-               $list['nickname'] = getMessage('NICKNAME');
+               $list['nickname'] = '{--NICKNAME--}';
        } // END - if
 
        foreach ($list as $sort => $title) {
                if ($sortby == $sort) {
-                       $OUT .= '<strong>' . $title . '</strong>&nbsp;|&nbsp;';
+                       $OUT .= '<strong>' . $title . '</strong>|';
                } else {
-                       $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=list_user&amp;letter=' . $letter . '&amp;sortby=' . $sort.$add . '%}">' . $title . '</a>&nbsp;|&nbsp;';
+                       $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=list_user&amp;letter=' . $letter . '&amp;sortby=' . $sort . $add . '%}">' . $title . '</a>|';
                }
        } // END - foreach
 
-       $content['list'] = substr($OUT, 0, -13);
+       // Add list and colspan
+       $content['list'] = substr($OUT, 0, -1);
+       $content['colspan2'] = $colspan;
 
        // Load template
        $OUT = loadTemplate('admin_list_user_sort', true, $content);
@@ -134,7 +140,7 @@ function addSortLinks ($letter, $sortby, $colspan, $return=false) {
 }
 
 // Add page navigation
-function addPageNavigation ($pages, $offset, $showForm, $colspan, $return=false) {
+function addPageNavigation ($numPages, $offset, $showForm, $colspan, $return=false) {
        // @TODO These two constants are no longer used, maybe we reactivate this code?
        //if ($showForm === true) {
        //      // Load form for changing number of lines
@@ -147,11 +153,11 @@ function addPageNavigation ($pages, $offset, $showForm, $colspan, $return=false)
        //}
 
        $OUT = '';
-       for ($page = 1; $page <= $pages; $page++) {
+       for ($page = 1; $page <= $numPages; $page++) {
                if (($page == getRequestParameter('page')) || ((!isGetRequestParameterSet('page')) && ($page == 1))) {
                        $OUT .= '<strong>-';
                } else {
-                       if (!isGetRequestParameterSet('letter')) setGetRequestParameter('letter', getMessage('_ALL2'));
+                       if (!isGetRequestParameterSet('letter')) setGetRequestParameter('letter', '');
                        if (!isGetRequestParameterSet('sortby')) setGetRequestParameter('sortby', 'userid');
 
                        // Base link
@@ -173,11 +179,12 @@ function addPageNavigation ($pages, $offset, $showForm, $colspan, $return=false)
                        $OUT .= '</a>';
                }
 
-               if ($page < $pages) $OUT .= '&nbsp;|&nbsp;';
+               if ($page < $numPages) $OUT .= '|';
        } // END - for
 
-       // Remember the list
-       $content['list'] = $OUT;
+       // Remember the list and colspan
+       $content['list']     = $OUT;
+       $content['colspan2'] = $colspan;
 
        // Load template
        $OUT = loadTemplate('admin_list_user_pagenav', true, $content);
@@ -191,7 +198,7 @@ function addPageNavigation ($pages, $offset, $showForm, $colspan, $return=false)
 }
 
 // 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'";
 
@@ -225,12 +232,12 @@ 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')) {
                // Get all user ids
-               $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true, " AND `rand_confirmed` >= ".getConfig('user_min_confirmed')."");
+               $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true, " AND `rand_confirmed` >= {?user_min_confirmed?}");
 
                // Do we have at least one?
                if ($totalUsers > 0) {
@@ -246,8 +253,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
 
@@ -267,6 +274,7 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
        $add = '';
        $errorCode = '0';
        $ext = '';
+       $isFound = false;
 
        // Init array
        $content = array(
@@ -287,11 +295,11 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                $ext = 'nickname';
        } else {
                // Direct userid entered
-               fetchUserData($userid);
+               $isFound = fetchUserData($userid);
        }
 
        // No error found?
-       if ($errorCode == '0') {
+       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']);
@@ -331,7 +339,9 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                                $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');
+                               if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getBonusMode() != 'ADD')) {
+                                       handleBonusPoints('login_bonus');
+                               } // END - if
                        } // END - if
 
                        // @TODO Make this filter working: $url = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
@@ -345,7 +355,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
@@ -376,14 +386,14 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                        // Wrong password!
                        $errorCode = getCode('WRONG_PASS');
                }
-       } elseif (getUserData('status') != 'CONFIRMED') {
+       } elseif ((isUserDataValid()) && (getUserData('status') != 'CONFIRMED')) {
                // Create an error code from given status
                $errorCode = generateErrorCodeFromUserStatus(getUserData('status'));
 
                // 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
@@ -419,7 +429,7 @@ function doNewUserPassword ($email, $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__);
-       } elseif (($userid > 0) && (empty($email))) {
+       } 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__);
@@ -444,10 +454,10 @@ function doNewUserPassword ($email, $userid) {
                        $message = loadEmailTemplate('new-pass', array('new_pass' => $NEW_PASS, 'nickname' => $userid), $userid);
 
                        // ... and send it away
-                       sendEmail($userid, getMessage('GUEST_NEW_PASSWORD'), $message);
+                       sendEmail($userid, '{--GUEST_NEW_PASSWORD--}', $message);
 
                        // Output note to user
-                       loadTemplate('admin_settings_saved', false, getMessage('GUEST_NEW_PASSWORD_SEND'));
+                       displayMessage('{--GUEST_NEW_PASSWORD_SEND--}');
                } else {
                        // Account is locked or unconfirmed
                        $errorCode = generateErrorCodeFromUserStatus($status);
@@ -457,7 +467,7 @@ function doNewUserPassword ($email, $userid) {
                }
        } 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
@@ -521,11 +531,233 @@ function insertUserStatsRecord ($userid, $statsType, $statsData) {
        if ((!getTimestampFromUserStats($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')",
-                       array(bigintval($userid), $statsType, $statsData), __FUNCTION__, __LINE__);
+                       array(
+                               bigintval($userid),
+                               $statsType,
+                               $statsData
+                       ), __FUNCTION__, __LINE__);
        } elseif (is_array($statsData)) {
                // Invalid data!
-               logDebugMessage(__FUNCTION__, __LINE__, "userid={$userid},type={$statsType},data={".gettype($statsData).": Invalid statistics data type!");
+               logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',type=' . $statsType . ',data=' . gettype($statsData) . ': Invalid statistics data type!');
+       }
+}
+
+// Confirms a user account
+function doConfirmUserAccount ($hash) {
+       // Init content
+       $content = array(
+               'message' => '{--GUEST_CONFIRMED_FAILED--}',
+               'userid'  => 0,
+       );
+
+       // Initialize the user id
+       $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($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);
+
+               // Fetch user data
+               if (!fetchUserData($userid)) {
+                       // Not found, should not happen
+                       debug_report_bug(__FILE__, __LINE__, 'User account ' . $userid . ' not found.');
+               } // END - if
+
+               // Load all data and add points
+               $content = getUserDataArray();
+
+               // Unlock his account (but only when it is on UNCONFIRMED!)
+               SQL_QUERY_ESC("UPDATE
+       `{?_MYSQL_PREFIX?}_user_data`
+SET
+       `status`='CONFIRMED',
+       `ref_payout`={?ref_payout?},
+       `user_hash`=NULL
+WHERE
+       `user_hash`='%s' AND
+       `status`='UNCONFIRMED'
+LIMIT 1",
+                       array($hash), __FILE__, __LINE__);
+
+               // Was it updated?
+               if (!SQL_HASZEROAFFECTED()) {
+                       // Send email if updated
+                       $message = loadEmailTemplate('confirm-member', $content, bigintval($userid));
+
+                       // And send him right away the confirmation mail
+                       sendEmail($email, '{--GUEST_THANX_CONFIRM--}', $message);
+
+                       // Maybe he got "referaled"?
+                       if (($refid > 0) && ($refid != $userid)) {
+                               // Select the referal userid
+                               if (fetchUserData($refid)) {
+                                       // Update ref counter...
+                                       updateReferalCounter($refid);
+
+                                       // If version matches add ref bonus to refid's account
+                                       if ((isExtensionInstalledAndNewer('bonus', '0.4.4')) && (isBonusRallyeActive())) {
+                                               // Add points (directly only!)
+                                               SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `bonus_ref`=`bonus_ref`+{?bonus_ref?} WHERE `userid`=%s LIMIT 1",
+                                                       array(bigintval($refid)), __FILE__, __LINE__);
+
+                                               // Subtract points from system
+                                               handleBonusPoints(getConfig('bonus_ref'));
+                                       } // 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'));
+                               } // END - if
+                       } // END - if
+
+                       if (isExtensionActive('rallye')) {
+                               // Add user to rallye (or not?)
+                               addUserToReferalRallye(bigintval($userid));
+                       } // END - if
+
+                       // Account confirmed!
+                       if (isExtensionActive('lead')) {
+                               // Set special lead cookie
+                               setSession('lead_userid', bigintval($userid));
+
+                               // Lead-Code mode enabled
+                               redirectToUrl('lead-confirm.php');
+                       } else {
+                               $content['message'] = '{--GUEST_CONFIRMED_DONE--}';
+                               $content['userid']  = bigintval($userid);
+                       }
+               } elseif (isExtensionActive('lead')) {
+                       // Set special lead cookie
+                       setSession('lead_userid', bigintval($userid));
+
+                       // Lead-Code mode enabled
+                       redirectToUrl('lead-confirm.php');
+               } else {
+                       // Nobody was found unter this hash key... or our new member want's to confirm twice?
+                       $content['message'] = '{--GUEST_CONFIRMED_TWICE--}';
+               }
+       } else {
+               // Nobody was found unter this hash key... or our new member want's to confirm twice?
+               $content['message'] = '{--GUEST_CONFIRMED_TWICE--}';
+       }
+
+       // Load template
+       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('hash' => $content['user_hash']), $content['userid']);
+
+                       // Send email
+                       sendEmail($email, '{--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 = getMaskedMessage('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
+function doExpressionUser ($data) {
+       // Use current userid by default
+       $functionName = 'getMemberId()';
+
+       // User-related data, so is there a userid?
+       if (!empty($data['matches'][4][$data['key']])) {
+               // Do we have a userid or $userid?
+               if ($data['matches'][4][$data['key']] == '$userid') {
+                       // Use dynamic call
+                       $functionName = "getFetchedUserData('userid', \$userid, '" . $data['callback'] . "')";
+               } elseif (!empty($data['matches'][4][$data['key']])) {
+                       // User data found
+                       $functionName = "getFetchedUserData('userid', " . $data['matches'][4][$data['key']] . ", '" . $data['callback'] . "')";
+               }
+       } elseif ((!empty($data['callback'])) && (isUserDataValid())) {
+               // "Call-back" alias column for current logged in user's data
+               $functionName = "getUserData('" . $data['callback'] . "')";
+       }
+
+       // Do we have 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;
+}
+
+// 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]