1c4bc867ccdc873b5cd0641fb33045f4f0b97244
[mailer.git] / inc / libs / user_functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                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 - 2009 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         die();
42 } // END - if
43
44 // Add links for selecting some users
45 function alpha ($sortby, $colspan, $return=false) {
46         if (!isGetRequestElementSet('offset')) setGetRequestElement('offset', 0);
47         $add = '&amp;page='.getRequestElement('page').'&amp;offset='.getRequestElement('offset');
48         if (isGetRequestElementSet('mode')) $add .= '&amp;mode='.getRequestElement('mode');
49
50         /* Creates the list of letters and makes them a link. */
51         $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'));
52         $num = count($alphabet) - 1;
53         $OUT = '';
54         while (list($counter, $ltr) = each($alphabet)) {
55                 if (getRequestElement('letter') == $ltr) {
56                         // Current letter is letter from URL
57                         $OUT .= '<strong>' . $ltr . '</strong>';
58                 } else {
59                         // Output link to letter
60                         $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=' . getWhat();
61                         if (isGetRequestElementSet('mode')) $OUT .= '&amp;mode=' . getRequestElement('mode');
62                         $OUT .= '&amp;letter=' . $ltr . '&amp;sortby=' . $sortby . $add . '%}">' . $ltr . '</a>';
63                 }
64
65                 if ((($counter / getConfig('user_alpha')) == round($counter / getConfig('user_alpha'))) && ($counter > 0)) {
66                         $OUT .= '&nbsp;]<br />[&nbsp;';
67                 } elseif ( $counter != $num ) {
68                         $OUT .= '&nbsp;|&nbsp;';
69                 }
70         } // END - while
71
72         // Load template
73         $OUT = loadTemplate('admin_list_user_alpha', true, $OUT);
74         if ($return === true) {
75                 // Return generated code
76                 return $OUT;
77         } else {
78                 // Output generated code
79                 outputHtml($OUT);
80         }
81 }
82
83 // Add links for sorting
84 function addSortLinks ($letter, $sortby, $colspan, $return=false) {
85         $OUT = '';
86         if (!isGetRequestElementSet('offset')) setGetRequestElement('offset', 0);
87         if (!isGetRequestElementSet('page'))   setGetRequestElement('page'  , 0);
88
89         // Add page and offset
90         $add = '&amp;page=' . getRequestElement('page') . '&amp;offset=' . getRequestElement('offset');
91
92         // Add status or mode
93         if (isGetRequestElementSet('status'))   $add .= '&amp;mode=' . getRequestElement('status');
94         elseif (isGetRequestElementSet('mode')) $add .= '&amp;mode=' . getRequestElement('mode');
95
96         // Makes order by links..
97         if ($letter == 'front') $letter = getMessage('_ALL2');
98
99         // Prepare array with all possible sorters
100         $list = array(
101                 'userid'      => getMessage('_UID'),
102                 'family'      => getMessage('FAMILY'),
103                 'email'       => getMessage('EMAIL'),
104                 'REMOTE_ADDR' => getMessage('REMOTE_IP')
105         );
106
107         // Add nickname if extension is installed
108         if (isExtensionActive('nickname')) {
109                 $list['nickname'] = getMessage('NICKNAME');
110         } // END - if
111
112         foreach ($list as $sort => $title) {
113                 if ($sortby == $sort) {
114                         $OUT .= '<strong>' . $title . '</strong>&nbsp;|&nbsp;';
115                 } else {
116                         $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=list_user&amp;letter=' . $letter . '&amp;sortby=' . $sort.$add . '%}">' . $title . '</a>&nbsp;|&nbsp;';
117                 }
118         } // END - foreach
119
120         $content['list'] = substr($OUT, 0, -13);
121
122         // Load template
123         $OUT = loadTemplate('admin_list_user_sort', true, $content);
124
125         // Should we return or output?
126         if ($return === true) {
127                 // Return code
128                 return $OUT;
129         } else {
130                 // Output code
131                 outputHtml($OUT);
132         }
133 }
134
135 // Add page navigation
136 function addPageNavigation ($PAGES, $offset, $show_form, $colspan,$return=false) {
137         // @TODO These two constants are no longer used, maybe we reactivate this code?
138         //if ($show_form === true) {
139         //      // Load form for changing number of lines
140         //      define('__FORM_HEADER', loadTemplate('admin_list_user_sort_form', true));
141         //      define('__FORM_FOOTER', '<tr><td colspan="'.$colspan.'" class="seperator bottom">&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="' . $colspan . '" class="seperator bottom">&nbsp;</td></tr>');
146         //}
147
148         $OUT = '';
149         for ($page = 1; $page <= $PAGES; $page++) {
150                 if (($page == getRequestElement('page')) || ((!isGetRequestElementSet('page')) && ($page == 1))) {
151                         $OUT .= '<strong>-';
152                 } else {
153                         if (!isGetRequestElementSet('letter')) setGetRequestElement('letter', getMessage('_ALL2'));
154                         if (!isGetRequestElementSet('sortby')) setGetRequestElement('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 (isGetRequestElementSet('status'))    $OUT .= '&amp;mode=' . getRequestElement('status');
161                          elseif (isGetRequestElementSet('mode')) $OUT .= '&amp;mode=' . getRequestElement('mode');
162
163                         // Letter and so on
164                         $OUT .= '&amp;letter=' . getRequestElement('letter') . '&amp;sortby=' . getRequestElement('sortby') . '&amp;page=' . $page . '&amp;offset=' . $offset . '%}">';
165                 }
166
167                 $OUT .= $page;
168
169                 if (($page == getRequestElement('page')) || ((!isGetRequestElementSet('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         // Remember the list
179         $content['list'] = $OUT;
180
181         // Load template
182         $OUT = loadTemplate('admin_list_user_pagenav', true, $content);
183         if ($return === true) {
184                 // Return code
185                 return $OUT;
186         } else {
187                 // Output code
188                 outputHtml($OUT);
189         }
190 }
191
192 // Create email link to user's account
193 function generateUserEmailLink($email, $mod = 'admin') {
194         // Show contact link only if user is confirmed by default
195         $locked = " AND `status`='CONFIRMED'";
196
197         // But admins shall always see it
198         if (isAdmin()) $locked = '';
199
200         $result = SQL_QUERY_ESC("SELECT
201         `userid`
202 FROM
203         `{?_MYSQL_PREFIX?}_user_data`
204 WHERE
205         `email`='%s'" . $locked."
206 LIMIT 1",
207                 array($email), __FUNCTION__, __LINE__);
208         if (SQL_NUMROWS($result) == 1) {
209                 // Load userid
210                 list($userid) = SQL_FETCHROW($result);
211
212                 // Rewrite email address to contact link
213                 $email = '{%url=modules.php?module=' . $mod . '&amp;what=user_contct&amp;userid=' . bigintval($userid) . '%}';
214         } // END - if
215
216         // Free memory
217         SQL_FREERESULT($result);
218
219         // Return rewritten (?) email address
220         return $email;
221 }
222
223 // Selects a random user id as the new referal id if they have at least X confirmed mails in this run
224 // @TODO Double-check configuration entry here
225 function determineRandomReferalId () {
226         // Default is zero refid
227         $refid = '0';
228
229         // Is the extension version fine?
230         if (getExtensionVersion('user') >= '0.3.4') {
231                 // Get all user ids
232                 $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true, " AND `rand_confirmed` >= ".getConfig('user_min_confirmed')."");
233
234                 // Do we have at least one?
235                 if ($totalUsers > 0) {
236                         // Then choose random number
237                         $randNum = mt_rand(0, ($totalUsers - 1));
238
239                         // Look for random user
240                         $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",
241                                 array($randNum), __FUNCTION__, __LINE__);
242
243                         // Do we have one entry there?
244                         if (SQL_NUMROWS($result) == 1) {
245                                 // Use that userid as new referal id
246                                 list($refid) = SQL_FETCHROW($result);
247
248                                 // Reset this user's counter
249                                 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `rand_confirmed`=0 WHERE `userid`=%s LIMIT 1",
250                                         array($refid), __FUNCTION__, __LINE__);
251                         } // END - if
252
253                         // Free result
254                         SQL_FREERESULT($result);
255                 } // END - if
256         } // END - if
257
258         // Return result
259         return $refid;
260 }
261
262 // Do the user login
263 function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.php?module=index&amp;what=login&amp;login=') {
264         // Init variables
265         $dmy = '';
266         $add = '';
267         $errorCode = '0';
268         $ext = '';
269
270         // Add last_login if available
271         $lastOnline = '';
272         if (getExtensionVersion('sql_patches') >= '0.2.8') {
273                 $lastOnline = ', `last_login`';
274         } // END - if
275
276         // Init array
277         $content = array(
278                 'password'    => '',
279                 'userid'      => '',
280                 'last_online' => 0,
281                 'last_login'  => 0,
282                 'hash'        => ''
283         );
284
285         // Check login data
286         if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
287                 // Nickname entered
288                 fetchUserData($userid, 'nickname');
289         } elseif (isNicknameUsed($userid)) {
290                 // No nickname installed
291                 $errorCode = getCode('EXTENSION_PROBLEM');
292                 $ext = 'nickname';
293         } else {
294                 // Direct userid entered
295                 fetchUserData($userid);
296         }
297
298         // Load entry
299         $content = getUserDataArray();
300         if (!empty($content['userid'])) $userid = bigintval($content['userid']);
301
302         // Is there an entry?
303         if ((isUserDataValid()) && (getUserData('status') == 'CONFIRMED') && (!empty($content['userid']))) {
304                 // Check for old MD5 passwords
305                 if ((strlen(getUserData('password')) == 32) && (md5($passwd) == getUserData('password'))) {
306                         // Just set the hash to the password from DB... :)
307                         $content['hash'] = getUserData('password');
308                 } else {
309                         // Hash password with improved way for comparsion
310                         $content['hash'] = generateHash($passwd, substr(getUserData('password'), 0, -40));
311                 }
312
313                 // Does the password match the hash?
314                 if ($content['hash'] == getUserData('password')) {
315                         // New hashed password found so let's generate a new one
316                         $content['hash'] = generateHash($passwd);
317
318                         // ... and update database
319                         // @TODO Make this filter working: $ADDON = runFilterChain('post_login_update', $content);
320                         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `password`='%s' WHERE `userid`=%s AND `status`='CONFIRMED' LIMIT 1",
321                                 array($content['hash'], $userid), __FUNCTION__, __LINE__);
322
323                         // No login bonus by default
324                         $GLOBALS['bonus_payed'] = false;
325
326                         // Probe for last online timemark
327                         $probe = time() -  getUserData('last_online');
328                         if (getUserData('last_login') > 0) $probe = time() - getUserData('last_login');
329
330                         if ((isExtensionInstalledAndNewer('bonus', '0.2.2')) && ($probe >= getConfig('login_timeout'))) {
331                                 // Add login bonus to user's account
332                                 $add = ', `login_bonus`=`login_bonus`+{?login_bonus?}';
333                                 $GLOBALS['bonus_payed'] = true;
334
335                                 // Subtract login bonus from userid's account or jackpot
336                                 if ((getExtensionVersion('bonus') >= '0.3.5') && (getConfig('bonus_mode') != 'ADD')) handleBonusPoints('login_bonus');
337                         } // END - if
338
339                         // Calculate new hash with the secret key and master salt together
340                         $content['hash'] = generatePassString($content['hash']);
341
342                         // Update global array
343                         // @TODO Make this filter working: $URL = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
344                         setMemberId($userid);
345
346                         // Try to set session data (which shall normally always work!)
347                         if ((setSession('userid', $userid )) && (setSession('u_hash', $content['hash']))) {
348                                 // Update database records
349                                 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `total_logins`=`total_logins`+1" . $add . " WHERE `userid`=%s LIMIT 1",
350                                         array($userid), __FUNCTION__, __LINE__);
351                                 if (SQL_AFFECTEDROWS() == 1) {
352                                         // Is a success URL set?
353                                         if (empty($successUrl)) {
354                                                 // Procedure to checking for login data
355                                                 if (($GLOBALS['bonus_payed']) && (isExtensionActive('bonus'))) {
356                                                         // Bonus added (just displaying!)
357                                                         $URL = 'modules.php?module=chk_login&amp;mode=bonus';
358                                                 } else {
359                                                         // Bonus not added
360                                                         $URL = 'modules.php?module=chk_login&amp;mode=login';
361                                                 }
362                                         } else {
363                                                 // Use this URL
364                                                 $URL = $successUrl;
365                                         }
366                                 } else {
367                                         // Cannot update counter!
368                                         $errorCode = getCode('CNTR_FAILED');
369                                 }
370                         } else {
371                                 // Cookies not setable!
372                                 $errorCode = getCode('COOKIES_DISABLED');
373                         }
374                 } elseif (getExtensionVersion('sql_patches') >= '0.6.1') {
375                         // Update failture counter
376                         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `login_failures`=`login_failures`+1,`last_failure`=NOW() WHERE `userid`=%s LIMIT 1",
377                                 array($userid), __FUNCTION__, __LINE__);
378
379                         // Wrong password!
380                         $errorCode = getCode('WRONG_PASS');
381                 }
382         } elseif (getUserData('status') != 'CONFIRMED') {
383                 // Create an error code from given status
384                 $errorCode = generateErrorCodeFromUserStatus(getUserData('status'));
385
386                 // Set userid in session
387                 setSession('current_userid', getUserData('userid'));
388         } elseif (!isUserDataValid()) {
389                 // User id not found!
390                 $errorCode = getCode('WRONG_ID');
391         } else {
392                 // Unknown error
393                 $errorCode = getCode('UNKNOWN_ERROR');
394         }
395
396         // Error code provided?
397         if ($errorCode > 0) {
398                 // Then reconstruct the URL
399                 $URL = $errorUrl . $errorCode;
400
401                 // Extension set? Then add it as well.
402                 if (!empty($ext)) $URL .= '&amp;ext=' . $ext;
403         } // END - if
404
405         // Return URL
406         return $URL;
407 }
408
409 // Try to send a new password for the given user account
410 function doNewUserPassword ($email, $userid) {
411         // Init result and error
412         $errorCode = '';
413         $result = false;
414
415         // Probe userid/nickname
416         // @TODO We should try to rewrite this to fetchUserData() somehow
417         if (!empty($email)) {
418                 // Email entered
419                 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `email`='%s' OR `email`='%s' LIMIT 1",
420                         array($email, str_replace('.', '{DOT}', $email)), __FUNCTION__, __LINE__);
421         } elseif ((isExtensionActive('nickname')) && (isNicknameOrUserid($userid))) {
422                 // Nickname entered
423                 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `nickname`='%s' OR `userid`='%s' OR `email`='%s' LIMIT 1",
424                         array($userid, $userid, $email), __FUNCTION__, __LINE__);
425         } elseif (($userid > 0) && (empty($email))) {
426                 // Direct userid entered
427                 $result = SQL_QUERY_ESC("SELECT `userid`, `status` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `userid`=%s LIMIT 1",
428                         array(bigintval($userid)), __FUNCTION__, __LINE__);
429         } else {
430                 // Userid not set!
431                 logDebugMessage(__FUNCTION__, __LINE__, 'Userid is not set! BUG!');
432                 $errorCode = getCode('WRONG_ID');
433         }
434
435         // Any entry found?
436         if (SQL_NUMROWS($result) == 1) {
437                 // This data is valid, so we create a new pass... :-)
438                 list($userid, $status) = SQL_FETCHROW($result);
439
440                 if ($status == 'CONFIRMED') {
441                         // Ooppps, this was missing! ;-) We should update the database...
442                         $NEW_PASS = generatePassword();
443                         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `password`='%s' WHERE `userid`=%s LIMIT 1",
444                                 array(generateHash($NEW_PASS), $userid), __FUNCTION__, __LINE__);
445
446                         // Prepare data and message for email
447                         $message = loadEmailTemplate('new-pass', array('new_pass' => $NEW_PASS, 'nickname' => $userid), $userid);
448
449                         // ... and send it away
450                         sendEmail($userid, getMessage('GUEST_NEW_PASSWORD'), $message);
451
452                         // Output note to user
453                         loadTemplate('admin_settings_saved', false, getMessage('GUEST_NEW_PASSWORD_SEND'));
454                 } else {
455                         // Account is locked or unconfirmed
456                         $errorCode = generateErrorCodeFromUserStatus($status);
457
458                         // Load URL
459                         redirectToUrl('modules.php?module=index&amp;what=login&amp;login='.$errorCode);
460                 }
461         } else {
462                 // id or email is wrong
463                 loadTemplate('admin_settings_saved', false, '<span class="guest_failed">{--GUEST_WRONG_ID_EMAIL--}</span>');
464         }
465
466         // Return the error code
467         return $errorCode;
468 }
469
470 // [EOF]
471 ?>