]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/User.php
Sets maximum to 64 for username_min/max_length config keys
[friendica.git] / src / Model / User.php
index 2621897f4eb87084a97040bba458d7c8f1078560..bca3e73f5dd6d898588f48dde020c6dd1d49f4ea 100644 (file)
@@ -5,25 +5,21 @@
  */
 namespace Friendica\Model;
 
-use DivineOmega\PasswordExposed\PasswordStatus;
+use DivineOmega\PasswordExposed;
+use Exception;
 use Friendica\Core\Addon;
 use Friendica\Core\Config;
 use Friendica\Core\L10n;
 use Friendica\Core\PConfig;
+use Friendica\Core\Protocol;
 use Friendica\Core\System;
 use Friendica\Core\Worker;
-use Friendica\Database\DBM;
-use Friendica\Model\Contact;
-use Friendica\Model\Group;
-use Friendica\Model\Photo;
+use Friendica\Database\DBA;
 use Friendica\Object\Image;
 use Friendica\Util\Crypto;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Network;
-use dba;
-use Exception;
 use LightOpenID;
-use function password_exposed;
 
 require_once 'boot.php';
 require_once 'include/dba.php';
@@ -34,6 +30,43 @@ require_once 'include/text.php';
  */
 class User
 {
+       /**
+        * Returns true if a user record exists with the provided id
+        *
+        * @param  integer $uid
+        * @return boolean
+        */
+       public static function exists($uid)
+       {
+               return DBA::exists('user', ['uid' => $uid]);
+       }
+
+       /**
+        * @param  integer       $uid
+        * @return array|boolean User record if it exists, false otherwise
+        */
+       public static function getById($uid)
+       {
+               return DBA::selectFirst('user', [], ['uid' => $uid]);
+       }
+
+       /**
+        * @brief Returns the user id of a given profile URL
+        *
+        * @param string $url
+        *
+        * @return integer user id
+        */
+       public static function getIdForURL($url)
+       {
+               $self = DBA::selectFirst('contact', ['uid'], ['nurl' => normalise_link($url), 'self' => true]);
+               if (!DBA::isResult($self)) {
+                       return false;
+               } else {
+                       return $self['uid'];
+               }
+       }
+
        /**
         * @brief Get owner data by user id
         *
@@ -41,7 +74,7 @@ class User
         * @return boolean|array
         */
        public static function getOwnerDataById($uid) {
-               $r = dba::fetch_first("SELECT
+               $r = DBA::fetchFirst("SELECT
                        `contact`.*,
                        `user`.`prvkey` AS `uprvkey`,
                        `user`.`timezone`,
@@ -59,12 +92,29 @@ class User
                        LIMIT 1",
                        $uid
                );
-               if (!DBM::is_result($r)) {
+               if (!DBA::isResult($r)) {
                        return false;
                }
                return $r;
        }
 
+       /**
+        * @brief Get owner data by nick name
+        *
+        * @param int $nick
+        * @return boolean|array
+        */
+       public static function getOwnerDataByNick($nick)
+       {
+               $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
+
+               if (!DBA::isResult($user)) {
+                       return false;
+               }
+
+               return self::getOwnerDataById($user['uid']);
+       }
+
        /**
         * @brief Returns the default group for a given user and network
         *
@@ -77,7 +127,7 @@ class User
        {
                $default_group = 0;
 
-               if ($network == NETWORK_OSTATUS) {
+               if ($network == Protocol::OSTATUS) {
                        $default_group = PConfig::get($uid, "ostatus", "default_group");
                }
 
@@ -85,9 +135,9 @@ class User
                        return $default_group;
                }
 
-               $user = dba::selectFirst('user', ['def_gid'], ['uid' => $uid]);
+               $user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
 
-               if (DBM::is_result($user)) {
+               if (DBA::isResult($user)) {
                        $default_group = $user["def_gid"];
                }
 
@@ -186,7 +236,7 @@ class User
                        }
                } elseif (is_int($user_info) || is_string($user_info)) {
                        if (is_int($user_info)) {
-                               $user = dba::selectFirst('user', ['uid', 'password', 'legacy_password'],
+                               $user = DBA::selectFirst('user', ['uid', 'password', 'legacy_password'],
                                        [
                                                'uid' => $user_info,
                                                'blocked' => 0,
@@ -196,21 +246,14 @@ class User
                                        ]
                                );
                        } else {
-                               $user = dba::fetch_first('SELECT `uid`, `password`, `legacy_password`
-                                       FROM `user`
-                                       WHERE (`email` = ? OR `username` = ? OR `nickname` = ?)
-                                       AND `blocked` = 0
-                                       AND `account_expired` = 0
-                                       AND `account_removed` = 0
-                                       AND `verified` = 1
-                                       LIMIT 1',
-                                       $user_info,
-                                       $user_info,
-                                       $user_info
-                               );
+                               $fields = ['uid', 'password', 'legacy_password'];
+                               $condition = ["(`email` = ? OR `username` = ? OR `nickname` = ?)
+                                       AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
+                                       $user_info, $user_info, $user_info];
+                               $user = DBA::selectFirst('user', $fields, $condition);
                        }
 
-                       if (!DBM::is_result($user)) {
+                       if (!DBA::isResult($user)) {
                                throw new Exception(L10n::t('User not found'));
                        }
                }
@@ -236,7 +279,14 @@ class User
         */
        public static function isPasswordExposed($password)
        {
-               return password_exposed($password) === PasswordStatus::EXPOSED;
+               $cache = new \DivineOmega\DOFileCachePSR6\CacheItemPool();
+               $cache->changeConfig([
+                       'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
+               ]);
+
+               $PasswordExposedCHecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
+
+               return $PasswordExposedCHecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
        }
 
        /**
@@ -258,6 +308,10 @@ class User
         */
        public static function hashPassword($password)
        {
+               if (!trim($password)) {
+                       throw new Exception(L10n::t('Password can\'t be empty'));
+               }
+
                return password_hash($password, PASSWORD_DEFAULT);
        }
 
@@ -289,7 +343,37 @@ class User
                        'pwdreset_time' => null,
                        'legacy_password' => false
                ];
-               return dba::update('user', $fields, ['uid' => $uid]);
+               return DBA::update('user', $fields, ['uid' => $uid]);
+       }
+
+       /**
+        * @brief Checks if a nickname is in the list of the forbidden nicknames
+        *
+        * Check if a nickname is forbidden from registration on the node by the
+        * admin. Forbidden nicknames (e.g. role namess) can be configured in the
+        * admin panel.
+        *
+        * @param string $nickname The nickname that should be checked
+        * @return boolean True is the nickname is blocked on the node
+        */
+       public static function isNicknameBlocked($nickname)
+       {
+               $forbidden_nicknames = Config::get('system', 'forbidden_nicknames', '');
+
+               // if the config variable is empty return false
+               if (empty($forbidden_nicknames)) {
+                       return false;
+               }
+
+               // check if the nickname is in the list of blocked nicknames
+               $forbidden = explode(',', $forbidden_nicknames);
+               $forbidden = array_map('trim', $forbidden);
+               if (in_array(strtolower($nickname), $forbidden)) {
+                       return true;
+               }
+
+               // else return false
+               return false;
        }
 
        /**
@@ -316,19 +400,20 @@ class User
                $using_invites = Config::get('system', 'invitation_only');
                $num_invites   = Config::get('system', 'number_invites');
 
-               $invite_id  = x($data, 'invite_id')  ? notags(trim($data['invite_id']))  : '';
-               $username   = x($data, 'username')   ? notags(trim($data['username']))   : '';
-               $nickname   = x($data, 'nickname')   ? notags(trim($data['nickname']))   : '';
-               $email      = x($data, 'email')      ? notags(trim($data['email']))      : '';
-               $openid_url = x($data, 'openid_url') ? notags(trim($data['openid_url'])) : '';
-               $photo      = x($data, 'photo')      ? notags(trim($data['photo']))      : '';
-               $password   = x($data, 'password')   ? trim($data['password'])           : '';
-               $password1  = x($data, 'password1')  ? trim($data['password1'])          : '';
-               $confirm    = x($data, 'confirm')    ? trim($data['confirm'])            : '';
-               $blocked    = x($data, 'blocked')    ? intval($data['blocked'])          : 0;
-               $verified   = x($data, 'verified')   ? intval($data['verified'])         : 0;
-
-               $publish = x($data, 'profile_publish_reg') && intval($data['profile_publish_reg']) ? 1 : 0;
+               $invite_id  = !empty($data['invite_id'])  ? notags(trim($data['invite_id']))  : '';
+               $username   = !empty($data['username'])   ? notags(trim($data['username']))   : '';
+               $nickname   = !empty($data['nickname'])   ? notags(trim($data['nickname']))   : '';
+               $email      = !empty($data['email'])      ? notags(trim($data['email']))      : '';
+               $openid_url = !empty($data['openid_url']) ? notags(trim($data['openid_url'])) : '';
+               $photo      = !empty($data['photo'])      ? notags(trim($data['photo']))      : '';
+               $password   = !empty($data['password'])   ? trim($data['password'])           : '';
+               $password1  = !empty($data['password1'])  ? trim($data['password1'])          : '';
+               $confirm    = !empty($data['confirm'])    ? trim($data['confirm'])            : '';
+               $blocked    = !empty($data['blocked'])    ? intval($data['blocked'])          : 0;
+               $verified   = !empty($data['verified'])   ? intval($data['verified'])         : 0;
+               $language   = !empty($data['language'])   ? notags(trim($data['language']))   : 'en';
+
+               $publish = !empty($data['profile_publish_reg']) && intval($data['profile_publish_reg']) ? 1 : 0;
                $netpublish = strlen(Config::get('system', 'directory')) ? $publish : 0;
 
                if ($password1 != $confirm) {
@@ -342,12 +427,12 @@ class User
                                throw new Exception(L10n::t('An invitation is required.'));
                        }
 
-                       if (!dba::exists('register', ['hash' => $invite_id])) {
+                       if (!Register::existsByHash($invite_id)) {
                                throw new Exception(L10n::t('Invitation could not be verified.'));
                        }
                }
 
-               if (!x($username) || !x($email) || !x($nickname)) {
+               if (empty($username) || empty($email) || empty($nickname)) {
                        if ($openid_url) {
                                if (!Network::isUrlValid($openid_url)) {
                                        throw new Exception(L10n::t('Invalid OpenID url'));
@@ -355,7 +440,7 @@ class User
                                $_SESSION['register'] = 1;
                                $_SESSION['openid'] = $openid_url;
 
-                               $openid = new LightOpenID;
+                               $openid = new LightOpenID($a->getHostName());
                                $openid->identity = $openid_url;
                                $openid->returnUrl = System::baseUrl() . '/openid';
                                $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
@@ -381,19 +466,30 @@ class User
                // collapse multiple spaces in name
                $username = preg_replace('/ +/', ' ', $username);
 
-               if (mb_strlen($username) > 48) {
-                       throw new Exception(L10n::t('Please use a shorter name.'));
+               $username_min_length = max(1, min(64, intval(Config::get('system', 'username_min_length', 3))));
+               $username_max_length = max(1, min(64, intval(Config::get('system', 'username_max_length', 48))));
+
+               if ($username_min_length > $username_max_length) {
+                       logger(L10n::t('system.username_min_length (%s) and system.username_max_length (%s) are excluding each other, swapping values.', $username_min_length, $username_max_length), LOGGER_WARNING);
+                       $tmp = $username_min_length;
+                       $username_min_length = $username_max_length;
+                       $username_max_length = $tmp;
+               }
+
+               if (mb_strlen($username) < $username_min_length) {
+                       throw new Exception(L10n::tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
                }
-               if (mb_strlen($username) < 3) {
-                       throw new Exception(L10n::t('Name too short.'));
+
+               if (mb_strlen($username) > $username_max_length) {
+                       throw new Exception(L10n::tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
                }
 
                // So now we are just looking for a space in the full name.
                $loose_reg = Config::get('system', 'no_regfullname');
                if (!$loose_reg) {
                        $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
-                       if (!strpos($username, ' ')) {
-                               throw new Exception(L10n::t("That doesn't appear to be your full \x28First Last\x29 name."));
+                       if (strpos($username, ' ') === false) {
+                               throw new Exception(L10n::t("That doesn't appear to be your full (First Last) name."));
                        }
                }
 
@@ -404,15 +500,18 @@ class User
                if (!valid_email($email) || !Network::isEmailDomainValid($email)) {
                        throw new Exception(L10n::t('Not a valid email address.'));
                }
+               if (self::isNicknameBlocked($nickname)) {
+                       throw new Exception(L10n::t('The nickname was blocked from registration by the nodes admin.'));
+               }
 
-               if (Config::get('system', 'block_extended_register', false) && dba::exists('user', ['email' => $email])) {
+               if (Config::get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
                        throw new Exception(L10n::t('Cannot use that email.'));
                }
 
                // Disallow somebody creating an account using openid that uses the admin email address,
                // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
-               if (x($a->config, 'admin_email') && strlen($openid_url)) {
-                       $adminlist = explode(',', str_replace(' ', '', strtolower($a->config['admin_email'])));
+               if (Config::get('config', 'admin_email') && strlen($openid_url)) {
+                       $adminlist = explode(',', str_replace(' ', '', strtolower(Config::get('config', 'admin_email'))));
                        if (in_array(strtolower($email), $adminlist)) {
                                throw new Exception(L10n::t('Cannot use that email.'));
                        }
@@ -425,8 +524,8 @@ class User
                }
 
                // Check existing and deleted accounts for this nickname.
-               if (dba::exists('user', ['nickname' => $nickname])
-                       || dba::exists('userd', ['username' => $nickname])
+               if (DBA::exists('user', ['nickname' => $nickname])
+                       || DBA::exists('userd', ['username' => $nickname])
                ) {
                        throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
                }
@@ -449,8 +548,8 @@ class User
                $sprvkey = $sres['prvkey'];
                $spubkey = $sres['pubkey'];
 
-               $insert_result = dba::insert('user', [
-                       'guid'     => generate_user_guid(),
+               $insert_result = DBA::insert('user', [
+                       'guid'     => System::createUUID(),
                        'username' => $username,
                        'password' => $new_password_encoded,
                        'email'    => $email,
@@ -462,14 +561,15 @@ class User
                        'sprvkey'  => $sprvkey,
                        'verified' => $verified,
                        'blocked'  => $blocked,
+                       'language' => $language,
                        'timezone' => 'UTC',
                        'register_date' => DateTimeFormat::utcNow(),
                        'default-location' => ''
                ]);
 
                if ($insert_result) {
-                       $uid = dba::lastInsertId();
-                       $user = dba::selectFirst('user', [], ['uid' => $uid]);
+                       $uid = DBA::lastInsertId();
+                       $user = DBA::selectFirst('user', [], ['uid' => $uid]);
                } else {
                        throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
                }
@@ -480,14 +580,14 @@ class User
 
                // if somebody clicked submit twice very quickly, they could end up with two accounts
                // due to race condition. Remove this one.
-               $user_count = dba::count('user', ['nickname' => $nickname]);
+               $user_count = DBA::count('user', ['nickname' => $nickname]);
                if ($user_count > 1) {
-                       dba::delete('user', ['uid' => $uid]);
+                       DBA::delete('user', ['uid' => $uid]);
 
                        throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
                }
 
-               $insert_result = dba::insert('profile', [
+               $insert_result = DBA::insert('profile', [
                        'uid' => $uid,
                        'name' => $username,
                        'photo' => System::baseUrl() . "/photo/profile/{$uid}.jpg",
@@ -498,14 +598,14 @@ class User
                        'profile-name' => L10n::t('default')
                ]);
                if (!$insert_result) {
-                       dba::delete('user', ['uid' => $uid]);
+                       DBA::delete('user', ['uid' => $uid]);
 
                        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]);
+                       DBA::delete('user', ['uid' => $uid]);
 
                        throw new Exception(L10n::t('An error occurred creating your self contact. Please try again.'));
                }
@@ -514,7 +614,7 @@ class User
                // right away as a default group for new contacts.
                $def_gid = Group::create($uid, L10n::t('Friends'));
                if (!$def_gid) {
-                       dba::delete('user', ['uid' => $uid]);
+                       DBA::delete('user', ['uid' => $uid]);
 
                        throw new Exception(L10n::t('An error occurred creating your default contact group. Please try again.'));
                }
@@ -524,7 +624,7 @@ class User
                        $fields['allow_gid'] = '<' . $def_gid . '>';
                }
 
-               dba::update('user', $fields, ['uid' => $uid]);
+               DBA::update('user', $fields, ['uid' => $uid]);
 
                // if we have no OpenID photo try to look up an avatar
                if (!strlen($photo)) {
@@ -569,7 +669,7 @@ class User
                                }
 
                                if (!$photo_failure) {
-                                       dba::update('photo', ['profile' => 1], ['resource-id' => $hash]);
+                                       DBA::update('photo', ['profile' => 1], ['resource-id' => $hash]);
                                }
                        }
                }
@@ -581,27 +681,36 @@ class User
        }
 
        /**
-        * @brief Sends pending registration confiŕmation email
+        * @brief Sends pending registration confirmation email
         *
-        * @param string $email
+        * @param array  $user     User record array
         * @param string $sitename
-        * @param string $username
+        * @param string $siteurl
+        * @param string $password Plaintext password
         * @return NULL|boolean from notification() and email() inherited
         */
-       public static function sendRegisterPendingEmail($email, $sitename, $username)
+       public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
        {
                $body = deindent(L10n::t('
                        Dear %1$s,
                                Thank you for registering at %2$s. Your account is pending for approval by the administrator.
-               '));
 
-               $body = sprintf($body, $username, $sitename);
+                       Your login details are as follows:
+
+                       Site Location:  %3$s
+                       Login Name:             %4$s
+                       Password:               %5$s
+               ',
+                       $user['username'], $sitename, $siteurl, $user['nickname'], $password
+               ));
 
                return notification([
-                       'type' => SYSTEM_EMAIL,
-                       'to_email' => $email,
-                       'subject'=> L10n::t('Registration at %s', $sitename),
-                       'body' => $body]);
+                       'type'     => SYSTEM_EMAIL,
+                       'uid'      => $user['uid'],
+                       'to_email' => $user['email'],
+                       'subject'  => L10n::t('Registration at %s', $sitename),
+                       'body'     => $body
+               ]);
        }
 
        /**
@@ -609,19 +718,20 @@ class User
         *
         * It's here as a function because the mail is sent from different parts
         *
-        * @param string $email
+        * @param array  $user     User record array
         * @param string $sitename
         * @param string $siteurl
-        * @param string $username
-        * @param string $password
+        * @param string $password Plaintext password
         * @return NULL|boolean from notification() and email() inherited
         */
-       public static function sendRegisterOpenEmail($email, $sitename, $siteurl, $username, $password)
+       public static function sendRegisterOpenEmail($user, $sitename, $siteurl, $password)
        {
                $preamble = deindent(L10n::t('
                        Dear %1$s,
                                Thank you for registering at %2$s. Your account has been created.
-               '));
+               ',
+                       $preamble, $user['username'], $sitename
+               ));
                $body = deindent(L10n::t('
                        The login details are as follows:
 
@@ -648,17 +758,19 @@ class User
 
                        If you ever want to delete your account, you can do so at %3$s/removeme
 
-                       Thank you and welcome to %2$s.'));
-
-               $preamble = sprintf($preamble, $username, $sitename);
-               $body = sprintf($body, $email, $sitename, $siteurl, $username, $password);
+                       Thank you and welcome to %2$s.',
+                       $user['email'], $sitename, $siteurl, $user['username'], $password
+               ));
 
                return notification([
-                       'type' => SYSTEM_EMAIL,
-                       'to_email' => $email,
-                       'subject'=> L10n::t('Registration details for %s', $sitename),
-                       'preamble'=> $preamble,
-                       'body' => $body]);
+                       'uid'      => $user['uid'],
+                       'language' => $user['language'],
+                       'type'     => SYSTEM_EMAIL,
+                       'to_email' => $user['email'],
+                       'subject'  => L10n::t('Registration details for %s', $sitename),
+                       'preamble' => $preamble,
+                       'body'     => $body
+               ]);
        }
 
        /**
@@ -673,25 +785,29 @@ class User
 
                logger('Removing user: ' . $uid);
 
-               $user = dba::selectFirst('user', [], ['uid' => $uid]);
+               $user = DBA::selectFirst('user', [], ['uid' => $uid]);
 
                Addon::callHooks('remove_user', $user);
 
                // save username (actually the nickname as it is guaranteed
                // unique), so it cannot be re-registered in the future.
-               dba::insert('userd', ['username' => $user['nickname']]);
+               DBA::insert('userd', ['username' => $user['nickname']]);
 
                // The user and related data will be deleted in "cron_expire_and_remove_users" (cronjobs.php)
-               dba::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utcNow()], ['uid' => $uid]);
+               DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc(DateTimeFormat::utcNow() . " + 7 day")], ['uid' => $uid]);
                Worker::add(PRIORITY_HIGH, "Notifier", "removeme", $uid);
 
                // Send an update to the directory
-               Worker::add(PRIORITY_LOW, "Directory", $user['url']);
+               $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
+               Worker::add(PRIORITY_LOW, "Directory", $self['url']);
+
+               // Remove the user relevant data
+               Worker::add(PRIORITY_LOW, "RemoveUser", $uid);
 
                if ($uid == local_user()) {
                        unset($_SESSION['authenticated']);
                        unset($_SESSION['uid']);
-                       goaway(System::baseUrl());
+                       goaway();;
                }
        }
 }