source: trunk/lib/Auth_SQL.inc.php @ 670

Last change on this file since 670 was 634, checked in by anonymous, 6 years ago

Remove conflict css.

File size: 51.1 KB
Line 
1<?php
2/**
3 * The Strangecode Codebase - a general application development framework for PHP
4 * For details visit the project site: <http://trac.strangecode.com/codebase/>
5 * Copyright 2001-2012 Strangecode, LLC
6 *
7 * This file is part of The Strangecode Codebase.
8 *
9 * The Strangecode Codebase is free software: you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License as published by the
11 * Free Software Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * The Strangecode Codebase is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * details.
18 *
19 * You should have received a copy of the GNU General Public License along with
20 * The Strangecode Codebase. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23/*
24* The Auth_SQL class provides a SQL implementation for authentication.
25*
26* @author  Quinn Comendant <quinn@strangecode.com>
27* @version 2.1
28*/
29
30require_once dirname(__FILE__) . '/Email.inc.php';
31
32class Auth_SQL
33{
34    // Available hash types for class Auth_SQL.
35    const ENCRYPT_PLAINTEXT = 1;
36    const ENCRYPT_CRYPT = 2;
37    const ENCRYPT_SHA1 = 3;
38    const ENCRYPT_SHA1_HARDENED = 4;
39    const ENCRYPT_MD5 = 5;
40    const ENCRYPT_MD5_HARDENED = 6;
41    const ENCRYPT_PASSWORD_BCRYPT = 7;
42    const ENCRYPT_PASSWORD_DEFAULT = 8;
43
44    // Namespace of this auth object.
45    protected $_ns;
46
47    // Static var for test.
48    protected $_authentication_tested;
49
50    // Parameters to be configured by setParam.
51    protected $_params = array();
52    protected $_default_params = array(
53
54        // Automatically create table and verify columns. Better set to false after site launch.
55        // This value is overwritten by the $app->getParam('db_create_tables') setting if it is available.
56        'create_table' => true,
57
58        // The database table containing users to authenticate.
59        'db_table' => 'user_tbl',
60
61        // The name of the primary key for the db_table.
62        'db_primary_key' => 'user_id',
63
64        // The name of the username key for the db_table.
65        'db_username_column' => 'username',
66
67        // If using the db_login_table feature, specify the db_login_table. The primary key must match the primary key for the db_table.
68        'db_login_table' => 'user_login_tbl',
69
70        // The type of hash to use for passwords stored in the db_table. Use one of the Auth_SQL::ENCRYPT_* types specified above.
71        // Hardened password hashes rely on the same key/salt being used to compare hashes.
72        // Be aware that when using one of the hardened types the App signing_key or $more_salt below cannot change!
73        'hash_type' => self::ENCRYPT_MD5,
74        'encryption_type' => null, // Backwards misnomer compatibility.
75
76        // Automatically update stored user hashes when the user next authenticates if the hash type changes (requires user_tbl with populated userpass_hashtype column).
77        'hash_type_autoupdate' => true,
78
79        // The URL to the login script.
80        'login_url' => '/',
81
82        // The maximum amount of time a user is allowed to be logged in. They will be forced to login again if they expire.
83        // In seconds. 21600 seconds = 6 hours.
84        'login_timeout' => 21600,
85
86        // The maximum amount of time a user is allowed to be idle before their session expires. They will be forced to login again if they expire.
87        // In seconds. 3600 seconds = 1 hour.
88        'idle_timeout' => 3600,
89
90        // The period of time to compare login abuse attempts. If a threshold of logins is reached in this amount of time the account is blocked.
91        // Days and hours, like this: 'DD:HH'
92        'login_abuse_timeframe' => '04:00',
93
94        // The number of warnings a user will receive (and their password reset each time) before their account is completely blocked.
95        'login_abuse_warnings' => 3,
96
97        // The maximum number of IP addresses a user can login with over the timeout period before their account is blocked.
98        'login_abuse_max_ips' => 5,
99
100        // The IP address subnet size threshold. Uses a CIDR notation network mask (see CIDR cheat-sheet at bottom).
101        // Any integer between 0 and 32 is permitted. Setting this to '24' permits any address in a
102        // class C network (255.255.255.0) to be considered the same. Setting to '32' compares each IP absolutely.
103        // Setting to '0' ignores all IPs, thus disabling login_abuse checking.
104        'login_abuse_ip_bitmask' => 32,
105
106        // Specify usernames to exclude from the account abuse detection system. This is specified as a hardcoded array provided at
107        // class instantiation time, or can be saved in the db_table under the login_abuse_exempt field.
108        'login_abuse_exempt_usernames' => array(),
109
110        // Specify usernames to exclude from remote_ip matching. Users behind proxy servers should be appended to this array so their shifting remote IP will not log them out.
111        'match_remote_ip_exempt_usernames' => array(),
112
113        // Match the user's current remote IP against the one they logged in with.
114        'match_remote_ip' => true,
115
116        // An array of IP blocks that are bypass the remote_ip comparison check. Useful for dynamic IPs or those behind proxy servers.
117        'trusted_networks' => array(),
118
119        // Allow user accounts to be blocked? Requires the user table to have the columns 'blocked' and 'blocked_reason'
120        'blocking' => false,
121
122        // Use a db_login_table to detect excessive logins. This requires blocking to be enabled.
123        'abuse_detection' => false,
124
125        // Allow users to save login form passwords in their browser? Setting to 'true' may pose a potential security risk.
126        'login_form_allow_autocomplete' => false,
127    );
128
129    /**
130     * Constructs a new authentication object.
131     *
132     * @access public
133     * @param optional array $params  A hash containing parameters.
134     */
135    public function __construct($namespace='')
136    {
137        $app =& App::getInstance();
138
139        $this->_ns = $namespace;
140
141        // Initialize default parameters.
142        $this->setParam($this->_default_params);
143
144        // Get create tables config from global context.
145        if (!is_null($app->getParam('db_create_tables'))) {
146            $this->setParam(array('create_table' => $app->getParam('db_create_tables')));
147        }
148
149        if (!isset($_SESSION['_auth_sql'][$this->_ns])) {
150            $app->logMsg(sprintf('No _auth_sql session found; initializing', null), LOG_DEBUG, __FILE__, __LINE__);
151            $this->clear();
152        }
153    }
154
155    /**
156     * Setup the database tables for this class.
157     *
158     * @access  public
159     * @author  Quinn Comendant <quinn@strangecode.com>
160     * @since   26 Aug 2005 17:09:36
161     */
162    public function initDB($recreate_db=false)
163    {
164        $app =& App::getInstance();
165        $db =& DB::getInstance();
166
167        static $_db_tested = false;
168
169        if ($recreate_db || !$_db_tested && $this->getParam('create_table')) {
170
171            // User table.
172            if ($recreate_db) {
173                $db->query("DROP TABLE IF EXISTS " . $this->getParam('db_table'));
174                $app->logMsg(sprintf('Dropping and recreating table %s.', $this->getParam('db_table')), LOG_INFO, __FILE__, __LINE__);
175            }
176
177            // The minimal columns for a table compatible with the Auth_SQL class.
178            $db->query(sprintf(
179                "CREATE TABLE IF NOT EXISTS %1\$s (
180                    %2\$s MEDIUMINT UNSIGNED NOT NULL PRIMARY KEY AUTO_INCREMENT,
181                    %3\$s varchar(255) NOT NULL default '',
182                    userpass VARCHAR(255) NOT NULL DEFAULT '',
183                    userpass_hashtype TINYINT UNSIGNED NOT NULL DEFAULT '0',
184                    first_name VARCHAR(50) NOT NULL DEFAULT '',
185                    last_name VARCHAR(50) NOT NULL DEFAULT '',
186                    email VARCHAR(255) NOT NULL DEFAULT '',
187                    login_abuse_exempt ENUM('true') DEFAULT NULL,
188                    blocked ENUM('true') DEFAULT NULL,
189                    blocked_reason VARCHAR(255) NOT NULL DEFAULT '',
190                    abuse_warning_level TINYINT NOT NULL DEFAULT '0',
191                    seconds_online INT NOT NULL DEFAULT '0',
192                    last_login_datetime DATETIME NOT NULL DEFAULT '%4\$s 00:00:00',
193                    last_access_datetime DATETIME NOT NULL DEFAULT '%4\$s 00:00:00',
194                    last_login_ip VARCHAR(45) NOT NULL DEFAULT '0.0.0.0',
195                    added_by_user_id SMALLINT DEFAULT NULL,
196                    modified_by_user_id SMALLINT DEFAULT NULL,
197                    added_datetime DATETIME NOT NULL DEFAULT '%4\$s 00:00:00',
198                    modified_datetime DATETIME NOT NULL DEFAULT '%4\$s 00:00:00',
199                    KEY %5\$s (%5\$s),
200                    KEY userpass (userpass),
201                    KEY email (email),
202                    KEY last_login_datetime (last_login_datetime),
203                    KEY last_access_datetime (last_access_datetime)
204                )",
205                $db->escapeString($this->getParam('db_table')),
206                $this->getParam('db_primary_key'),
207                $this->getParam('db_username_column'),
208                $db->getParam('zero_date'),
209                $this->getParam('db_username_column')
210            ));
211
212            if (!$db->columnExists($this->getParam('db_table'), array(
213                $this->getParam('db_primary_key'),
214                $this->getParam('db_username_column'),
215                'userpass',
216                'first_name',
217                'last_name',
218                'email',
219                'login_abuse_exempt',
220                'blocked',
221                'blocked_reason',
222                'abuse_warning_level',
223                'seconds_online',
224                'last_login_datetime',
225                'last_access_datetime',
226                'last_login_ip',
227                'added_by_user_id',
228                'modified_by_user_id',
229                'added_datetime',
230                'modified_datetime',
231            ), false, false)) {
232                $app->logMsg(sprintf('Database table %s has invalid columns. Please update this table manually.', $this->getParam('db_table')), LOG_ALERT, __FILE__, __LINE__);
233                trigger_error(sprintf('Database table %s has invalid columns. Please update this table manually.', $this->getParam('db_table')), E_USER_ERROR);
234            }
235
236            // Login table is used for abuse_detection features.
237            if ($this->getParam('abuse_detection')) {
238                if ($recreate_db) {
239                    $db->query("DROP TABLE IF EXISTS " . $this->getParam('db_login_table'));
240                    $app->logMsg(sprintf('Dropping and recreating table %s.', $this->getParam('db_login_table')), LOG_INFO, __FILE__, __LINE__);
241                }
242                $db->query(sprintf(
243                    "CREATE TABLE IF NOT EXISTS %1\$s (
244                        %2\$s MEDIUMINT UNSIGNED NOT NULL DEFAULT '0',
245                        login_datetime DATETIME NOT NULL DEFAULT '%3\$s 00:00:00',
246                        remote_ip_binary CHAR(32) NOT NULL DEFAULT '',
247                        KEY %4\$s (%4\$s),
248                        KEY login_datetime (login_datetime),
249                        KEY remote_ip_binary (remote_ip_binary)
250                    )",
251                    $this->getParam('db_login_table'),
252                    $this->getParam('db_primary_key'),
253                    $db->getParam('zero_date'),
254                    $this->getParam('db_primary_key')
255                ));
256
257                if (!$db->columnExists($this->getParam('db_login_table'), array(
258                    $this->getParam('db_primary_key'),
259                    'login_datetime',
260                    'remote_ip_binary',
261                ), false, false)) {
262                    $app->logMsg(sprintf('Database table %s has invalid columns. Please update this table manually.', $this->getParam('db_login_table')), LOG_ALERT, __FILE__, __LINE__);
263                    trigger_error(sprintf('Database table %s has invalid columns. Please update this table manually.', $this->getParam('db_login_table')), E_USER_ERROR);
264                }
265            }
266        }
267        $_db_tested = true;
268    }
269
270    /**
271     * Set the params of an auth object.
272     *
273     * @param  array $params   Array of parameter keys and value to set.
274     * @return bool true on success, false on failure
275     */
276    public function setParam($params)
277    {
278        $app =& App::getInstance();
279
280        if (isset($params['match_remote_ip_exempt_usernames'])) {
281            $params['match_remote_ip_exempt_usernames'] = array_map('strtolower', $params['match_remote_ip_exempt_usernames']);
282        }
283        if (isset($params['login_abuse_exempt_usernames'])) {
284            $params['login_abuse_exempt_usernames'] = array_map('strtolower', $params['login_abuse_exempt_usernames']);
285        }
286        if (isset($params['encryption_type'])) {
287            // Backwards misnomer compatibility.
288            $params['hash_type'] = $params['encryption_type'];
289        }
290        if (isset($params['hash_type']) && version_compare(PHP_VERSION, '5.5.0', '<') && in_array($params['hash_type'], array(self::ENCRYPT_PASSWORD_BCRYPT, self::ENCRYPT_PASSWORD_DEFAULT))) {
291            // These hash types require the password_* userland lib in PHP < 5.5.0
292            $pw_compat_lib = 'vendor/ircmaxell/password-compat/lib/password.php';
293            if (false !== stream_resolve_include_path($pw_compat_lib)) {
294                include_once $pw_compat_lib;
295            } else {
296                $app->logMsg(sprintf('Hash type %s requires password-compat lib in PHP < 5.5.0; falling back to ENCRYPT_SHA1_HARDENED', $params['hash_type']), LOG_ERR, __FILE__, __LINE__);
297                $params['hash_type'] = self::ENCRYPT_SHA1_HARDENED;
298            }
299        }
300        if (isset($params['hash_type']) && !in_array($params['hash_type'], array(self::ENCRYPT_PLAINTEXT, self::ENCRYPT_CRYPT, self::ENCRYPT_SHA1, self::ENCRYPT_SHA1_HARDENED, self::ENCRYPT_MD5, self::ENCRYPT_MD5_HARDENED, self::ENCRYPT_PASSWORD_BCRYPT, self::ENCRYPT_PASSWORD_DEFAULT))) {
301            $app->logMsg(sprintf('Invalid hash type %s; falling back to ENCRYPT_SHA1_HARDENED', $params['hash_type']), LOG_ERR, __FILE__, __LINE__);
302            $params['hash_type'] = self::ENCRYPT_SHA1_HARDENED;
303        }
304        if (isset($params) && is_array($params)) {
305            // Merge new parameters with old overriding only those passed.
306            $this->_params = array_merge($this->_params, $params);
307        }
308    }
309
310    /**
311     * Return the value of a parameter, if it exists.
312     *
313     * @access public
314     * @param string $param        Which parameter to return.
315     * @return mixed               Configured parameter value.
316     */
317    public function getParam($param)
318    {
319        $app =& App::getInstance();
320
321        if (array_key_exists($param, $this->_params)) {
322            return $this->_params[$param];
323        } else {
324            $app->logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__);
325            return null;
326        }
327    }
328
329    /**
330     * Clear any authentication tokens in the current session. A.K.A. logout.
331     *
332     * @access public
333     */
334    public function clear()
335    {
336        $app =& App::getInstance();
337        $db =& DB::getInstance();
338
339        if ($this->get('user_id', false)) {
340
341            $this->initDB();
342
343            // FIX ME: Should we check if the session is active?
344            $db->query(sprintf(
345                "UPDATE %s SET
346                    seconds_online = seconds_online + ABS(UNIX_TIMESTAMP() - UNIX_TIMESTAMP(last_access_datetime)),
347                    last_login_datetime = '%s 00:00:00'
348                    WHERE %s = '%s'
349                ",
350                $this->_params['db_table'],
351                $db->getParam('zero_date'),
352                $this->_params['db_primary_key'],
353                $this->get('user_id')
354            ));
355        }
356        $_SESSION['_auth_sql'][$this->_ns] = array(
357            'authenticated'         => false,
358            'user_id'               => null,
359            'username'              => null,
360            'login_datetime'        => null,
361            'last_access_datetime'  => null,
362            'remote_ip'             => getRemoteAddr(),
363            'login_abuse_exempt'    => null,
364            'match_remote_ip_exempt'=> null,
365            'user_data'             => null,
366        );
367
368        $app->logMsg(sprintf('Cleared %s auth', $this->_ns), LOG_DEBUG, __FILE__, __LINE__);
369    }
370
371    /**
372     * Sets a variable into a registered auth session.
373     *
374     * @access public
375     * @param mixed $key      Which value to set.
376     * @param mixed $val      Value to set variable to.
377     */
378    public function set($key, $val)
379    {
380        if (!isset($_SESSION['_auth_sql'][$this->_ns]['user_data'])) {
381            $_SESSION['_auth_sql'][$this->_ns]['user_data'] = array();
382        }
383        $_SESSION['_auth_sql'][$this->_ns]['user_data'][$key] = $val;
384    }
385
386    /**
387     * Returns a specified value from a registered auth session.
388     *
389     * @access public
390     * @param mixed $key      Which value to return.
391     * @param mixed $default  Value to return if key not found in user_data.
392     * @return mixed          Value stored in session.
393     */
394    public function get($key, $default='')
395    {
396        if (isset($_SESSION['_auth_sql'][$this->_ns][$key])) {
397            return $_SESSION['_auth_sql'][$this->_ns][$key];
398        } else if (isset($_SESSION['_auth_sql'][$this->_ns]['user_data'][$key])) {
399            return $_SESSION['_auth_sql'][$this->_ns]['user_data'][$key];
400        } else {
401            return $default;
402        }
403    }
404
405    /**
406     * Retrieve and verify the given username and password against a matching user record in the database.
407     *
408     * @access private
409     * @param string $username      The username to check.
410     * @param string $password      The password to compare to username.
411     * @return mixed  False if credentials not found in DB, or returns DB row matching credentials.
412     */
413    public function authenticate($username, $password)
414    {
415        $app =& App::getInstance();
416        $db =& DB::getInstance();
417
418        $this->initDB();
419
420        // Get user data for specified username.
421        $qid = $db->query("
422            SELECT *, " . $this->_params['db_primary_key'] . " AS user_id
423            FROM " . $this->_params['db_table'] . "
424            WHERE " . $this->_params['db_username_column'] . " = '" . $db->escapeString($username) . "'
425        ");
426        if (!$user_data = mysql_fetch_assoc($qid)) {
427            $app->logMsg(sprintf('Username %s not found for authentication', $username), LOG_NOTICE, __FILE__, __LINE__);
428            return false;
429        }
430
431        // Check given password against hashed DB password.
432        $old_hash_type = isset($user_data['userpass_hashtype']) && !empty($user_data['userpass_hashtype']) ? $user_data['userpass_hashtype'] : $this->getParam('hash_type');
433        if ($this->verifyPassword($password, $user_data['userpass'], $old_hash_type)) {
434            $app->logMsg(sprintf('Authentication successful for %s (user_id=%s)', $username, $user_data['user_id']), LOG_INFO, __FILE__, __LINE__);
435            unset($user_data['userpass']); // Avoid revealing the encrypted password in the $user_data.
436            if ($this->getParam('hash_type_autoupdate') && $old_hash_type != $this->getParam('hash_type')) {
437                // Let's update user's password hash to new type (just run setPassword with this authenticated password
).
438                $this->setPassword($user_data['user_id'], $password);
439                $app->logMsg(sprintf('User %s password hash type updated from %s to %s', $username, $old_hash_type, $this->getParam('hash_type')), LOG_INFO, __FILE__, __LINE__);
440            }
441            return $user_data;
442        }
443
444        $app->logMsg(sprintf('Authentication failed for %s (user_id=%s)', $username, $user_data['user_id']), LOG_NOTICE, __FILE__, __LINE__);
445        return false;
446    }
447
448    /**
449     * Check username and password, and create new session if authenticated.
450     *
451     * @access private
452     * @param string $username     The username to check.
453     * @param string $password     The password to compare for username.
454     * @return boolean  Whether or not the credentials are valid.
455     */
456    public function login($username, $password)
457    {
458        $app =& App::getInstance();
459        $db =& DB::getInstance();
460
461        if ($user_data = $this->authenticate($username, $password)) {
462            // The credentials match. Now setup the session.
463            return $this->createSession($user_data);
464        }
465        // No login: failed authentication!
466        return false;
467    }
468
469    /**
470     * Create new login session for given user.
471     *
472     * @access private
473     * @param string $user_data User data that is normally returned from this->authenticate(). If provided manually:
474     *                          Required array values:
475     *                              'user_id' => '1'
476     *                              'username' => 'name'
477     *                          Optional array values:
478     *                              'match_remote_ip_exempt' => true
479     *                              'login_abuse_exempt' => true
480     *                              'abuse_warning_level' => true
481     *                              'blocked' => true
482     *                              'blocked_reason' => ''
483     *                              '
' => '
' (any other values that should be retrievable via this->get())
484     * @return boolean          Whether or not the session was created. It will return true unless abuse detection is enabled and triggered.
485     */
486    public function createSession($user_data)
487    {
488        $app =& App::getInstance();
489        $db =& DB::getInstance();
490
491        $this->initDB();
492
493        $this->clear();
494
495        // Convert 'priv' to 'user_type' nomenclature to support older implementations.
496        if (isset($user_data['priv'])) {
497            $user_data['user_type'] = $user_data['priv'];
498        }
499
500        // Register authenticated session.
501        $_SESSION['_auth_sql'][$this->_ns] = array(
502            'authenticated'         => true,
503            'user_id'               => $user_data['user_id'],
504            'username'              => $user_data['username'],
505            'login_datetime'        => date('Y-m-d H:i:s'),
506            'last_access_datetime'  => date('Y-m-d H:i:s'),
507            'remote_ip'             => getRemoteAddr(),
508            'login_abuse_exempt'    => isset($user_data['login_abuse_exempt']) ? !empty($user_data['login_abuse_exempt']) : in_array(strtolower($user_data['username']), $this->_params['login_abuse_exempt_usernames']),
509            'match_remote_ip_exempt'=> isset($user_data['match_remote_ip_exempt']) ? !empty($user_data['match_remote_ip_exempt']) : in_array(strtolower($user_data['username']), $this->_params['match_remote_ip_exempt_usernames']),
510            'user_data'             => $user_data
511        );
512
513        /**
514         * Check if the account is blocked, respond in context to reason. Cancel the login if blocked.
515         */
516        if ($this->getParam('blocking')) {
517            if (isset($user_data['blocked']) && !empty($user_data['blocked'])) {
518                switch ($this->get('blocked_reason')) {
519                case 'account abuse' :
520                    $app->raiseMsg(sprintf(_("This account has been blocked due to possible account abuse. Please contact an administrator to reactivate."), null), MSG_WARNING, __FILE__, __LINE__);
521                    break;
522                default :
523                    $app->raiseMsg(sprintf(_("This account is currently not active. %s"), $this->get('blocked_reason')), MSG_WARNING, __FILE__, __LINE__);
524                    break;
525                }
526
527                // No login: user is blocked!
528                $app->logMsg(sprintf('User_id %s (%s) login failed due to blocked account: %s', $this->get('user_id'), $this->get('username'), $this->get('blocked_reason')), LOG_NOTICE, __FILE__, __LINE__);
529                $this->clear();
530                return false;
531            }
532        }
533
534        /**
535         * Check the db_login_table for too many logins under this account.
536         * (1) Count the number of unique IP addresses that logged in under this user within the login_abuse_timeframe
537         * (2) If this number exceeds the login_abuse_max_ips, assume multiple people are logging in under the same account.
538        **/
539        // TODO: make this ipv6 compatible. At the moment, ipv6 addresses are converted into zero for remote_ip_binary.
540        // http://www.highonphp.com/5-tips-for-working-with-ipv6-in-php
541        // https://stackoverflow.com/questions/444966/working-with-ipv6-addresses-in-php
542        if ($this->getParam('abuse_detection') && !$this->get('login_abuse_exempt')) {
543            $qid = $db->query("
544                SELECT COUNT(DISTINCT LEFT(remote_ip_binary, " . $this->_params['login_abuse_ip_bitmask'] . "))
545                FROM " . $this->_params['db_login_table'] . "
546                WHERE " . $this->_params['db_primary_key'] . " = '" . $this->get('user_id') . "'
547                AND DATE_ADD(login_datetime, INTERVAL '" . $this->_params['login_abuse_timeframe'] . "' DAY_HOUR) > NOW()
548            ");
549            list($distinct_ips) = mysql_fetch_row($qid);
550            if ($distinct_ips > $this->_params['login_abuse_max_ips']) {
551                if ($this->get('abuse_warning_level') < $this->_params['login_abuse_warnings']) {
552                    // Warn the user with a password reset.
553                    $this->resetPassword(null, _("This is a security precaution. We have detected this account has been accessed from multiple computers simultaneously. It is against policy to share credentials with others. If further account abuse is detected this account will be blocked."));
554                    $app->raiseMsg(_("Your password has been reset as a security precaution. Please check your email for more information."), MSG_NOTICE, __FILE__, __LINE__);
555                    $app->logMsg(sprintf('Account abuse detected for user_id %s (%s) from IP %s', $this->get('user_id'), $this->get('username'), $this->get('remote_ip')), LOG_WARNING, __FILE__, __LINE__);
556                } else {
557                    // Block the account with the reason of account abuse.
558                    $this->blockAccount(null, 'account abuse');
559                    $app->raiseMsg(_("Your account has been blocked as a security precaution. Please contact us for more information."), MSG_NOTICE, __FILE__, __LINE__);
560                    $app->logMsg(sprintf('Account blocked for user_id %s (%s) from IP %s', $this->get('user_id'), $this->get('username'), $this->get('remote_ip')), LOG_ALERT, __FILE__, __LINE__);
561                }
562                // Increment user's warning level.
563                $db->query("UPDATE " . $this->_params['db_table'] . " SET abuse_warning_level = abuse_warning_level + 1 WHERE " . $this->_params['db_primary_key'] . " = '" . $this->get('user_id') . "'");
564                // Reset the login counter for this user.
565                $db->query("DELETE FROM " . $this->_params['db_login_table'] . " WHERE " . $this->_params['db_primary_key'] . " = '" . $this->get('user_id') . "'");
566                // No login: reset password because of account abuse!
567                $this->clear();
568                return false;
569            }
570
571            // Update the login counter table with this login access. Convert IP to binary.
572            // TODO: this query could benefit from INSERT DELAYED.
573            $db->query("
574                INSERT INTO " . $this->_params['db_login_table'] . " (
575                    " . $this->_params['db_primary_key'] . ",
576                    login_datetime,
577                    remote_ip_binary
578                ) VALUES (
579                    '" . $this->get('user_id') . "',
580                    '" . $this->get('login_datetime') . "',
581                    '" . sprintf('%032b', ip2long($this->get('remote_ip'))) . "'
582                )
583            ");
584        }
585
586        // Update user table with this login.
587        $db->query("
588            UPDATE " . $this->_params['db_table'] . " SET
589                last_login_datetime = '" . $this->get('login_datetime') . "',
590                last_access_datetime = '" . $this->get('login_datetime') . "',
591                last_login_ip = '" . $this->get('remote_ip') . "'
592            WHERE " . $this->_params['db_primary_key'] . " = '" . $this->get('user_id') . "'
593        ");
594
595        // Session created! We're logged-in!
596        return true;
597    }
598
599    /**
600     * Test if user has a currently logged-in session.
601     *  - authentication flag set to true
602     *  - username not empty
603     *  - total logged-in time is not greater than login_timeout
604     *  - idle time is not greater than idle_timeout
605     *  - remote address is the same as the login remote address
606     *
607     * @access public
608     */
609    public function isLoggedIn($user_id=null)
610    {
611        $app =& App::getInstance();
612        $db =& DB::getInstance();
613
614        $this->initDB();
615
616        if (isset($user_id)) {
617            // Check the login status of a specific user.
618            $qid = $db->query("
619                SELECT 1 FROM " . $this->_params['db_table'] . "
620                WHERE " . $this->_params['db_primary_key'] . " = '" . $db->escapeString($user_id) . "'
621                AND last_login_datetime > DATE_SUB(NOW(), INTERVAL '" . $this->_params['login_timeout'] . "' SECOND)
622                AND last_access_datetime > DATE_SUB(NOW(), INTERVAL '" . $this->_params['idle_timeout'] . "' SECOND)
623            ");
624            $login_status = (mysql_num_rows($qid) > 0);
625            $app->logMsg(sprintf('Returning %s login status for user_id %s', ($login_status ? 'true' : 'false'), $user_id), LOG_DEBUG, __FILE__, __LINE__);
626            return $login_status;
627        }
628
629        // User login test need only be run once per script execution. We cache the result in the session.
630        if ($this->_authentication_tested && isset($_SESSION['_auth_sql'][$this->_ns]['authenticated'])) {
631            $app->logMsg(sprintf('Returning cached authentication status: %s', ($_SESSION['_auth_sql'][$this->_ns]['authenticated'] ? 'true' : 'false')), LOG_DEBUG, __FILE__, __LINE__);
632            return $_SESSION['_auth_sql'][$this->_ns]['authenticated'];
633        }
634
635        // Testing login should occur once. This is the first time. Set flag.
636        $this->_authentication_tested = true;
637
638        // Some users will access from networks with a changing IP number (i.e. behind a proxy server).
639        // These users must be allowed entry by adding their IP to the list of trusted_networks, or their usernames to the list of match_remote_ip_exempt_usernames.
640        if ($trusted_net = ipInRange(getRemoteAddr(), $this->_params['trusted_networks'])) {
641            $user_in_trusted_network = true;
642            $app->logMsg(sprintf('User_id %s accessing from trusted network %s',
643                ($this->get('user_id') ? $this->get('user_id') . ' (' .  $this->get('username') . ')' : 'unknown'),
644                $trusted_net
645            ), LOG_DEBUG, __FILE__, __LINE__);
646        } else {
647            $user_in_trusted_network = false;
648        }
649
650        // Do we match the user's remote IP at all? Yes, if set in config and not disabled for specific user.
651        if ($this->getParam('match_remote_ip') && !$this->get('match_remote_ip_exempt')) {
652            $remote_ip_is_matched = (isset($_SESSION['_auth_sql'][$this->_ns]['remote_ip']) && $_SESSION['_auth_sql'][$this->_ns]['remote_ip'] == getRemoteAddr()) || $user_in_trusted_network;
653        } else {
654            $app->logMsg(sprintf('User_id %s exempt from remote_ip match (comparing %s == %s)',
655                ($this->get('user_id') ? $this->get('user_id') . ' (' .  $this->get('username') . ')' : 'unknown'),
656                $_SESSION['_auth_sql'][$this->_ns]['remote_ip'],
657                getRemoteAddr()
658            ), LOG_DEBUG, __FILE__, __LINE__);
659            $remote_ip_is_matched = true;
660        }
661
662        // Test login with information stored in session. Skip IP matching for users from trusted networks.
663        if (isset($_SESSION['_auth_sql'][$this->_ns]['authenticated'])
664            && true === $_SESSION['_auth_sql'][$this->_ns]['authenticated']
665            && isset($_SESSION['_auth_sql'][$this->_ns]['username'])
666            && !empty($_SESSION['_auth_sql'][$this->_ns]['username'])
667            && isset($_SESSION['_auth_sql'][$this->_ns]['login_datetime'])
668            && strtotime($_SESSION['_auth_sql'][$this->_ns]['login_datetime']) > (time() - $this->_params['login_timeout'])
669            && isset($_SESSION['_auth_sql'][$this->_ns]['last_access_datetime'])
670            && strtotime($_SESSION['_auth_sql'][$this->_ns]['last_access_datetime']) > (time() - $this->_params['idle_timeout'])
671            && $remote_ip_is_matched
672        ) {
673            // User is authenticated!
674            $_SESSION['_auth_sql'][$this->_ns]['last_access_datetime'] = date('Y-m-d H:i:s');
675
676            // Update the DB with the last_access_datetime and increment the seconds_online.
677            $db->query("
678                UPDATE " . $this->_params['db_table'] . " SET
679                seconds_online = seconds_online + ABS(UNIX_TIMESTAMP() - UNIX_TIMESTAMP(last_access_datetime)) + 1,
680                last_access_datetime = '" . $this->get('last_access_datetime') . "'
681                WHERE " . $this->_params['db_primary_key'] . " = '" . $this->get('user_id') . "'
682            ");
683            if (mysql_affected_rows($db->getDBH()) > 0) {
684                // User record still exists in DB. Do this to ensure user was not delete from DB between accesses. Notice "+ 1" in SQL above to ensure record is modified.
685                return true;
686            } else {
687                $app->logMsg(sprintf('Session update failed; record not found for user_id %s (%s).', $this->get('user_id'), $this->get('username')), LOG_NOTICE, __FILE__, __LINE__);
688            }
689        } else if (isset($_SESSION['_auth_sql'][$this->_ns]['authenticated']) && true === $_SESSION['_auth_sql'][$this->_ns]['authenticated']) {
690            // User is authenticated, but login has expired.
691
692            // Log the reason for login expiration.
693            $expire_reasons = array();
694            $user_notified = false;
695            if (!isset($_SESSION['_auth_sql'][$this->_ns]['username']) || empty($_SESSION['_auth_sql'][$this->_ns]['username'])) {
696                $expire_reasons[] = 'username not found';
697            }
698            if (!isset($_SESSION['_auth_sql'][$this->_ns]['login_datetime']) || strtotime($_SESSION['_auth_sql'][$this->_ns]['login_datetime']) <= (time() - $this->_params['login_timeout'])) {
699                $expire_reasons[] = sprintf('login_timeout expired (%s older than %s seconds ago)', $_SESSION['_auth_sql'][$this->_ns]['login_datetime'], $this->_params['login_timeout']);
700            }
701            if (!isset($_SESSION['_auth_sql'][$this->_ns]['last_access_datetime']) || strtotime($_SESSION['_auth_sql'][$this->_ns]['last_access_datetime']) <= (time() - $this->_params['idle_timeout'])) {
702                $expire_reasons[] = sprintf('idle_timeout expired (%s older than %s seconds ago)', $_SESSION['_auth_sql'][$this->_ns]['last_access_datetime'], $this->_params['idle_timeout']);
703                if (strtotime($_SESSION['_auth_sql'][$this->_ns]['last_access_datetime']) > (time() - 43200)) {
704                    // Only raise message if last session is less than 12 hours old.
705                    // Notify user why they were logged out if they haven't yet been given a reason.
706                    $user_notified || $app->raiseMsg(sprintf(_("For your security we logged you out after being idle for %s. Please log in again."), humanTime($this->_params['idle_timeout'], 'hour', '%01.0f')), MSG_NOTICE, __FILE__, __LINE__);
707                    $user_notified = true;
708                }
709            }
710            if (!isset($_SESSION['_auth_sql'][$this->_ns]['remote_ip']) || $_SESSION['_auth_sql'][$this->_ns]['remote_ip'] != getRemoteAddr()) {
711                if ($this->getParam('match_remote_ip') && !$this->get('match_remote_ip_exempt') && !$user_in_trusted_network) {
712                    // There are three cases when a remote IP match will be the cause of a session termination:
713                    //   1. match_remote_ip config is enabled
714                    //   2. user is not match_remote_ip_exempt (set in the user_data, or in the match_remote_ip_exempt_usernames list)
715                    //   3. the user is connecting from a trusted network (their IP is listed in the trusted_networks)
716                    $expire_reasons[] = sprintf('remote_ip not matched (%s != %s)', $_SESSION['_auth_sql'][$this->_ns]['remote_ip'], getRemoteAddr());
717                    // Notify user why they were logged out if they haven't yet been given a reason.
718                    $user_notified || $app->raiseMsg(sprintf(_("For your security we logged you out because your IP address has changed. Please log in again."), null), MSG_NOTICE, __FILE__, __LINE__);
719                    $user_notified = true;
720                } else {
721                    $expire_reasons[] = sprintf('remote_ip not matched but user was exempt from this check (%s != %s)', $_SESSION['_auth_sql'][$this->_ns]['remote_ip'], getRemoteAddr());
722                }
723            }
724            $app->logMsg(sprintf('User_id %s (%s) session expired: %s', $this->get('user_id'), $this->get('username'), join(', ', $expire_reasons)), LOG_INFO, __FILE__, __LINE__);
725        } else {
726            $app->logMsg('Session is not authenticated', LOG_DEBUG, __FILE__, __LINE__);
727        }
728
729        // User is not authenticated.
730        $this->clear();
731        return false;
732    }
733
734    /**
735     * Redirect user to login page if they are not logged in.
736     *
737     * @param string $message The text description of a message to raise.
738     * @param int    $type    The type of message: MSG_NOTICE,
739     *                        MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
740     * @param string $file    __FILE__.
741     * @param string $line    __LINE__.
742     * @access public
743     */
744    public function requireLogin($message='', $type=MSG_NOTICE, $file=null, $line=null)
745    {
746        $app =& App::getInstance();
747
748        if (!$this->isLoggedIn()) {
749            // Display message for requiring login. (RaiseMsg will ignore empty strings.)
750            if ('' != $message) {
751                $app->raiseMsg($message, $type, $file, $line);
752            }
753
754            // Login scripts must have the same 'login' tag for boomerangURL verification/manipulation.
755            $app->setBoomerangURL(absoluteMe(), 'login');
756            $app->dieURL($this->_params['login_url']);
757        }
758    }
759
760    /**
761     * This sets the 'blocked' field for a user in the db_table, and also
762     * adds an optional reason
763     *
764     * @param  string   $reason      The reason for blocking the account.
765     */
766    public function blockAccount($user_id=null, $reason='')
767    {
768        $app =& App::getInstance();
769        $db =& DB::getInstance();
770
771        $this->initDB();
772
773        if ($this->getParam('blocking')) {
774            if (mb_strlen($db->escapeString($reason)) > 255) {
775                // blocked_reason field is varchar(255).
776                $app->logMsg(sprintf('Blocked reason provided is greater than 255 characters: %s', $reason), LOG_WARNING, __FILE__, __LINE__);
777            }
778
779            // Get user_id if specified.
780            $user_id = isset($user_id) ? $user_id : $this->get('user_id');
781            $db->query("
782                UPDATE " . $this->_params['db_table'] . " SET
783                blocked = 'true',
784                blocked_reason = '" . $db->escapeString($reason) . "'
785                WHERE " . $this->_params['db_primary_key'] . " = '" . $db->escapeString($user_id) . "'
786            ");
787        }
788    }
789
790    /**
791     * Tests if the "blocked" flag is set for a user.
792     *
793     * @param  int      $user_id    User id to look for.
794     * @return boolean              True if the user is blocked, false otherwise.
795     */
796    public function isBlocked($user_id=null)
797    {
798        $db =& DB::getInstance();
799
800        $this->initDB();
801
802        if ($this->getParam('blocking')) {
803            // Get user_id if specified.
804            $user_id = isset($user_id) ? $user_id : $this->getVal('user_id');
805            $qid = $db->query("
806                SELECT 1
807                FROM " . $this->_params['db_table'] . "
808                WHERE blocked = 'true'
809                AND " . $this->_params['db_primary_key'] . " = '" . $db->escapeString($user_id) . "'
810            ");
811            return mysql_num_rows($qid) === 1;
812        }
813    }
814
815    /**
816     * Unblocks a user in the db_table, and clears any blocked_reason.
817     */
818    public function unblockAccount($user_id=null)
819    {
820        $db =& DB::getInstance();
821
822        $this->initDB();
823
824        if ($this->getParam('blocking')) {
825            // Get user_id if specified.
826            $user_id = isset($user_id) ? $user_id : $this->get('user_id');
827            $db->query("
828                UPDATE " . $this->_params['db_table'] . " SET
829                blocked = NULL,
830                blocked_reason = ''
831                WHERE " . $this->_params['db_primary_key'] . " = '" . $db->escapeString($user_id) . "'
832            ");
833        }
834    }
835
836    /**
837     * Returns true if username already exists in database.
838     *
839     * @param  string  $username    Username to look for.
840     * @return bool                 True if username exists.
841     */
842    public function usernameExists($username)
843    {
844        $db =& DB::getInstance();
845
846        $this->initDB();
847
848        $qid = $db->query("
849            SELECT 1
850            FROM " . $this->_params['db_table'] . "
851            WHERE " . $this->_params['db_username_column'] . " = '" . $db->escapeString($username) . "'
852        ");
853        return (mysql_num_rows($qid) > 0);
854    }
855
856    /**
857     * Returns a username for a specified user id.
858     *
859     * @param  string  $user_id     User id to look for.
860     * @return string               Username, or false if none found.
861     */
862    public function getUsername($user_id)
863    {
864        $db =& DB::getInstance();
865
866        $this->initDB();
867
868        $qid = $db->query("
869            SELECT " . $this->_params['db_username_column'] . "
870            FROM " . $this->_params['db_table'] . "
871            WHERE " . $this->_params['db_primary_key'] . " = '" . $db->escapeString($user_id) . "'
872        ");
873        if (list($username) = mysql_fetch_row($qid)) {
874            return $username;
875        } else {
876            return false;
877        }
878    }
879
880    /*
881    * Generate a cryptographically secure, random password.
882    *
883    * @access   public
884    * @param    int  $bytes     Length of password (in bytes)
885    * @return   string          Random string of characters.
886    * @author   Quinn Comendant <quinn@strangecode.com>
887    * @version  1.0
888    * @since    15 Nov 2014 20:30:27
889    */
890    public function generatePassword($bytes=10)
891    {
892        $app =& App::getInstance();
893
894        $bytes = is_numeric($bytes) ? $bytes : 10;
895        $string = strtok(base64_encode(openssl_random_pseudo_bytes($bytes, $strong)), '=');
896        if (!$strong) {
897            $app->logMsg(sprintf('Password generated was not "cryptographically strong"; check your openssl.', null), LOG_NOTICE, __FILE__, __LINE__);
898        }
899
900        return $string;
901    }
902
903    /**
904     *
905     */
906    public function encryptPassword($password, $salt=null, $hash_type=null)
907    {
908        $app =& App::getInstance();
909
910        $password = (string)$password;
911
912        // Existing password hashes rely on the same key/salt being used to compare hashs.
913        // Don't change this (or the value applied to signing_key) unless you know existing hashes or signatures will not be affected!
914        $more_salt = 'B36D18E5-3FE4-4D58-8150-F26642852B81';
915
916        $hash_type = isset($hash_type) && !empty($hash_type) ? $hash_type : $this->getParam('hash_type');
917
918        switch ($hash_type) {
919        case self::ENCRYPT_PLAINTEXT :
920            $encrypted_password = $password;
921            break;
922
923        case self::ENCRYPT_CRYPT :
924            // If comparing password with an existing hashed password, provide the hashed password as the salt.
925            $encrypted_password = isset($salt) ? crypt($password, $salt) : crypt($password);
926            break;
927
928        case self::ENCRYPT_SHA1 :
929            $encrypted_password = sha1($password);
930            break;
931
932        case self::ENCRYPT_SHA1_HARDENED :
933            $encrypted_password = sha1($app->getParam('signing_key') . $password . $more_salt);
934            for ($i=0; $i < pow(2, 20); $i++) {
935                $encrypted_password = sha1($password . $encrypted_password);
936            }
937            break;
938
939        case self::ENCRYPT_MD5 :
940            $encrypted_password = md5($password);
941            break;
942
943        case self::ENCRYPT_MD5_HARDENED :
944            $encrypted_password = md5($app->getParam('signing_key') . $password . $more_salt);
945            for ($i=0; $i < pow(2, 20); $i++) {
946                $encrypted_password = md5($password . $encrypted_password);
947            }
948            break;
949
950        case self::ENCRYPT_PASSWORD_BCRYPT :
951            $encrypted_password = password_hash($password, PASSWORD_BCRYPT, array('cost' => 12));
952            break;
953
954        case self::ENCRYPT_PASSWORD_DEFAULT :
955            $encrypted_password = password_hash($password, PASSWORD_DEFAULT, array('cost' => 12));
956            break;
957
958        default :
959            $app->logMsg(sprintf('Unknown hash type: %s', $hash_type), LOG_WARNING, __FILE__, __LINE__);
960            return false;
961        }
962
963        // In case our hashing function returns 'false' or another empty value, bail out.
964        if ('' == trim((string)$encrypted_password)) {
965            $app->logMsg(sprintf('Invalid password hash returned ("%s") for hash type %s; check yo crypto!', $encrypted_password, $hash_type), LOG_ALERT, __FILE__, __LINE__);
966            return false;
967        }
968
969        return $encrypted_password;
970    }
971
972    /*
973    *
974    *
975    * @access   public
976    * @param
977    * @return
978    * @author   Quinn Comendant <quinn@strangecode.com>
979    * @version  1.0
980    * @since    15 Nov 2014 21:37:28
981    */
982    public function verifyPassword($password, $encrypted_password, $hash_type=null)
983    {
984        $app =& App::getInstance();
985
986        $hash_type = isset($hash_type) && !empty($hash_type) ? $hash_type : $this->getParam('hash_type');
987
988        switch ($hash_type) {
989        case self::ENCRYPT_CRYPT :
990            return $this->encryptPassword($password, $encrypted_password, $hash_type) == $encrypted_password;
991
992        case self::ENCRYPT_PLAINTEXT :
993        case self::ENCRYPT_MD5 :
994        case self::ENCRYPT_MD5_HARDENED :
995        case self::ENCRYPT_SHA1 :
996        case self::ENCRYPT_SHA1_HARDENED :
997            return $this->encryptPassword($password, $encrypted_password, $hash_type) == $encrypted_password;
998
999        case self::ENCRYPT_PASSWORD_BCRYPT :
1000        case self::ENCRYPT_PASSWORD_DEFAULT :
1001            return password_verify($password, $encrypted_password);
1002
1003        default :
1004            $app->logMsg(sprintf('Unknown hash type: %s', $hash_type), LOG_WARNING, __FILE__, __LINE__);
1005            return false;
1006        }
1007
1008    }
1009
1010    /**
1011     *
1012     */
1013    public function setPassword($user_id=null, $password, $hash_type=null)
1014    {
1015        $app =& App::getInstance();
1016        $db =& DB::getInstance();
1017
1018        $this->initDB();
1019
1020        // Get user_id if specified.
1021        $user_id = isset($user_id) ? $user_id : $this->get('user_id');
1022
1023        // New hash type.
1024        $hash_type = isset($hash_type) ? $hash_type : $this->getParam('hash_type');
1025
1026        // Save the hash method used if a table exists for it.
1027        $userpass_hashtype_clause = '';
1028        if ($db->columnExists($this->_params['db_table'], 'userpass_hashtype', false)) {
1029            $userpass_hashtype_clause = ", userpass_hashtype = '" . $db->escapeString($hash_type) . "'";
1030        }
1031
1032        // Issue the password change query.
1033        $db->query("
1034            UPDATE " . $this->_params['db_table'] . " SET
1035                userpass = '" . $db->escapeString($this->encryptPassword($password, null, $hash_type)) . "',
1036                modified_datetime = NOW(),
1037                modified_by_user_id = '" . $db->escapeString($user_id) . "'
1038                $userpass_hashtype_clause
1039            WHERE " . $this->_params['db_primary_key'] . " = '" . $db->escapeString($user_id) . "'
1040        ");
1041
1042        if (mysql_affected_rows($db->getDBH()) != 1) {
1043            $app->logMsg(sprintf('Failed to update password for user_id %s (no affected rows)', $user_id), LOG_WARNING, __FILE__, __LINE__);
1044            return false;
1045        }
1046
1047        $app->logMsg(sprintf('Password change successful for user_id %s', $user_id), LOG_INFO, __FILE__, __LINE__);
1048        return true;
1049    }
1050
1051    /**
1052     * Resets the password for the user with the specified id.
1053     *
1054     * @param  string $user_id   The id of the user to reset.
1055     * @param  string $reason    Additional message to add to the reset email.
1056     * @return string            The user's new password.
1057     */
1058    public function resetPassword($user_id=null, $reason='')
1059    {
1060        $app =& App::getInstance();
1061        $db =& DB::getInstance();
1062
1063        $this->initDB();
1064
1065        // Get user_id if specified.
1066        $user_id = isset($user_id) ? $user_id : $this->get('user_id');
1067
1068        // Reset password of a specific user.
1069        $qid = $db->query("
1070            SELECT * FROM " . $this->_params['db_table'] . "
1071            WHERE " . $this->_params['db_primary_key'] . " = '" . $db->escapeString($user_id) . "'
1072        ");
1073        if (!$user_data = mysql_fetch_assoc($qid)) {
1074            $app->logMsg(sprintf('Reset password failed. User_id %s not found.', $user_id), LOG_NOTICE, __FILE__, __LINE__);
1075            return false;
1076        }
1077
1078        // Get new password.
1079        $password = $this->generatePassword();
1080
1081        // Update password query.
1082        $this->setPassword($user_id, $password);
1083
1084        // Make sure user has an email on record before continuing.
1085        if (!isset($user_data['email']) || '' == trim($user_data['email'])) {
1086            $app->logMsg(sprintf('Password reset but notification failed, no email address for user_id %s (%s).', $user_data[$this->_params['db_primary_key']], $user_data[$this->_params['db_username_column']]), LOG_NOTICE, __FILE__, __LINE__);
1087        } else {
1088            // Send the new password in an email.
1089            $email = new Email(array(
1090                'to' => $user_data['email'],
1091                'from' => sprintf('"%s" <%s>', addcslashes($app->getParam('site_name'), '"'), $app->getParam('site_email')),
1092                'subject' => sprintf('%s password change', $app->getParam('site_name'))
1093            ));
1094            $email->setTemplate('codebase/services/templates/email_reset_password.txt');
1095            $email->replace(array(
1096                'SITE_NAME' => $app->getParam('site_name'),
1097                'SITE_URL' => $app->getParam('site_url'),
1098                'SITE_EMAIL' => $app->getParam('site_email'),
1099                'NAME' => ('' != $user_data['first_name'] . $user_data['last_name'] ? $user_data['first_name'] . ' ' . $user_data['last_name'] : $user_data[$this->_params['db_username_column']]),
1100                'USERNAME' => $user_data[$this->_params['db_username_column']],
1101                'PASSWORD' => $password,
1102                'REASON' => ('' == trim($reason) ? '' : trim($reason) . ' '), // Add a space after the reason if it exists for better formatting.
1103            ));
1104            $email->send();
1105        }
1106
1107        return array(
1108            'username' => $user_data[$this->_params['db_username_column']],
1109            'userpass' => $password
1110        );
1111    }
1112
1113} // end class
Note: See TracBrowser for help on using the repository browser.