c199c3affce760aeba5f8477bf8e0fc299d3872d
[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  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
20  * For more information visit: http://mxchange.org                      *
21  *                                                                      *
22  * This program is free software; you can redistribute it and/or modify *
23  * it under the terms of the GNU General Public License as published by *
24  * the Free Software Foundation; either version 2 of the License, or    *
25  * (at your option) any later version.                                  *
26  *                                                                      *
27  * This program is distributed in the hope that it will be useful,      *
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
30  * GNU General Public License for more details.                         *
31  *                                                                      *
32  * You should have received a copy of the GNU General Public License    *
33  * along with this program; if not, write to the Free Software          *
34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Add links for selecting some users
44 function addAlphabeticalSorting ($sortby) {
45         $add = '';
46         foreach (array('page', 'offset', 'do', 'status') as $param) {
47                 if (isGetRequestElementSet($param)) {
48                         $add .= '&amp;' . $param . '=' . getRequestElement($param);
49                 } // END - if
50         } // END - foreach
51
52         // Creates the list of letters and makes them a link.
53         $alphabet = explode(',', '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,');
54         $num = count($alphabet) - 1;
55
56         // Add all letter links
57         $OUT = '';
58         while (list($counter, $ltr) = each($alphabet)) {
59                 if (getRequestElement('letter') == $ltr) {
60                         // Current letter is letter from URL
61                         $OUT .= '<strong>' . $ltr . '</strong>';
62                 } else {
63                         // Output link to letter
64                         $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=' . getWhat() . '&amp;letter=' . $ltr . '&amp;sortby=' . $sortby . $add . '%}">' . $ltr . '</a>';
65                 }
66
67                 if ((($counter / getUserAlpha()) == round($counter / getUserAlpha())) && ($counter > 0)) {
68                         $OUT .= ']<br />[';
69                 } elseif ($counter != $num) {
70                         $OUT .= '|';
71                 }
72         } // END - while
73
74         // Prepare content
75         $content = array (
76                 'alpha_selection' => $OUT,
77         );
78
79         // Load template
80         $OUT = loadTemplate('admin_list_user_alpha', TRUE, $content);
81
82         // Return generated code
83         return $OUT;
84 }
85
86 // Add links for sorting
87 function addSortLinks ($letter, $sortby) {
88         $OUT = '';
89         if (!isGetRequestElementSet('offset')) setGetRequestElement('offset', 0);
90         if (!isGetRequestElementSet('page'))   setGetRequestElement('page'  , 0);
91
92         // Add page and offset
93         $add = '&amp;page=' . getRequestElement('page') . '&amp;offset=' . getRequestElement('offset');
94
95         // Add status/ mode
96         foreach (array('do','status') as $param) {
97                 if (isGetRequestElementSet($param)) {
98                         $add .= '&amp;' . $param . '=' . getRequestElement($param);
99                 } // END - if
100         } // END - foreach
101
102         // Makes order by links..
103         if ($letter == 'front') {
104                 $letter = '';
105         } // END - if
106
107         // Prepare array with all possible sorters
108         $list = array(
109                 'userid'      => '{--_USERID--}',
110                 'family'      => '{--FAMILY--}',
111                 'email'       => '{--EMAIL--}',
112                 'REMOTE_ADDR' => '{--REMOTE_IP--}'
113         );
114
115         // Add nickname if extension is installed
116         if (isExtensionActive('nickname')) {
117                 $list['nickname'] = '{--NICKNAME--}';
118         } // END - if
119
120         foreach ($list as $sort => $title) {
121                 if ($sortby == $sort) {
122                         $OUT .= '<strong>' . $title . '</strong>|';
123                 } else {
124                         $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=list_user&amp;letter=' . $letter . '&amp;sortby=' . $sort . $add . '%}">' . $title . '</a>|';
125                 }
126         } // END - foreach
127
128         // Add output
129         $content['list'] = substr($OUT, 0, -1);
130
131         // Load template
132         $OUT = loadTemplate('admin_list_user_sort', TRUE, $content);
133
134         // Return code
135         return $OUT;
136 }
137
138 // Add page navigation
139 function addPageNavigation ($numPages) {
140         // Start with empty content
141         $OUT = '';
142
143         // Create only the navigation if page count > 1
144         if ($numPages > 1) {
145                 // Create navigation links for every page
146                 for ($page = 1; $page <= $numPages; $page++) {
147                         if (($page == getRequestElement('page')) || ((!isGetRequestElementSet('page')) && ($page == 1))) {
148                                 $OUT .= '<strong>-';
149                         } else {
150                                 if (!isGetRequestElementSet('letter')) setGetRequestElement('letter', '');
151                                 if (!isGetRequestElementSet('sortby')) setGetRequestElement('sortby', 'userid');
152
153                                 // Base link
154                                 $OUT .= '<a href="{%url=modules.php?module=admin&amp;what=' . getWhat();
155
156                                 // Add status/mode
157                                 foreach (array('do','status') as $param) {
158                                         if (isGetRequestElementSet($param)) {
159                                                 $OUT .= '&amp;' . $param . '=' . getRequestElement($param);
160                                         } // END - if
161                                 } // END - foreach
162
163                                 // Letter and so on
164                                 $OUT .= '&amp;letter=' . getRequestElement('letter') . '&amp;sortby=' . getRequestElement('sortby') . '&amp;page=' . $page . '&amp;offset=' . getUserLimit() . '%}">';
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 < $numPages) {
176                                 $OUT .= '|';
177                         } // END - if
178                 } // END - for
179
180                 // Add list output
181                 $content['list'] = $OUT;
182
183                 // Load template
184                 $OUT = loadTemplate('admin_list_user_pagenav', TRUE, $content);
185         } // END - if
186
187         // Return code
188         return $OUT;
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 (isAdmin()) {
198                 $locked = '';
199         } // END - if
200
201         // Search for the email address
202         $result = sqlQueryEscaped("SELECT
203         `userid`
204 FROM
205         `{?_MYSQL_PREFIX?}_user_data`
206 WHERE
207         '%s' REGEXP `email`
208         " . $locked . "
209 LIMIT 1",
210                 array($email), __FUNCTION__, __LINE__);
211
212         // Is there an entry?
213         if (sqlNumRows($result) == 1) {
214                 // Load userid
215                 list($userid) = sqlFetchRow($result);
216
217                 // Rewrite email address to contact link
218                 $email = '{%url=modules.php?module=' . $mod . '&amp;what=user_contct&amp;userid=' . bigintval($userid) . '%}';
219         } // END - if
220
221         // Free memory
222         sqlFreeResult($result);
223
224         // Return rewritten (?) email address
225         return $email;
226 }
227
228 // Selects a random user id as the new referral id if they have at least X confirmed mails in this run
229 function determineRandomReferralId () {
230         // Default is zero refid
231         $refid = NULL;
232
233         // Is the extension version fine?
234         if ((isRandomReferralIdEnabled()) && (isExtensionInstalledAndNewer('user', '0.3.4'))) {
235                 // Get all user ids
236                 $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', TRUE, runFilterChain('user_exclusion_sql', ' AND `rand_confirmed` >= {?user_min_confirmed?}'));
237
238                 // Is there at least one?
239                 if ($totalUsers > 0) {
240                         // Then choose random userid
241                         $randUserid = mt_rand(0, ($totalUsers - 1));
242
243                         // Look for random user
244                         $result = sqlQueryEscaped("SELECT `userid` FROM `{?_MYSQL_PREFIX?}_user_data` " . runFilterChain('user_exclusion_sql', "WHERE `status`='CONFIRMED'") . ' AND `rand_confirmed` >= {?user_min_confirmed?} ORDER BY `rand_confirmed` DESC LIMIT %s, 1',
245                                 array($randUserid), __FUNCTION__, __LINE__);
246
247                         // Is there one entry there?
248                         if (sqlNumRows($result) == 1) {
249                                 // Use that userid as new referral id
250                                 list($refid) = sqlFetchRow($result);
251
252                                 // Debug message
253                                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'refid=' . $refid . ' - choosen!');
254                         } // END - if
255
256                         // Free result
257                         sqlFreeResult($result);
258                 } // END - if
259         } // END - if
260
261         // Return result
262         return $refid;
263 }
264
265 // Do the user login
266 function doUserLogin ($userid, $passwd, $successUrl = '', $errorUrl = 'modules.php?module=index&amp;what=login&amp;login=') {
267         // Init variables
268         $dmy = '';
269         $add = '';
270         $errorCode = '0';
271         $ext = '';
272         $isFound = FALSE;
273
274         // Init array
275         $content = array(
276                 'password'    => '',
277                 'userid'      => '',
278                 'last_online' => 0,
279                 'last_login'  => 0,
280                 'hash'        => ''
281         );
282
283         // Check login data
284         if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
285                 // Nickname entered
286                 $isFound = fetchUserData($userid, 'nickname');
287         } elseif (isNicknameUsed($userid)) {
288                 // No nickname installed
289                 $errorCode = getCode('EXTENSION_PROBLEM');
290                 $ext = 'nickname';
291         } else {
292                 // Direct userid entered
293                 $isFound = fetchUserData($userid);
294         }
295
296         // No error found?
297         if (($errorCode == '0') && ($isFound === TRUE)) {
298                 // Get user data array and set userid (e.g. important if we login with nickname)
299                 $content = getUserDataArray();
300                 if (!empty($content['userid'])) {
301                         $userid = bigintval($content['userid']);
302                 } // END - if
303         } // END - if
304
305         // Debug message
306         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',isUserDataValid()=' . intval(isUserDataValid()) . ',userStatus=' . getUserData('status') . ',errorCode=' . $errorCode . ',ext=' . $ext . ',isFound=' . intval($isFound));
307
308         // Is there an entry?
309         if (($errorCode == '0') && (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');
314                 } else {
315                         // Hash password with improved way for comparsion
316                         $content['hash'] = generateHash($passwd, substr(getUserData('password'), 0, -40));
317                 }
318
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);
323
324                         // ... and update database
325                         // @TODO Make this filter working: $ADDON = runFilterChain('post_login_update', $content);
326                         sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `password`='%s' WHERE `userid`=%s AND `status`='CONFIRMED' LIMIT 1",
327                                 array($content['hash'], $userid), __FUNCTION__, __LINE__);
328
329                         // No login bonus by default
330                         $GLOBALS['bonus_payed'] = FALSE;
331
332                         // Is bonus up-to-date?
333                         if (isExtensionInstalledAndNewer('bonus', '0.2.2')) {
334                                 // Probe for last online timemark
335                                 $probe = time() -  getUserData('last_online');
336                                 if (getUserData('last_login') > 0) {
337                                         // Use timestamp from last login
338                                         $probe = time() - getUserData('last_login');
339                                 } // END - if
340
341                                 // Is the timeout reached?
342                                 if ($probe >= getLoginTimeout()) {
343                                         // Add login bonus to user's account
344                                         $add = ',`login_bonus`=`login_bonus`+{?login_bonus?}';
345                                         $GLOBALS['bonus_payed'] = TRUE;
346
347                                         // Subtract login bonus from userid's account or jackpot
348                                         if ((isExtensionInstalledAndNewer('bonus', '0.3.5')) && (getBonusMode() != 'ADD')) {
349                                                 handleBonusPoints('login_bonus', $userid);
350                                         } // END - if
351                                 } // END - if
352                         } // END - if
353
354                         // @TODO Make this filter working: $url = runFilterChain('do_login', array('content' => $content, 'addon' => $ADDON));
355
356                         // Set member id
357                         setMemberId($userid);
358
359                         // Try to set session data (which shall normally always work!)
360                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',hash=' . $content['hash'] . '(' . strlen($content['hash']) . ')');
361                         if ((setSession('userid', $userid )) && (setSession('u_hash', encodeHashForCookie($content['hash'])))) {
362                                 // Update database records
363                                 sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `total_logins`=`total_logins`+1" . $add . " WHERE `userid`=%s LIMIT 1",
364                                         array($userid), __FUNCTION__, __LINE__);
365                                 if (!ifSqlHasZeroAffectedRows()) {
366                                         // Is a success URL set?
367                                         if (empty($successUrl)) {
368                                                 // Procedure to checking for login data
369                                                 if (($GLOBALS['bonus_payed'] === TRUE) && (isExtensionActive('bonus'))) {
370                                                         // Bonus added (just displaying!)
371                                                         $url = 'modules.php?module=chk_login&amp;do=bonus';
372                                                 } else {
373                                                         // Bonus not added
374                                                         $url = 'modules.php?module=chk_login&amp;do=login';
375                                                 }
376                                         } else {
377                                                 // Use this URL
378                                                 $url = $successUrl;
379                                         }
380                                 } else {
381                                         // Cannot update counter!
382                                         $errorCode = getCode('CNTR_FAILED');
383                                 }
384                         } else {
385                                 // Cookies not setable!
386                                 $errorCode = getCode('COOKIES_DISABLED');
387                         }
388                 } elseif (isExtensionInstalledAndNewer('sql_patches', '0.6.1')) {
389                         // Update failure counter
390                         sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `login_failures`=`login_failures`+1,`last_failure`=NOW() WHERE `userid`=%s LIMIT 1",
391                                 array($userid), __FUNCTION__, __LINE__);
392
393                         // Wrong password!
394                         $errorCode = getCode('WRONG_PASS');
395                 }
396         } elseif ((isUserDataValid()) && (getUserData('status') != 'CONFIRMED')) {
397                 // Create an error code from given status
398                 $errorCode = generateErrorCodeFromUserStatus(getUserData('status'));
399
400                 // Set userid in session
401                 setSession('userid', getUserData('userid'));
402         } elseif (!isUserDataValid()) {
403                 // User id not found
404                 $errorCode = getCode('WRONG_ID');
405         } else {
406                 // Unknown error
407                 $errorCode = getCode('UNKNOWN_ERROR');
408         }
409
410         // Error code provided?
411         if ($errorCode > 0) {
412                 // Then reconstruct the URL
413                 $url = $errorUrl . $errorCode;
414
415                 // Extension set? Then add it as well.
416                 if (!empty($ext)) {
417                         $url .= '&amp;ext=' . $ext;
418                 } // END - if
419         } // END - if
420
421         // Return URL
422         return $url;
423 }
424
425 // Try to send a new password for the given user account
426 function doNewUserPassword ($email, $userid) {
427         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'email=' . $email . ',userid=' . $userid . ' - ENTERED!');
428         // Init found-status and error
429         $errorCode = '';
430         $accountFound = FALSE;
431
432         // Probe userid/nickname
433         if (!empty($email)) {
434                 // Email entered
435                 $accountFound = fetchUserData($email, 'email');
436         } elseif ((isExtensionActive('nickname')) && (isNicknameOrUserid($userid))) {
437                 // Nickname entered
438                 $accountFound = fetchUserData($userid, 'nickname');
439         } elseif ((isValidId($userid)) && (empty($email))) {
440                 // Direct userid entered
441                 $accountFound = fetchUserData($userid);
442         } elseif (isDebugModeEnabled()) {
443                 // Userid not set!
444                 logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',email=' . $email . ': Important variables are empty.');
445         }
446
447         // Any entry found?
448         if ($accountFound === TRUE) {
449                 // Is the account confirmed
450                 if (getUserData('status') == 'CONFIRMED') {
451                         // Generate new password
452                         $newPassword = generatePassword();
453
454                         // Update database
455                         sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `password`='%s' WHERE `userid`=%s LIMIT 1",
456                                 array(
457                                         generateHash($newPassword),
458                                         getUserData('userid')
459                                 ), __FUNCTION__, __LINE__);
460
461                         // Prepare data and message for email
462                         $message = loadEmailTemplate('guest_new_password',
463                                 array(
464                                         'new_pass' => $newPassword,
465                                         'nickname' => $userid
466                                 ), getUserData('userid'));
467
468                         // ... and send it away
469                         sendEmail(bigintval(getUserData('userid')), '{--GUEST_NEW_PASSWORD--}', $message);
470
471                         // Output note to user
472                         displayMessage('{--GUEST_NEW_PASSWORD_SEND--}');
473                 } else {
474                         // Account is locked or unconfirmed
475                         $errorCode = generateErrorCodeFromUserStatus(getUserData('status'));
476
477                         // Load URL
478                         redirectToUrl('modules.php?module=index&amp;what=login&amp;login=' . $errorCode);
479                 }
480         } else {
481                 // Id or email is wrong
482                 displayMessage('<span class="bad">{--GUEST_WRONG_ID_EMAIL--}</span>');
483         }
484
485         // Return the error code
486         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'email=' . $email . ',userid=' . $userid . ',errorCode=' . $errorCode . ' - EXIT!');
487         return $errorCode;
488 }
489
490 // Get timestamp for given stats type and data
491 function getEpocheTimeFromUserStats ($statsType, $statsData, $userid = NULL) {
492         // Default timestamp is zero
493         $data['inserted'] = '0';
494
495         // User id set?
496         if ((isMemberIdSet()) && (is_null($userid))) {
497                 $userid = getMemberId();
498         } // END - if
499
500         // Is the extension installed and updated?
501         if ((!isExtensionActive('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.6'))) {
502                 // Return zero here
503                 return $data['inserted'];
504         } // END - if
505
506         // Try to find the entry
507         $result = sqlQueryEscaped("SELECT
508         UNIX_TIMESTAMP(`inserted`) AS `inserted`
509 FROM
510         `{?_MYSQL_PREFIX?}_user_stats_data`
511 WHERE
512         `userid`=%s AND
513         `stats_type`='%s' AND
514         `stats_data`='%s'
515 LIMIT 1",
516                 array(
517                         bigintval($userid),
518                         $statsType,
519                         $statsData
520                 ), __FUNCTION__, __LINE__);
521
522         // Is the entry there?
523         if (sqlNumRows($result) == 1) {
524                 // Get this stamp
525                 $data = sqlFetchArray($result);
526         } // END - if
527
528         // Free result
529         sqlFreeResult($result);
530
531         // Return stamp
532         return $data['inserted'];
533 }
534
535 // Inserts user stats
536 function insertUserStatsRecord ($userid, $statsType, $statsData) {
537         // Is the extension installed and updated?
538         if ((!isExtensionActive('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.6'))) {
539                 // Return zero here
540                 return FALSE;
541         } // END - if
542
543         // Default is not working
544         $return = FALSE;
545
546         // Does it exist?
547         if ((!getEpocheTimeFromUserStats($statsType, $statsData, $userid)) && (!is_array($statsData))) {
548                 // Then insert it!
549                 sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_user_stats_data` (`userid`, `stats_type`, `stats_data`) VALUES (%s,'%s','%s')",
550                         array(
551                                 bigintval($userid),
552                                 $statsType,
553                                 $statsData
554                         ), __FUNCTION__, __LINE__);
555
556                 // Does it have worked?
557                 $return = (!ifSqlHasZeroAffectedRows());
558         } elseif (is_array($statsData)) {
559                 // Invalid data!
560                 logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',type=' . $statsType . ',data=' . gettype($statsData) . ': Invalid statistics data type!');
561         }
562
563         // Return status
564         return $return;
565 }
566
567 // Confirms a user account
568 function doConfirmUserAccount ($hash) {
569         // Init content
570         $content = array(
571                 'message' => '{--GUEST_CONFIRMED_FAILED--}',
572                 'userid'  => 0,
573         );
574
575         // Initialize the user id
576         $userid = NULL;
577
578         // Search for an unconfirmed or confirmed account
579         $result = sqlQueryEscaped("SELECT `userid`, `refid` FROM `{?_MYSQL_PREFIX?}_user_data` WHERE `user_hash`='%s' AND (`status`='UNCONFIRMED' OR `status`='CONFIRMED') LIMIT 1",
580                 array($hash), __FILE__, __LINE__);
581         if (sqlNumRows($result) == 1) {
582                 // Ok, he want's to confirm now so we load some data
583                 list($userid, $refid) = sqlFetchRow($result);
584
585                 // Fetch user data
586                 if (!fetchUserData($userid)) {
587                         // Not found, should not happen
588                         reportBug(__FILE__, __LINE__, 'User account ' . $userid . ' not found.');
589                 } // END - if
590
591                 // Load all data and add points
592                 $content = getUserDataArray();
593
594                 // Unlock his account (but only when it is on UNCONFIRMED!)
595                 sqlQueryEscaped("UPDATE
596         `{?_MYSQL_PREFIX?}_user_data`
597 SET
598         `status`='CONFIRMED',
599         `user_hash`=NULL
600 WHERE
601         `user_hash`='%s' AND
602         `status`='UNCONFIRMED'
603 LIMIT 1",
604                         array($hash), __FILE__, __LINE__);
605
606                 // Was it updated?
607                 if (!ifSqlHasZeroAffectedRows()) {
608                         // Send email if updated
609                         $message = loadEmailTemplate('guest_user_confirmed', $content, bigintval($userid));
610
611                         // And send him right away the confirmation mail
612                         sendEmail($userid, '{--GUEST_THANX_CONFIRM--}', $message);
613
614                         // Maybe he got "referraled"?
615                         if ((isValidId($refid)) && ($refid != $userid)) {
616                                 // Select the referral userid
617                                 if (fetchUserData($refid)) {
618                                         // Update ref counter...
619                                         updateReferralCounter($refid);
620
621                                         // If version matches add ref bonus to refid's account
622                                         if ((isExtensionInstalledAndNewer('bonus', '0.4.4')) && (isBonusRallyeActive())) {
623                                                 // Add points (directly only!)
624                                                 sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `bonus_ref`=`bonus_ref`+{?bonus_ref?} WHERE `userid`=%s LIMIT 1",
625                                                         array(bigintval($refid)), __FILE__, __LINE__);
626
627                                                 // Subtract points from system
628                                                 handleBonusPoints(getBonusRef(), $refid);
629                                         } // END - if
630
631                                         // Add one-time referral bonus over referral system or directly
632                                         initReferralSystem();
633                                         addPointsThroughReferralSystem('referral_bonus', $refid, getPointsRef(), bigintval($userid));
634                                 } // END - if
635                         } // END - if
636
637                         if (isExtensionActive('rallye')) {
638                                 // Add user to rallye (or not?)
639                                 addUserToReferralRallye(bigintval($userid));
640                         } // END - if
641
642                         // Account confirmed!
643                         if (isExtensionActive('lead')) {
644                                 // Set special lead cookie
645                                 setSession('lead_userid', bigintval($userid));
646
647                                 // Lead-Code mode enabled
648                                 redirectToUrl('lead-confirm.php');
649                         } else {
650                                 $content['message'] = '{--GUEST_CONFIRMED_DONE--}';
651                                 $content['userid']  = bigintval($userid);
652                         }
653                 } elseif (isExtensionActive('lead')) {
654                         // Set special lead cookie
655                         setSession('lead_userid', bigintval($userid));
656
657                         // Lead-Code mode enabled
658                         redirectToUrl('lead-confirm.php');
659                 } else {
660                         // Nobody was found unter this hash key... or our new member want's to confirm twice?
661                         $content['message'] = '{--GUEST_CONFIRMED_TWICE--}';
662                 }
663         } else {
664                 // Nobody was found unter this hash key... or our new member want's to confirm twice?
665                 $content['message'] = '{--GUEST_CONFIRMED_TWICE--}';
666         }
667
668         // Load template
669         displayMessage($content['message']);
670 }
671
672 // Does resend the user's confirmation link for given email address
673 function doResendUserConfirmationLink ($email) {
674         // Email address not registered is default message
675         $message = '{--EMAIL_404--}';
676
677         // Confirmation link requested
678         if (fetchUserData($email, 'email')) {
679                 // Email address found
680                 $content = getUserDataArray();
681
682                 // Is the account unconfirmed?
683                 if ($content['status'] == 'UNCONFIRMED') {
684                         // Load email template
685                         $message = loadEmailTemplate('guest_request_confirm', array(), $content['userid']);
686
687                         // Send email
688                         sendEmail($content['userid'], '{--GUEST_REQUEST_CONFIRM_LINK_SUBJECT--}', $message);
689                 } // END - if
690
691                 // Create message based on the status
692                 $message = getConfirmationMessageFromUserStatus($content['status']);
693         } // END - if
694
695         // Output message
696         displayMessage($message);
697 }
698
699 // Get a message (somewhat translation) from user status for confirmation link.
700 // This is different to translateUserStatus() in text messages.
701 function getConfirmationMessageFromUserStatus ($status) {
702         // Default is 'UNKNOWN'
703         $message = '{%message,GUEST_LOGIN_ID_UNKNOWN_STATUS=' . $status . '%}';
704
705         // Which status is it?
706         switch ($status) {
707                 case 'UNCONFIRMED': // Account is unconfirmed
708                         // And set message
709                         $message = '{--GUEST_CONFIRM_LINK_SENT--}';
710                         break;
711
712                 case 'CONFIRMED': // Account already confirmed
713                         $message = '{--GUEST_LOGIN_ID_CONFIRMED--}';
714                         break;
715
716                 case 'LOCKED': // Account is locked
717                         $message = '{--GUEST_LOGIN_ID_LOCKED--}';
718                         break;
719
720                 default: // This should not happen
721                         reportBug(__FUNCTION__, __LINE__, 'Unknown user status ' . $status . ' detected.');
722                         break;
723         } // END - switch
724
725         // Return message
726         return $message;
727 }
728
729 // "Getter" for total tester accounts
730 function getTotalTesterUsers () {
731         // Is there cache?
732         if (!isset($GLOBALS[__FUNCTION__])) {
733                 // Determine it
734                 $GLOBALS[__FUNCTION__] = countSumTotalData('', 'user_data', 'userid', '', TRUE, runFilterChain('user_inclusion_sql'));
735         } // END - if
736
737         // Return cache
738         return $GLOBALS[__FUNCTION__];
739 }
740
741 // Checks whether the admin is allowed to create more tester accounts
742 function isNewUserTesterAllowed () {
743         // By default only admins are allowed
744         if (!isAdmin()) {
745                 // This should not happen and must be fixed
746                 reportBug(__FUNCTION__, __LINE__, 'isAdmin()=false - Not allowed.');
747         } // END - if
748
749         // Are more tester accounts allowed?
750         $isAllowed = (getTotalTesterUsers() < bigintval(getTesterUserMaximum() + 1));
751
752         // Return result
753         return $isAllowed;
754 }
755
756 // "Getter" for next free tester account number
757 function getNextFreeTesterUserNumber () {
758         // Get current total amount because we start with zero
759         $nextTester = getTotalTesterUsers();
760
761         // Prepend zeros
762         $nextTester = padLeftZero($nextTester, 6);
763
764         // Return it
765         return $nextTester;
766 }
767
768 // Wrapper function to return a selection box for tester user default referral id
769 function addTesterUserDefaultRefidSelectionBox ($fieldName = 'tester_user_default_refid') {
770         // Return it
771         return addMemberSelectionBox(getConfig('tester_user_default_refid'), FALSE, TRUE, TRUE, $fieldName, " WHERE `surname` LIKE '{?tester_user_surname_prefix?}%'");
772 }
773
774 // Checks whether given surname is a test user name
775 function isTesterUserName ($surname) {
776         // Determine it
777         return (substr($surname, 0, strlen(getTesterUserSurnamePrefix())) == getTesterUserSurnamePrefix());
778 }
779
780 // Creates a tester account from given POST data
781 function createTesterUserAccount () {
782         // Add generated surname
783         setPostRequestElement('surname', (getTesterUserSurnamePrefix() . getNextFreeTesterUserNumber()));
784
785         // Is the registration data complete?
786         if (!isRegistrationDataComplete()) {
787                 // Then abort here
788                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isRegistrationDataComplete()=false, please check if you e.g. have selected the required minimum of categories.');
789                 return FALSE;
790         } // END - if
791
792         // Do registration
793         $isCreated = doUserRegistration();
794
795         // Remove cache to force recalculation of total tester accounts
796         unset($GLOBALS['getTotalTesterUsers']);
797
798         // Return status
799         return $isCreated;
800 }
801
802 // Checks whether the given sub id is fused by current member
803 function isMemberSubIdFree ($subId) {
804         // Only do this for logged-in members
805         assert(isMember());
806
807         // Check it
808         $isFree = (countSumTotalData(getMemberId(), 'user_subids', 'id', 'userid', TRUE, sprintf(" AND `subid`='%s'", $subId)) == 0);
809
810         // Return result
811         return $isFree;
812 }
813
814 // Checks whether the sub id is valid
815 function isValidSubId ($subId) {
816         // First convert any spaces/dashes to underscores
817         $subId = str_replace(' ', '_', str_replace('-', '_', $subId));
818
819         // Then filter out any unwanted characters
820         $subIdTest = preg_replace('/([^a-zA-Z0-9_])/', '', $subId);
821
822         // Is it valid?
823         return ($subId == $subIdTest);
824 } // END - if
825
826 // Prepares found sub id for updating in database
827 function prepareFoundSubId ($subId) {
828         // Then check if it is valid and available
829         if ((!isValidSubId($subId)) || (isMemberSubIdFree($subId))) {
830                 // Is not free or invalid
831                 $subId = FALSE;
832         } // END - if
833
834         // Return prepared sub id
835         return $subId;
836 }
837
838 // Validates sub id and returns FALSE if not valid
839 function validateSubId ($subId) {
840         // Then check if it is valid and available
841         if (!isValidSubId($subId)) {
842                 // Is not free or invalid
843                 $subId = FALSE;
844         } // END - if
845
846         // Return prepared sub id
847         return $subId;
848 }
849
850 // Prepares given sub id for inserting into database
851 function prepareSubId ($subId) {
852         // Then check if it is valid and available
853         if ((!isValidSubId($subId)) || (!isMemberSubIdFree($subId))) {
854                 // Is not free or invalid
855                 $subId = FALSE;
856         } // END - if
857
858         // Return prepared sub id
859         return $subId;
860 }
861
862 // Check whether given sub *id* is assigned to current member
863 function isUserSubIdAssignedToMember ($subId, $userid = NULL) {
864         // Is there cache?
865         if (!isset($GLOBALS[__FUNCTION__][$subId][$userid])) {
866                 // Determine it
867                 $GLOBALS[__FUNCTION__][$subId][$userid] = (
868                         (
869                                 // Is a userid set or current set?
870                                 (isValidId($userid)) || (isMember())
871                         ) && (
872                                 // .. and it assigned with subid's id?
873                                 countSumTotalData(
874                                         (isValidId($userid) ? $userid : getMemberId()),
875                                                 'user_subids',
876                                                 'id',
877                                                 'userid',
878                                                 true,
879                                                 sprintf(" AND `id`=%s", bigintval($subId))
880                                 ) == 1
881                         )
882                 );
883         } // END - if
884
885         // Return cache
886         return $GLOBALS[__FUNCTION__][$subId][$userid];
887 }
888
889 // Getter for subid from given id number
890 function getSubId ($id) {
891         // Is there cache?
892         if (!isset($GLOBALS[__FUNCTION__][$id])) {
893                 // Check database for record
894                 $result = sqlQueryEscaped("SELECT `subid` FROM `{?_MYSQL_PREFIX?}_user_subids` WHERE `id`=%s LIMIT 1",
895                         array(bigintval($id)), __FUNCTION__, __LINE__);
896
897                 // Is there an entry?
898                 if (sqlNumRows($result) == 1) {
899                         // Load it
900                         list($GLOBALS[__FUNCTION__][$id]) = sqlFetchRow($result);
901                 } // END - if
902
903                 // Free result
904                 sqlFreeResult($result);
905         } // END - if
906
907         // Return cache
908         return $GLOBALS[__FUNCTION__][$id];
909 }
910
911 // "Getter for total count of current user's sub ids
912 function getTotalMemberSubIds () {
913         // Only do this for logged-in members
914         assert(isMember());
915
916         // Is there cache?
917         if (!isset($GLOBALS[__FUNCTION__])) {
918                 // Determine it
919                 $GLOBALS[__FUNCTION__] = countSumTotalData(getMemberId(), 'user_subids', 'id', 'userid', TRUE);
920         } // END - if
921
922         // Return cache
923         return $GLOBALS[__FUNCTION__];
924 }
925
926 //-----------------------------------------------------------------------------
927 //                                EL code functions
928 //-----------------------------------------------------------------------------
929
930 // Expression call-back function for fetching user data
931 function doExpressionUser ($data) {
932         // Use current userid by default
933         $functionName = 'getMemberId()';
934
935         // User-related data, so is there a userid?
936         if (!empty($data['matches'][4][$data['key']])) {
937                 // Is there a userid or $userid?
938                 if (substr($data['matches'][4][$data['key']], 0, 1) == '$') {
939                         // Use dynamic call
940                         $functionName = "getFetchedUserData('userid', " . $data['matches'][4][$data['key']] . ", '" . $data['callback'] . "')";
941                 } elseif (!empty($data['matches'][4][$data['key']])) {
942                         // Is there a number or a dollar sign in front of it?
943                         if (preg_replace('/[^0123456789]/', '', $data['matches'][4][$data['key']]) != $data['matches'][4][$data['key']]) {
944                                 // Possible database column, so get it again
945                                 $data['matches'][4][$data['key']] = "getFetchedUserData('userid', getMemberId(), '" . $data['matches'][4][$data['key']] . "')";
946                         } // END - if
947
948                         // Fix all together
949                         $functionName = "getFetchedUserData('userid', " . $data['matches'][4][$data['key']] . ", '" . $data['callback'] . "')";
950                 }
951         } elseif ((!empty($data['callback'])) && (isUserDataValid())) {
952                 // "Call-back" alias column for current logged in user's data
953                 $functionName = "getUserData('" . $data['callback'] . "')";
954         }
955
956         // Is there another function to run (e.g. translations)
957         if (!empty($data['extra_func'])) {
958                 // Surround the original function call with it
959                 $functionName = $data['extra_func'] . '(' . $functionName . ')';
960         } // END - if
961         //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'functionName=' . $functionName);
962
963         // Generate replacer
964         $replacer = '{DQUOTE} . ' . $functionName . ' . {DQUOTE}';
965
966         // Now replace the code
967         $code = replaceExpressionCode($data, $replacer);
968
969         // Return replaced code
970         return $code;
971 }
972
973 //-----------------------------------------------------------------------------
974 //                             Template helper functions
975 //-----------------------------------------------------------------------------
976
977 // Template call-back function for list_user admin function
978 function doTemplateAdminListUserTitle ($template, $clear = FALSE) {
979         // Init title with "all accounts"
980         $code = '{--ADMIN_LIST_ALL_ACCOUNTS--}';
981
982         // Is there a 'status' or 'do' set?
983         if (isGetRequestElementSet('status')) {
984                 // Set title according to the 'status'
985                 $code = sprintf("{--ADMIN_LIST_STATUS_%s_ACCOUNTS--}", strtoupper(getRequestElement('status')));
986         } elseif (isGetRequestElementSet('do')) {
987                 // Set title according to 'do'
988                 $code = sprintf("{--ADMIN_LIST_DO_%s_ACCOUNTS--}", strtoupper(getRequestElement('do')));
989         }
990
991         // Return the code
992         return $code;
993 }
994
995 // Template call-back function for displaying "username"
996 function doTemplateDisplayUsername ($template, $clear = FALSE, $userid = NULL) {
997         // Is a userid set?
998         if (!isValidId($userid)) {
999                 // Please don't call this without a valid userid
1000                 reportBug(__FUNCTION__, __LINE__, 'template=' . $template . ',clear=' . intval($clear) . ',userid[' . gettype($userid) . ']=' . intval($userid) . ' - Invalid userid provided.');
1001         } // END - if
1002
1003         // Is there cache?
1004         if (!isset($GLOBALS[__FUNCTION__][$userid])) {
1005                 // Generate code
1006                 $GLOBALS[__FUNCTION__][$userid] = $userid . ' ({%user,nickname,fixEmptyContentToDashes=' . $userid . '%})';
1007         } // END - if
1008
1009         // Return cache
1010         return $GLOBALS[__FUNCTION__][$userid];
1011 }
1012
1013 // ----------------------------------------------------------------------------
1014 //                             XML call-back functions
1015 // ----------------------------------------------------------------------------
1016
1017 // For 'doing' add subid, the column-index is required
1018 function addXmlSpecialMemberAddDoUserSubid () {
1019         // So set it all here
1020         $GLOBALS['__COLUMN_INDEX']['doXmlCallbackFunction']  = 'column';
1021         $GLOBALS['__XML_ARGUMENTS']['doXmlCallbackFunction']['column_index'] = 'column';
1022 }
1023
1024 // ----------------------------------------------------------------------------
1025 //                 Wrapper functions for configuration entries
1026 // ----------------------------------------------------------------------------
1027
1028 // Getter for user_alpha
1029 function getUserAlpha () {
1030         // Is there cache?
1031         if (!isset($GLOBALS[__FUNCTION__])) {
1032                 // Determine it
1033                 $GLOBALS[__FUNCTION__] = getConfig('user_alpha');
1034         } // END - if
1035
1036         // Return cache
1037         return $GLOBALS[__FUNCTION__];
1038 }
1039
1040 // Getter for user_limit
1041 function getUserLimit () {
1042         // Is there cache?
1043         if (!isset($GLOBALS[__FUNCTION__])) {
1044                 // Determine it
1045                 $GLOBALS[__FUNCTION__] = getConfig('user_limit');
1046         } // END - if
1047
1048         // Return cache
1049         return $GLOBALS[__FUNCTION__];
1050 }
1051
1052 // Getter for tester_user_surname_prefix
1053 function getTesterUserSurnamePrefix () {
1054         // Is there cache?
1055         if (!isset($GLOBALS[__FUNCTION__])) {
1056                 // Determine it
1057                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_surname_prefix');
1058         } // END - if
1059
1060         // Return cache
1061         return $GLOBALS[__FUNCTION__];
1062 }
1063
1064 // Getter for tester_user_maximum
1065 function getTesterUserMaximum () {
1066         // Is there cache?
1067         if (!isset($GLOBALS[__FUNCTION__])) {
1068                 // Determine it
1069                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_maximum');
1070         } // END - if
1071
1072         // Return cache
1073         return $GLOBALS[__FUNCTION__];
1074 }
1075
1076 // Getter for tester_user_check_cat
1077 function getTesterUserCheckCat () {
1078         // Is there cache?
1079         if (!isset($GLOBALS[__FUNCTION__])) {
1080                 // Determine it
1081                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_check_cat');
1082         } // END - if
1083
1084         // Return cache
1085         return $GLOBALS[__FUNCTION__];
1086 }
1087
1088 // Getter for tester_user_gender
1089 function getTesterUserGender () {
1090         // Is there cache?
1091         if (!isset($GLOBALS[__FUNCTION__])) {
1092                 // Determine it
1093                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_gender');
1094         } // END - if
1095
1096         // Return cache
1097         return $GLOBALS[__FUNCTION__];
1098 }
1099
1100 // Getter for tester_user_family
1101 function getTesterUserFamily () {
1102         // Is there cache?
1103         if (!isset($GLOBALS[__FUNCTION__])) {
1104                 // Determine it
1105                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_family');
1106         } // END - if
1107
1108         // Return cache
1109         return $GLOBALS[__FUNCTION__];
1110 }
1111
1112 // Getter for tester_user_password
1113 function getTesterUserPassword () {
1114         // Is there cache?
1115         if (!isset($GLOBALS[__FUNCTION__])) {
1116                 // Determine it
1117                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_password');
1118         } // END - if
1119
1120         // Return cache
1121         return $GLOBALS[__FUNCTION__];
1122 }
1123
1124 // Getter for tester_user_street_nr
1125 function getTesterUserStreetNr () {
1126         // Is there cache?
1127         if (!isset($GLOBALS[__FUNCTION__])) {
1128                 // Determine it
1129                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_street_nr');
1130         } // END - if
1131
1132         // Return cache
1133         return $GLOBALS[__FUNCTION__];
1134 }
1135
1136 // Getter for tester_user_zip
1137 function getTesterUserZip () {
1138         // Is there cache?
1139         if (!isset($GLOBALS[__FUNCTION__])) {
1140                 // Determine it
1141                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_zip');
1142         } // END - if
1143
1144         // Return cache
1145         return $GLOBALS[__FUNCTION__];
1146 }
1147
1148 // Getter for tester_user_city
1149 function getTesterUserCity () {
1150         // Is there cache?
1151         if (!isset($GLOBALS[__FUNCTION__])) {
1152                 // Determine it
1153                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_city');
1154         } // END - if
1155
1156         // Return cache
1157         return $GLOBALS[__FUNCTION__];
1158 }
1159
1160 // Getter for tester_user_email
1161 function getTesterUserEmail () {
1162         // Is there cache?
1163         if (!isset($GLOBALS[__FUNCTION__])) {
1164                 // Determine it
1165                 $GLOBALS[__FUNCTION__] = getConfig('tester_user_email');
1166         } // END - if
1167
1168         // Return cache
1169         return $GLOBALS[__FUNCTION__];
1170 }
1171
1172 // Getter for 'ap_subids' config entry
1173 function getApSubids () {
1174         // Is there cache?
1175         if (!isset($GLOBALS[__FUNCTION__])) {
1176                 // Determine it
1177                 $GLOBALS[__FUNCTION__] = getConfig('ap_subids');
1178         } // END - if
1179
1180         // Return cache
1181         return $GLOBALS[__FUNCTION__];
1182 }
1183
1184 // Determines whether 'ap_subids' is set to 'Y'
1185 function isApSubidsEnabled () {
1186         // Is there cache?
1187         if (!isset($GLOBALS[__FUNCTION__])) {
1188                 // Determine it
1189                 $GLOBALS[__FUNCTION__] = (getApSubids() == 'Y');
1190         } // END - if
1191
1192         // Return cache
1193         return $GLOBALS[__FUNCTION__];
1194 }
1195
1196 // Getter for 'ap_subids_since' config entry
1197 function getApSubidsSince () {
1198         // Is there cache?
1199         if (!isset($GLOBALS[__FUNCTION__])) {
1200                 // Determine it
1201                 $GLOBALS[__FUNCTION__] = getConfig('ap_subids_since');
1202         } // END - if
1203
1204         // Return cache
1205         return $GLOBALS[__FUNCTION__];
1206 }
1207
1208 // Getter for 'select_user_zero_refid' config entry
1209 function getSelectUserZeroRefid () {
1210         // Is there cache?
1211         if (!isset($GLOBALS[__FUNCTION__])) {
1212                 // Determine it
1213                 $GLOBALS[__FUNCTION__] = getConfig('select_user_zero_refid');
1214         } // END - if
1215
1216         // Return cache
1217         return $GLOBALS[__FUNCTION__];
1218 }
1219
1220 // [EOF]
1221 ?>