inc/libs/user_functions.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    Start: 07/16/2004 *
   4  * ===============                              Last change: 10/27/2004 *
   5  *                                                                      *
   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  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  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 - 2008 by Roland Haeder                           *
  21  * For more information visit: http://www.mxchange.org                  *
  22  *                                                                      *
  23  * This program is free software; you can redistribute it and/or modify *
  24  * it under the terms of the GNU General Public License as published by *
  25  * the Free Software Foundation; either version 2 of the License, or    *
  26  * (at your option) any later version.                                  *
  27  *                                                                      *
  28  * This program is distributed in the hope that it will be useful,      *
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  31  * GNU General Public License for more details.                         *
  32  *                                                                      *
  33  * You should have received a copy of the GNU General Public License    *
  34  * along with this program; if not, write to the Free Software          *
  35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  36  * MA  02110-1301  USA                                                  *
  37  ************************************************************************/
  38
  39 // Some security stuff...
  40 if (!defined('__SECURITY')) {
  41         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
  42         require($INC);
  43 }
  44
  45 // Add links for selecting some users
  46 function alpha ($sortby, $colspan, $return=false) {
  47         if (!REQUEST_ISSET_GET('offset')) REQUEST_SET_GET('offset', 0);
  48         $add = "&amp;page=".REQUEST_GET('page')."&amp;offset=".REQUEST_GET('offset');
  49         if (REQUEST_ISSET_GET('mode')) $add .= "&amp;mode=".REQUEST_GET('mode');
  50
  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;
  54         $OUT = '';
  55         while (list($counter, $ltr) = each($alphabet)) {
  56                 if (REQUEST_GET('letter') == $ltr) {
  57                         // Current letter is letter from URL
  58                         $OUT .= "<strong>".$ltr."</strong>";
  59                 } else {
  60                         // Output link to letter
  61                         $OUT .= "<a href=\"{!URL!}/modules.php?module=admin&amp;what=".getWhat();
  62                         if (REQUEST_ISSET_GET('mode')) $OUT .= "&amp;mode=".REQUEST_GET('mode');
  63                         $OUT .= "&amp;letter=".$ltr."&amp;sortby=".$sortby.$add."\">".$ltr."</a>";
  64                 }
  65
  66                 if ((($counter / getConfig('user_alpha')) == round($counter / getConfig('user_alpha'))) && ($counter > 0)) {
  67                         $OUT .= "&nbsp;]<br />[&nbsp;";
  68                 } elseif ( $counter != $num ) {
  69                         $OUT .= "&nbsp;|&nbsp;";
  70                 }
  71         } // END - while
  72
  73         define('__ALPHA_LIST', $OUT);
  74
  75         // Load template
  76         $OUT = LOAD_TEMPLATE("admin_list_user_alpha", true);
  77         if ($return === true) {
  78                 // Return generated code
  79                 return $OUT;
  80         } else {
  81                 // Output generated code
  82                 OUTPUT_HTML($OUT);
  83         }
  84 }
  85
  86 // Add links for sorting
  87 function SortLinks ($letter, $sortby, $colspan, $return=false) {
  88         $OUT = '';
  89         if (!REQUEST_ISSET_GET('offset')) REQUEST_SET_GET('offset', 0);
  90         if (!REQUEST_ISSET_GET('page'))   REQUEST_SET_GET('page'  , 0);
  91
  92         // Add page and offset
  93         $add = "&amp;page=".REQUEST_GET('page')."&amp;offset=".REQUEST_GET('offset');
  94
  95         // Add status or mode
  96         if (REQUEST_ISSET_GET('status'))   $add .= '&amp;mode=' . REQUEST_GET('status');
  97         elseif (REQUEST_ISSET_GET('mode')) $add .= '&amp;mode=' . REQUEST_GET('mode');
  98
  99         // Makes order by links..
 100         if ($letter == "front") $letter = getMessage('_ALL2');
 101
 102         // Prepare array with all possible sorters
 103         $list = array(
 104                 'userid'      => getMessage('_UID'),
 105                 'family'      => getMessage('FAMILY_NAME'),
 106                 'email'       => getMessage('ADDY'),
 107                 'REMOTE_ADDR' => getMessage('REMOTE_IP')
 108         );
 109
 110         // Add nickname if extension is installed
 111         if (EXT_IS_ACTIVE('nickname')) {
 112                 $list['nickname'] = getMessage('NICKNAME');
 113         } // END - if
 114
 115         foreach ($list as $sort => $title) {
 116                 if ($sortby == $sort) {
 117                         $OUT .= "<strong>" . $title . "</strong>&nbsp;|&nbsp;";
 118                 } else {
 119                         $OUT .= "<a href=\"{!URL!}/modules.php?module=admin&amp;what=list_user&amp;letter=" . $letter . "&amp;sortby=" . $sort.$add . "\">" . $title . "</a>&nbsp;|&nbsp;";
 120                 }
 121         } // END - foreach
 122
 123         define('__SORT_LIST', substr($OUT, 0, -13));
 124
 125         // Load template
 126         $OUT = LOAD_TEMPLATE('admin_list_user_sort', true);
 127         if ($return === true) {
 128                 // Return code
 129                 return $OUT;
 130         } else {
 131                 // Output code
 132                 OUTPUT_HTML($OUT);
 133         }
 134 }
 135
 136 // Add page navigation
 137 function ADD_PAGENAV ($PAGES, $offset, $show_form, $colspan,$return=false) {
 138         if ($show_form) {
 139                 // Load form for changing number of lines
 140                 define('__FORM_HEADER', LOAD_TEMPLATE('admin_list_user_sort_form', true));
 141                 define('__FORM_FOOTER', '<tr><td colspan="{!__COLSPAN2!}" class="seperator bottom2">&nbsp;</td></tr>');
 142         } else {
 143                 // Empty row
 144                 define('__FORM_HEADER', '<tr><td colspan="' . $colspan . '" class="seperator">&nbsp;</td></tr>');
 145                 define('__FORM_FOOTER', '<tr><td colspan="{!__COLSPAN2!}" class="seperator bottom2">&nbsp;</td></tr>');
 146         }
 147
 148         $OUT = '';
 149         for ($page = 1; $page <= $PAGES; $page++) {
 150                 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET('page')) && ($page == '1'))) {
 151                         $OUT .= '<strong>-';
 152                 } else {
 153                         if (!REQUEST_ISSET_GET('letter')) REQUEST_SET_GET('letter', getMessage('_ALL2'));
 154                         if (!REQUEST_ISSET_GET('sortby')) REQUEST_SET_GET('sortby', 'userid');
 155
 156                         // Base link
 157                         $OUT .= '<a href="{!URL!}/modules.php?module=admin&amp;what=' . getWhat();
 158
 159                         // Add status or mode
 160                         if (REQUEST_ISSET_GET('status'))    $OUT .= '&amp;mode=' . REQUEST_GET('status');
 161                          elseif (REQUEST_ISSET_GET('mode')) $OUT .= '&amp;mode=' . REQUEST_GET('mode');
 162
 163                         // Letter and so on
 164                         $OUT .= '&amp;letter=' . REQUEST_GET('letter') . '&amp;sortby=' . REQUEST_GET('sortby') . '&amp;page=' . $page . '&amp;offset=' . $offset . '">';
 165                 }
 166
 167                 $OUT .= $page;
 168
 169                 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET('page')) && ($page == '1'))) {
 170                         $OUT .= '-</strong>';
 171                 } else  {
 172                         $OUT .= '</a>';
 173                 }
 174
 175                 if ($page < $PAGES) $OUT .= '&nbsp;|&nbsp;';
 176         } // END - for
 177
 178         define('__PAGENAV_LIST', $OUT);
 179
 180         // Load template
 181         $OUT = LOAD_TEMPLATE('admin_list_user_pagenav', true);
 182         if ($return === true) {
 183                 // Return code
 184                 return $OUT;
 185         } else {
 186                 // Output code
 187                 OUTPUT_HTML($OUT);
 188         }
 189 }
 190
 191 // Create email link to user's account
 192 function generateUserEmailLink($email, $mod='admin') {
 193         // Show contact link only if user is confirmed by default
 194         $locked = " AND `status`='CONFIRMED'";
 195
 196         // But admins shall always see it
 197         if (IS_ADMIN()) $locked = '';
 198
 199         $result = SQL_QUERY_ESC("SELECT `userid`
 200 FROM `{!_MYSQL_PREFIX!}_user_data`
 201 WHERE `email`='%s'" . $locked." LIMIT 1",
 202                 array($email), __FUNCTION__, __LINE__);
 203         if (SQL_NUMROWS($result) == 1) {
 204                 // Load userid
 205                 list($uid) = SQL_FETCHROW($result);
 206
 207                 // Rewrite email address to contact link
 208                 $email = '{!URL!}/modules.php?module=' . $mod . '&amp;what=user_contct&amp;uid=' . bigintval($uid);
 209         } // END - if
 210
 211         // Free memory
 212         SQL_FREERESULT($result);
 213
 214         // Return rewritten (?) email address
 215         return $email;
 216 }
 217
 218 // Selects a random user id as the new referal id if they have at least X confirmed mails in this run
 219 function determineRandomReferalId () {
 220         // Default is zero refid
 221         $refid = 0;
 222
 223         // Is the extension version fine?
 224         if (GET_EXT_VERSION('user') >= '0.3.4') {
 225                 // Get all user ids
 226                 $totalUsers = GET_TOTAL_DATA('CONFIRMED', 'user_data', 'userid', 'status', true, " AND `rand_confirmed` >= ".getConfig('user_min_confirmed')."");
 227
 228                 // Do we have at least one?
 229                 if ($totalUsers > 0) {
 230                         // Then choose random number
 231                         $randNum = mt_rand(0, ($totalUsers - 1));
 232
 233                         // Look for random user
 234                         $result = SQL_QUERY_ESC("SELECT `userid` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `status`='CONFIRMED' AND `rand_confirmed` >= %s ORDER BY `rand_confirmed` DESC LIMIT %s, 1",
 235                                 array(getConfig('user_min_confirmed'), $randNum), __FUNCTION__, __LINE__);
 236
 237                         // Do we have one entry there?
 238                         if (SQL_NUMROWS($result) == 1) {
 239                                 // Use that userid as new referal id
 240                                 list($refid) = SQL_FETCHROW($result);
 241
 242                                 // Reset this user's counter
 243                                 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `rand_confirmed`=0 WHERE `userid`=%s LIMIT 1",
 244                                         array($refid), __FUNCTION__, __LINE__);
 245                         } // END - if
 246
 247                         // Free result
 248                         SQL_FREERESULT($result);
 249                 } // END - if
 250         } // END - if
 251
 252         // Return result
 253         return $refid;
 254 }
 255
 256 // Do the user login
 257 function USER_DO_LOGIN ($uid, $passwd) {
 258         // Init variables
 259         $dmy = '';
 260
 261         // Add last_login if available
 262         $lastOnline = '';
 263         if (GET_EXT_VERSION('sql_patches') >= '0.2.8') {
 264                 $lastOnline = ', last_login';
 265         } // END - if
 266
 267         // Init array
 268         $content = array(
 269                 'password'    => '',
 270                 'userid'      => '',
 271                 'last_online' => 0,
 272                 'last_login'  => 0,
 273                 'hash'        => ''
 274                 );
 275
 276                 // Check login data
 277                 if ((EXT_IS_ACTIVE('nickname')) && (NICKNAME_IS_ACTIVE($uid))) {
 278                         // Nickname entered
 279                         $result = SQL_QUERY_ESC("SELECT `userid`, `password`, `last_online`" . $lastOnline . " FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `nickname`='%s' AND `status`='CONFIRMED' LIMIT 1",
 280                                 array($uid), __FUNCTION__, __LINE__);
 281                 } else {
 282                         // Direct userid entered
 283                         $result = SQL_QUERY_ESC("SELECT `userid`, `password`, `last_online`" . $lastOnline . " FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s AND `status`='CONFIRMED' LIMIT 1",
 284                                 array($uid, $content['hash']), __FUNCTION__, __LINE__);
 285                 }
 286
 287                 // Load entry
 288                 $content = SQL_FETCHARRAY($result);
 289                 if (!empty($content['userid'])) $uid = bigintval($content['userid']);
 290
 291                 // Is there an entry?
 292                 if ((SQL_NUMROWS($result) == 1) && ((isNicknameUsed($content['userid'] === true) && (!empty($content['userid']))) || ($content['userid'] == $uid))) {
 293                         // Free result
 294                         SQL_FREERESULT($result);
 295
 296                         // Check for old MD5 passwords
 297                         if ((strlen($content['password']) == 32) && (md5($passwd) == $content['password'])) {
 298                                 // Just set the hash to the password from DB... :)
 299                                 $content['hash'] = $content['password'];
 300                         } else {
 301                                 // Hash password with improved way for comparsion
 302                                 $content['hash'] = generateHash($passwd, substr($content['password'], 0, -40));
 303                         }
 304
 305                         // Does the password match the hash?
 306                         if ($content['hash'] == $content['password']) {
 307                                 // New hashed password found so let's generate a new one
 308                                 $content['hash'] = generateHash($passwd);
 309
 310                                 // ... and update database
 311                                 // @TODO Make this filter working: $ADDON = runFilterChain('post_login_update', $content);
 312                                 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `password`='%s' WHERE `userid`=%s AND `status`='CONFIRMED' LIMIT 1",
 313                                         array($content['hash'], $uid), __FUNCTION__, __LINE__);
 314
 315                                 // No login bonus by default
 316                                 $GLOBALS['bonus_payed'] = false;
 317
 318                                 // Probe for last online timemark
 319                                 $probe = time() -  $content['last_online'];
 320                                 if (!empty($content['last_login'])) $probe = time() - $content['last_login'];
 321                                 if ((GET_EXT_VERSION('bonus') >= '0.2.2') && ($probe >= getConfig('login_timeout'))) {
 322                                         // Add login bonus to user's account
 323                                         $add = sprintf(", `login_bonus`=`login_bonus`+%s",
 324                                         (float)getConfig('login_bonus')
 325                                         );
 326                                         $GLOBALS['bonus_payed'] = true;
 327
 328                                         // Subtract login bonus from userid's account or jackpot
 329                                         if ((GET_EXT_VERSION('bonus') >= '0.3.5') && (getConfig('bonus_mode') != 'ADD')) BONUS_POINTS_HANDLER('login_bonus');
 330                                 } // END - if
 331
 332                                 // Calculate new hash with the secret key and master salt together
 333                                 $content['hash'] = generatePassString($content['hash']);
 334
 335                                 // Update global array
 336                                 // @TODO Make this filter working: $URL = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
 337                                 setUserId($uid);
 338
 339                                 // Try to set session data (which shall normally always work!)
 340                                 if ((setSession('userid', $uid )) && (setSession('u_hash', $content['hash']))) {
 341                                         // Update database records
 342                                         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `total_logins`=`total_logins +1" . $add . " WHERE `userid`=%s LIMIT 1",
 343                                                 array($uid), __FUNCTION__, __LINE__);
 344                                         if (SQL_AFFECTEDROWS() == 1) {
 345                                                 // Procedure to checking for login data
 346                                                 if (($GLOBALS['bonus_payed']) && (EXT_IS_ACTIVE('bonus'))) {
 347                                                         // Bonus added (just displaying!)
 348                                                         $URL = 'modules.php?module=chk_login&amp;mode=bonus';
 349                                                 } else {
 350                                                         // Bonus not added
 351                                                         $URL = 'modules.php?module=chk_login&amp;mode=login';
 352                                                 }
 353                                         } else {
 354                                                 // Cannot update counter!
 355                                                 $URL = 'modules.php?module=index&amp;what=login&amp;login='.getCode('CNTR_FAILED');
 356                                         }
 357                                 } else {
 358                                         // Cookies not setable!
 359                                         $URL = 'modules.php?module=index&amp;what=login&amp;login='.getCode('NO_COOKIES');
 360                                 }
 361                         } elseif (GET_EXT_VERSION('sql_patches') >= '0.6.1') {
 362                                 // Update failture counter
 363                                 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `login_failures`=`login_failures`+1,`last_failure`=NOW() WHERE `userid`=%s LIMIT 1",
 364                                         array($uid), __FUNCTION__, __LINE__);
 365
 366                                 // Wrong password!
 367                                 $URL = 'modules.php?module=index&amp;what=login&amp;login='.getCode('WRONG_PASS');
 368                         }
 369                 } elseif (((isNicknameUsed($content['userid'])) && (!empty($content['userid']))) || ($content['userid'] == $uid)) {
 370                         // Other account status?
 371                         // @TODO Can this query be merged with above query?
 372                         $result = SQL_QUERY_ESC("SELECT status FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
 373                                 array($uid), __FUNCTION__, __LINE__);
 374
 375                         // Entry found?
 376                         if (SQL_NUMROWS($result) == 1) {
 377                                 // Load status
 378                                 list($status) = SQL_FETCHROW($result);
 379
 380                                 // Create an error code from given status
 381                                 $errorCode = generateErrorCodeFromUserStatus($status);
 382                         } else {
 383                                 // ID not found!
 384                                 $errorCode = getCode('WRONG_ID');
 385                         }
 386
 387                         // Construct URL
 388                         $URL = 'modules.php?module=index&amp;what=login&amp;login='.$errorCode;
 389                 } else {
 390                         // ID not found!
 391                         $URL = 'modules.php?module=index&amp;what=login&amp;login='.getCode('WRONG_ID');
 392                 }
 393
 394                 // Return URL
 395                 return $URL;
 396 }
 397
 398 // Try to send a new password for the given user account
 399 function USER_DO_NEW_PASSWORD ($email, $uid) {
 400         // Compile email when found in address (only secure chars!)
 401         if (!empty($email)) $email = str_replace('{DOT}', '.', $email);
 402
 403         // Init result and error
 404         $errorCode = '';
 405         $result = false;
 406
 407         // Probe userid/nickname
 408         if ((EXT_IS_ACTIVE('nickname')) && (NICKNAME_IS_ACTIVE($uid))) {
 409                 // Nickname entered
 410                 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `nickname`='%s' OR `email`='%s' LIMIT 1",
 411                         array($uid, $email), __FUNCTION__, __LINE__);
 412         } elseif (($uid > 0) && (empty($email))) {
 413                 // Direct userid entered
 414                 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
 415                         array(bigintval($uid)), __FUNCTION__, __LINE__);
 416         } elseif (!empty($email)) {
 417                 // Email entered
 418                 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `email`='%s' LIMIT 1",
 419                         array($email), __FUNCTION__, __LINE__);
 420         } else {
 421                 // Userid not set!
 422                 DEBUG_LOG(__FUNCTION__, __LINE__, 'Userid is not set! BUG!');
 423                 $errorCode = getCode('WRONG_ID');
 424         }
 425
 426         // Any entry found?
 427         if (SQL_NUMROWS($result) == 1) {
 428                 // This data is valid, so we create a new pass... :-)
 429                 list($uid, $status) = SQL_FETCHROW($result);
 430
 431                 if ($status == 'CONFIRMED') {
 432                         // Ooppps, this was missing! ;-) We should update the database...
 433                         $NEW_PASS = generatePassword();
 434                         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `password`='%s' WHERE `userid`=%s LIMIT 1",
 435                                 array(generateHash($NEW_PASS), $uid), __FUNCTION__, __LINE__);
 436
 437                         // Prepare data and message for email
 438                         $msg = LOAD_EMAIL_TEMPLATE('new-pass', array('new_pass' => $NEW_PASS), $uid);
 439
 440                         // ... and send it away
 441                         sendEmail($uid, getMessage('GUEST_NEW_PASSWORD'), $msg);
 442
 443                         // Output note to user
 444                         LOAD_TEMPLATE('admin_settings_saved', false, getMessage('GUEST_NEW_PASSWORD_SEND'));
 445                 } else {
 446                         // Account is locked or unconfirmed
 447                         $errorCode = generateErrorCodeFromUserStatus($status);
 448
 449                         // Load URL
 450                         redirectToUrl('modules.php?module=index&amp;what=login&amp;login='.$errorCode);
 451                 }
 452         } else {
 453                 // ID or email is wrong
 454                 LOAD_TEMPLATE('admin_settings_saved', false, '<span class="guest_failed">{--GUEST_WRONG_ID_EMAIL--}</span>');
 455         }
 456
 457         // Return the error code
 458         return $errorCode;
 459 }
 460
 461 // [EOF]
 462 ?>