2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 07/16/2004 *
4 * =================== Last change: 10/27/2004 *
6 * -------------------------------------------------------------------- *
7 * File : user_functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Special functions for user extension *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Spezielle Funktionen fuer die user-Erweiterung *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // Add links for selecting some users
46 function alpha ($sortby, $colspan, $return=false) {
47 if (!isGetRequestParameterSet('offset')) setGetRequestParameter('offset', 0);
48 $add = '&page='.getRequestParameter('page').'&offset='.getRequestParameter('offset');
49 if (isGetRequestParameterSet('mode')) $add .= '&mode='.getRequestParameter('mode');
51 /* Creates the list of letters and makes them a link. */
52 $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'));
53 $num = count($alphabet) - 1;
55 while (list($counter, $ltr) = each($alphabet)) {
56 if (getRequestParameter('letter') == $ltr) {
57 // Current letter is letter from URL
58 $OUT .= '<strong>' . $ltr . '</strong>';
60 // Output link to letter
61 $OUT .= '<a href="{%url=modules.php?module=admin&what=' . getWhat();
62 if (isGetRequestParameterSet('mode')) $OUT .= '&mode=' . getRequestParameter('mode');
63 $OUT .= '&letter=' . $ltr . '&sortby=' . $sortby . $add . '%}">' . $ltr . '</a>';
66 if ((($counter / getConfig('user_alpha')) == round($counter / getConfig('user_alpha'))) && ($counter > 0)) {
68 } elseif ( $counter != $num ) {
75 'colspan2' => $colspan,
76 'alpha_selection' => $OUT
80 $OUT = loadTemplate('admin_list_user_alpha', true, $content);
81 if ($return === true) {
82 // Return generated code
85 // Output generated code
90 // Add links for sorting
91 function addSortLinks ($letter, $sortby, $colspan, $return=false) {
93 if (!isGetRequestParameterSet('offset')) setGetRequestParameter('offset', 0);
94 if (!isGetRequestParameterSet('page')) setGetRequestParameter('page' , 0);
96 // Add page and offset
97 $add = '&page=' . getRequestParameter('page') . '&offset=' . getRequestParameter('offset');
100 if (isGetRequestParameterSet('status')) $add .= '&mode=' . getRequestParameter('status');
101 elseif (isGetRequestParameterSet('mode')) $add .= '&mode=' . getRequestParameter('mode');
103 // Makes order by links..
104 if ($letter == 'front') $letter = getMessage('_ALL2');
106 // Prepare array with all possible sorters
108 'userid' => getMessage('_UID'),
109 'family' => getMessage('FAMILY'),
110 'email' => getMessage('EMAIL'),
111 'REMOTE_ADDR' => getMessage('REMOTE_IP')
114 // Add nickname if extension is installed
115 if (isExtensionActive('nickname')) {
116 $list['nickname'] = getMessage('NICKNAME');
119 foreach ($list as $sort => $title) {
120 if ($sortby == $sort) {
121 $OUT .= '<strong>' . $title . '</strong>|';
123 $OUT .= '<a href="{%url=modules.php?module=admin&what=list_user&letter=' . $letter . '&sortby=' . $sort . $add . '%}">' . $title . '</a>|';
127 // Add list and colspan
128 $content['list'] = substr($OUT, 0, -13);
129 $content['colspan2'] = $colspan;
132 $OUT = loadTemplate('admin_list_user_sort', true, $content);
134 // Should we return or output?
135 if ($return === true) {
144 // Add page navigation
145 function addPageNavigation ($pages, $offset, $showForm, $colspan, $return=false) {
146 // @TODO These two constants are no longer used, maybe we reactivate this code?
147 //if ($showForm === true) {
148 // // Load form for changing number of lines
149 // define('__FORM_HEADER', loadTemplate('admin_list_user_sort_form', true));
150 // define('__FORM_FOOTER', '<tr><td colspan="'.$colspan.'" class="seperator bottom"> </td></tr>');
153 // define('__FORM_HEADER', '<tr><td colspan="' . $colspan . '" class="seperator"> </td></tr>');
154 // define('__FORM_FOOTER', '<tr><td colspan="' . $colspan . '" class="seperator bottom"> </td></tr>');
158 for ($page = 1; $page <= $pages; $page++) {
159 if (($page == getRequestParameter('page')) || ((!isGetRequestParameterSet('page')) && ($page == 1))) {
162 if (!isGetRequestParameterSet('letter')) setGetRequestParameter('letter', getMessage('_ALL2'));
163 if (!isGetRequestParameterSet('sortby')) setGetRequestParameter('sortby', 'userid');
166 $OUT .= '<a href="{%url=modules.php?module=admin&what=' . getWhat();
168 // Add status or mode
169 if (isGetRequestParameterSet('status')) $OUT .= '&mode=' . getRequestParameter('status');
170 elseif (isGetRequestParameterSet('mode')) $OUT .= '&mode=' . getRequestParameter('mode');
173 $OUT .= '&letter=' . getRequestParameter('letter') . '&sortby=' . getRequestParameter('sortby') . '&page=' . $page . '&offset=' . $offset . '%}">';
178 if (($page == getRequestParameter('page')) || ((!isGetRequestParameterSet('page')) && ($page == 1))) {
179 $OUT .= '-</strong>';
184 if ($page < $pages) $OUT .= '|';
188 $content['list'] = $OUT;
191 $OUT = loadTemplate('admin_list_user_pagenav', true, $content);
192 if ($return === true) {
201 // Create email link to user's account
202 function generateUserEmailLink($email, $mod = 'admin') {
203 // Show contact link only if user is confirmed by default
204 $locked = " AND `status`='CONFIRMED'";
206 // But admins shall always see it
207 if (isAdmin()) $locked = '';
209 $result = SQL_QUERY_ESC("SELECT
212 `{?_MYSQL_PREFIX?}_user_data`
214 `email`='%s'" . $locked."
216 array($email), __FUNCTION__, __LINE__);
217 if (SQL_NUMROWS($result) == 1) {
219 list($userid) = SQL_FETCHROW($result);
221 // Rewrite email address to contact link
222 $email = '{%url=modules.php?module=' . $mod . '&what=user_contct&userid=' . bigintval($userid) . '%}';
226 SQL_FREERESULT($result);
228 // Return rewritten (?) email address
232 // Selects a random user id as the new referal id if they have at least X confirmed mails in this run
233 // @TODO Double-check configuration entry here
234 function determineRandomReferalId () {
235 // Default is zero refid
238 // Is the extension version fine?
239 if (isExtensionInstalledAndNewer('user', '0.3.4')) {
241 $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true, " AND `rand_confirmed` >= {?user_min_confirmed?}");
243 // Do we have at least one?
244 if ($totalUsers > 0) {
245 // Then choose random number
246 $randNum = mt_rand(0, ($totalUsers - 1));
248 // Look for random user
249 $result = SQL_QUERY_ESC("SELECT `userid` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `status`='CONFIRMED' AND `rand_confirmed` >= {?user_min_confirmed?} ORDER BY `rand_confirmed` DESC LIMIT %s, 1",
250 array($randNum), __FUNCTION__, __LINE__);
252 // Do we have one entry there?
253 if (SQL_NUMROWS($result) == 1) {
254 // Use that userid as new referal id
255 list($refid) = SQL_FETCHROW($result);
257 // Reset this user's counter
258 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `rand_confirmed`=0 WHERE `userid`=%s LIMIT 1",
259 array($refid), __FUNCTION__, __LINE__);
263 SQL_FREERESULT($result);
272 function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.php?module=index&what=login&login=') {
289 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
291 fetchUserData($userid, 'nickname');
292 } elseif (isNicknameUsed($userid)) {
293 // No nickname installed
294 $errorCode = getCode('EXTENSION_PROBLEM');
297 // Direct userid entered
298 fetchUserData($userid);
302 if ($errorCode == '0') {
303 // Get user data array and set userid (e.g. important if we login with nickname)
304 $content = getUserDataArray();
305 if (!empty($content['userid'])) $userid = bigintval($content['userid']);
308 // Is there an entry?
309 if ((isUserDataValid()) && (getUserData('status') == 'CONFIRMED') && (!empty($content['userid']))) {
310 // Check for old MD5 passwords
311 if ((strlen(getUserData('password')) == 32) && (md5($passwd) == getUserData('password'))) {
312 // Just set the hash to the password from DB... :)
313 $content['hash'] = getUserData('password');
315 // Hash password with improved way for comparsion
316 $content['hash'] = generateHash($passwd, substr(getUserData('password'), 0, -40));
319 // Does the password match the hash?
320 if ($content['hash'] == getUserData('password')) {
321 // New hashed password found so let's generate a new one
322 $content['hash'] = generateHash($passwd);
324 // ... and update database
325 // @TODO Make this filter working: $ADDON = runFilterChain('post_login_update', $content);
326 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `password`='%s' WHERE `userid`=%s AND `status`='CONFIRMED' LIMIT 1",
327 array($content['hash'], $userid), __FUNCTION__, __LINE__);
329 // No login bonus by default
330 $GLOBALS['bonus_payed'] = false;
332 // Probe for last online timemark
333 $probe = time() - getUserData('last_online');
334 if (getUserData('last_login') > 0) $probe = time() - getUserData('last_login');
336 if ((isExtensionInstalledAndNewer('bonus', '0.2.2')) && ($probe >= getConfig('login_timeout'))) {
337 // Add login bonus to user's account
338 $add = ', `login_bonus`=`login_bonus`+{?login_bonus?}';
339 $GLOBALS['bonus_payed'] = true;
341 // Subtract login bonus from userid's account or jackpot
342 if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getConfig('bonus_mode') != 'ADD')) handleBonusPoints('login_bonus');
345 // @TODO Make this filter working: $url = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
348 setMemberId($userid);
350 // Try to set session data (which shall normally always work!)
351 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',hash=' . $content['hash'] . '(' . strlen($content['hash']) . ')');
352 if ((setSession('userid', $userid )) && (setSession('u_hash', encodeHashForCookie($content['hash'])))) {
353 // Update database records
354 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `total_logins`=`total_logins`+1" . $add . " WHERE `userid`=%s LIMIT 1",
355 array($userid), __FUNCTION__, __LINE__);
356 if (SQL_AFFECTEDROWS() == 1) {
357 // Is a success URL set?
358 if (empty($successUrl)) {
359 // Procedure to checking for login data
360 if (($GLOBALS['bonus_payed'] === true) && (isExtensionActive('bonus'))) {
361 // Bonus added (just displaying!)
362 $url = 'modules.php?module=chk_login&mode=bonus';
365 $url = 'modules.php?module=chk_login&mode=login';
372 // Cannot update counter!
373 $errorCode = getCode('CNTR_FAILED');
376 // Cookies not setable!
377 $errorCode = getCode('COOKIES_DISABLED');
379 } elseif (isExtensionInstalledAndNewer('sql_patches', '0.6.1')) {
380 // Update failture counter
381 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `login_failures`=`login_failures`+1,`last_failure`=NOW() WHERE `userid`=%s LIMIT 1",
382 array($userid), __FUNCTION__, __LINE__);
385 $errorCode = getCode('WRONG_PASS');
387 } elseif (getUserData('status') != 'CONFIRMED') {
388 // Create an error code from given status
389 $errorCode = generateErrorCodeFromUserStatus(getUserData('status'));
391 // Set userid in session
392 setSession('current_userid', getUserData('userid'));
393 } elseif (!isUserDataValid()) {
394 // User id not found!
395 $errorCode = getCode('WRONG_ID');
398 $errorCode = getCode('UNKNOWN_ERROR');
401 // Error code provided?
402 if ($errorCode > 0) {
403 // Then reconstruct the URL
404 $url = $errorUrl . $errorCode;
406 // Extension set? Then add it as well.
407 if (!empty($ext)) $url .= '&ext=' . $ext;
414 // Try to send a new password for the given user account
415 function doNewUserPassword ($email, $userid) {
416 // Init result and error
420 // Probe userid/nickname
421 // @TODO We should try to rewrite this to fetchUserData() somehow
422 if (!empty($email)) {
424 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `email`='%s' OR `email`='%s' LIMIT 1",
425 array($email, str_replace('.', '{DOT}', $email)), __FUNCTION__, __LINE__);
426 } elseif ((isExtensionActive('nickname')) && (isNicknameOrUserid($userid))) {
428 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `nickname`='%s' OR `userid`='%s' OR `email`='%s' LIMIT 1",
429 array($userid, $userid, $email), __FUNCTION__, __LINE__);
430 } elseif (($userid > 0) && (empty($email))) {
431 // Direct userid entered
432 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `userid`=%s LIMIT 1",
433 array(bigintval($userid)), __FUNCTION__, __LINE__);
436 logDebugMessage(__FUNCTION__, __LINE__, 'Userid is not set! BUG!');
437 $errorCode = getCode('WRONG_ID');
441 if (SQL_NUMROWS($result) == 1) {
442 // This data is valid, so we create a new pass... :-)
443 list($userid, $status) = SQL_FETCHROW($result);
445 if ($status == 'CONFIRMED') {
446 // Ooppps, this was missing! ;-) We should update the database...
447 $NEW_PASS = generatePassword();
448 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `password`='%s' WHERE `userid`=%s LIMIT 1",
449 array(generateHash($NEW_PASS), $userid), __FUNCTION__, __LINE__);
451 // Prepare data and message for email
452 $message = loadEmailTemplate('new-pass', array('new_pass' => $NEW_PASS, 'nickname' => $userid), $userid);
454 // ... and send it away
455 sendEmail($userid, getMessage('GUEST_NEW_PASSWORD'), $message);
457 // Output note to user
458 loadTemplate('admin_settings_saved', false, getMessage('GUEST_NEW_PASSWORD_SEND'));
460 // Account is locked or unconfirmed
461 $errorCode = generateErrorCodeFromUserStatus($status);
464 redirectToUrl('modules.php?module=index&what=login&login='.$errorCode);
467 // id or email is wrong
468 loadTemplate('admin_settings_saved', false, '<span class="guest_failed">{--GUEST_WRONG_ID_EMAIL--}</span>');
471 // Return the error code
475 // Get timestamp for given stats type and data
476 function getTimestampFromUserStats ($statsType, $statsData, $userid = '0') {
477 // Default timestamp is zero
478 $data['inserted'] = '0';
481 if ((isMemberIdSet()) && ($userid == '0')) {
482 $userid = getMemberId();
485 // Is the extension installed and updated?
486 if ((!isExtensionActive('sql_patches')) || (isExtensionOlder('sql_patches', '0.5.6'))) {
488 return $data['inserted'];
491 // Try to find the entry
492 $result = SQL_QUERY_ESC("SELECT
493 UNIX_TIMESTAMP(`inserted`) AS inserted
495 `{?_MYSQL_PREFIX?}_user_stats_data`
498 `stats_type`='%s' AND
505 ), __FUNCTION__, __LINE__);
507 // Is the entry there?
508 if (SQL_NUMROWS($result) == 1) {
510 $data = SQL_FETCHARRAY($result);
514 SQL_FREERESULT($result);
517 return $data['inserted'];
520 // Inserts user stats
521 function insertUserStatsRecord ($userid, $statsType, $statsData) {
522 // Is the extension installed and updated?
523 if ((!isExtensionActive('sql_patches')) || (isExtensionOlder('sql_patches', '0.5.6'))) {
529 if ((!getTimestampFromUserStats($statsType, $statsData, $userid)) && (!is_array($statsData))) {
531 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_stats_data` (`userid`,`stats_type`,`stats_data`) VALUES (%s,'%s','%s')",
532 array(bigintval($userid), $statsType, $statsData), __FUNCTION__, __LINE__);
533 } elseif (is_array($statsData)) {
535 logDebugMessage(__FUNCTION__, __LINE__, "userid={$userid},type={$statsType},data={".gettype($statsData).": Invalid statistics data type!");