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\PasswordExposed;
26 use Friendica\Content\Pager;
27 use Friendica\Core\Hook;
28 use Friendica\Core\L10n;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Protocol;
31 use Friendica\Core\System;
32 use Friendica\Core\Worker;
33 use Friendica\Database\DBA;
35 use Friendica\Model\TwoFactor\AppSpecificPassword;
36 use Friendica\Network\HTTPException\InternalServerErrorException;
37 use Friendica\Object\Image;
38 use Friendica\Util\Crypto;
39 use Friendica\Util\DateTimeFormat;
40 use Friendica\Util\Images;
41 use Friendica\Util\Network;
42 use Friendica\Util\Strings;
43 use Friendica\Worker\Delivery;
47 * This class handles User related functions
54 * PAGE_FLAGS_NORMAL is a typical personal profile account
55 * PAGE_FLAGS_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
56 * PAGE_FLAGS_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
57 * write access to wall and comments (no email and not included in page owner's ACL lists)
58 * PAGE_FLAGS_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
62 const PAGE_FLAGS_NORMAL = 0;
63 const PAGE_FLAGS_SOAPBOX = 1;
64 const PAGE_FLAGS_COMMUNITY = 2;
65 const PAGE_FLAGS_FREELOVE = 3;
66 const PAGE_FLAGS_BLOG = 4;
67 const PAGE_FLAGS_PRVGROUP = 5;
75 * ACCOUNT_TYPE_PERSON - the account belongs to a person
76 * Associated page types: PAGE_FLAGS_NORMAL, PAGE_FLAGS_SOAPBOX, PAGE_FLAGS_FREELOVE
78 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
79 * Associated page type: PAGE_FLAGS_SOAPBOX
81 * ACCOUNT_TYPE_NEWS - the account is a news reflector
82 * Associated page type: PAGE_FLAGS_SOAPBOX
84 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
85 * Associated page types: PAGE_COMMUNITY, PAGE_FLAGS_PRVGROUP
87 * ACCOUNT_TYPE_RELAY - the account is a relay
88 * This will only be assigned to contacts, not to user accounts
91 const ACCOUNT_TYPE_PERSON = 0;
92 const ACCOUNT_TYPE_ORGANISATION = 1;
93 const ACCOUNT_TYPE_NEWS = 2;
94 const ACCOUNT_TYPE_COMMUNITY = 3;
95 const ACCOUNT_TYPE_RELAY = 4;
101 * Returns true if a user record exists with the provided id
103 * @param integer $uid
107 public static function exists($uid)
109 return DBA::exists('user', ['uid' => $uid]);
113 * @param integer $uid
114 * @param array $fields
115 * @return array|boolean User record if it exists, false otherwise
118 public static function getById($uid, array $fields = [])
120 return DBA::selectFirst('user', $fields, ['uid' => $uid]);
124 * Returns a user record based on it's GUID
126 * @param string $guid The guid of the user
127 * @param array $fields The fields to retrieve
128 * @param bool $active True, if only active records are searched
130 * @return array|boolean User record if it exists, false otherwise
133 public static function getByGuid(string $guid, array $fields = [], bool $active = true)
136 $cond = ['guid' => $guid, 'account_expired' => false, 'account_removed' => false];
138 $cond = ['guid' => $guid];
141 return DBA::selectFirst('user', $fields, $cond);
145 * @param string $nickname
146 * @param array $fields
147 * @return array|boolean User record if it exists, false otherwise
150 public static function getByNickname($nickname, array $fields = [])
152 return DBA::selectFirst('user', $fields, ['nickname' => $nickname]);
156 * Returns the user id of a given profile URL
160 * @return integer user id
163 public static function getIdForURL($url)
165 $self = DBA::selectFirst('contact', ['uid'], ['nurl' => Strings::normaliseLink($url), 'self' => true]);
166 if (!DBA::isResult($self)) {
174 * Get a user based on its email
176 * @param string $email
177 * @param array $fields
179 * @return array|boolean User record if it exists, false otherwise
183 public static function getByEmail($email, array $fields = [])
185 return DBA::selectFirst('user', $fields, ['email' => $email]);
189 * Get owner data by user id
192 * @param boolean $check_valid Test if data is invalid and correct it
193 * @return boolean|array
196 public static function getOwnerDataById($uid, $check_valid = true)
198 $r = DBA::fetchFirst(
201 `user`.`prvkey` AS `uprvkey`,
207 `user`.`account-type`,
209 `user`.`account_removed`,
213 ON `user`.`uid` = `contact`.`uid`
214 WHERE `contact`.`uid` = ?
219 if (!DBA::isResult($r)) {
223 if (empty($r['nickname'])) {
231 // Check if the returned data is valid, otherwise fix it. See issue #6122
233 // Check for correct url and normalised nurl
234 $url = DI::baseUrl() . '/profile/' . $r['nickname'];
235 $repair = ($r['url'] != $url) || ($r['nurl'] != Strings::normaliseLink($r['url']));
238 // Check if "addr" is present and correct
239 $addr = $r['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
240 $repair = ($addr != $r['addr']);
244 // Check if the avatar field is filled and the photo directs to the correct path
245 $avatar = Photo::selectFirst(['resource-id'], ['uid' => $uid, 'profile' => true]);
246 if (DBA::isResult($avatar)) {
247 $repair = empty($r['avatar']) || !strpos($r['photo'], $avatar['resource-id']);
252 Contact::updateSelfFromUserID($uid);
253 // Return the corrected data and avoid a loop
254 $r = self::getOwnerDataById($uid, false);
261 * Get owner data by nick name
264 * @return boolean|array
267 public static function getOwnerDataByNick($nick)
269 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
271 if (!DBA::isResult($user)) {
275 return self::getOwnerDataById($user['uid']);
279 * Returns the default group for a given user and network
281 * @param int $uid User id
282 * @param string $network network name
284 * @return int group id
285 * @throws InternalServerErrorException
287 public static function getDefaultGroup($uid, $network = '')
291 if ($network == Protocol::OSTATUS) {
292 $default_group = DI::pConfig()->get($uid, "ostatus", "default_group");
295 if ($default_group != 0) {
296 return $default_group;
299 $user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
301 if (DBA::isResult($user)) {
302 $default_group = $user["def_gid"];
305 return $default_group;
310 * Authenticate a user with a clear text password
312 * @param mixed $user_info
313 * @param string $password
314 * @param bool $third_party
315 * @return int|boolean
316 * @deprecated since version 3.6
317 * @see User::getIdFromPasswordAuthentication()
319 public static function authenticate($user_info, $password, $third_party = false)
322 return self::getIdFromPasswordAuthentication($user_info, $password, $third_party);
323 } catch (Exception $ex) {
329 * Authenticate a user with a clear text password
331 * Returns the user id associated with a successful password authentication
333 * @param mixed $user_info
334 * @param string $password
335 * @param bool $third_party
336 * @return int User Id if authentication is successful
339 public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
341 $user = self::getAuthenticationInfo($user_info);
343 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
344 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
345 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
348 } elseif (strpos($user['password'], '$') === false) {
349 //Legacy hash that has not been replaced by a new hash yet
350 if (self::hashPasswordLegacy($password) === $user['password']) {
351 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
355 } elseif (!empty($user['legacy_password'])) {
356 //Legacy hash that has been double-hashed and not replaced by a new hash yet
357 //Warning: `legacy_password` is not necessary in sync with the content of `password`
358 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
359 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
363 } elseif (password_verify($password, $user['password'])) {
365 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
366 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
372 throw new Exception(DI::l10n()->t('Login failed'));
376 * Returns authentication info from various parameters types
378 * User info can be any of the following:
381 * - User email or username or nickname
382 * - User array with at least the uid and the hashed password
384 * @param mixed $user_info
388 private static function getAuthenticationInfo($user_info)
392 if (is_object($user_info) || is_array($user_info)) {
393 if (is_object($user_info)) {
394 $user = (array) $user_info;
401 || !isset($user['password'])
402 || !isset($user['legacy_password'])
404 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
406 } elseif (is_int($user_info) || is_string($user_info)) {
407 if (is_int($user_info)) {
408 $user = DBA::selectFirst(
410 ['uid', 'password', 'legacy_password'],
414 'account_expired' => 0,
415 'account_removed' => 0,
420 $fields = ['uid', 'password', 'legacy_password'];
422 "(`email` = ? OR `username` = ? OR `nickname` = ?)
423 AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
424 $user_info, $user_info, $user_info
426 $user = DBA::selectFirst('user', $fields, $condition);
429 if (!DBA::isResult($user)) {
430 throw new Exception(DI::l10n()->t('User not found'));
438 * Generates a human-readable random password
442 public static function generateNewPassword()
444 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
448 * Checks if the provided plaintext password has been exposed or not
450 * @param string $password
454 public static function isPasswordExposed($password)
456 $cache = new \DivineOmega\DOFileCachePSR6\CacheItemPool();
457 $cache->changeConfig([
458 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
462 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
464 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
465 } catch (\Exception $e) {
466 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
467 'code' => $e->getCode(),
468 'file' => $e->getFile(),
469 'line' => $e->getLine(),
470 'trace' => $e->getTraceAsString()
478 * Legacy hashing function, kept for password migration purposes
480 * @param string $password
483 private static function hashPasswordLegacy($password)
485 return hash('whirlpool', $password);
489 * Global user password hashing function
491 * @param string $password
495 public static function hashPassword($password)
497 if (!trim($password)) {
498 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
501 return password_hash($password, PASSWORD_DEFAULT);
505 * Updates a user row with a new plaintext password
508 * @param string $password
512 public static function updatePassword($uid, $password)
514 $password = trim($password);
516 if (empty($password)) {
517 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
520 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
521 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
524 $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
526 if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
527 throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
530 return self::updatePasswordHashed($uid, self::hashPassword($password));
534 * Updates a user row with a new hashed password.
535 * Empties the password reset token field just in case.
538 * @param string $pasword_hashed
542 private static function updatePasswordHashed($uid, $pasword_hashed)
545 'password' => $pasword_hashed,
547 'pwdreset_time' => null,
548 'legacy_password' => false
550 return DBA::update('user', $fields, ['uid' => $uid]);
554 * Checks if a nickname is in the list of the forbidden nicknames
556 * Check if a nickname is forbidden from registration on the node by the
557 * admin. Forbidden nicknames (e.g. role namess) can be configured in the
560 * @param string $nickname The nickname that should be checked
561 * @return boolean True is the nickname is blocked on the node
562 * @throws InternalServerErrorException
564 public static function isNicknameBlocked($nickname)
566 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
568 // if the config variable is empty return false
569 if (empty($forbidden_nicknames)) {
573 // check if the nickname is in the list of blocked nicknames
574 $forbidden = explode(',', $forbidden_nicknames);
575 $forbidden = array_map('trim', $forbidden);
576 if (in_array(strtolower($nickname), $forbidden)) {
585 * Catch-all user creation function
587 * Creates a user from the provided data array, either form fields or OpenID.
588 * Required: { username, nickname, email } or { openid_url }
590 * Performs the following:
591 * - Sends to the OpenId auth URL (if relevant)
592 * - Creates new key pairs for crypto
593 * - Create self-contact
594 * - Create profile image
598 * @throws \ErrorException
599 * @throws InternalServerErrorException
600 * @throws \ImagickException
603 public static function create(array $data)
605 $return = ['user' => null, 'password' => ''];
607 $using_invites = DI::config()->get('system', 'invitation_only');
609 $invite_id = !empty($data['invite_id']) ? Strings::escapeTags(trim($data['invite_id'])) : '';
610 $username = !empty($data['username']) ? Strings::escapeTags(trim($data['username'])) : '';
611 $nickname = !empty($data['nickname']) ? Strings::escapeTags(trim($data['nickname'])) : '';
612 $email = !empty($data['email']) ? Strings::escapeTags(trim($data['email'])) : '';
613 $openid_url = !empty($data['openid_url']) ? Strings::escapeTags(trim($data['openid_url'])) : '';
614 $photo = !empty($data['photo']) ? Strings::escapeTags(trim($data['photo'])) : '';
615 $password = !empty($data['password']) ? trim($data['password']) : '';
616 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
617 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
618 $blocked = !empty($data['blocked']);
619 $verified = !empty($data['verified']);
620 $language = !empty($data['language']) ? Strings::escapeTags(trim($data['language'])) : 'en';
622 $netpublish = $publish = !empty($data['profile_publish_reg']);
624 if ($password1 != $confirm) {
625 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
626 } elseif ($password1 != '') {
627 $password = $password1;
630 if ($using_invites) {
632 throw new Exception(DI::l10n()->t('An invitation is required.'));
635 if (!Register::existsByHash($invite_id)) {
636 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
640 /// @todo Check if this part is really needed. We should have fetched all this data in advance
641 if (empty($username) || empty($email) || empty($nickname)) {
643 if (!Network::isUrlValid($openid_url)) {
644 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
646 $_SESSION['register'] = 1;
647 $_SESSION['openid'] = $openid_url;
649 $openid = new LightOpenID(DI::baseUrl()->getHostname());
650 $openid->identity = $openid_url;
651 $openid->returnUrl = DI::baseUrl() . '/openid';
652 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
653 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
655 $authurl = $openid->authUrl();
656 } catch (Exception $e) {
657 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);
659 System::externalRedirect($authurl);
663 throw new Exception(DI::l10n()->t('Please enter the required information.'));
666 if (!Network::isUrlValid($openid_url)) {
670 // collapse multiple spaces in name
671 $username = preg_replace('/ +/', ' ', $username);
673 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
674 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
676 if ($username_min_length > $username_max_length) {
677 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);
678 $tmp = $username_min_length;
679 $username_min_length = $username_max_length;
680 $username_max_length = $tmp;
683 if (mb_strlen($username) < $username_min_length) {
684 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
687 if (mb_strlen($username) > $username_max_length) {
688 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
691 // So now we are just looking for a space in the full name.
692 $loose_reg = DI::config()->get('system', 'no_regfullname');
694 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
695 if (strpos($username, ' ') === false) {
696 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
700 if (!Network::isEmailDomainAllowed($email)) {
701 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
704 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
705 throw new Exception(DI::l10n()->t('Not a valid email address.'));
707 if (self::isNicknameBlocked($nickname)) {
708 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
711 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
712 throw new Exception(DI::l10n()->t('Cannot use that email.'));
715 // Disallow somebody creating an account using openid that uses the admin email address,
716 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
717 if (DI::config()->get('config', 'admin_email') && strlen($openid_url)) {
718 $adminlist = explode(',', str_replace(' ', '', strtolower(DI::config()->get('config', 'admin_email'))));
719 if (in_array(strtolower($email), $adminlist)) {
720 throw new Exception(DI::l10n()->t('Cannot use that email.'));
724 $nickname = $data['nickname'] = strtolower($nickname);
726 if (!preg_match('/^[a-z0-9][a-z0-9\_]*$/', $nickname)) {
727 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
730 // Check existing and deleted accounts for this nickname.
732 DBA::exists('user', ['nickname' => $nickname])
733 || DBA::exists('userd', ['username' => $nickname])
735 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
738 $new_password = strlen($password) ? $password : User::generateNewPassword();
739 $new_password_encoded = self::hashPassword($new_password);
741 $return['password'] = $new_password;
743 $keys = Crypto::newKeypair(4096);
744 if ($keys === false) {
745 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
748 $prvkey = $keys['prvkey'];
749 $pubkey = $keys['pubkey'];
751 // Create another keypair for signing/verifying salmon protocol messages.
752 $sres = Crypto::newKeypair(512);
753 $sprvkey = $sres['prvkey'];
754 $spubkey = $sres['pubkey'];
756 $insert_result = DBA::insert('user', [
757 'guid' => System::createUUID(),
758 'username' => $username,
759 'password' => $new_password_encoded,
761 'openid' => $openid_url,
762 'nickname' => $nickname,
765 'spubkey' => $spubkey,
766 'sprvkey' => $sprvkey,
767 'verified' => $verified,
768 'blocked' => $blocked,
769 'language' => $language,
771 'register_date' => DateTimeFormat::utcNow(),
772 'default-location' => ''
775 if ($insert_result) {
776 $uid = DBA::lastInsertId();
777 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
779 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
783 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
786 // if somebody clicked submit twice very quickly, they could end up with two accounts
787 // due to race condition. Remove this one.
788 $user_count = DBA::count('user', ['nickname' => $nickname]);
789 if ($user_count > 1) {
790 DBA::delete('user', ['uid' => $uid]);
792 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
795 $insert_result = DBA::insert('profile', [
798 'photo' => DI::baseUrl() . "/photo/profile/{$uid}.jpg",
799 'thumb' => DI::baseUrl() . "/photo/avatar/{$uid}.jpg",
800 'publish' => $publish,
801 'net-publish' => $netpublish,
803 if (!$insert_result) {
804 DBA::delete('user', ['uid' => $uid]);
806 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
809 // Create the self contact
810 if (!Contact::createSelfFromUserId($uid)) {
811 DBA::delete('user', ['uid' => $uid]);
813 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
816 // Create a group with no members. This allows somebody to use it
817 // right away as a default group for new contacts.
818 $def_gid = Group::create($uid, DI::l10n()->t('Friends'));
820 DBA::delete('user', ['uid' => $uid]);
822 throw new Exception(DI::l10n()->t('An error occurred creating your default contact group. Please try again.'));
825 $fields = ['def_gid' => $def_gid];
826 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
827 $fields['allow_gid'] = '<' . $def_gid . '>';
830 DBA::update('user', $fields, ['uid' => $uid]);
832 // if we have no OpenID photo try to look up an avatar
833 if (!strlen($photo)) {
834 $photo = Network::lookupAvatarByEmail($email);
837 // unless there is no avatar-addon loaded
838 if (strlen($photo)) {
839 $photo_failure = false;
841 $filename = basename($photo);
842 $img_str = Network::fetchUrl($photo, true);
843 // guess mimetype from headers or filename
844 $type = Images::guessType($photo, true);
846 $Image = new Image($img_str, $type);
847 if ($Image->isValid()) {
848 $Image->scaleToSquare(300);
850 $resource_id = Photo::newResource();
852 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 4);
855 $photo_failure = true;
858 $Image->scaleDown(80);
860 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 5);
863 $photo_failure = true;
866 $Image->scaleDown(48);
868 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 6);
871 $photo_failure = true;
874 if (!$photo_failure) {
875 Photo::update(['profile' => 1], ['resource-id' => $resource_id]);
880 Hook::callAll('register_account', $uid);
882 $return['user'] = $user;
887 * Sets block state for a given user
889 * @param int $uid The user id
890 * @param bool $block Block state (default is true)
892 * @return bool True, if successfully blocked
896 public static function block(int $uid, bool $block = true)
898 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
902 * Allows a registration based on a hash
904 * @param string $hash
906 * @return bool True, if the allow was successful
908 * @throws InternalServerErrorException
911 public static function allow(string $hash)
913 $register = Register::getByHash($hash);
914 if (!DBA::isResult($register)) {
918 $user = User::getById($register['uid']);
919 if (!DBA::isResult($user)) {
923 Register::deleteByHash($hash);
925 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
927 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
929 if (DBA::isResult($profile) && $profile['net-publish'] && DI::config()->get('system', 'directory')) {
930 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
931 Worker::add(PRIORITY_LOW, "Directory", $url);
934 $l10n = DI::l10n()->withLang($register['language']);
936 return User::sendRegisterOpenEmail(
939 DI::config()->get('config', 'sitename'),
940 DI::baseUrl()->get(),
941 ($register['password'] ?? '') ?: 'Sent in a previous email'
946 * Denys a pending registration
948 * @param string $hash The hash of the pending user
950 * This does not have to go through user_remove() and save the nickname
951 * permanently against re-registration, as the person was not yet
952 * allowed to have friends on this system
954 * @return bool True, if the deny was successfull
957 public static function deny(string $hash)
959 $register = Register::getByHash($hash);
960 if (!DBA::isResult($register)) {
964 $user = User::getById($register['uid']);
965 if (!DBA::isResult($user)) {
969 return DBA::delete('user', ['uid' => $register['uid']]) &&
970 Register::deleteByHash($register['hash']);
974 * Creates a new user based on a minimal set and sends an email to this user
976 * @param string $name The user's name
977 * @param string $email The user's email address
978 * @param string $nick The user's nick name
979 * @param string $lang The user's language (default is english)
981 * @return bool True, if the user was created successfully
982 * @throws InternalServerErrorException
983 * @throws \ErrorException
984 * @throws \ImagickException
986 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
991 throw new InternalServerErrorException('Invalid arguments.');
994 $result = self::create([
1002 $user = $result['user'];
1003 $preamble = Strings::deindent(DI::l10n()->t('
1005 the administrator of %2$s has set up an account for you.'));
1006 $body = Strings::deindent(DI::l10n()->t('
1007 The login details are as follows:
1013 You may change your password from your account "Settings" page after logging
1016 Please take a few moments to review the other account settings on that page.
1018 You may also wish to add some basic information to your default profile
1019 (on the "Profiles" page) so that other people can easily find you.
1021 We recommend setting your full name, adding a profile photo,
1022 adding some profile "keywords" (very useful in making new friends) - and
1023 perhaps what country you live in; if you do not wish to be more specific
1026 We fully respect your right to privacy, and none of these items are necessary.
1027 If you are new and do not know anybody here, they may help
1028 you to make some new and interesting friends.
1030 If you ever want to delete your account, you can do so at %1$s/removeme
1032 Thank you and welcome to %4$s.'));
1034 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1035 $body = sprintf($body, DI::baseUrl()->get(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1037 $email = DI::emailer()
1039 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1041 ->withRecipient($user['email'])
1043 return DI::emailer()->send($email);
1047 * Sends pending registration confirmation email
1049 * @param array $user User record array
1050 * @param string $sitename
1051 * @param string $siteurl
1052 * @param string $password Plaintext password
1053 * @return NULL|boolean from notification() and email() inherited
1054 * @throws InternalServerErrorException
1056 public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
1058 $body = Strings::deindent(DI::l10n()->t(
1061 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1063 Your login details are as follows:
1076 $email = DI::emailer()
1078 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1080 ->withRecipient($user['email'])
1082 return DI::emailer()->send($email);
1086 * Sends registration confirmation
1088 * It's here as a function because the mail is sent from different parts
1090 * @param \Friendica\Core\L10n $l10n The used language
1091 * @param array $user User record array
1092 * @param string $sitename
1093 * @param string $siteurl
1094 * @param string $password Plaintext password
1096 * @return NULL|boolean from notification() and email() inherited
1097 * @throws InternalServerErrorException
1099 public static function sendRegisterOpenEmail(\Friendica\Core\L10n $l10n, $user, $sitename, $siteurl, $password)
1101 $preamble = Strings::deindent($l10n->t(
1104 Thank you for registering at %2$s. Your account has been created.
1109 $body = Strings::deindent($l10n->t(
1111 The login details are as follows:
1117 You may change your password from your account "Settings" page after logging
1120 Please take a few moments to review the other account settings on that page.
1122 You may also wish to add some basic information to your default profile
1123 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1125 We recommend setting your full name, adding a profile photo,
1126 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
1127 perhaps what country you live in; if you do not wish to be more specific
1130 We fully respect your right to privacy, and none of these items are necessary.
1131 If you are new and do not know anybody here, they may help
1132 you to make some new and interesting friends.
1134 If you ever want to delete your account, you can do so at %3$s/removeme
1136 Thank you and welcome to %2$s.',
1144 $email = DI::emailer()
1146 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1148 ->withRecipient($user['email'])
1150 return DI::emailer()->send($email);
1154 * @param int $uid user to remove
1156 * @throws InternalServerErrorException
1158 public static function remove(int $uid)
1164 Logger::log('Removing user: ' . $uid);
1166 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1168 Hook::callAll('remove_user', $user);
1170 // save username (actually the nickname as it is guaranteed
1171 // unique), so it cannot be re-registered in the future.
1172 DBA::insert('userd', ['username' => $user['nickname']]);
1174 // The user and related data will be deleted in "cron_expire_and_remove_users" (cronjobs.php)
1175 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1176 Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1178 // Send an update to the directory
1179 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1180 Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
1182 // Remove the user relevant data
1183 Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1189 * Return all identities to a user
1191 * @param int $uid The user id
1192 * @return array All identities for this user
1194 * Example for a return:
1198 * 'username' => 'maxmuster',
1199 * 'nickname' => 'Max Mustermann'
1203 * 'username' => 'johndoe',
1204 * 'nickname' => 'John Doe'
1209 public static function identities($uid)
1213 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid]);
1214 if (!DBA::isResult($user)) {
1218 if ($user['parent-uid'] == 0) {
1219 // First add our own entry
1221 'uid' => $user['uid'],
1222 'username' => $user['username'],
1223 'nickname' => $user['nickname']
1226 // Then add all the children
1229 ['uid', 'username', 'nickname'],
1230 ['parent-uid' => $user['uid'], 'account_removed' => false]
1232 if (DBA::isResult($r)) {
1233 $identities = array_merge($identities, DBA::toArray($r));
1236 // First entry is our parent
1239 ['uid', 'username', 'nickname'],
1240 ['uid' => $user['parent-uid'], 'account_removed' => false]
1242 if (DBA::isResult($r)) {
1243 $identities = DBA::toArray($r);
1246 // Then add all siblings
1249 ['uid', 'username', 'nickname'],
1250 ['parent-uid' => $user['parent-uid'], 'account_removed' => false]
1252 if (DBA::isResult($r)) {
1253 $identities = array_merge($identities, DBA::toArray($r));
1258 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1260 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1261 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
1264 if (DBA::isResult($r)) {
1265 $identities = array_merge($identities, DBA::toArray($r));
1272 * Returns statistical information about the current users of this node
1278 public static function getStatistics()
1282 'active_users_halfyear' => 0,
1283 'active_users_monthly' => 0,
1286 $userStmt = DBA::p("SELECT `user`.`uid`, `user`.`login_date`, `contact`.`last-item`
1288 INNER JOIN `contact` ON `contact`.`uid` = `user`.`uid` AND `contact`.`self`
1289 WHERE `user`.`verified`
1290 AND `user`.`login_date` > ?
1291 AND NOT `user`.`blocked`
1292 AND NOT `user`.`account_removed`
1293 AND NOT `user`.`account_expired`",
1297 if (!DBA::isResult($userStmt)) {
1301 $halfyear = time() - (180 * 24 * 60 * 60);
1302 $month = time() - (30 * 24 * 60 * 60);
1304 while ($user = DBA::fetch($userStmt)) {
1305 $statistics['total_users']++;
1307 if ((strtotime($user['login_date']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1309 $statistics['active_users_halfyear']++;
1312 if ((strtotime($user['login_date']) > $month) || (strtotime($user['last-item']) > $month)
1314 $statistics['active_users_monthly']++;
1322 * Get all users of the current node
1324 * @param int $start Start count (Default is 0)
1325 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1326 * @param string $type The type of users, which should get (all, bocked, removed)
1327 * @param string $order Order of the user list (Default is 'contact.name')
1328 * @param string $order_direction Order direction (Default is ASC)
1330 * @return array The list of the users
1333 public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'contact.name', $order_direction = '+')
1335 $sql_order = '`' . str_replace('.', '`.`', $order) . '`';
1336 $sql_order_direction = ($order_direction === '+') ? 'ASC' : 'DESC';
1340 $sql_extra = 'AND `user`.`blocked` = 0';
1343 $sql_extra = 'AND `user`.`blocked` = 1';
1346 $sql_extra = 'AND `user`.`account_removed` = 1';
1354 $usersStmt = DBA::p("SELECT `user`.*, `contact`.`name`, `contact`.`url`, `contact`.`micro`, `user`.`account_expired`, `contact`.`last-item` AS `lastitem_date`, `contact`.`nick`, `contact`.`created`
1356 INNER JOIN `contact` ON `contact`.`uid` = `user`.`uid` AND `contact`.`self`
1357 WHERE `user`.`verified` $sql_extra
1358 ORDER BY $sql_order $sql_order_direction LIMIT ?, ?", $start, $count
1361 return DBA::toArray($usersStmt);