Even more rewrites/fixes from EL branch (please report any broken part after you...
[mailer.git] / inc / libs / user_functions.php
index 9ab8d98..ca86a9b 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 07/16/2004 *
- * ===============                              Last change: 10/27/2004 *
+ * Mailer v0.2.1-FINAL                                Start: 07/16/2004 *
+ * ===================                          Last change: 10/27/2004 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : user_functions.php                               *
@@ -18,6 +18,7 @@
  * 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                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
 // Some security stuff...
 if (!defined('__SECURITY')) {
        die();
-}
+} // END - if
 
 // Add links for selecting some users
 function alpha ($sortby, $colspan, $return=false) {
-       if (!isGetRequestElementSet('offset')) setRequestGetElement('offset', 0);
-       $add = "&amp;page=".getRequestElement('page')."&amp;offset=".getRequestElement('offset');
-       if (isGetRequestElementSet('mode')) $add .= "&amp;mode=".getRequestElement('mode');
+       if (!isGetRequestParameterSet('offset')) setGetRequestParameter('offset', 0);
+       $add = '&amp;page='.getRequestParameter('page').'&amp;offset='.getRequestParameter('offset');
+       if (isGetRequestParameterSet('mode')) $add .= '&amp;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'));
        $num = count($alphabet) - 1;
        $OUT = '';
        while (list($counter, $ltr) = each($alphabet)) {
-               if (getRequestElement('letter') == $ltr) {
+               if (getRequestParameter('letter') == $ltr) {
                        // Current letter is letter from URL
-                       $OUT .= "<strong>".$ltr."</strong>";
+                       $OUT .= '<strong>' . $ltr . '</strong>';
                } else {
                        // Output link to letter
-                       $OUT .= "<a href=\"{?URL?}/modules.php?module=admin&amp;what=".getWhat();
-                       if (isGetRequestElementSet('mode')) $OUT .= "&amp;mode=".getRequestElement('mode');
-                       $OUT .= "&amp;letter=".$ltr."&amp;sortby=".$sortby.$add."\">".$ltr."</a>";
+                       $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=' . getWhat();
+                       if (isGetRequestParameterSet('mode')) $OUT .= '&amp;mode=' . getRequestParameter('mode');
+                       $OUT .= '&amp;letter=' . $ltr . '&amp;sortby=' . $sortby . $add . '%}">' . $ltr . '</a>';
                }
 
                if ((($counter / getConfig('user_alpha')) == round($counter / getConfig('user_alpha'))) && ($counter > 0)) {
-                       $OUT .= "&nbsp;]<br />[&nbsp;";
+                       $OUT .= '&nbsp;]<br />[&nbsp;';
                } elseif ( $counter != $num ) {
-                       $OUT .= "&nbsp;|&nbsp;";
+                       $OUT .= '&nbsp;|&nbsp;';
                }
        } // END - while
 
@@ -83,15 +84,15 @@ function alpha ($sortby, $colspan, $return=false) {
 // Add links for sorting
 function addSortLinks ($letter, $sortby, $colspan, $return=false) {
        $OUT = '';
-       if (!isGetRequestElementSet('offset')) setRequestGetElement('offset', 0);
-       if (!isGetRequestElementSet('page'))   setRequestGetElement('page'  , 0);
+       if (!isGetRequestParameterSet('offset')) setGetRequestParameter('offset', 0);
+       if (!isGetRequestParameterSet('page'))   setGetRequestParameter('page'  , 0);
 
        // Add page and offset
-       $add = '&amp;page=' . getRequestElement('page') . '&amp;offset=' . getRequestElement('offset');
+       $add = '&amp;page=' . getRequestParameter('page') . '&amp;offset=' . getRequestParameter('offset');
 
        // Add status or mode
-       if (isGetRequestElementSet('status'))   $add .= '&amp;mode=' . getRequestElement('status');
-       elseif (isGetRequestElementSet('mode')) $add .= '&amp;mode=' . getRequestElement('mode');
+       if (isGetRequestParameterSet('status'))   $add .= '&amp;mode=' . getRequestParameter('status');
+       elseif (isGetRequestParameterSet('mode')) $add .= '&amp;mode=' . getRequestParameter('mode');
 
        // Makes order by links..
        if ($letter == 'front') $letter = getMessage('_ALL2');
@@ -99,8 +100,8 @@ function addSortLinks ($letter, $sortby, $colspan, $return=false) {
        // Prepare array with all possible sorters
        $list = array(
                'userid'      => getMessage('_UID'),
-               'family'      => getMessage('FAMILY_NAME'),
-               'email'       => getMessage('EMAIL_ADDRESS'),
+               'family'      => getMessage('FAMILY'),
+               'email'       => getMessage('EMAIL'),
                'REMOTE_ADDR' => getMessage('REMOTE_IP')
        );
 
@@ -111,9 +112,9 @@ function addSortLinks ($letter, $sortby, $colspan, $return=false) {
 
        foreach ($list as $sort => $title) {
                if ($sortby == $sort) {
-                       $OUT .= "<strong>" . $title . "</strong>&nbsp;|&nbsp;";
+                       $OUT .= '<strong>' . $title . '</strong>&nbsp;|&nbsp;';
                } 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>&nbsp;|&nbsp;';
                }
        } // END - foreach
 
@@ -133,46 +134,46 @@ function addSortLinks ($letter, $sortby, $colspan, $return=false) {
 }
 
 // Add page navigation
-function addPageNavigation ($PAGES, $offset, $show_form, $colspan,$return=false) {
+function addPageNavigation ($pages, $offset, $showForm, $colspan, $return=false) {
        // @TODO These two constants are no longer used, maybe we reactivate this code?
-       //if ($show_form === true) {
+       //if ($showForm === true) {
        //      // Load form for changing number of lines
        //      define('__FORM_HEADER', loadTemplate('admin_list_user_sort_form', true));
-       //      define('__FORM_FOOTER', '<tr><td colspan="'.$colspan.'" class="seperator bottom2">&nbsp;</td></tr>');
+       //      define('__FORM_FOOTER', '<tr><td colspan="'.$colspan.'" class="seperator bottom">&nbsp;</td></tr>');
        //} else {
        //      // Empty row
        //      define('__FORM_HEADER', '<tr><td colspan="' . $colspan . '" class="seperator">&nbsp;</td></tr>');
-       //      define('__FORM_FOOTER', '<tr><td colspan="' . $colspan . '" class="seperator bottom2">&nbsp;</td></tr>');
+       //      define('__FORM_FOOTER', '<tr><td colspan="' . $colspan . '" class="seperator bottom">&nbsp;</td></tr>');
        //}
 
        $OUT = '';
-       for ($page = 1; $page <= $PAGES; $page++) {
-               if (($page == getRequestElement('page')) || ((!isGetRequestElementSet('page')) && ($page == 1))) {
+       for ($page = 1; $page <= $pages; $page++) {
+               if (($page == getRequestParameter('page')) || ((!isGetRequestParameterSet('page')) && ($page == 1))) {
                        $OUT .= '<strong>-';
                } else {
-                       if (!isGetRequestElementSet('letter')) setRequestGetElement('letter', getMessage('_ALL2'));
-                       if (!isGetRequestElementSet('sortby')) setRequestGetElement('sortby', 'userid');
+                       if (!isGetRequestParameterSet('letter')) setGetRequestParameter('letter', getMessage('_ALL2'));
+                       if (!isGetRequestParameterSet('sortby')) setGetRequestParameter('sortby', 'userid');
 
                        // Base link
-                       $OUT .= '<a href="{?URL?}/modules.php?module=admin&amp;what=' . getWhat();
+                       $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=' . getWhat();
 
                        // Add status or mode
-                       if (isGetRequestElementSet('status'))    $OUT .= '&amp;mode=' . getRequestElement('status');
-                        elseif (isGetRequestElementSet('mode')) $OUT .= '&amp;mode=' . getRequestElement('mode');
+                       if (isGetRequestParameterSet('status'))    $OUT .= '&amp;mode=' . getRequestParameter('status');
+                        elseif (isGetRequestParameterSet('mode')) $OUT .= '&amp;mode=' . getRequestParameter('mode');
 
                        // Letter and so on
-                       $OUT .= '&amp;letter=' . getRequestElement('letter') . '&amp;sortby=' . getRequestElement('sortby') . '&amp;page=' . $page . '&amp;offset=' . $offset . '">';
+                       $OUT .= '&amp;letter=' . getRequestParameter('letter') . '&amp;sortby=' . getRequestParameter('sortby') . '&amp;page=' . $page . '&amp;offset=' . $offset . '%}">';
                }
 
                $OUT .= $page;
 
-               if (($page == getRequestElement('page')) || ((!isGetRequestElementSet('page')) && ($page == 1))) {
+               if (($page == getRequestParameter('page')) || ((!isGetRequestParameterSet('page')) && ($page == 1))) {
                        $OUT .= '-</strong>';
                } else  {
                        $OUT .= '</a>';
                }
 
-               if ($page < $PAGES) $OUT .= '&nbsp;|&nbsp;';
+               if ($page < $pages) $OUT .= '&nbsp;|&nbsp;';
        } // END - for
 
        // Remember the list
@@ -210,7 +211,7 @@ LIMIT 1",
                list($userid) = SQL_FETCHROW($result);
 
                // Rewrite email address to contact link
-               $email = '{?URL?}/modules.php?module=' . $mod . '&amp;what=user_contct&amp;userid=' . bigintval($userid);
+               $email = '{%url=modules.php?module=' . $mod . '&amp;what=user_contct&amp;userid=' . bigintval($userid) . '%}';
        } // END - if
 
        // Free memory
@@ -221,12 +222,13 @@ LIMIT 1",
 }
 
 // Selects a random user id as the new referal id if they have at least X confirmed mails in this run
+// @TODO Double-check configuration entry here
 function determineRandomReferalId () {
        // Default is zero refid
-       $refid = 0;
+       $refid = '0';
 
        // Is the extension version fine?
-       if (getExtensionVersion('user') >= '0.3.4') {
+       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')."");
 
@@ -263,13 +265,8 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
        // Init variables
        $dmy = '';
        $add = '';
-       $errorCode = 0;
-
-       // Add last_login if available
-       $lastOnline = '';
-       if (getExtensionVersion('sql_patches') >= '0.2.8') {
-               $lastOnline = ', `last_login`';
-       } // END - if
+       $errorCode = '0';
+       $ext = '';
 
        // Init array
        $content = array(
@@ -281,31 +278,38 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
        );
 
        // Check login data
-       if ((isExtensionActive('nickname')) && (isNicknameOrUserid($userid))) {
+       if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
                // Nickname entered
                fetchUserData($userid, 'nickname');
+       } elseif (isNicknameUsed($userid)) {
+               // No nickname installed
+               $errorCode = getCode('EXTENSION_PROBLEM');
+               $ext = 'nickname';
        } else {
                // Direct userid entered
                fetchUserData($userid);
        }
 
-       // Load entry
-       $content = getUserDataArray();
-       if (!empty($content['userid'])) $userid = bigintval($content['userid']);
+       // No error found?
+       if ($errorCode == '0') {
+               // 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']);
+       } // END - if
 
        // Is there an entry?
-       if ((isUserDataValid()) && (getUserData('status') == 'CONFIRMED') && ((isNicknameUsed($content['userid'] === true) && (!empty($content['userid']))) || ($content['userid'] == $userid))) {
+       if ((isUserDataValid()) && (getUserData('status') == 'CONFIRMED') && (!empty($content['userid']))) {
                // Check for old MD5 passwords
-               if ((strlen($content['password']) == 32) && (md5($passwd) == $content['password'])) {
+               if ((strlen(getUserData('password')) == 32) && (md5($passwd) == getUserData('password'))) {
                        // Just set the hash to the password from DB... :)
-                       $content['hash'] = $content['password'];
+                       $content['hash'] = getUserData('password');
                } else {
                        // Hash password with improved way for comparsion
-                       $content['hash'] = generateHash($passwd, substr($content['password'], 0, -40));
+                       $content['hash'] = generateHash($passwd, substr(getUserData('password'), 0, -40));
                }
 
                // Does the password match the hash?
-               if ($content['hash'] == $content['password']) {
+               if ($content['hash'] == getUserData('password')) {
                        // New hashed password found so let's generate a new one
                        $content['hash'] = generateHash($passwd);
 
@@ -318,26 +322,26 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                        $GLOBALS['bonus_payed'] = false;
 
                        // Probe for last online timemark
-                       $probe = time() -  $content['last_online'];
-                       if (!empty($content['last_login'])) $probe = time() - $content['last_login'];
-                       if ((getExtensionVersion('bonus') >= '0.2.2') && ($probe >= getConfig('login_timeout'))) {
+                       $probe = time() -  getUserData('last_online');
+                       if (getUserData('last_login') > 0) $probe = time() - getUserData('last_login');
+
+                       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;
 
                                // Subtract login bonus from userid's account or jackpot
-                               if ((getExtensionVersion('bonus') >= '0.3.5') && (getConfig('bonus_mode') != 'ADD')) handleBonusPoints('login_bonus');
+                               if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getConfig('bonus_mode') != 'ADD')) handleBonusPoints('login_bonus');
                        } // END - if
 
-                       // Calculate new hash with the secret key and master salt together
-                       $content['hash'] = generatePassString($content['hash']);
+                       // @TODO Make this filter working: $url = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
 
-                       // Update global array
-                       // @TODO Make this filter working: $URL = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
+                       // Set member id
                        setMemberId($userid);
 
                        // Try to set session data (which shall normally always work!)
-                       if ((setSession('userid', $userid )) && (setSession('u_hash', $content['hash']))) {
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',hash=' . $content['hash'] . '(' . strlen($content['hash']) . ')');
+                       if ((setSession('userid', $userid )) && (setSession('u_hash', encodeHashForCookie($content['hash'])))) {
                                // 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__);
@@ -345,16 +349,16 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                                        // Is a success URL set?
                                        if (empty($successUrl)) {
                                                // Procedure to checking for login data
-                                               if (($GLOBALS['bonus_payed']) && (isExtensionActive('bonus'))) {
+                                               if (($GLOBALS['bonus_payed'] === true) && (isExtensionActive('bonus'))) {
                                                        // Bonus added (just displaying!)
-                                                       $URL = 'modules.php?module=chk_login&amp;mode=bonus';
+                                                       $url = 'modules.php?module=chk_login&amp;mode=bonus';
                                                } else {
                                                        // Bonus not added
-                                                       $URL = 'modules.php?module=chk_login&amp;mode=login';
+                                                       $url = 'modules.php?module=chk_login&amp;mode=login';
                                                }
                                        } else {
                                                // Use this URL
-                                               $URL = $successUrl;
+                                               $url = $successUrl;
                                        }
                                } else {
                                        // Cannot update counter!
@@ -362,9 +366,9 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                                }
                        } else {
                                // Cookies not setable!
-                               $errorCode = getCode('NO_COOKIES');
+                               $errorCode = getCode('COOKIES_DISABLED');
                        }
-               } elseif (getExtensionVersion('sql_patches') >= '0.6.1') {
+               } elseif (isExtensionInstalledAndNewer('sql_patches', '0.6.1')) {
                        // Update failture 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__);
@@ -372,42 +376,46 @@ function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.p
                        // Wrong password!
                        $errorCode = getCode('WRONG_PASS');
                }
-       } elseif (((isNicknameUsed($content['userid'])) && (!empty($content['userid']))) || ($content['userid'] == $userid)) {
-               // Other account status?
-               if (fetchUserData($userid)) {
-                       // Create an error code from given status
-                       $errorCode = generateErrorCodeFromUserStatus(getUserData('status'));
-               } else {
-                       // id not found!
-                       $errorCode = getCode('WRONG_ID');
-               }
-       } else {
-               // id not found!
+       } elseif (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!
                $errorCode = getCode('WRONG_ID');
+       } else {
+               // Unknown error
+               $errorCode = getCode('UNKNOWN_ERROR');
        }
 
        // Error code provided?
        if ($errorCode > 0) {
                // Then reconstruct the URL
-               $URL = $errorUrl . $errorCode;
+               $url = $errorUrl . $errorCode;
+
+               // Extension set? Then add it as well.
+               if (!empty($ext)) $url .= '&amp;ext=' . $ext;
        } // END - if
 
        // Return URL
-       return $URL;
+       return $url;
 }
 
 // Try to send a new password for the given user account
 function doNewUserPassword ($email, $userid) {
-       // Compile email when found in address (only secure chars!)
-       if (!empty($email)) $email = str_replace('{DOT}', '.', $email);
-
        // Init result and error
        $errorCode = '';
        $result = false;
 
        // Probe userid/nickname
        // @TODO We should try to rewrite this to fetchUserData() somehow
-       if ((isExtensionActive('nickname')) && (isNicknameOrUserid($userid))) {
+       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__);
+       } 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__);
@@ -415,10 +423,6 @@ function doNewUserPassword ($email, $userid) {
                // 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__);
-       } elseif (!empty($email)) {
-               // Email entered
-               $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `email`='%s' LIMIT 1",
-                       array($email), __FUNCTION__, __LINE__);
        } else {
                // Userid not set!
                logDebugMessage(__FUNCTION__, __LINE__, 'Userid is not set! BUG!');
@@ -460,5 +464,69 @@ function doNewUserPassword ($email, $userid) {
        return $errorCode;
 }
 
+// Get timestamp for given stats type and data
+function getTimestampFromUserStats ($statsType, $statsData, $userid = '0') {
+       // Default timestamp is zero
+       $data['inserted'] = '0';
+
+       // User id set?
+       if ((isMemberIdSet()) && ($userid == '0')) {
+               $userid = getMemberId();
+       } // END - if
+
+       // Is the extension installed and updated?
+       if ((!isExtensionActive('sql_patches')) || (isExtensionOlder('sql_patches', '0.5.6'))) {
+               // Return zero here
+               return $data['inserted'];
+       } // END - if
+
+       // Try to find the entry
+       $result = SQL_QUERY_ESC("SELECT
+       UNIX_TIMESTAMP(`inserted`) AS inserted
+FROM
+       `{?_MYSQL_PREFIX?}_user_stats_data`
+WHERE
+       `userid`=%s AND
+       `stats_type`='%s' AND
+       `stats_data`='%s'
+LIMIT 1",
+               array(
+                       bigintval($userid),
+                       $statsType,
+                       $statsData
+               ), __FUNCTION__, __LINE__);
+
+       // Is the entry there?
+       if (SQL_NUMROWS($result) == 1) {
+               // Get this stamp
+               $data = SQL_FETCHARRAY($result);
+       } // END - if
+
+       // Free result
+       SQL_FREERESULT($result);
+
+       // Return stamp
+       return $data['inserted'];
+}
+
+// Inserts user stats
+function insertUserStatsRecord ($userid, $statsType, $statsData) {
+       // Is the extension installed and updated?
+       if ((!isExtensionActive('sql_patches')) || (isExtensionOlder('sql_patches', '0.5.6'))) {
+               // Return zero here
+               return false;
+       } // END - if
+
+       // Does it exist?
+       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__);
+       } elseif (is_array($statsData)) {
+               // Invalid data!
+               logDebugMessage(__FUNCTION__, __LINE__, "userid={$userid},type={$statsType},data={".gettype($statsData).": Invalid statistics data type!");
+       }
+}
+
 // [EOF]
 ?>