3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
24 use DivineOmega\DOFileCachePSR6\CacheItemPool;
25 use DivineOmega\PasswordExposed;
28 use Friendica\Content\Pager;
29 use Friendica\Core\Hook;
30 use Friendica\Core\L10n;
31 use Friendica\Core\Logger;
32 use Friendica\Core\Protocol;
33 use Friendica\Core\System;
34 use Friendica\Core\Worker;
35 use Friendica\Database\DBA;
37 use Friendica\Model\TwoFactor\AppSpecificPassword;
38 use Friendica\Network\HTTPException;
39 use Friendica\Object\Image;
40 use Friendica\Util\Crypto;
41 use Friendica\Util\DateTimeFormat;
42 use Friendica\Util\Images;
43 use Friendica\Util\Network;
44 use Friendica\Util\Strings;
45 use Friendica\Worker\Delivery;
50 * This class handles User related functions
57 * PAGE_FLAGS_NORMAL is a typical personal profile account
58 * PAGE_FLAGS_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
59 * PAGE_FLAGS_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
60 * write access to wall and comments (no email and not included in page owner's ACL lists)
61 * PAGE_FLAGS_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
65 const PAGE_FLAGS_NORMAL = 0;
66 const PAGE_FLAGS_SOAPBOX = 1;
67 const PAGE_FLAGS_COMMUNITY = 2;
68 const PAGE_FLAGS_FREELOVE = 3;
69 const PAGE_FLAGS_BLOG = 4;
70 const PAGE_FLAGS_PRVGROUP = 5;
78 * ACCOUNT_TYPE_PERSON - the account belongs to a person
79 * Associated page types: PAGE_FLAGS_NORMAL, PAGE_FLAGS_SOAPBOX, PAGE_FLAGS_FREELOVE
81 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
82 * Associated page type: PAGE_FLAGS_SOAPBOX
84 * ACCOUNT_TYPE_NEWS - the account is a news reflector
85 * Associated page type: PAGE_FLAGS_SOAPBOX
87 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
88 * Associated page types: PAGE_COMMUNITY, PAGE_FLAGS_PRVGROUP
90 * ACCOUNT_TYPE_RELAY - the account is a relay
91 * This will only be assigned to contacts, not to user accounts
94 const ACCOUNT_TYPE_PERSON = 0;
95 const ACCOUNT_TYPE_ORGANISATION = 1;
96 const ACCOUNT_TYPE_NEWS = 2;
97 const ACCOUNT_TYPE_COMMUNITY = 3;
98 const ACCOUNT_TYPE_RELAY = 4;
104 * Returns true if a user record exists with the provided id
106 * @param integer $uid
110 public static function exists($uid)
112 return DBA::exists('user', ['uid' => $uid]);
116 * @param integer $uid
117 * @param array $fields
118 * @return array|boolean User record if it exists, false otherwise
121 public static function getById($uid, array $fields = [])
123 return DBA::selectFirst('user', $fields, ['uid' => $uid]);
127 * Returns a user record based on it's GUID
129 * @param string $guid The guid of the user
130 * @param array $fields The fields to retrieve
131 * @param bool $active True, if only active records are searched
133 * @return array|boolean User record if it exists, false otherwise
136 public static function getByGuid(string $guid, array $fields = [], bool $active = true)
139 $cond = ['guid' => $guid, 'account_expired' => false, 'account_removed' => false];
141 $cond = ['guid' => $guid];
144 return DBA::selectFirst('user', $fields, $cond);
148 * @param string $nickname
149 * @param array $fields
150 * @return array|boolean User record if it exists, false otherwise
153 public static function getByNickname($nickname, array $fields = [])
155 return DBA::selectFirst('user', $fields, ['nickname' => $nickname]);
159 * Returns the user id of a given profile URL
163 * @return integer user id
166 public static function getIdForURL($url)
168 $self = DBA::selectFirst('contact', ['uid'], ['nurl' => Strings::normaliseLink($url), 'self' => true]);
169 if (!DBA::isResult($self)) {
177 * Get a user based on its email
179 * @param string $email
180 * @param array $fields
182 * @return array|boolean User record if it exists, false otherwise
186 public static function getByEmail($email, array $fields = [])
188 return DBA::selectFirst('user', $fields, ['email' => $email]);
192 * Get owner data by user id
195 * @param boolean $check_valid Test if data is invalid and correct it
196 * @return boolean|array
199 public static function getOwnerDataById($uid, $check_valid = true)
201 $owner = DBA::selectFirst('owner-view', [], ['uid' => $uid]);
202 if (!DBA::isResult($owner)) {
203 if (!DBA::exists('user', ['uid' => $uid]) || !$check_valid) {
206 Contact::createSelfFromUserId($uid);
207 $owner = self::getOwnerDataById($uid, false);
210 if (empty($owner['nickname'])) {
218 // Check if the returned data is valid, otherwise fix it. See issue #6122
220 // Check for correct url and normalised nurl
221 $url = DI::baseUrl() . '/profile/' . $owner['nickname'];
222 $repair = ($owner['url'] != $url) || ($owner['nurl'] != Strings::normaliseLink($owner['url']));
225 // Check if "addr" is present and correct
226 $addr = $owner['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
227 $repair = ($addr != $owner['addr']);
231 // Check if the avatar field is filled and the photo directs to the correct path
232 $avatar = Photo::selectFirst(['resource-id'], ['uid' => $uid, 'profile' => true]);
233 if (DBA::isResult($avatar)) {
234 $repair = empty($owner['avatar']) || !strpos($owner['photo'], $avatar['resource-id']);
239 Contact::updateSelfFromUserID($uid);
240 // Return the corrected data and avoid a loop
241 $owner = self::getOwnerDataById($uid, false);
248 * Get owner data by nick name
251 * @return boolean|array
254 public static function getOwnerDataByNick($nick)
256 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
258 if (!DBA::isResult($user)) {
262 return self::getOwnerDataById($user['uid']);
266 * Returns the default group for a given user and network
268 * @param int $uid User id
269 * @param string $network network name
271 * @return int group id
274 public static function getDefaultGroup($uid, $network = '')
278 if ($network == Protocol::OSTATUS) {
279 $default_group = DI::pConfig()->get($uid, "ostatus", "default_group");
282 if ($default_group != 0) {
283 return $default_group;
286 $user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
288 if (DBA::isResult($user)) {
289 $default_group = $user["def_gid"];
292 return $default_group;
297 * Authenticate a user with a clear text password
299 * @param mixed $user_info
300 * @param string $password
301 * @param bool $third_party
302 * @return int|boolean
303 * @deprecated since version 3.6
304 * @see User::getIdFromPasswordAuthentication()
306 public static function authenticate($user_info, $password, $third_party = false)
309 return self::getIdFromPasswordAuthentication($user_info, $password, $third_party);
310 } catch (Exception $ex) {
316 * Authenticate a user with a clear text password
318 * Returns the user id associated with a successful password authentication
320 * @param mixed $user_info
321 * @param string $password
322 * @param bool $third_party
323 * @return int User Id if authentication is successful
326 public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
328 $user = self::getAuthenticationInfo($user_info);
330 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
331 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
332 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
335 } elseif (strpos($user['password'], '$') === false) {
336 //Legacy hash that has not been replaced by a new hash yet
337 if (self::hashPasswordLegacy($password) === $user['password']) {
338 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
342 } elseif (!empty($user['legacy_password'])) {
343 //Legacy hash that has been double-hashed and not replaced by a new hash yet
344 //Warning: `legacy_password` is not necessary in sync with the content of `password`
345 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
346 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
350 } elseif (password_verify($password, $user['password'])) {
352 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
353 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
359 throw new Exception(DI::l10n()->t('Login failed'));
363 * Returns authentication info from various parameters types
365 * User info can be any of the following:
368 * - User email or username or nickname
369 * - User array with at least the uid and the hashed password
371 * @param mixed $user_info
375 private static function getAuthenticationInfo($user_info)
379 if (is_object($user_info) || is_array($user_info)) {
380 if (is_object($user_info)) {
381 $user = (array) $user_info;
388 || !isset($user['password'])
389 || !isset($user['legacy_password'])
391 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
393 } elseif (is_int($user_info) || is_string($user_info)) {
394 if (is_int($user_info)) {
395 $user = DBA::selectFirst(
397 ['uid', 'password', 'legacy_password'],
401 'account_expired' => 0,
402 'account_removed' => 0,
407 $fields = ['uid', 'password', 'legacy_password'];
409 "(`email` = ? OR `username` = ? OR `nickname` = ?)
410 AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
411 $user_info, $user_info, $user_info
413 $user = DBA::selectFirst('user', $fields, $condition);
416 if (!DBA::isResult($user)) {
417 throw new Exception(DI::l10n()->t('User not found'));
425 * Generates a human-readable random password
430 public static function generateNewPassword()
432 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
436 * Checks if the provided plaintext password has been exposed or not
438 * @param string $password
442 public static function isPasswordExposed($password)
444 $cache = new CacheItemPool();
445 $cache->changeConfig([
446 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
450 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
452 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
453 } catch (Exception $e) {
454 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
455 'code' => $e->getCode(),
456 'file' => $e->getFile(),
457 'line' => $e->getLine(),
458 'trace' => $e->getTraceAsString()
466 * Legacy hashing function, kept for password migration purposes
468 * @param string $password
471 private static function hashPasswordLegacy($password)
473 return hash('whirlpool', $password);
477 * Global user password hashing function
479 * @param string $password
483 public static function hashPassword($password)
485 if (!trim($password)) {
486 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
489 return password_hash($password, PASSWORD_DEFAULT);
493 * Updates a user row with a new plaintext password
496 * @param string $password
500 public static function updatePassword($uid, $password)
502 $password = trim($password);
504 if (empty($password)) {
505 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
508 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
509 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
512 $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
514 if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
515 throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
518 return self::updatePasswordHashed($uid, self::hashPassword($password));
522 * Updates a user row with a new hashed password.
523 * Empties the password reset token field just in case.
526 * @param string $pasword_hashed
530 private static function updatePasswordHashed($uid, $pasword_hashed)
533 'password' => $pasword_hashed,
535 'pwdreset_time' => null,
536 'legacy_password' => false
538 return DBA::update('user', $fields, ['uid' => $uid]);
542 * Checks if a nickname is in the list of the forbidden nicknames
544 * Check if a nickname is forbidden from registration on the node by the
545 * admin. Forbidden nicknames (e.g. role namess) can be configured in the
548 * @param string $nickname The nickname that should be checked
549 * @return boolean True is the nickname is blocked on the node
551 public static function isNicknameBlocked($nickname)
553 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
555 // if the config variable is empty return false
556 if (empty($forbidden_nicknames)) {
560 // check if the nickname is in the list of blocked nicknames
561 $forbidden = explode(',', $forbidden_nicknames);
562 $forbidden = array_map('trim', $forbidden);
563 if (in_array(strtolower($nickname), $forbidden)) {
572 * Catch-all user creation function
574 * Creates a user from the provided data array, either form fields or OpenID.
575 * Required: { username, nickname, email } or { openid_url }
577 * Performs the following:
578 * - Sends to the OpenId auth URL (if relevant)
579 * - Creates new key pairs for crypto
580 * - Create self-contact
581 * - Create profile image
585 * @throws ErrorException
586 * @throws HTTPException\InternalServerErrorException
587 * @throws ImagickException
590 public static function create(array $data)
592 $return = ['user' => null, 'password' => ''];
594 $using_invites = DI::config()->get('system', 'invitation_only');
596 $invite_id = !empty($data['invite_id']) ? Strings::escapeTags(trim($data['invite_id'])) : '';
597 $username = !empty($data['username']) ? Strings::escapeTags(trim($data['username'])) : '';
598 $nickname = !empty($data['nickname']) ? Strings::escapeTags(trim($data['nickname'])) : '';
599 $email = !empty($data['email']) ? Strings::escapeTags(trim($data['email'])) : '';
600 $openid_url = !empty($data['openid_url']) ? Strings::escapeTags(trim($data['openid_url'])) : '';
601 $photo = !empty($data['photo']) ? Strings::escapeTags(trim($data['photo'])) : '';
602 $password = !empty($data['password']) ? trim($data['password']) : '';
603 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
604 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
605 $blocked = !empty($data['blocked']);
606 $verified = !empty($data['verified']);
607 $language = !empty($data['language']) ? Strings::escapeTags(trim($data['language'])) : 'en';
609 $netpublish = $publish = !empty($data['profile_publish_reg']);
611 if ($password1 != $confirm) {
612 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
613 } elseif ($password1 != '') {
614 $password = $password1;
617 if ($using_invites) {
619 throw new Exception(DI::l10n()->t('An invitation is required.'));
622 if (!Register::existsByHash($invite_id)) {
623 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
627 /// @todo Check if this part is really needed. We should have fetched all this data in advance
628 if (empty($username) || empty($email) || empty($nickname)) {
630 if (!Network::isUrlValid($openid_url)) {
631 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
633 $_SESSION['register'] = 1;
634 $_SESSION['openid'] = $openid_url;
636 $openid = new LightOpenID(DI::baseUrl()->getHostname());
637 $openid->identity = $openid_url;
638 $openid->returnUrl = DI::baseUrl() . '/openid';
639 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
640 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
642 $authurl = $openid->authUrl();
643 } catch (Exception $e) {
644 throw new Exception(DI::l10n()->t('We encountered a problem while logging in with the OpenID you provided. Please check the correct spelling of the ID.') . EOL . EOL . DI::l10n()->t('The error message was:') . $e->getMessage(), 0, $e);
646 System::externalRedirect($authurl);
650 throw new Exception(DI::l10n()->t('Please enter the required information.'));
653 if (!Network::isUrlValid($openid_url)) {
657 // collapse multiple spaces in name
658 $username = preg_replace('/ +/', ' ', $username);
660 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
661 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
663 if ($username_min_length > $username_max_length) {
664 Logger::log(DI::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);
665 $tmp = $username_min_length;
666 $username_min_length = $username_max_length;
667 $username_max_length = $tmp;
670 if (mb_strlen($username) < $username_min_length) {
671 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
674 if (mb_strlen($username) > $username_max_length) {
675 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
678 // So now we are just looking for a space in the full name.
679 $loose_reg = DI::config()->get('system', 'no_regfullname');
681 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
682 if (strpos($username, ' ') === false) {
683 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
687 if (!Network::isEmailDomainAllowed($email)) {
688 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
691 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
692 throw new Exception(DI::l10n()->t('Not a valid email address.'));
694 if (self::isNicknameBlocked($nickname)) {
695 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
698 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
699 throw new Exception(DI::l10n()->t('Cannot use that email.'));
702 // Disallow somebody creating an account using openid that uses the admin email address,
703 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
704 if (DI::config()->get('config', 'admin_email') && strlen($openid_url)) {
705 $adminlist = explode(',', str_replace(' ', '', strtolower(DI::config()->get('config', 'admin_email'))));
706 if (in_array(strtolower($email), $adminlist)) {
707 throw new Exception(DI::l10n()->t('Cannot use that email.'));
711 $nickname = $data['nickname'] = strtolower($nickname);
713 if (!preg_match('/^[a-z0-9][a-z0-9_]*$/', $nickname)) {
714 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
717 // Check existing and deleted accounts for this nickname.
719 DBA::exists('user', ['nickname' => $nickname])
720 || DBA::exists('userd', ['username' => $nickname])
722 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
725 $new_password = strlen($password) ? $password : User::generateNewPassword();
726 $new_password_encoded = self::hashPassword($new_password);
728 $return['password'] = $new_password;
730 $keys = Crypto::newKeypair(4096);
731 if ($keys === false) {
732 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
735 $prvkey = $keys['prvkey'];
736 $pubkey = $keys['pubkey'];
738 // Create another keypair for signing/verifying salmon protocol messages.
739 $sres = Crypto::newKeypair(512);
740 $sprvkey = $sres['prvkey'];
741 $spubkey = $sres['pubkey'];
743 $insert_result = DBA::insert('user', [
744 'guid' => System::createUUID(),
745 'username' => $username,
746 'password' => $new_password_encoded,
748 'openid' => $openid_url,
749 'nickname' => $nickname,
752 'spubkey' => $spubkey,
753 'sprvkey' => $sprvkey,
754 'verified' => $verified,
755 'blocked' => $blocked,
756 'language' => $language,
758 'register_date' => DateTimeFormat::utcNow(),
759 'default-location' => ''
762 if ($insert_result) {
763 $uid = DBA::lastInsertId();
764 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
766 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
770 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
773 // if somebody clicked submit twice very quickly, they could end up with two accounts
774 // due to race condition. Remove this one.
775 $user_count = DBA::count('user', ['nickname' => $nickname]);
776 if ($user_count > 1) {
777 DBA::delete('user', ['uid' => $uid]);
779 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
782 $insert_result = DBA::insert('profile', [
785 'photo' => DI::baseUrl() . "/photo/profile/{$uid}.jpg",
786 'thumb' => DI::baseUrl() . "/photo/avatar/{$uid}.jpg",
787 'publish' => $publish,
788 'net-publish' => $netpublish,
790 if (!$insert_result) {
791 DBA::delete('user', ['uid' => $uid]);
793 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
796 // Create the self contact
797 if (!Contact::createSelfFromUserId($uid)) {
798 DBA::delete('user', ['uid' => $uid]);
800 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
803 // Create a group with no members. This allows somebody to use it
804 // right away as a default group for new contacts.
805 $def_gid = Group::create($uid, DI::l10n()->t('Friends'));
807 DBA::delete('user', ['uid' => $uid]);
809 throw new Exception(DI::l10n()->t('An error occurred creating your default contact group. Please try again.'));
812 $fields = ['def_gid' => $def_gid];
813 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
814 $fields['allow_gid'] = '<' . $def_gid . '>';
817 DBA::update('user', $fields, ['uid' => $uid]);
819 // if we have no OpenID photo try to look up an avatar
820 if (!strlen($photo)) {
821 $photo = Network::lookupAvatarByEmail($email);
824 // unless there is no avatar-addon loaded
825 if (strlen($photo)) {
826 $photo_failure = false;
828 $filename = basename($photo);
829 $curlResult = Network::curl($photo, true);
830 if ($curlResult->isSuccess()) {
831 $img_str = $curlResult->getBody();
832 $type = $curlResult->getContentType();
838 $type = Images::getMimeTypeByData($img_str, $photo, $type);
840 $Image = new Image($img_str, $type);
841 if ($Image->isValid()) {
842 $Image->scaleToSquare(300);
844 $resource_id = Photo::newResource();
846 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 4);
849 $photo_failure = true;
852 $Image->scaleDown(80);
854 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 5);
857 $photo_failure = true;
860 $Image->scaleDown(48);
862 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 6);
865 $photo_failure = true;
868 if (!$photo_failure) {
869 Photo::update(['profile' => 1], ['resource-id' => $resource_id]);
874 Hook::callAll('register_account', $uid);
876 $return['user'] = $user;
881 * Sets block state for a given user
883 * @param int $uid The user id
884 * @param bool $block Block state (default is true)
886 * @return bool True, if successfully blocked
890 public static function block(int $uid, bool $block = true)
892 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
896 * Allows a registration based on a hash
898 * @param string $hash
900 * @return bool True, if the allow was successful
902 * @throws HTTPException\InternalServerErrorException
905 public static function allow(string $hash)
907 $register = Register::getByHash($hash);
908 if (!DBA::isResult($register)) {
912 $user = User::getById($register['uid']);
913 if (!DBA::isResult($user)) {
917 Register::deleteByHash($hash);
919 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
921 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
923 if (DBA::isResult($profile) && $profile['net-publish'] && DI::config()->get('system', 'directory')) {
924 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
925 Worker::add(PRIORITY_LOW, "Directory", $url);
928 $l10n = DI::l10n()->withLang($register['language']);
930 return User::sendRegisterOpenEmail(
933 DI::config()->get('config', 'sitename'),
934 DI::baseUrl()->get(),
935 ($register['password'] ?? '') ?: 'Sent in a previous email'
940 * Denys a pending registration
942 * @param string $hash The hash of the pending user
944 * This does not have to go through user_remove() and save the nickname
945 * permanently against re-registration, as the person was not yet
946 * allowed to have friends on this system
948 * @return bool True, if the deny was successfull
951 public static function deny(string $hash)
953 $register = Register::getByHash($hash);
954 if (!DBA::isResult($register)) {
958 $user = User::getById($register['uid']);
959 if (!DBA::isResult($user)) {
963 return DBA::delete('user', ['uid' => $register['uid']]) &&
964 Register::deleteByHash($register['hash']);
968 * Creates a new user based on a minimal set and sends an email to this user
970 * @param string $name The user's name
971 * @param string $email The user's email address
972 * @param string $nick The user's nick name
973 * @param string $lang The user's language (default is english)
975 * @return bool True, if the user was created successfully
976 * @throws HTTPException\InternalServerErrorException
977 * @throws ErrorException
978 * @throws ImagickException
980 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
985 throw new HTTPException\InternalServerErrorException('Invalid arguments.');
988 $result = self::create([
996 $user = $result['user'];
997 $preamble = Strings::deindent(DI::l10n()->t('
999 the administrator of %2$s has set up an account for you.'));
1000 $body = Strings::deindent(DI::l10n()->t('
1001 The login details are as follows:
1007 You may change your password from your account "Settings" page after logging
1010 Please take a few moments to review the other account settings on that page.
1012 You may also wish to add some basic information to your default profile
1013 (on the "Profiles" page) so that other people can easily find you.
1015 We recommend setting your full name, adding a profile photo,
1016 adding some profile "keywords" (very useful in making new friends) - and
1017 perhaps what country you live in; if you do not wish to be more specific
1020 We fully respect your right to privacy, and none of these items are necessary.
1021 If you are new and do not know anybody here, they may help
1022 you to make some new and interesting friends.
1024 If you ever want to delete your account, you can do so at %1$s/removeme
1026 Thank you and welcome to %4$s.'));
1028 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1029 $body = sprintf($body, DI::baseUrl()->get(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1031 $email = DI::emailer()
1033 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1035 ->withRecipient($user['email'])
1037 return DI::emailer()->send($email);
1041 * Sends pending registration confirmation email
1043 * @param array $user User record array
1044 * @param string $sitename
1045 * @param string $siteurl
1046 * @param string $password Plaintext password
1047 * @return NULL|boolean from notification() and email() inherited
1048 * @throws HTTPException\InternalServerErrorException
1050 public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
1052 $body = Strings::deindent(DI::l10n()->t(
1055 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1057 Your login details are as follows:
1070 $email = DI::emailer()
1072 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1074 ->withRecipient($user['email'])
1076 return DI::emailer()->send($email);
1080 * Sends registration confirmation
1082 * It's here as a function because the mail is sent from different parts
1084 * @param L10n $l10n The used language
1085 * @param array $user User record array
1086 * @param string $sitename
1087 * @param string $siteurl
1088 * @param string $password Plaintext password
1090 * @return NULL|boolean from notification() and email() inherited
1091 * @throws HTTPException\InternalServerErrorException
1093 public static function sendRegisterOpenEmail(L10n $l10n, $user, $sitename, $siteurl, $password)
1095 $preamble = Strings::deindent($l10n->t(
1098 Thank you for registering at %2$s. Your account has been created.
1103 $body = Strings::deindent($l10n->t(
1105 The login details are as follows:
1111 You may change your password from your account "Settings" page after logging
1114 Please take a few moments to review the other account settings on that page.
1116 You may also wish to add some basic information to your default profile
1117 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1119 We recommend setting your full name, adding a profile photo,
1120 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
1121 perhaps what country you live in; if you do not wish to be more specific
1124 We fully respect your right to privacy, and none of these items are necessary.
1125 If you are new and do not know anybody here, they may help
1126 you to make some new and interesting friends.
1128 If you ever want to delete your account, you can do so at %3$s/removeme
1130 Thank you and welcome to %2$s.',
1138 $email = DI::emailer()
1140 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1142 ->withRecipient($user['email'])
1144 return DI::emailer()->send($email);
1148 * @param int $uid user to remove
1150 * @throws HTTPException\InternalServerErrorException
1152 public static function remove(int $uid)
1158 Logger::log('Removing user: ' . $uid);
1160 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1162 Hook::callAll('remove_user', $user);
1164 // save username (actually the nickname as it is guaranteed
1165 // unique), so it cannot be re-registered in the future.
1166 DBA::insert('userd', ['username' => $user['nickname']]);
1168 // The user and related data will be deleted in Friendica\Worker\CronJobs::expireAndRemoveUsers()
1169 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1170 Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1172 // Send an update to the directory
1173 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1174 Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
1176 // Remove the user relevant data
1177 Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1183 * Return all identities to a user
1185 * @param int $uid The user id
1186 * @return array All identities for this user
1188 * Example for a return:
1192 * 'username' => 'maxmuster',
1193 * 'nickname' => 'Max Mustermann'
1197 * 'username' => 'johndoe',
1198 * 'nickname' => 'John Doe'
1203 public static function identities($uid)
1207 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid]);
1208 if (!DBA::isResult($user)) {
1212 if ($user['parent-uid'] == 0) {
1213 // First add our own entry
1215 'uid' => $user['uid'],
1216 'username' => $user['username'],
1217 'nickname' => $user['nickname']
1220 // Then add all the children
1223 ['uid', 'username', 'nickname'],
1224 ['parent-uid' => $user['uid'], 'account_removed' => false]
1226 if (DBA::isResult($r)) {
1227 $identities = array_merge($identities, DBA::toArray($r));
1230 // First entry is our parent
1233 ['uid', 'username', 'nickname'],
1234 ['uid' => $user['parent-uid'], 'account_removed' => false]
1236 if (DBA::isResult($r)) {
1237 $identities = DBA::toArray($r);
1240 // Then add all siblings
1243 ['uid', 'username', 'nickname'],
1244 ['parent-uid' => $user['parent-uid'], 'account_removed' => false]
1246 if (DBA::isResult($r)) {
1247 $identities = array_merge($identities, DBA::toArray($r));
1252 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1254 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1255 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
1258 if (DBA::isResult($r)) {
1259 $identities = array_merge($identities, DBA::toArray($r));
1266 * Returns statistical information about the current users of this node
1272 public static function getStatistics()
1276 'active_users_halfyear' => 0,
1277 'active_users_monthly' => 0,
1278 'active_users_weekly' => 0,
1281 $userStmt = DBA::select('owner-view', ['uid', 'login_date', 'last-item'],
1282 ["`verified` AND `login_date` > ? AND NOT `blocked`
1283 AND NOT `account_removed` AND NOT `account_expired`",
1284 DBA::NULL_DATETIME]);
1285 if (!DBA::isResult($userStmt)) {
1289 $halfyear = time() - (180 * 24 * 60 * 60);
1290 $month = time() - (30 * 24 * 60 * 60);
1291 $week = time() - (7 * 24 * 60 * 60);
1293 while ($user = DBA::fetch($userStmt)) {
1294 $statistics['total_users']++;
1296 if ((strtotime($user['login_date']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1298 $statistics['active_users_halfyear']++;
1301 if ((strtotime($user['login_date']) > $month) || (strtotime($user['last-item']) > $month)
1303 $statistics['active_users_monthly']++;
1306 if ((strtotime($user['login_date']) > $week) || (strtotime($user['last-item']) > $week)
1308 $statistics['active_users_weekly']++;
1311 DBA::close($userStmt);
1317 * Get all users of the current node
1319 * @param int $start Start count (Default is 0)
1320 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1321 * @param string $type The type of users, which should get (all, bocked, removed)
1322 * @param string $order Order of the user list (Default is 'contact.name')
1323 * @param bool $descending Order direction (Default is ascending)
1325 * @return array The list of the users
1328 public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'name', bool $descending = false)
1330 $param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
1334 $condition['account_removed'] = false;
1335 $condition['blocked'] = false;
1338 $condition['blocked'] = true;
1341 $condition['account_removed'] = true;
1345 return DBA::selectToArray('owner-view', [], $condition, $param);