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 (password_verify($password, $user['password'])) {
131 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
132 self::updatePassword($user['uid'], $password);
136 } elseif (strpos($user['password'], '$') === false) {
137 if (self::hashPasswordLegacy($password) === $user['password']) {
138 self::updatePassword($user['uid'], $password);
144 throw new Exception(L10n::t('Login failed'));
148 * Returns authentication info from various parameters types
150 * User info can be any of the following:
153 * - User email or username or nickname
154 * - User array with at least the uid and the hashed password
156 * @param mixed $user_info
160 private static function getAuthenticationInfo($user_info)
164 if (is_object($user_info) || is_array($user_info)) {
165 if (is_object($user_info)) {
166 $user = (array) $user_info;
171 if (!isset($user['uid'])
172 || !isset($user['password'])
174 throw new Exception(L10n::t('Not enough information to authenticate'));
176 } elseif (is_int($user_info) || is_string($user_info)) {
177 if (is_int($user_info)) {
178 $user = dba::selectFirst('user', ['uid', 'password'],
182 'account_expired' => 0,
183 'account_removed' => 0,
188 $user = dba::fetch_first('SELECT `uid`, `password`
190 WHERE (`email` = ? OR `username` = ? OR `nickname` = ?)
192 AND `account_expired` = 0
193 AND `account_removed` = 0
202 if (!DBM::is_result($user)) {
203 throw new Exception(L10n::t('User not found'));
211 * Generates a human-readable random password
215 public static function generateNewPassword()
217 return autoname(6) . mt_rand(100, 9999);
221 * Checks if the provided plaintext password has been exposed or not
223 * @param string $password
226 public static function isPasswordExposed($password)
228 return password_exposed($password) === PasswordStatus::EXPOSED;
232 * Legacy hashing function, kept for password migration purposes
234 * @param string $password
237 private static function hashPasswordLegacy($password)
239 return hash('whirlpool', $password);
243 * Global user password hashing function
245 * @param string $password
248 public static function hashPassword($password)
250 return password_hash($password, PASSWORD_DEFAULT);
254 * Updates a user row with a new plaintext password
257 * @param string $password
260 public static function updatePassword($uid, $password)
262 return self::updatePasswordHashed($uid, self::hashPassword($password));
266 * Updates a user row with a new hashed password.
267 * Empties the password reset token field just in case.
270 * @param string $pasword_hashed
273 private static function updatePasswordHashed($uid, $pasword_hashed)
276 'password' => $pasword_hashed,
278 'pwdreset_time' => null,
280 return dba::update('user', $fields, ['uid' => $uid]);
284 * @brief Catch-all user creation function
286 * Creates a user from the provided data array, either form fields or OpenID.
287 * Required: { username, nickname, email } or { openid_url }
289 * Performs the following:
290 * - Sends to the OpenId auth URL (if relevant)
291 * - Creates new key pairs for crypto
292 * - Create self-contact
293 * - Create profile image
299 public static function create(array $data)
302 $return = ['user' => null, 'password' => ''];
304 $using_invites = Config::get('system', 'invitation_only');
305 $num_invites = Config::get('system', 'number_invites');
307 $invite_id = x($data, 'invite_id') ? notags(trim($data['invite_id'])) : '';
308 $username = x($data, 'username') ? notags(trim($data['username'])) : '';
309 $nickname = x($data, 'nickname') ? notags(trim($data['nickname'])) : '';
310 $email = x($data, 'email') ? notags(trim($data['email'])) : '';
311 $openid_url = x($data, 'openid_url') ? notags(trim($data['openid_url'])) : '';
312 $photo = x($data, 'photo') ? notags(trim($data['photo'])) : '';
313 $password = x($data, 'password') ? trim($data['password']) : '';
314 $password1 = x($data, 'password1') ? trim($data['password1']) : '';
315 $confirm = x($data, 'confirm') ? trim($data['confirm']) : '';
316 $blocked = x($data, 'blocked') ? intval($data['blocked']) : 0;
317 $verified = x($data, 'verified') ? intval($data['verified']) : 0;
319 $publish = x($data, 'profile_publish_reg') && intval($data['profile_publish_reg']) ? 1 : 0;
320 $netpublish = strlen(Config::get('system', 'directory')) ? $publish : 0;
322 if ($password1 != $confirm) {
323 throw new Exception(L10n::t('Passwords do not match. Password unchanged.'));
324 } elseif ($password1 != '') {
325 $password = $password1;
328 if ($using_invites) {
330 throw new Exception(L10n::t('An invitation is required.'));
333 if (!dba::exists('register', ['hash' => $invite_id])) {
334 throw new Exception(L10n::t('Invitation could not be verified.'));
338 if (!x($username) || !x($email) || !x($nickname)) {
340 if (!Network::isUrlValid($openid_url)) {
341 throw new Exception(L10n::t('Invalid OpenID url'));
343 $_SESSION['register'] = 1;
344 $_SESSION['openid'] = $openid_url;
346 $openid = new LightOpenID;
347 $openid->identity = $openid_url;
348 $openid->returnUrl = System::baseUrl() . '/openid';
349 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
350 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
352 $authurl = $openid->authUrl();
353 } catch (Exception $e) {
354 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);
360 throw new Exception(L10n::t('Please enter the required information.'));
363 if (!Network::isUrlValid($openid_url)) {
369 // collapse multiple spaces in name
370 $username = preg_replace('/ +/', ' ', $username);
372 if (mb_strlen($username) > 48) {
373 throw new Exception(L10n::t('Please use a shorter name.'));
375 if (mb_strlen($username) < 3) {
376 throw new Exception(L10n::t('Name too short.'));
379 // So now we are just looking for a space in the full name.
380 $loose_reg = Config::get('system', 'no_regfullname');
382 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
383 if (!strpos($username, ' ')) {
384 throw new Exception(L10n::t("That doesn't appear to be your full \x28First Last\x29 name."));
388 if (!Network::isEmailDomainAllowed($email)) {
389 throw new Exception(L10n::t('Your email domain is not among those allowed on this site.'));
392 if (!valid_email($email) || !Network::isEmailDomainValid($email)) {
393 throw new Exception(L10n::t('Not a valid email address.'));
396 if (Config::get('system', 'block_extended_register', false) && dba::exists('user', ['email' => $email])) {
397 throw new Exception(L10n::t('Cannot use that email.'));
400 // Disallow somebody creating an account using openid that uses the admin email address,
401 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
402 if (x($a->config, 'admin_email') && strlen($openid_url)) {
403 $adminlist = explode(',', str_replace(' ', '', strtolower($a->config['admin_email'])));
404 if (in_array(strtolower($email), $adminlist)) {
405 throw new Exception(L10n::t('Cannot use that email.'));
409 $nickname = $data['nickname'] = strtolower($nickname);
411 if (!preg_match('/^[a-z0-9][a-z0-9\_]*$/', $nickname)) {
412 throw new Exception(L10n::t('Your nickname can only contain a-z, 0-9 and _.'));
415 // Check existing and deleted accounts for this nickname.
416 if (dba::exists('user', ['nickname' => $nickname])
417 || dba::exists('userd', ['username' => $nickname])
419 throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
422 $new_password = strlen($password) ? $password : User::generateNewPassword();
423 $new_password_encoded = self::hashPassword($new_password);
425 $return['password'] = $new_password;
427 $keys = Crypto::newKeypair(4096);
428 if ($keys === false) {
429 throw new Exception(L10n::t('SERIOUS ERROR: Generation of security keys failed.'));
432 $prvkey = $keys['prvkey'];
433 $pubkey = $keys['pubkey'];
435 // Create another keypair for signing/verifying salmon protocol messages.
436 $sres = Crypto::newKeypair(512);
437 $sprvkey = $sres['prvkey'];
438 $spubkey = $sres['pubkey'];
440 $insert_result = dba::insert('user', [
441 'guid' => generate_user_guid(),
442 'username' => $username,
443 'password' => $new_password_encoded,
445 'openid' => $openid_url,
446 'nickname' => $nickname,
449 'spubkey' => $spubkey,
450 'sprvkey' => $sprvkey,
451 'verified' => $verified,
452 'blocked' => $blocked,
454 'register_date' => DateTimeFormat::utcNow(),
455 'default-location' => ''
458 if ($insert_result) {
459 $uid = dba::lastInsertId();
460 $user = dba::selectFirst('user', [], ['uid' => $uid]);
462 throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
466 throw new Exception(L10n::t('An error occurred during registration. Please try again.'));
469 // if somebody clicked submit twice very quickly, they could end up with two accounts
470 // due to race condition. Remove this one.
471 $user_count = dba::count('user', ['nickname' => $nickname]);
472 if ($user_count > 1) {
473 dba::delete('user', ['uid' => $uid]);
475 throw new Exception(L10n::t('Nickname is already registered. Please choose another.'));
478 $insert_result = dba::insert('profile', [
481 'photo' => System::baseUrl() . "/photo/profile/{$uid}.jpg",
482 'thumb' => System::baseUrl() . "/photo/avatar/{$uid}.jpg",
483 'publish' => $publish,
485 'net-publish' => $netpublish,
486 'profile-name' => L10n::t('default')
488 if (!$insert_result) {
489 dba::delete('user', ['uid' => $uid]);
491 throw new Exception(L10n::t('An error occurred creating your default profile. Please try again.'));
494 // Create the self contact
495 if (!Contact::createSelfFromUserId($uid)) {
496 dba::delete('user', ['uid' => $uid]);
498 throw new Exception(L10n::t('An error occurred creating your self contact. Please try again.'));
501 // Create a group with no members. This allows somebody to use it
502 // right away as a default group for new contacts.
503 $def_gid = Group::create($uid, L10n::t('Friends'));
505 dba::delete('user', ['uid' => $uid]);
507 throw new Exception(L10n::t('An error occurred creating your default contact group. Please try again.'));
510 $fields = ['def_gid' => $def_gid];
511 if (Config::get('system', 'newuser_private') && $def_gid) {
512 $fields['allow_gid'] = '<' . $def_gid . '>';
515 dba::update('user', $fields, ['uid' => $uid]);
517 // if we have no OpenID photo try to look up an avatar
518 if (!strlen($photo)) {
519 $photo = Network::lookupAvatarByEmail($email);
522 // unless there is no avatar-addon loaded
523 if (strlen($photo)) {
524 $photo_failure = false;
526 $filename = basename($photo);
527 $img_str = Network::fetchUrl($photo, true);
528 // guess mimetype from headers or filename
529 $type = Image::guessType($photo, true);
531 $Image = new Image($img_str, $type);
532 if ($Image->isValid()) {
533 $Image->scaleToSquare(175);
535 $hash = Photo::newResource();
537 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 4);
540 $photo_failure = true;
543 $Image->scaleDown(80);
545 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 5);
548 $photo_failure = true;
551 $Image->scaleDown(48);
553 $r = Photo::store($Image, $uid, 0, $hash, $filename, L10n::t('Profile Photos'), 6);
556 $photo_failure = true;
559 if (!$photo_failure) {
560 dba::update('photo', ['profile' => 1], ['resource-id' => $hash]);
565 Addon::callHooks('register_account', $uid);
567 $return['user'] = $user;
572 * @brief Sends pending registration confiĆmation email
574 * @param string $email
575 * @param string $sitename
576 * @param string $username
577 * @return NULL|boolean from notification() and email() inherited
579 public static function sendRegisterPendingEmail($email, $sitename, $username)
581 $body = deindent(L10n::t('
583 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
586 $body = sprintf($body, $username, $sitename);
588 return notification([
589 'type' => SYSTEM_EMAIL,
590 'to_email' => $email,
591 'subject'=> L10n::t('Registration at %s', $sitename),
596 * @brief Sends registration confirmation
598 * It's here as a function because the mail is sent from different parts
600 * @param string $email
601 * @param string $sitename
602 * @param string $siteurl
603 * @param string $username
604 * @param string $password
605 * @return NULL|boolean from notification() and email() inherited
607 public static function sendRegisterOpenEmail($email, $sitename, $siteurl, $username, $password)
609 $preamble = deindent(L10n::t('
611 Thank you for registering at %2$s. Your account has been created.
613 $body = deindent(L10n::t('
614 The login details are as follows:
620 You may change your password from your account "Settings" page after logging
623 Please take a few moments to review the other account settings on that page.
625 You may also wish to add some basic information to your default profile
626 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
628 We recommend setting your full name, adding a profile photo,
629 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
630 perhaps what country you live in; if you do not wish to be more specific
633 We fully respect your right to privacy, and none of these items are necessary.
634 If you are new and do not know anybody here, they may help
635 you to make some new and interesting friends.
637 If you ever want to delete your account, you can do so at %3$s/removeme
639 Thank you and welcome to %2$s.'));
641 $preamble = sprintf($preamble, $username, $sitename);
642 $body = sprintf($body, $email, $sitename, $siteurl, $username, $password);
644 return notification([
645 'type' => SYSTEM_EMAIL,
646 'to_email' => $email,
647 'subject'=> L10n::t('Registration details for %s', $sitename),
648 'preamble'=> $preamble,
653 * @param object $uid user to remove
656 public static function remove($uid)
662 logger('Removing user: ' . $uid);
664 $user = dba::selectFirst('user', [], ['uid' => $uid]);
666 Addon::callHooks('remove_user', $user);
668 // save username (actually the nickname as it is guaranteed
669 // unique), so it cannot be re-registered in the future.
670 dba::insert('userd', ['username' => $user['nickname']]);
672 // The user and related data will be deleted in "cron_expire_and_remove_users" (cronjobs.php)
673 dba::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utcNow()], ['uid' => $uid]);
674 Worker::add(PRIORITY_HIGH, "Notifier", "removeme", $uid);
676 // Send an update to the directory
677 Worker::add(PRIORITY_LOW, "Directory", $user['url']);
679 if ($uid == local_user()) {
680 unset($_SESSION['authenticated']);
681 unset($_SESSION['uid']);
682 goaway(System::baseUrl());