Fixed logfile writing in installation phase, .revision is now ignored
[mailer.git] / 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:: 856                                                    $ *
14  * $Date:: 2009-03-06 20:24:32 +0100 (Fr, 06. Mär 2009)              $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author:: stelzi                                                   $ *
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 = array(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=".$GLOBALS['what'];
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                 // Empty row
140                 define('__FORM_HEADER', "<tr><td colspan=\"".$colspan."\" class=\"seperator\">&nbsp;</td></tr>");
141         } else {
142                 // Load form for changing number of lines
143                 define('__FORM_HEADER', LOAD_TEMPLATE("admin_list_user_sort_form", true));
144         }
145
146         if (!$show_form) {
147                 // Add line with bottom border
148                 define('__FORM_FOOTER', "<tr><td colspan=\"{!__COLSPAN2!}\" class=\"seperator bottom2\">&nbsp;</td></tr>");
149         } else {
150                 // Add line without bottom border
151                 define('__FORM_FOOTER', "<tr><td colspan=\"{!__COLSPAN2!}\" class=\"seperator bottom2\">&nbsp;</td></tr>");
152         }
153
154         $OUT = "";
155         for ($page = 1; $page <= $PAGES; $page++) {
156                 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET(('page'))) && ($page == "1"))) {
157                         $OUT .= "<strong>-";
158                 } else {
159                         if (!REQUEST_ISSET_GET(('letter'))) REQUEST_SET_GET('letter', getMessage('_ALL2'));
160                         if (!REQUEST_ISSET_GET(('sortby'))) REQUEST_SET_GET('sortby', "userid");
161
162                         // Base link
163                         $OUT .= "<a href=\"{!URL!}/modules.php?module=admin&amp;what=".$GLOBALS['what'];
164
165                         // Add status or mode
166                         if (REQUEST_ISSET_GET(('status'))) $OUT .= "&amp;mode=".REQUEST_GET(('status'));
167                          elseif (REQUEST_ISSET_GET(('mode'))) $OUT .= "&amp;mode=".REQUEST_GET(('mode'));
168
169                          // Letter and so on
170                         $OUT .= "&amp;letter=".REQUEST_GET(('letter'))."&amp;sortby=".REQUEST_GET(('sortby'))."&amp;page=".$page."&amp;offset=".$offset."\">";
171                 }
172
173                 $OUT .= $page;
174
175                 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET(('page'))) && ($page == "1"))) {
176                         $OUT .= "-</strong>";
177                 } else  {
178                         $OUT .= "</a>";
179                 }
180
181                 if ($page < $PAGES) $OUT .= "&nbsp;|&nbsp;";
182         } // END - for
183
184         define('__PAGENAV_LIST', $OUT);
185
186         // Load template
187         $OUT = LOAD_TEMPLATE("admin_list_user_pagenav", true);
188         if ($return === true) {
189                 // Return code
190                 return $OUT;
191         } else {
192                 // Output code
193                 OUTPUT_HTML($OUT);
194         }
195 }
196
197 // Create email link to user's account
198 function USER_CREATE_EMAIL_LINK($email, $mod="admin") {
199         // Show contact link only if user is confirmed by default
200         $locked = " AND `status`='CONFIRMED'";
201
202         // But admins shall always see it
203         if (IS_ADMIN()) $locked = "";
204
205         $result = SQL_QUERY_ESC("SELECT userid
206 FROM `{!_MYSQL_PREFIX!}_user_data`
207 WHERE email='%s'".$locked." LIMIT 1",
208          array($email), __FUNCTION__, __LINE__);
209         if (SQL_NUMROWS($result) == 1) {
210                 // Load userid
211                 list($uid) = SQL_FETCHROW($result);
212
213                 // Rewrite email address to contact link
214                 $email = "{!URL!}/modules.php?module=".$mod."&amp;what=user_contct&amp;uid=".bigintval($uid);
215         } // END - if
216
217         // Free memory
218         SQL_FREERESULT($result);
219
220         // Return rewritten (?) email address
221         return $email;
222 }
223
224 // Selects a random user id as the new referal id if they have at least X confirmed mails in this run
225 function SELECT_RANDOM_REFID () {
226         // Default is zero refid
227         $refid = 0;
228
229         // Is the extension version fine?
230         if (GET_EXT_VERSION("user") >= "0.3.4") {
231                 // Get all user ids
232                 $totalUsers = GET_TOTAL_DATA("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` >= %s ORDER BY `rand_confirmed` DESC LIMIT %s, 1",
241                                 array(getConfig('user_min_confirmed'), $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 USER_DO_LOGIN ($uid, $passwd) {
264         // Add last_login if available
265         $lastOnline = "";
266         if (GET_EXT_VERSION("sql_patches") >= "0.2.8") {
267                 $lastOnline = ", last_login";
268         } // END - if
269
270         // Check login data
271         $password = ""; $uid2 = ""; $dmy = ""; $online = 0; $login = 0;
272         if ((EXT_IS_ACTIVE("nickname")) && (NICKNAME_PROBE_ON_USERID($uid))) {
273                 // Nickname entered
274                 $result = SQL_QUERY_ESC("SELECT userid, password, last_online".$lastOnline." FROM `{!_MYSQL_PREFIX!}_user_data` WHERE nickname='%s' AND `status`='CONFIRMED' LIMIT 1",
275                         array($uid), __FUNCTION__, __LINE__);
276                 list($uid2, $password, $online, $login) = SQL_FETCHROW($result);
277                 if (!empty($uid2)) $uid = bigintval($uid2);
278         } else {
279                 // Direct userid entered
280                 $result = SQL_QUERY_ESC("SELECT userid, password, last_online".$lastOnline." FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s AND `status`='CONFIRMED' LIMIT 1",
281                         array($uid, $hash), __FUNCTION__, __LINE__);
282                 list($uid2, $password, $online, $login) = SQL_FETCHROW($result);
283         }
284
285         // Is there an entry?
286         if ((SQL_NUMROWS($result) == 1) && ((($probe_nickname) && (!empty($uid2))) || ($uid2 == $uid))) {
287                 // Free result
288                 SQL_FREERESULT($result);
289
290                 // By default the hash is empty
291                 $hash = "";
292
293                 // Check for old MD5 passwords
294                 if ((strlen($password) == 32) && (md5($passwd) == $password)) {
295                         // Just set the hash to the password from DB... :)
296                         $hash = $password;
297                 } else {
298                         // Hash password with improved way for comparsion
299                         $hash = generateHash($passwd, substr($password, 0, -40));
300                 }
301
302                 if ($hash == $password) {
303                         // New hashed password found so let's generate a new one
304                         $hash = generateHash($passwd);
305
306                         // ... and update database
307                         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET password='%s' WHERE userid=%s AND `status`='CONFIRMED' LIMIT 1",
308                                 array($hash, $uid), __FUNCTION__, __LINE__);
309
310                         // No login bonus by default
311                         // @TODO Make this filter working: $ADDON = runFilterChain('post_login_update', array('login' => $login, 'online' => $online));
312                         $BONUS = false;
313
314                         // Probe for last online timemark
315                         $probe = time() -  $online;
316                         if (!empty($login)) $probe = time() - $login;
317                         if ((GET_EXT_VERSION("bonus") >= "0.2.2") && ($probe >= getConfig('login_timeout'))) {
318                                 // Add login bonus to user's account
319                                 $ADD = sprintf(", login_bonus=login_bonus+%s",
320                                         (float)getConfig('login_bonus')
321                                 );
322                                 $BONUS = true;
323
324                                 // Subtract login bonus from userid's account or jackpot
325                                 if ((GET_EXT_VERSION("bonus") >= "0.3.5") && (getConfig('bonus_mode') != "ADD")) BONUS_POINTS_HANDLER('login_bonus');
326                         } // END - if
327
328                         // Init variables
329                         $login = false;
330
331                         // Calculate new hash with the secret key and master salt together
332                         $hash = generatePassString($hash);
333
334                         // Update global array
335                         // @TODO Make this filter working: $URL = runFilterChain('do_login', array('uid' => $uid, 'hash' => $hash, 'addon' => $ADDON));
336                         $GLOBALS['userid'] = $uid;
337
338                         // Try to set session data (which shall normally always work!)
339                         if ((set_session('userid', $uid )) && (set_session('u_hash', $hash))) {
340                                 // Update database records
341                                 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET total_logins=total_logins+1".$ADD." WHERE userid=%s LIMIT 1",
342                                         array($uid), __FUNCTION__, __LINE__);
343                                 if (SQL_AFFECTEDROWS() == 1) {
344                                         // Procedure to checking for login data
345                                         if (($BONUS) && (EXT_IS_ACTIVE("bonus"))) {
346                                                 // Bonus added (just displaying!)
347                                                 $URL = "modules.php?module=chk_login&amp;mode=bonus";
348                                         } else {
349                                                 // Bonus not added
350                                                 $URL = "modules.php?module=chk_login&amp;mode=login";
351                                         }
352                                 } else {
353                                         // Cannot update counter!
354                                         $URL = "modules.php?module=index&amp;what=login&amp;login=".constant('CODE_CNTR_FAILED');
355                                 }
356                         } else {
357                                 // Cookies not setable!
358                                 $URL = "modules.php?module=index&amp;what=login&amp;login=".constant('CODE_NO_COOKIES');
359                         }
360                 } elseif (GET_EXT_VERSION("sql_patches") >= "0.6.1") {
361                         // Update failture counter
362                         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET login_failures=login_failures+1,last_failure=NOW() WHERE userid=%s LIMIT 1",
363                                 array($uid), __FUNCTION__, __LINE__);
364
365                         // Wrong password!
366                         $URL = "modules.php?module=index&amp;what=login&amp;login=".constant('CODE_WRONG_PASS');
367                 }
368         } elseif ((($probe_nickname) && (!empty($uid2))) || ($uid2 == $uid)) {
369                 // Other account status?
370                 // @TODO Can this query be merged with above query?
371                 $result = SQL_QUERY_ESC("SELECT status FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
372                         array($uid), __FUNCTION__, __LINE__);
373
374                 // Entry found?
375                 if (SQL_NUMROWS($result) == 1) {
376                         // Load status
377                         list($status) = SQL_FETCHROW($result);
378
379                         // Create an error code from given status
380                         $ERROR = GEN_ERROR_CODE_FROM_ACCOUNT_STATUS($status);
381                 } else {
382                         // ID not found!
383                         $ERROR = constant('CODE_WRONG_ID');
384                 }
385
386                 // Construct URL
387                 $URL = "modules.php?module=index&amp;what=login&amp;login=".$ERROR;
388         } else {
389                 // ID not found!
390                 $URL = "modules.php?module=index&amp;what=login&amp;login=".constant('CODE_WRONG_ID');
391         }
392
393         // Return URL
394         return $URL;
395 }
396
397 // Try to send a new password for the given user account
398 function USER_DO_NEW_PASSWORD ($email, $uid) {
399         // Compile email when found in address (only secure chars!)
400         if (!empty($email)) $email = str_replace("{DOT}", '.', $email);
401
402         // Init result and error
403         $ERROR = "";
404         $result = false;
405
406         // Probe userid/nickname
407         if ((EXT_IS_ACTIVE("nickname")) && (NICKNAME_PROBE_ON_USERID($uid))) {
408                 // Nickname entered
409                 $result = SQL_QUERY_ESC("SELECT userid, status FROM `{!_MYSQL_PREFIX!}_user_data` WHERE nickname='%s' OR email='%s' LIMIT 1",
410                         array($uid, $email), __FUNCTION__, __LINE__);
411         } elseif (($uid > 0) && (empty($email))) {
412                 // Direct userid entered
413                 $result = SQL_QUERY_ESC("SELECT userid, status FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
414                         array(bigintval($uid)), __FUNCTION__, __LINE__);
415         } elseif (!empty($email)) {
416                 // Email entered
417                 $result = SQL_QUERY_ESC("SELECT userid, status FROM `{!_MYSQL_PREFIX!}_user_data` WHERE email='%s' LIMIT 1",
418                         array($email), __FUNCTION__, __LINE__);
419         } else {
420                 // Userid not set!
421                 DEBUG_LOG(__FUNCTION__, __LINE__, "Userid is not set! BUG!");
422                 $ERROR = constant('CODE_WRONG_ID');
423         }
424
425         // Any entry found?
426         if (SQL_NUMROWS($result) == 1) {
427                 // This data is valid, so we create a new pass... :-)
428                 list($uid, $status) = SQL_FETCHROW($result);
429
430                 if ($status == "CONFIRMED") {
431                         // Ooppps, this was missing! ;-) We should update the database...
432                         $NEW_PASS = GEN_PASS();
433                         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET password='%s' WHERE userid=%s LIMIT 1",
434                                 array(generateHash($NEW_PASS), $uid), __FUNCTION__, __LINE__);
435
436                         // Prepare data and message for email
437                         $msg = LOAD_EMAIL_TEMPLATE("new-pass", array('new_pass' => $NEW_PASS), $uid);
438
439                         // ... and send it away
440                         SEND_EMAIL($uid, getMessage('GUEST_NEW_PASSWORD'), $msg);
441
442                         // Output note to user
443                         LOAD_TEMPLATE("admin_settings_saved", false, getMessage('GUEST_NEW_PASSWORD_SEND'));
444                 } else {
445                         // Account is locked or unconfirmed
446                         $ERROR = GEN_ERROR_CODE_FROM_ACCOUNT_STATUS($status);
447
448                         // Load URL
449                         LOAD_URL("modules.php?module=index&amp;what=login&amp;login=".$ERROR);
450                 }
451         } else {
452                 // ID or email is wrong
453                 LOAD_TEMPLATE("admin_settings_saved", false, "<span class=\"guest_failed\">{--GUEST_WRONG_ID_EMAIL--}</span>");
454         }
455
456         // Return the error code
457         return $ERROR;
458 }
459
460 // [EOF]
461 ?>