3 * @file src/Model/User.php
4 * @brief This file includes the User class with user related database functions
6 namespace Friendica\Model;
8 use DivineOmega\PasswordExposed\PasswordStatus;
9 use Friendica\Core\Addon;
10 use Friendica\Core\Config;
11 use Friendica\Core\L10n;
12 use Friendica\Core\PConfig;
13 use Friendica\Core\System;
14 use Friendica\Core\Worker;
15 use Friendica\Database\DBM;
16 use Friendica\Model\Contact;
17 use Friendica\Model\Group;
18 use Friendica\Model\Photo;
19 use Friendica\Object\Image;
20 use Friendica\Util\Crypto;
21 use Friendica\Util\DateTimeFormat;
22 use Friendica\Util\Network;
26 use function password_exposed;
28 require_once 'boot.php';
29 require_once 'include/dba.php';
30 require_once 'include/enotify.php';
31 require_once 'include/text.php';
33 * @brief This class handles User related functions
38 * @brief Get owner data by user id
41 * @return boolean|array
43 public static function getOwnerDataById($uid) {
44 $r = dba::fetch_first("SELECT
46 `user`.`prvkey` AS `uprvkey`,
52 `user`.`account-type`,
56 ON `user`.`uid` = `contact`.`uid`
57 WHERE `contact`.`uid` = ?
62 if (!DBM::is_result($r)) {
69 * @brief Get owner data by nick name
72 * @return boolean|array
74 public static function getOwnerDataByNick($nick)
76 $user = dba::selectFirst('user', ['uid'], ['nickname' => $nick]);
77 if (!DBM::is_result($user)) {
80 return self::getOwnerDataById($user['uid']);
84 * @brief Returns the default group for a given user and network
86 * @param int $uid User id
87 * @param string $network network name
89 * @return int group id
91 public static function getDefaultGroup($uid, $network = '')
95 if ($network == NETWORK_OSTATUS) {
96 $default_group = PConfig::get($uid, "ostatus", "default_group");
99 if ($default_group != 0) {
100 return $default_group;
103 $user = dba::selectFirst('user', ['def_gid'], ['uid' => $uid]);
105 if (DBM::is_result($user)) {
106 $default_group = $user["def_gid"];
109 return $default_group;
114 * Authenticate a user with a clear text password
116 * @brief Authenticate a user with a clear text password
117 * @param mixed $user_info
118 * @param string $password
119 * @return int|boolean
120 * @deprecated since version 3.6
121 * @see User::getIdFromPasswordAuthentication()
123 public static function authenticate($user_info, $password)
126 return self::getIdFromPasswordAuthentication($user_info, $password);
127 } catch (Exception $ex) {
133 * Returns the user id associated with a successful password authentication
135 * @brief Authenticate a user with a clear text password
136 * @param mixed $user_info
137 * @param string $password
138 * @return int User Id if authentication is successful
141 public static function getIdFromPasswordAuthentication($user_info, $password)
143 $user = self::getAuthenticationInfo($user_info);
145 if (strpos($user['password'], '$') === false) {
146 //Legacy hash that has not been replaced by a new hash yet
147 if (self::hashPasswordLegacy($password) === $user['password']) {
148 self::updatePassword($user['uid'], $password);
152 } elseif (!empty($user['legacy_password'])) {
153 //Legacy hash that has been double-hashed and not replaced by a new hash yet
154 //Warning: `legacy_password` is not necessary in sync with the content of `password`
155 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
156 self::updatePassword($user['uid'], $password);
160 } elseif (password_verify($password, $user['password'])) {
162 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
163 self::updatePassword($user['uid'], $password);
169 throw new Exception(L10n::t('Login failed'));
173 * Returns authentication info from various parameters types
175 * User info can be any of the following:
178 * - User email or username or nickname
179 * - User array with at least the uid and the hashed password
181 * @param mixed $user_info
185 private static function getAuthenticationInfo($user_info)
189 if (is_object($user_info) || is_array($user_info)) {
190 if (is_object($user_info)) {
191 $user = (array) $user_info;
196 if (!isset($user['uid'])
197 || !isset($user['password'])
198 || !isset($user['legacy_password'])
200 throw new Exception(L10n::t('Not enough information to authenticate'));
202 } elseif (is_int($user_info) || is_string($user_info)) {
203 if (is_int($user_info)) {
204 $user = dba::selectFirst('user', ['uid', 'password', 'legacy_password'],
208 'account_expired' => 0,
209 'account_removed' => 0,
214 $user = dba::fetch_first('SELECT `uid`, `password`, `legacy_password`
216 WHERE (`email` = ? OR `username` = ? OR `nickname` = ?)
218 AND `account_expired` = 0
219 AND `account_removed` = 0
228 if (!DBM::is_result($user)) {
229 throw new Exception(L10n::t('User not found'));
237 * Generates a human-readable random password
241 public static function generateNewPassword()
243 return autoname(6) . mt_rand(100, 9999);
247 * Checks if the provided plaintext password has been exposed or not
249 * @param string $password
252 public static function isPasswordExposed($password)
254 return password_exposed($password) === PasswordStatus::EXPOSED;
258 * Legacy hashing function, kept for password migration purposes
260 * @param string $password
263 private static function hashPasswordLegacy($password)
265 return hash('whirlpool', $password);
269 * Global user password hashing function
271 * @param string $password
274 public static function hashPassword($password)
276 if (!trim($password)) {
277 throw new Exception(L10n::t('Password can\'t be empty'));
280 return password_hash($password, PASSWORD_DEFAULT);
284 * Updates a user row with a new plaintext password
287 * @param string $password
290 public static function updatePassword($uid, $password)
292 return self::updatePasswordHashed($uid, self::hashPassword($password));
296 * Updates a user row with a new hashed password.
297 * Empties the password reset token field just in case.
300 * @param string $pasword_hashed
303 private static function updatePasswordHashed($uid, $pasword_hashed)
306 'password' => $pasword_hashed,
308 'pwdreset_time' => null,
309 'legacy_password' => false
311 return dba::update('user', $fields, ['uid' => $uid]);
315 * @brief Catch-all user creation function
317 * Creates a user from the provided data array, either form fields or OpenID.
318 * Required: { username, nickname, email } or { openid_url }
320 * Performs the following:
321 * - Sends to the OpenId auth URL (if relevant)
322 * - Creates new key pairs for crypto
323 * - Create self-contact
324 * - Create profile image
330 public static function create(array $data)
333 $return = ['user' => null, 'password' => ''];
335 $using_invites = Config::get('system', 'invitation_only');
336 $num_invites = Config::get('system', 'number_invites');
338 $invite_id = x($data, 'invite_id') ? notags(trim($data['invite_id'])) : '';
339 $username = x($data, 'username') ? notags(trim($data['username'])) : '';
340 $nickname = x($data, 'nickname') ? notags(trim($data['nickname'])) : '';
341 $email = x($data, 'email') ? notags(trim($data['email'])) : '';
342 $openid_url = x($data, 'openid_url') ? notags(trim($data['openid_url'])) : '';
343 $photo = x($data, 'photo') ? notags(trim($data['photo'])) : '';
344 $password = x($data, 'password') ? trim($data['password']) : '';
345 $password1 = x($data, 'password1') ? trim($data['password1']) : '';
346 $confirm = x($data, 'confirm') ? trim($data['confirm']) : '';
347 $blocked = x($data, 'blocked') ? intval($data['blocked']) : 0;
348 $verified = x($data, 'verified') ? intval($data['verified']) : 0;
349 $language = x($data, 'language') ? notags(trim($data['language'])) : 'en';
351 $publish = x($data, 'profile_publish_reg') && intval($data['profile_publish_reg']) ? 1 : 0;
352 $netpublish = strlen(Config::get('system', 'directory')) ? $publish : 0;
354 if ($password1 != $confirm) {
355 throw new Exception(L10n::t('Passwords do not match. Password unchanged.'));
356 } elseif ($password1 != '') {
357 $password = $password1;
360 if ($using_invites) {
362 throw new Exception(L10n::t('An invitation is required.'));
365 if (!dba::exists('register', ['hash' => $invite_id])) {
366 throw new Exception(L10n::t('Invitation could not be verified.'));
370 if (!x($username) || !x($email) || !x($nickname)) {
372 if (!Network::isUrlValid($openid_url)) {
373 throw new Exception(L10n::t('Invalid OpenID url'));
375 $_SESSION['register'] = 1;
376 $_SESSION['openid'] = $openid_url;
378 $openid = new LightOpenID($a->get_hostname());
379 $openid->identity = $openid_url;
380 $openid->returnUrl = System::baseUrl() . '/openid';
381 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
382 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
384 $authurl = $openid->authUrl();
385 } catch (Exception $e) {
386 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);
392 throw new Exception(L10n::t('Please enter the required information.'));
395 if (!Network::isUrlValid($openid_url)) {
401 // collapse multiple spaces in name
402 $username = preg_replace('/ +/', ' ', $username);
404 if (mb_strlen($username) > 48) {
405 throw new Exception(L10n::t('Please use a shorter name.'));
407 if (mb_strlen($username) < 3) {
408 throw new Exception(L10n::t('Name too short.'));
411 // So now we are just looking for a space in the full name.
412 $loose_reg = Config::get('system', 'no_regfullname');
414 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
415 if (!strpos($username, ' ')) {
416 throw new Exception(L10n::t("That doesn't appear to be your full \x28First Last\x29 name."));
420 if (!Network::isEmailDomainAllowed($email)) {
421 throw new Exception(L10n::t('Your email domain is not among those allowed on this site.'));
424 if (!valid_email($email) || !Network::isEmailDomainValid($email)) {
425 throw new Exception(L10n::t('Not a valid email address.'));
428 if (Config::get('system', 'block_extended_register', false) && dba::exists('user', ['email' => $email])) {
429 throw new Exception(L10n::t('Cannot use that email.'));
432 // Disallow somebody creating an account using openid that uses the admin email address,
433 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
434 if (x($a->config, 'admin_email') && strlen($openid_url)) {
435 $adminlist = explode(',', str_replace(' ', '', strtolower($a->config['admin_email'])));
436 if (in_array(strtolower($email), $adminlist)) {
437 throw new Exception(L10n::t('Cannot use that email.'));
441 $nickname = $data['nickname'] = strtolower($nickname);
443 if (!preg_match('/^[a-z0-9][a-z0-9\_]*$/', $nickname)) {
444 throw new Exception(L10n::t('Your nickname can only contain a-z, 0-9 and _.'));
447 // Check existing and deleted accounts for this nickname.
448 if (dba::exists('user', ['nickname' => $nickname])
449 || dba::exists('userd', ['username' => $nickname])
451 throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
454 $new_password = strlen($password) ? $password : User::generateNewPassword();
455 $new_password_encoded = self::hashPassword($new_password);
457 $return['password'] = $new_password;
459 $keys = Crypto::newKeypair(4096);
460 if ($keys === false) {
461 throw new Exception(L10n::t('SERIOUS ERROR: Generation of security keys failed.'));
464 $prvkey = $keys['prvkey'];
465 $pubkey = $keys['pubkey'];
467 // Create another keypair for signing/verifying salmon protocol messages.
468 $sres = Crypto::newKeypair(512);
469 $sprvkey = $sres['prvkey'];
470 $spubkey = $sres['pubkey'];
472 $insert_result = dba::insert('user', [
473 'guid' => generate_user_guid(),
474 'username' => $username,
475 'password' => $new_password_encoded,
477 'openid' => $openid_url,
478 'nickname' => $nickname,
481 'spubkey' => $spubkey,
482 'sprvkey' => $sprvkey,
483 'verified' => $verified,
484 'blocked' => $blocked,
485 'language' => $language,
487 'register_date' => DateTimeFormat::utcNow(),
488 'default-location' => ''
491 if ($insert_result) {
492 $uid = dba::lastInsertId();
493 $user = dba::selectFirst('user', [], ['uid' => $uid]);
495 throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
499 throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
502 // if somebody clicked submit twice very quickly, they could end up with two accounts
503 // due to race condition. Remove this one.
504 $user_count = dba::count('user', ['nickname' => $nickname]);
505 if ($user_count > 1) {
506 dba::delete('user', ['uid' => $uid]);
508 throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
511 $insert_result = dba::insert('profile', [
514 'photo' => System::baseUrl() . "/photo/profile/{$uid}.jpg",
515 'thumb' => System::baseUrl() . "/photo/avatar/{$uid}.jpg",
516 'publish' => $publish,
518 'net-publish' => $netpublish,
519 'profile-name' => L10n::t('default')
521 if (!$insert_result) {
522 dba::delete('user', ['uid' => $uid]);
524 throw new Exception(L10n::t('An error occurred creating your default profile. Please try again.'));
527 // Create the self contact
528 if (!Contact::createSelfFromUserId($uid)) {
529 dba::delete('user', ['uid' => $uid]);
531 throw new Exception(L10n::t('An error occurred creating your self contact. Please try again.'));
534 // Create a group with no members. This allows somebody to use it
535 // right away as a default group for new contacts.
536 $def_gid = Group::create($uid, L10n::t('Friends'));
538 dba::delete('user', ['uid' => $uid]);
540 throw new Exception(L10n::t('An error occurred creating your default contact group. Please try again.'));
543 $fields = ['def_gid' => $def_gid];
544 if (Config::get('system', 'newuser_private') && $def_gid) {
545 $fields['allow_gid'] = '<' . $def_gid . '>';
548 dba::update('user', $fields, ['uid' => $uid]);
550 // if we have no OpenID photo try to look up an avatar
551 if (!strlen($photo)) {
552 $photo = Network::lookupAvatarByEmail($email);
555 // unless there is no avatar-addon loaded
556 if (strlen($photo)) {
557 $photo_failure = false;
559 $filename = basename($photo);
560 $img_str = Network::fetchUrl($photo, true);
561 // guess mimetype from headers or filename
562 $type = Image::guessType($photo, true);
564 $Image = new Image($img_str, $type);
565 if ($Image->isValid()) {
566 $Image->scaleToSquare(175);
568 $hash = Photo::newResource();
570 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 4);
573 $photo_failure = true;
576 $Image->scaleDown(80);
578 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 5);
581 $photo_failure = true;
584 $Image->scaleDown(48);
586 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 6);
589 $photo_failure = true;
592 if (!$photo_failure) {
593 dba::update('photo', ['profile' => 1], ['resource-id' => $hash]);
598 Addon::callHooks('register_account', $uid);
600 $return['user'] = $user;
605 * @brief Sends pending registration confiĆmation email
607 * @param string $email
608 * @param string $sitename
609 * @param string $username
610 * @return NULL|boolean from notification() and email() inherited
612 public static function sendRegisterPendingEmail($email, $sitename, $username)
614 $body = deindent(L10n::t('
616 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
619 $body = sprintf($body, $username, $sitename);
621 return notification([
622 'type' => SYSTEM_EMAIL,
623 'to_email' => $email,
624 'subject'=> L10n::t('Registration at %s', $sitename),
629 * @brief Sends registration confirmation
631 * It's here as a function because the mail is sent from different parts
633 * @param string $email
634 * @param string $sitename
635 * @param string $siteurl
636 * @param string $username
637 * @param string $password
638 * @return NULL|boolean from notification() and email() inherited
640 public static function sendRegisterOpenEmail($email, $sitename, $siteurl, $username, $password)
642 $preamble = deindent(L10n::t('
644 Thank you for registering at %2$s. Your account has been created.
646 $body = deindent(L10n::t('
647 The login details are as follows:
653 You may change your password from your account "Settings" page after logging
656 Please take a few moments to review the other account settings on that page.
658 You may also wish to add some basic information to your default profile
659 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
661 We recommend setting your full name, adding a profile photo,
662 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
663 perhaps what country you live in; if you do not wish to be more specific
666 We fully respect your right to privacy, and none of these items are necessary.
667 If you are new and do not know anybody here, they may help
668 you to make some new and interesting friends.
670 If you ever want to delete your account, you can do so at %3$s/removeme
672 Thank you and welcome to %2$s.'));
674 $preamble = sprintf($preamble, $username, $sitename);
675 $body = sprintf($body, $email, $sitename, $siteurl, $username, $password);
677 return notification([
678 'type' => SYSTEM_EMAIL,
679 'to_email' => $email,
680 'subject'=> L10n::t('Registration details for %s', $sitename),
681 'preamble'=> $preamble,
686 * @param object $uid user to remove
689 public static function remove($uid)
695 logger('Removing user: ' . $uid);
697 $user = dba::selectFirst('user', [], ['uid' => $uid]);
699 Addon::callHooks('remove_user', $user);
701 // save username (actually the nickname as it is guaranteed
702 // unique), so it cannot be re-registered in the future.
703 dba::insert('userd', ['username' => $user['nickname']]);
705 // The user and related data will be deleted in "cron_expire_and_remove_users" (cronjobs.php)
706 dba::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utcNow()], ['uid' => $uid]);
707 Worker::add(PRIORITY_HIGH, "Notifier", "removeme", $uid);
709 // Send an update to the directory
710 Worker::add(PRIORITY_LOW, "Directory", $user['url']);
712 if ($uid == local_user()) {
713 unset($_SESSION['authenticated']);
714 unset($_SESSION['uid']);
715 goaway(System::baseUrl());