]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/User.php
Fix translation strings for use with util/extract.php
[friendica.git] / src / Model / User.php
index 2ba0f05bd81a279ed5d27a95fdd738eb941a9571..07df7ca6150a35171be1cafa3335fd3a381bd64c 100644 (file)
@@ -1,14 +1,14 @@
 <?php
-
 /**
  * @file src/Model/User.php
  * @brief This file includes the User class with user related database functions
  */
-
 namespace Friendica\Model;
 
+use Friendica\Core\Addon;
 use Friendica\Core\Config;
 use Friendica\Core\PConfig;
+use Friendica\Core\L10n;
 use Friendica\Core\System;
 use Friendica\Core\Worker;
 use Friendica\Database\DBM;
@@ -25,8 +25,6 @@ require_once 'include/dba.php';
 require_once 'include/enotify.php';
 require_once 'include/network.php';
 require_once 'library/openid.php';
-require_once 'include/pgettext.php';
-require_once 'include/plugin.php';
 require_once 'include/text.php';
 /**
  * @brief This class handles User related functions
@@ -112,7 +110,7 @@ class User
                if (is_object($user_info)) {
                        $user = (array) $user_info;
                } elseif (is_int($user_info)) {
-                       $user = dba::selectFirst('user', ['uid', 'password'],
+                       $user = dba::selectFirst('user', ['uid', 'password', 'legacy_password'],
                                [
                                        'uid' => $user_info,
                                        'blocked' => 0,
@@ -122,7 +120,7 @@ class User
                                ]
                        );
                } elseif (is_string($user_info)) {
-                       $user = dba::fetch_first('SELECT `uid`, `password`
+                       $user = dba::fetch_first('SELECT `uid`, `password`, `legacy_password`
                                FROM `user`
                                WHERE (`email` = ? OR `username` = ? OR `nickname` = ?)
                                AND `blocked` = 0
@@ -138,17 +136,92 @@ class User
                        $user = $user_info;
                }
 
-               if (!DBM::is_result($user) || !isset($user['uid']) || !isset($user['password'])) {
-                       return false;
+               if (!DBM::is_result($user)
+                       || !isset($user['uid'])
+                       || !isset($user['password'])
+                       || !isset($user['legacy_password'])
+               ) {
+                       throw new Exception('Not enough information to authenticate');
                }
 
-               $password_hashed = hash('whirlpool', $password);
+               if ($user['legacy_password']) {
+                       if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
+                               self::updatePassword($user['uid'], $password);
 
-               if ($password_hashed !== $user['password']) {
-                       return false;
+                               return $user['uid'];
+                       }
+               } elseif (password_verify($password, $user['password'])) {
+                       if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
+                               self::updatePassword($user['uid'], $password);
+                       }
+
+                       return $user['uid'];
                }
 
-               return $user['uid'];
+               return false;
+       }
+
+       /**
+        * Generates a human-readable random password
+        *
+        * @return string
+        */
+       public static function generateNewPassword()
+       {
+               return autoname(6) . mt_rand(100, 9999);
+       }
+
+       /**
+        * Legacy hashing function, kept for password migration purposes
+        *
+        * @param string $password
+        * @return string
+        */
+       private static function hashPasswordLegacy($password)
+       {
+               return hash('whirlpool', $password);
+       }
+
+       /**
+        * Global user password hashing function
+        *
+        * @param string $password
+        * @return string
+        */
+       public static function hashPassword($password)
+       {
+               return password_hash($password, PASSWORD_DEFAULT);
+       }
+
+       /**
+        * Updates a user row with a new plaintext password
+        *
+        * @param int    $uid
+        * @param string $password
+        * @return bool
+        */
+       public static function updatePassword($uid, $password)
+       {
+               return self::updatePasswordHashed($uid, self::hashPassword($password));
+       }
+
+       /**
+        * Updates a user row with a new hashed password.
+        * Empties the password reset token field just in case.
+        *
+        * @param int    $uid
+        * @param string $pasword_hashed
+        * @return bool
+        */
+       private static function updatePasswordHashed($uid, $pasword_hashed)
+       {
+               $fields = [
+                       'password' => $pasword_hashed,
+                       'pwdreset' => null,
+                       'pwdreset_time' => null,
+                       'legacy_password' => false
+               ];
+               return dba::update('user', $fields, ['uid' => $uid]);
        }
 
        /**
@@ -191,25 +264,25 @@ class User
                $netpublish = strlen(Config::get('system', 'directory')) ? $publish : 0;
 
                if ($password1 != $confirm) {
-                       throw new Exception(t('Passwords do not match. Password unchanged.'));
+                       throw new Exception(L10n::t('Passwords do not match. Password unchanged.'));
                } elseif ($password1 != '') {
                        $password = $password1;
                }
 
                if ($using_invites) {
                        if (!$invite_id) {
-                               throw new Exception(t('An invitation is required.'));
+                               throw new Exception(L10n::t('An invitation is required.'));
                        }
 
                        if (!dba::exists('register', ['hash' => $invite_id])) {
-                               throw new Exception(t('Invitation could not be verified.'));
+                               throw new Exception(L10n::t('Invitation could not be verified.'));
                        }
                }
 
                if (!x($username) || !x($email) || !x($nickname)) {
                        if ($openid_url) {
                                if (!validate_url($openid_url)) {
-                                       throw new Exception(t('Invalid OpenID url'));
+                                       throw new Exception(L10n::t('Invalid OpenID url'));
                                }
                                $_SESSION['register'] = 1;
                                $_SESSION['openid'] = $openid_url;
@@ -222,13 +295,13 @@ class User
                                try {
                                        $authurl = $openid->authUrl();
                                } catch (Exception $e) {
-                                       throw new Exception(t('We encountered a problem while logging in with the OpenID you provided. Please check the correct spelling of the ID.') . EOL . EOL . t('The error message was:') . $e->getMessage(), 0, $e);
+                                       throw new Exception(L10n::t('We encountered a problem while logging in with the OpenID you provided. Please check the correct spelling of the ID.') . EOL . EOL . L10n::t('The error message was:') . $e->getMessage(), 0, $e);
                                }
                                goaway($authurl);
                                // NOTREACHED
                        }
 
-                       throw new Exception(t('Please enter the required information.'));
+                       throw new Exception(L10n::t('Please enter the required information.'));
                }
 
                if (!validate_url($openid_url)) {
@@ -241,10 +314,10 @@ class User
                $username = preg_replace('/ +/', ' ', $username);
 
                if (mb_strlen($username) > 48) {
-                       throw new Exception(t('Please use a shorter name.'));
+                       throw new Exception(L10n::t('Please use a shorter name.'));
                }
                if (mb_strlen($username) < 3) {
-                       throw new Exception(t('Name too short.'));
+                       throw new Exception(L10n::t('Name too short.'));
                }
 
                // So now we are just looking for a space in the full name.
@@ -252,20 +325,20 @@ class User
                if (!$loose_reg) {
                        $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
                        if (!strpos($username, ' ')) {
-                               throw new Exception(t("That doesn't appear to be your full \x28First Last\x29 name."));
+                               throw new Exception(L10n::t("That doesn't appear to be your full \x28First Last\x29 name."));
                        }
                }
 
                if (!allowed_email($email)) {
-                       throw new Exception(t('Your email domain is not among those allowed on this site.'));
+                       throw new Exception(L10n::t('Your email domain is not among those allowed on this site.'));
                }
 
                if (!valid_email($email) || !validate_email($email)) {
-                       throw new Exception(t('Not a valid email address.'));
+                       throw new Exception(L10n::t('Not a valid email address.'));
                }
 
                if (dba::exists('user', ['email' => $email])) {
-                       throw new Exception(t('Cannot use that email.'));
+                       throw new Exception(L10n::t('Cannot use that email.'));
                }
 
                // Disallow somebody creating an account using openid that uses the admin email address,
@@ -273,31 +346,31 @@ class User
                if (x($a->config, 'admin_email') && strlen($openid_url)) {
                        $adminlist = explode(',', str_replace(' ', '', strtolower($a->config['admin_email'])));
                        if (in_array(strtolower($email), $adminlist)) {
-                               throw new Exception(t('Cannot use that email.'));
+                               throw new Exception(L10n::t('Cannot use that email.'));
                        }
                }
 
                $nickname = $data['nickname'] = strtolower($nickname);
 
                if (!preg_match('/^[a-z0-9][a-z0-9\_]*$/', $nickname)) {
-                       throw new Exception(t('Your "nickname" can only contain "a-z", "0-9" and "_".'));
+                       throw new Exception(L10n::t('Your nickname can only contain a-z, 0-9 and _.'));
                }
 
                // Check existing and deleted accounts for this nickname.
                if (dba::exists('user', ['nickname' => $nickname])
                        || dba::exists('userd', ['username' => $nickname])
                ) {
-                       throw new Exception(t('Nickname is already registered. Please choose another.'));
+                       throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
                }
 
-               $new_password = strlen($password) ? $password : autoname(6) . mt_rand(100, 9999);
-               $new_password_encoded = hash('whirlpool', $new_password);
+               $new_password = strlen($password) ? $password : User::generateNewPassword();
+               $new_password_encoded = self::hashPassword($new_password);
 
                $return['password'] = $new_password;
 
                $keys = Crypto::newKeypair(4096);
                if ($keys === false) {
-                       throw new Exception(t('SERIOUS ERROR: Generation of security keys failed.'));
+                       throw new Exception(L10n::t('SERIOUS ERROR: Generation of security keys failed.'));
                }
 
                $prvkey = $keys['prvkey'];
@@ -330,11 +403,11 @@ class User
                        $uid = dba::lastInsertId();
                        $user = dba::selectFirst('user', [], ['uid' => $uid]);
                } else {
-                       throw new Exception(t('An error occurred during registration. Please try again.'));
+                       throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
                }
 
                if (!$uid) {
-                       throw new Exception(t('An error occurred during registration. Please try again.'));
+                       throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
                }
 
                // if somebody clicked submit twice very quickly, they could end up with two accounts
@@ -343,7 +416,7 @@ class User
                if ($user_count > 1) {
                        dba::delete('user', ['uid' => $uid]);
 
-                       throw new Exception(t('Nickname is already registered. Please choose another.'));
+                       throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
                }
 
                $insert_result = dba::insert('profile', [
@@ -354,28 +427,28 @@ class User
                        'publish' => $publish,
                        'is-default' => 1,
                        'net-publish' => $netpublish,
-                       'profile-name' => t('default')
+                       'profile-name' => L10n::t('default')
                ]);
                if (!$insert_result) {
                        dba::delete('user', ['uid' => $uid]);
 
-                       throw new Exception(t('An error occurred creating your default profile. Please try again.'));
+                       throw new Exception(L10n::t('An error occurred creating your default profile. Please try again.'));
                }
 
                // Create the self contact
                if (!Contact::createSelfFromUserId($uid)) {
                        dba::delete('user', ['uid' => $uid]);
 
-                       throw new Exception(t('An error occurred creating your self contact. Please try again.'));
+                       throw new Exception(L10n::t('An error occurred creating your self contact. Please try again.'));
                }
 
                // Create a group with no members. This allows somebody to use it
                // right away as a default group for new contacts.
-               $def_gid = Group::create($uid, t('Friends'));
+               $def_gid = Group::create($uid, L10n::t('Friends'));
                if (!$def_gid) {
                        dba::delete('user', ['uid' => $uid]);
 
-                       throw new Exception(t('An error occurred creating your default contact group. Please try again.'));
+                       throw new Exception(L10n::t('An error occurred creating your default contact group. Please try again.'));
                }
 
                $fields = ['def_gid' => $def_gid];
@@ -390,7 +463,7 @@ class User
                        $photo = avatar_img($email);
                }
 
-               // unless there is no avatar-plugin loaded
+               // unless there is no avatar-addon loaded
                if (strlen($photo)) {
                        $photo_failure = false;
 
@@ -405,7 +478,7 @@ class User
 
                                $hash = photo_new_resource();
 
-                               $r = Photo::store($Image, $uid, 0, $hash, $filename, t('Profile Photos'), 4);
+                               $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 4);
 
                                if ($r === false) {
                                        $photo_failure = true;
@@ -413,7 +486,7 @@ class User
 
                                $Image->scaleDown(80);
 
-                               $r = Photo::store($Image, $uid, 0, $hash, $filename, t('Profile Photos'), 5);
+                               $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 5);
 
                                if ($r === false) {
                                        $photo_failure = true;
@@ -421,7 +494,7 @@ class User
 
                                $Image->scaleDown(48);
 
-                               $r = Photo::store($Image, $uid, 0, $hash, $filename, t('Profile Photos'), 6);
+                               $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 6);
 
                                if ($r === false) {
                                        $photo_failure = true;
@@ -433,7 +506,7 @@ class User
                        }
                }
 
-               call_hooks('register_account', $uid);
+               Addon::callHooks('register_account', $uid);
 
                $return['user'] = $user;
                return $return;
@@ -449,7 +522,7 @@ class User
         */
        public static function sendRegisterPendingEmail($email, $sitename, $username)
        {
-               $body = deindent(t('
+               $body = deindent(L10n::t('
                        Dear %1$s,
                                Thank you for registering at %2$s. Your account is pending for approval by the administrator.
                '));
@@ -459,7 +532,7 @@ class User
                return notification([
                        'type' => SYSTEM_EMAIL,
                        'to_email' => $email,
-                       'subject'=> sprintf( t('Registration at %s'), $sitename),
+                       'subject'=> L10n::t('Registration at %s', $sitename),
                        'body' => $body]);
        }
 
@@ -477,26 +550,26 @@ class User
         */
        public static function sendRegisterOpenEmail($email, $sitename, $siteurl, $username, $password)
        {
-               $preamble = deindent(t('
+               $preamble = deindent(L10n::t('
                        Dear %1$s,
                                Thank you for registering at %2$s. Your account has been created.
                '));
-               $body = deindent(t('
+               $body = deindent(L10n::t('
                        The login details are as follows:
                                Site Location:  %3$s
                                Login Name:     %1$s
                                Password:       %5$s
 
-                       You may change your password from your account "Settings" page after logging
+                       You may change your password from your account Settings page after logging
                        in.
 
                        Please take a few moments to review the other account settings on that page.
 
                        You may also wish to add some basic information to your default profile
-                       (on the "Profiles" page) so that other people can easily find you.
+                       ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
 
                        We recommend setting your full name, adding a profile photo,
-                       adding some profile "keywords" (very useful in making new friends) - and
+                       adding some profile keywords ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
                        perhaps what country you live in; if you do not wish to be more specific
                        than that.
 
@@ -513,7 +586,7 @@ class User
                return notification([
                        'type' => SYSTEM_EMAIL,
                        'to_email' => $email,
-                       'subject'=> sprintf( t('Registration details for %s'), $sitename),
+                       'subject'=> L10n::t('Registration details for %s', $sitename),
                        'preamble'=> $preamble,
                        'body' => $body]);
        }
@@ -532,7 +605,7 @@ class User
 
                $user = dba::selectFirst('user', [], ['uid' => $uid]);
 
-               call_hooks('remove_user', $user);
+               Addon::callHooks('remove_user', $user);
 
                // save username (actually the nickname as it is guaranteed
                // unique), so it cannot be re-registered in the future.