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 Returns the default group for a given user and network
71 * @param int $uid User id
72 * @param string $network network name
74 * @return int group id
76 public static function getDefaultGroup($uid, $network = '')
80 if ($network == NETWORK_OSTATUS) {
81 $default_group = PConfig::get($uid, "ostatus", "default_group");
84 if ($default_group != 0) {
85 return $default_group;
88 $user = dba::selectFirst('user', ['def_gid'], ['uid' => $uid]);
90 if (DBM::is_result($user)) {
91 $default_group = $user["def_gid"];
94 return $default_group;
99 * Authenticate a user with a clear text password
101 * @brief Authenticate a user with a clear text password
102 * @param mixed $user_info
103 * @param string $password
104 * @return int|boolean
105 * @deprecated since version 3.6
106 * @see User::getIdFromPasswordAuthentication()
108 public static function authenticate($user_info, $password)
111 return self::getIdFromPasswordAuthentication($user_info, $password);
112 } catch (Exception $ex) {
118 * Returns the user id associated with a successful password authentication
120 * @brief Authenticate a user with a clear text password
121 * @param mixed $user_info
122 * @param string $password
123 * @return int User Id if authentication is successful
126 public static function getIdFromPasswordAuthentication($user_info, $password)
128 $user = self::getAuthenticationInfo($user_info);
130 if (strpos($user['password'], '$') === false) {
131 //Legacy hash that has not been replaced by a new hash yet
132 if (self::hashPasswordLegacy($password) === $user['password']) {
133 self::updatePassword($user['uid'], $password);
137 } elseif (!empty($user['legacy_password'])) {
138 //Legacy hash that has been double-hashed and not replaced by a new hash yet
139 //Warning: `legacy_password` is not necessary in sync with the content of `password`
140 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
141 self::updatePassword($user['uid'], $password);
145 } elseif (password_verify($password, $user['password'])) {
147 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
148 self::updatePassword($user['uid'], $password);
154 throw new Exception(L10n::t('Login failed'));
158 * Returns authentication info from various parameters types
160 * User info can be any of the following:
163 * - User email or username or nickname
164 * - User array with at least the uid and the hashed password
166 * @param mixed $user_info
170 private static function getAuthenticationInfo($user_info)
174 if (is_object($user_info) || is_array($user_info)) {
175 if (is_object($user_info)) {
176 $user = (array) $user_info;
181 if (!isset($user['uid'])
182 || !isset($user['password'])
183 || !isset($user['legacy_password'])
185 throw new Exception(L10n::t('Not enough information to authenticate'));
187 } elseif (is_int($user_info) || is_string($user_info)) {
188 if (is_int($user_info)) {
189 $user = dba::selectFirst('user', ['uid', 'password', 'legacy_password'],
193 'account_expired' => 0,
194 'account_removed' => 0,
199 $user = dba::fetch_first('SELECT `uid`, `password`, `legacy_password`
201 WHERE (`email` = ? OR `username` = ? OR `nickname` = ?)
203 AND `account_expired` = 0
204 AND `account_removed` = 0
213 if (!DBM::is_result($user)) {
214 throw new Exception(L10n::t('User not found'));
222 * Generates a human-readable random password
226 public static function generateNewPassword()
228 return autoname(6) . mt_rand(100, 9999);
232 * Checks if the provided plaintext password has been exposed or not
234 * @param string $password
237 public static function isPasswordExposed($password)
239 return password_exposed($password) === PasswordStatus::EXPOSED;
243 * Legacy hashing function, kept for password migration purposes
245 * @param string $password
248 private static function hashPasswordLegacy($password)
250 return hash('whirlpool', $password);
254 * Global user password hashing function
256 * @param string $password
259 public static function hashPassword($password)
261 if (!trim($password)) {
262 throw new Exception(L10n::t('Password can\'t be empty'));
265 return password_hash($password, PASSWORD_DEFAULT);
269 * Updates a user row with a new plaintext password
272 * @param string $password
275 public static function updatePassword($uid, $password)
277 return self::updatePasswordHashed($uid, self::hashPassword($password));
281 * Updates a user row with a new hashed password.
282 * Empties the password reset token field just in case.
285 * @param string $pasword_hashed
288 private static function updatePasswordHashed($uid, $pasword_hashed)
291 'password' => $pasword_hashed,
293 'pwdreset_time' => null,
294 'legacy_password' => false
296 return dba::update('user', $fields, ['uid' => $uid]);
300 * @brief Catch-all user creation function
302 * Creates a user from the provided data array, either form fields or OpenID.
303 * Required: { username, nickname, email } or { openid_url }
305 * Performs the following:
306 * - Sends to the OpenId auth URL (if relevant)
307 * - Creates new key pairs for crypto
308 * - Create self-contact
309 * - Create profile image
315 public static function create(array $data)
318 $return = ['user' => null, 'password' => ''];
320 $using_invites = Config::get('system', 'invitation_only');
321 $num_invites = Config::get('system', 'number_invites');
323 $invite_id = x($data, 'invite_id') ? notags(trim($data['invite_id'])) : '';
324 $username = x($data, 'username') ? notags(trim($data['username'])) : '';
325 $nickname = x($data, 'nickname') ? notags(trim($data['nickname'])) : '';
326 $email = x($data, 'email') ? notags(trim($data['email'])) : '';
327 $openid_url = x($data, 'openid_url') ? notags(trim($data['openid_url'])) : '';
328 $photo = x($data, 'photo') ? notags(trim($data['photo'])) : '';
329 $password = x($data, 'password') ? trim($data['password']) : '';
330 $password1 = x($data, 'password1') ? trim($data['password1']) : '';
331 $confirm = x($data, 'confirm') ? trim($data['confirm']) : '';
332 $blocked = x($data, 'blocked') ? intval($data['blocked']) : 0;
333 $verified = x($data, 'verified') ? intval($data['verified']) : 0;
334 $language = x($data, 'language') ? notags(trim($data['language'])) : 'en';
336 $publish = x($data, 'profile_publish_reg') && intval($data['profile_publish_reg']) ? 1 : 0;
337 $netpublish = strlen(Config::get('system', 'directory')) ? $publish : 0;
339 if ($password1 != $confirm) {
340 throw new Exception(L10n::t('Passwords do not match. Password unchanged.'));
341 } elseif ($password1 != '') {
342 $password = $password1;
345 if ($using_invites) {
347 throw new Exception(L10n::t('An invitation is required.'));
350 if (!dba::exists('register', ['hash' => $invite_id])) {
351 throw new Exception(L10n::t('Invitation could not be verified.'));
355 if (!x($username) || !x($email) || !x($nickname)) {
357 if (!Network::isUrlValid($openid_url)) {
358 throw new Exception(L10n::t('Invalid OpenID url'));
360 $_SESSION['register'] = 1;
361 $_SESSION['openid'] = $openid_url;
363 $openid = new LightOpenID($a->get_hostname());
364 $openid->identity = $openid_url;
365 $openid->returnUrl = System::baseUrl() . '/openid';
366 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
367 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
369 $authurl = $openid->authUrl();
370 } catch (Exception $e) {
371 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);
377 throw new Exception(L10n::t('Please enter the required information.'));
380 if (!Network::isUrlValid($openid_url)) {
386 // collapse multiple spaces in name
387 $username = preg_replace('/ +/', ' ', $username);
389 if (mb_strlen($username) > 48) {
390 throw new Exception(L10n::t('Please use a shorter name.'));
392 if (mb_strlen($username) < 3) {
393 throw new Exception(L10n::t('Name too short.'));
396 // So now we are just looking for a space in the full name.
397 $loose_reg = Config::get('system', 'no_regfullname');
399 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
400 if (!strpos($username, ' ')) {
401 throw new Exception(L10n::t("That doesn't appear to be your full \x28First Last\x29 name."));
405 if (!Network::isEmailDomainAllowed($email)) {
406 throw new Exception(L10n::t('Your email domain is not among those allowed on this site.'));
409 if (!valid_email($email) || !Network::isEmailDomainValid($email)) {
410 throw new Exception(L10n::t('Not a valid email address.'));
413 if (Config::get('system', 'block_extended_register', false) && dba::exists('user', ['email' => $email])) {
414 throw new Exception(L10n::t('Cannot use that email.'));
417 // Disallow somebody creating an account using openid that uses the admin email address,
418 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
419 if (x($a->config, 'admin_email') && strlen($openid_url)) {
420 $adminlist = explode(',', str_replace(' ', '', strtolower($a->config['admin_email'])));
421 if (in_array(strtolower($email), $adminlist)) {
422 throw new Exception(L10n::t('Cannot use that email.'));
426 $nickname = $data['nickname'] = strtolower($nickname);
428 if (!preg_match('/^[a-z0-9][a-z0-9\_]*$/', $nickname)) {
429 throw new Exception(L10n::t('Your nickname can only contain a-z, 0-9 and _.'));
432 // Check existing and deleted accounts for this nickname.
433 if (dba::exists('user', ['nickname' => $nickname])
434 || dba::exists('userd', ['username' => $nickname])
436 throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
439 $new_password = strlen($password) ? $password : User::generateNewPassword();
440 $new_password_encoded = self::hashPassword($new_password);
442 $return['password'] = $new_password;
444 $keys = Crypto::newKeypair(4096);
445 if ($keys === false) {
446 throw new Exception(L10n::t('SERIOUS ERROR: Generation of security keys failed.'));
449 $prvkey = $keys['prvkey'];
450 $pubkey = $keys['pubkey'];
452 // Create another keypair for signing/verifying salmon protocol messages.
453 $sres = Crypto::newKeypair(512);
454 $sprvkey = $sres['prvkey'];
455 $spubkey = $sres['pubkey'];
457 $insert_result = dba::insert('user', [
458 'guid' => generate_user_guid(),
459 'username' => $username,
460 'password' => $new_password_encoded,
462 'openid' => $openid_url,
463 'nickname' => $nickname,
466 'spubkey' => $spubkey,
467 'sprvkey' => $sprvkey,
468 'verified' => $verified,
469 'blocked' => $blocked,
470 'language' => $language,
472 'register_date' => DateTimeFormat::utcNow(),
473 'default-location' => ''
476 if ($insert_result) {
477 $uid = dba::lastInsertId();
478 $user = dba::selectFirst('user', [], ['uid' => $uid]);
480 throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
484 throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
487 // if somebody clicked submit twice very quickly, they could end up with two accounts
488 // due to race condition. Remove this one.
489 $user_count = dba::count('user', ['nickname' => $nickname]);
490 if ($user_count > 1) {
491 dba::delete('user', ['uid' => $uid]);
493 throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
496 $insert_result = dba::insert('profile', [
499 'photo' => System::baseUrl() . "/photo/profile/{$uid}.jpg",
500 'thumb' => System::baseUrl() . "/photo/avatar/{$uid}.jpg",
501 'publish' => $publish,
503 'net-publish' => $netpublish,
504 'profile-name' => L10n::t('default')
506 if (!$insert_result) {
507 dba::delete('user', ['uid' => $uid]);
509 throw new Exception(L10n::t('An error occurred creating your default profile. Please try again.'));
512 // Create the self contact
513 if (!Contact::createSelfFromUserId($uid)) {
514 dba::delete('user', ['uid' => $uid]);
516 throw new Exception(L10n::t('An error occurred creating your self contact. Please try again.'));
519 // Create a group with no members. This allows somebody to use it
520 // right away as a default group for new contacts.
521 $def_gid = Group::create($uid, L10n::t('Friends'));
523 dba::delete('user', ['uid' => $uid]);
525 throw new Exception(L10n::t('An error occurred creating your default contact group. Please try again.'));
528 $fields = ['def_gid' => $def_gid];
529 if (Config::get('system', 'newuser_private') && $def_gid) {
530 $fields['allow_gid'] = '<' . $def_gid . '>';
533 dba::update('user', $fields, ['uid' => $uid]);
535 // if we have no OpenID photo try to look up an avatar
536 if (!strlen($photo)) {
537 $photo = Network::lookupAvatarByEmail($email);
540 // unless there is no avatar-addon loaded
541 if (strlen($photo)) {
542 $photo_failure = false;
544 $filename = basename($photo);
545 $img_str = Network::fetchUrl($photo, true);
546 // guess mimetype from headers or filename
547 $type = Image::guessType($photo, true);
549 $Image = new Image($img_str, $type);
550 if ($Image->isValid()) {
551 $Image->scaleToSquare(175);
553 $hash = Photo::newResource();
555 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 4);
558 $photo_failure = true;
561 $Image->scaleDown(80);
563 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 5);
566 $photo_failure = true;
569 $Image->scaleDown(48);
571 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 6);
574 $photo_failure = true;
577 if (!$photo_failure) {
578 dba::update('photo', ['profile' => 1], ['resource-id' => $hash]);
583 Addon::callHooks('register_account', $uid);
585 $return['user'] = $user;
590 * @brief Sends pending registration confiĆmation email
592 * @param string $email
593 * @param string $sitename
594 * @param string $username
595 * @return NULL|boolean from notification() and email() inherited
597 public static function sendRegisterPendingEmail($email, $sitename, $username)
599 $body = deindent(L10n::t('
601 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
604 $body = sprintf($body, $username, $sitename);
606 return notification([
607 'type' => SYSTEM_EMAIL,
608 'to_email' => $email,
609 'subject'=> L10n::t('Registration at %s', $sitename),
614 * @brief Sends registration confirmation
616 * It's here as a function because the mail is sent from different parts
618 * @param string $email
619 * @param string $sitename
620 * @param string $siteurl
621 * @param string $username
622 * @param string $password
623 * @return NULL|boolean from notification() and email() inherited
625 public static function sendRegisterOpenEmail($email, $sitename, $siteurl, $username, $password)
627 $preamble = deindent(L10n::t('
629 Thank you for registering at %2$s. Your account has been created.
631 $body = deindent(L10n::t('
632 The login details are as follows:
638 You may change your password from your account "Settings" page after logging
641 Please take a few moments to review the other account settings on that page.
643 You may also wish to add some basic information to your default profile
644 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
646 We recommend setting your full name, adding a profile photo,
647 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
648 perhaps what country you live in; if you do not wish to be more specific
651 We fully respect your right to privacy, and none of these items are necessary.
652 If you are new and do not know anybody here, they may help
653 you to make some new and interesting friends.
655 If you ever want to delete your account, you can do so at %3$s/removeme
657 Thank you and welcome to %2$s.'));
659 $preamble = sprintf($preamble, $username, $sitename);
660 $body = sprintf($body, $email, $sitename, $siteurl, $username, $password);
662 return notification([
663 'type' => SYSTEM_EMAIL,
664 'to_email' => $email,
665 'subject'=> L10n::t('Registration details for %s', $sitename),
666 'preamble'=> $preamble,
671 * @param object $uid user to remove
674 public static function remove($uid)
680 logger('Removing user: ' . $uid);
682 $user = dba::selectFirst('user', [], ['uid' => $uid]);
684 Addon::callHooks('remove_user', $user);
686 // save username (actually the nickname as it is guaranteed
687 // unique), so it cannot be re-registered in the future.
688 dba::insert('userd', ['username' => $user['nickname']]);
690 // The user and related data will be deleted in "cron_expire_and_remove_users" (cronjobs.php)
691 dba::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utcNow()], ['uid' => $uid]);
692 Worker::add(PRIORITY_HIGH, "Notifier", "removeme", $uid);
694 // Send an update to the directory
695 Worker::add(PRIORITY_LOW, "Directory", $user['url']);
697 if ($uid == local_user()) {
698 unset($_SESSION['authenticated']);
699 unset($_SESSION['uid']);
700 goaway(System::baseUrl());