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
324 * @throws HTTPException\ForbiddenException
325 * @throws HTTPException\NotFoundException
327 public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
329 $user = self::getAuthenticationInfo($user_info);
331 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
332 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
333 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
336 } elseif (strpos($user['password'], '$') === false) {
337 //Legacy hash that has not been replaced by a new hash yet
338 if (self::hashPasswordLegacy($password) === $user['password']) {
339 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
343 } elseif (!empty($user['legacy_password'])) {
344 //Legacy hash that has been double-hashed and not replaced by a new hash yet
345 //Warning: `legacy_password` is not necessary in sync with the content of `password`
346 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
347 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
351 } elseif (password_verify($password, $user['password'])) {
353 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
354 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
360 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
364 * Returns authentication info from various parameters types
366 * User info can be any of the following:
369 * - User email or username or nickname
370 * - User array with at least the uid and the hashed password
372 * @param mixed $user_info
374 * @throws HTTPException\NotFoundException
376 private static function getAuthenticationInfo($user_info)
380 if (is_object($user_info) || is_array($user_info)) {
381 if (is_object($user_info)) {
382 $user = (array) $user_info;
389 || !isset($user['password'])
390 || !isset($user['legacy_password'])
392 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
394 } elseif (is_int($user_info) || is_string($user_info)) {
395 if (is_int($user_info)) {
396 $user = DBA::selectFirst(
398 ['uid', 'password', 'legacy_password'],
402 'account_expired' => 0,
403 'account_removed' => 0,
408 $fields = ['uid', 'password', 'legacy_password'];
410 "(`email` = ? OR `username` = ? OR `nickname` = ?)
411 AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
412 $user_info, $user_info, $user_info
414 $user = DBA::selectFirst('user', $fields, $condition);
417 if (!DBA::isResult($user)) {
418 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
426 * Generates a human-readable random password
431 public static function generateNewPassword()
433 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
437 * Checks if the provided plaintext password has been exposed or not
439 * @param string $password
443 public static function isPasswordExposed($password)
445 $cache = new CacheItemPool();
446 $cache->changeConfig([
447 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
451 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
453 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
454 } catch (Exception $e) {
455 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
456 'code' => $e->getCode(),
457 'file' => $e->getFile(),
458 'line' => $e->getLine(),
459 'trace' => $e->getTraceAsString()
467 * Legacy hashing function, kept for password migration purposes
469 * @param string $password
472 private static function hashPasswordLegacy($password)
474 return hash('whirlpool', $password);
478 * Global user password hashing function
480 * @param string $password
484 public static function hashPassword($password)
486 if (!trim($password)) {
487 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
490 return password_hash($password, PASSWORD_DEFAULT);
494 * Updates a user row with a new plaintext password
497 * @param string $password
501 public static function updatePassword($uid, $password)
503 $password = trim($password);
505 if (empty($password)) {
506 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
509 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
510 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
513 $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
515 if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
516 throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
519 return self::updatePasswordHashed($uid, self::hashPassword($password));
523 * Updates a user row with a new hashed password.
524 * Empties the password reset token field just in case.
527 * @param string $pasword_hashed
531 private static function updatePasswordHashed($uid, $pasword_hashed)
534 'password' => $pasword_hashed,
536 'pwdreset_time' => null,
537 'legacy_password' => false
539 return DBA::update('user', $fields, ['uid' => $uid]);
543 * Checks if a nickname is in the list of the forbidden nicknames
545 * Check if a nickname is forbidden from registration on the node by the
546 * admin. Forbidden nicknames (e.g. role namess) can be configured in the
549 * @param string $nickname The nickname that should be checked
550 * @return boolean True is the nickname is blocked on the node
552 public static function isNicknameBlocked($nickname)
554 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
556 // if the config variable is empty return false
557 if (empty($forbidden_nicknames)) {
561 // check if the nickname is in the list of blocked nicknames
562 $forbidden = explode(',', $forbidden_nicknames);
563 $forbidden = array_map('trim', $forbidden);
564 if (in_array(strtolower($nickname), $forbidden)) {
573 * Catch-all user creation function
575 * Creates a user from the provided data array, either form fields or OpenID.
576 * Required: { username, nickname, email } or { openid_url }
578 * Performs the following:
579 * - Sends to the OpenId auth URL (if relevant)
580 * - Creates new key pairs for crypto
581 * - Create self-contact
582 * - Create profile image
586 * @throws ErrorException
587 * @throws HTTPException\InternalServerErrorException
588 * @throws ImagickException
591 public static function create(array $data)
593 $return = ['user' => null, 'password' => ''];
595 $using_invites = DI::config()->get('system', 'invitation_only');
597 $invite_id = !empty($data['invite_id']) ? Strings::escapeTags(trim($data['invite_id'])) : '';
598 $username = !empty($data['username']) ? Strings::escapeTags(trim($data['username'])) : '';
599 $nickname = !empty($data['nickname']) ? Strings::escapeTags(trim($data['nickname'])) : '';
600 $email = !empty($data['email']) ? Strings::escapeTags(trim($data['email'])) : '';
601 $openid_url = !empty($data['openid_url']) ? Strings::escapeTags(trim($data['openid_url'])) : '';
602 $photo = !empty($data['photo']) ? Strings::escapeTags(trim($data['photo'])) : '';
603 $password = !empty($data['password']) ? trim($data['password']) : '';
604 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
605 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
606 $blocked = !empty($data['blocked']);
607 $verified = !empty($data['verified']);
608 $language = !empty($data['language']) ? Strings::escapeTags(trim($data['language'])) : 'en';
610 $netpublish = $publish = !empty($data['profile_publish_reg']);
612 if ($password1 != $confirm) {
613 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
614 } elseif ($password1 != '') {
615 $password = $password1;
618 if ($using_invites) {
620 throw new Exception(DI::l10n()->t('An invitation is required.'));
623 if (!Register::existsByHash($invite_id)) {
624 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
628 /// @todo Check if this part is really needed. We should have fetched all this data in advance
629 if (empty($username) || empty($email) || empty($nickname)) {
631 if (!Network::isUrlValid($openid_url)) {
632 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
634 $_SESSION['register'] = 1;
635 $_SESSION['openid'] = $openid_url;
637 $openid = new LightOpenID(DI::baseUrl()->getHostname());
638 $openid->identity = $openid_url;
639 $openid->returnUrl = DI::baseUrl() . '/openid';
640 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
641 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
643 $authurl = $openid->authUrl();
644 } catch (Exception $e) {
645 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);
647 System::externalRedirect($authurl);
651 throw new Exception(DI::l10n()->t('Please enter the required information.'));
654 if (!Network::isUrlValid($openid_url)) {
658 // collapse multiple spaces in name
659 $username = preg_replace('/ +/', ' ', $username);
661 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
662 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
664 if ($username_min_length > $username_max_length) {
665 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);
666 $tmp = $username_min_length;
667 $username_min_length = $username_max_length;
668 $username_max_length = $tmp;
671 if (mb_strlen($username) < $username_min_length) {
672 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
675 if (mb_strlen($username) > $username_max_length) {
676 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
679 // So now we are just looking for a space in the full name.
680 $loose_reg = DI::config()->get('system', 'no_regfullname');
682 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
683 if (strpos($username, ' ') === false) {
684 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
688 if (!Network::isEmailDomainAllowed($email)) {
689 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
692 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
693 throw new Exception(DI::l10n()->t('Not a valid email address.'));
695 if (self::isNicknameBlocked($nickname)) {
696 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
699 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
700 throw new Exception(DI::l10n()->t('Cannot use that email.'));
703 // Disallow somebody creating an account using openid that uses the admin email address,
704 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
705 if (DI::config()->get('config', 'admin_email') && strlen($openid_url)) {
706 $adminlist = explode(',', str_replace(' ', '', strtolower(DI::config()->get('config', 'admin_email'))));
707 if (in_array(strtolower($email), $adminlist)) {
708 throw new Exception(DI::l10n()->t('Cannot use that email.'));
712 $nickname = $data['nickname'] = strtolower($nickname);
714 if (!preg_match('/^[a-z0-9][a-z0-9_]*$/', $nickname)) {
715 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
718 // Check existing and deleted accounts for this nickname.
720 DBA::exists('user', ['nickname' => $nickname])
721 || DBA::exists('userd', ['username' => $nickname])
723 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
726 $new_password = strlen($password) ? $password : User::generateNewPassword();
727 $new_password_encoded = self::hashPassword($new_password);
729 $return['password'] = $new_password;
731 $keys = Crypto::newKeypair(4096);
732 if ($keys === false) {
733 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
736 $prvkey = $keys['prvkey'];
737 $pubkey = $keys['pubkey'];
739 // Create another keypair for signing/verifying salmon protocol messages.
740 $sres = Crypto::newKeypair(512);
741 $sprvkey = $sres['prvkey'];
742 $spubkey = $sres['pubkey'];
744 $insert_result = DBA::insert('user', [
745 'guid' => System::createUUID(),
746 'username' => $username,
747 'password' => $new_password_encoded,
749 'openid' => $openid_url,
750 'nickname' => $nickname,
753 'spubkey' => $spubkey,
754 'sprvkey' => $sprvkey,
755 'verified' => $verified,
756 'blocked' => $blocked,
757 'language' => $language,
759 'register_date' => DateTimeFormat::utcNow(),
760 'default-location' => ''
763 if ($insert_result) {
764 $uid = DBA::lastInsertId();
765 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
767 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
771 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
774 // if somebody clicked submit twice very quickly, they could end up with two accounts
775 // due to race condition. Remove this one.
776 $user_count = DBA::count('user', ['nickname' => $nickname]);
777 if ($user_count > 1) {
778 DBA::delete('user', ['uid' => $uid]);
780 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
783 $insert_result = DBA::insert('profile', [
786 'photo' => DI::baseUrl() . "/photo/profile/{$uid}.jpg",
787 'thumb' => DI::baseUrl() . "/photo/avatar/{$uid}.jpg",
788 'publish' => $publish,
789 'net-publish' => $netpublish,
791 if (!$insert_result) {
792 DBA::delete('user', ['uid' => $uid]);
794 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
797 // Create the self contact
798 if (!Contact::createSelfFromUserId($uid)) {
799 DBA::delete('user', ['uid' => $uid]);
801 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
804 // Create a group with no members. This allows somebody to use it
805 // right away as a default group for new contacts.
806 $def_gid = Group::create($uid, DI::l10n()->t('Friends'));
808 DBA::delete('user', ['uid' => $uid]);
810 throw new Exception(DI::l10n()->t('An error occurred creating your default contact group. Please try again.'));
813 $fields = ['def_gid' => $def_gid];
814 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
815 $fields['allow_gid'] = '<' . $def_gid . '>';
818 DBA::update('user', $fields, ['uid' => $uid]);
820 // if we have no OpenID photo try to look up an avatar
821 if (!strlen($photo)) {
822 $photo = Network::lookupAvatarByEmail($email);
825 // unless there is no avatar-addon loaded
826 if (strlen($photo)) {
827 $photo_failure = false;
829 $filename = basename($photo);
830 $curlResult = Network::curl($photo, true);
831 if ($curlResult->isSuccess()) {
832 $img_str = $curlResult->getBody();
833 $type = $curlResult->getContentType();
839 $type = Images::getMimeTypeByData($img_str, $photo, $type);
841 $Image = new Image($img_str, $type);
842 if ($Image->isValid()) {
843 $Image->scaleToSquare(300);
845 $resource_id = Photo::newResource();
847 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 4);
850 $photo_failure = true;
853 $Image->scaleDown(80);
855 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 5);
858 $photo_failure = true;
861 $Image->scaleDown(48);
863 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 6);
866 $photo_failure = true;
869 if (!$photo_failure) {
870 Photo::update(['profile' => 1], ['resource-id' => $resource_id]);
875 Hook::callAll('register_account', $uid);
877 $return['user'] = $user;
882 * Sets block state for a given user
884 * @param int $uid The user id
885 * @param bool $block Block state (default is true)
887 * @return bool True, if successfully blocked
891 public static function block(int $uid, bool $block = true)
893 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
897 * Allows a registration based on a hash
899 * @param string $hash
901 * @return bool True, if the allow was successful
903 * @throws HTTPException\InternalServerErrorException
906 public static function allow(string $hash)
908 $register = Register::getByHash($hash);
909 if (!DBA::isResult($register)) {
913 $user = User::getById($register['uid']);
914 if (!DBA::isResult($user)) {
918 Register::deleteByHash($hash);
920 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
922 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
924 if (DBA::isResult($profile) && $profile['net-publish'] && DI::config()->get('system', 'directory')) {
925 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
926 Worker::add(PRIORITY_LOW, "Directory", $url);
929 $l10n = DI::l10n()->withLang($register['language']);
931 return User::sendRegisterOpenEmail(
934 DI::config()->get('config', 'sitename'),
935 DI::baseUrl()->get(),
936 ($register['password'] ?? '') ?: 'Sent in a previous email'
941 * Denys a pending registration
943 * @param string $hash The hash of the pending user
945 * This does not have to go through user_remove() and save the nickname
946 * permanently against re-registration, as the person was not yet
947 * allowed to have friends on this system
949 * @return bool True, if the deny was successfull
952 public static function deny(string $hash)
954 $register = Register::getByHash($hash);
955 if (!DBA::isResult($register)) {
959 $user = User::getById($register['uid']);
960 if (!DBA::isResult($user)) {
964 return DBA::delete('user', ['uid' => $register['uid']]) &&
965 Register::deleteByHash($register['hash']);
969 * Creates a new user based on a minimal set and sends an email to this user
971 * @param string $name The user's name
972 * @param string $email The user's email address
973 * @param string $nick The user's nick name
974 * @param string $lang The user's language (default is english)
976 * @return bool True, if the user was created successfully
977 * @throws HTTPException\InternalServerErrorException
978 * @throws ErrorException
979 * @throws ImagickException
981 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
986 throw new HTTPException\InternalServerErrorException('Invalid arguments.');
989 $result = self::create([
997 $user = $result['user'];
998 $preamble = Strings::deindent(DI::l10n()->t('
1000 the administrator of %2$s has set up an account for you.'));
1001 $body = Strings::deindent(DI::l10n()->t('
1002 The login details are as follows:
1008 You may change your password from your account "Settings" page after logging
1011 Please take a few moments to review the other account settings on that page.
1013 You may also wish to add some basic information to your default profile
1014 (on the "Profiles" page) so that other people can easily find you.
1016 We recommend setting your full name, adding a profile photo,
1017 adding some profile "keywords" (very useful in making new friends) - and
1018 perhaps what country you live in; if you do not wish to be more specific
1021 We fully respect your right to privacy, and none of these items are necessary.
1022 If you are new and do not know anybody here, they may help
1023 you to make some new and interesting friends.
1025 If you ever want to delete your account, you can do so at %1$s/removeme
1027 Thank you and welcome to %4$s.'));
1029 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1030 $body = sprintf($body, DI::baseUrl()->get(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1032 $email = DI::emailer()
1034 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1036 ->withRecipient($user['email'])
1038 return DI::emailer()->send($email);
1042 * Sends pending registration confirmation email
1044 * @param array $user User record array
1045 * @param string $sitename
1046 * @param string $siteurl
1047 * @param string $password Plaintext password
1048 * @return NULL|boolean from notification() and email() inherited
1049 * @throws HTTPException\InternalServerErrorException
1051 public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
1053 $body = Strings::deindent(DI::l10n()->t(
1056 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1058 Your login details are as follows:
1071 $email = DI::emailer()
1073 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1075 ->withRecipient($user['email'])
1077 return DI::emailer()->send($email);
1081 * Sends registration confirmation
1083 * It's here as a function because the mail is sent from different parts
1085 * @param L10n $l10n The used language
1086 * @param array $user User record array
1087 * @param string $sitename
1088 * @param string $siteurl
1089 * @param string $password Plaintext password
1091 * @return NULL|boolean from notification() and email() inherited
1092 * @throws HTTPException\InternalServerErrorException
1094 public static function sendRegisterOpenEmail(L10n $l10n, $user, $sitename, $siteurl, $password)
1096 $preamble = Strings::deindent($l10n->t(
1099 Thank you for registering at %2$s. Your account has been created.
1104 $body = Strings::deindent($l10n->t(
1106 The login details are as follows:
1112 You may change your password from your account "Settings" page after logging
1115 Please take a few moments to review the other account settings on that page.
1117 You may also wish to add some basic information to your default profile
1118 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1120 We recommend setting your full name, adding a profile photo,
1121 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
1122 perhaps what country you live in; if you do not wish to be more specific
1125 We fully respect your right to privacy, and none of these items are necessary.
1126 If you are new and do not know anybody here, they may help
1127 you to make some new and interesting friends.
1129 If you ever want to delete your account, you can do so at %3$s/removeme
1131 Thank you and welcome to %2$s.',
1139 $email = DI::emailer()
1141 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1143 ->withRecipient($user['email'])
1145 return DI::emailer()->send($email);
1149 * @param int $uid user to remove
1151 * @throws HTTPException\InternalServerErrorException
1153 public static function remove(int $uid)
1159 Logger::log('Removing user: ' . $uid);
1161 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1163 Hook::callAll('remove_user', $user);
1165 // save username (actually the nickname as it is guaranteed
1166 // unique), so it cannot be re-registered in the future.
1167 DBA::insert('userd', ['username' => $user['nickname']]);
1169 // The user and related data will be deleted in Friendica\Worker\CronJobs::expireAndRemoveUsers()
1170 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1171 Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1173 // Send an update to the directory
1174 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1175 Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
1177 // Remove the user relevant data
1178 Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1184 * Return all identities to a user
1186 * @param int $uid The user id
1187 * @return array All identities for this user
1189 * Example for a return:
1193 * 'username' => 'maxmuster',
1194 * 'nickname' => 'Max Mustermann'
1198 * 'username' => 'johndoe',
1199 * 'nickname' => 'John Doe'
1204 public static function identities($uid)
1208 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid]);
1209 if (!DBA::isResult($user)) {
1213 if ($user['parent-uid'] == 0) {
1214 // First add our own entry
1216 'uid' => $user['uid'],
1217 'username' => $user['username'],
1218 'nickname' => $user['nickname']
1221 // Then add all the children
1224 ['uid', 'username', 'nickname'],
1225 ['parent-uid' => $user['uid'], 'account_removed' => false]
1227 if (DBA::isResult($r)) {
1228 $identities = array_merge($identities, DBA::toArray($r));
1231 // First entry is our parent
1234 ['uid', 'username', 'nickname'],
1235 ['uid' => $user['parent-uid'], 'account_removed' => false]
1237 if (DBA::isResult($r)) {
1238 $identities = DBA::toArray($r);
1241 // Then add all siblings
1244 ['uid', 'username', 'nickname'],
1245 ['parent-uid' => $user['parent-uid'], 'account_removed' => false]
1247 if (DBA::isResult($r)) {
1248 $identities = array_merge($identities, DBA::toArray($r));
1253 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1255 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1256 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
1259 if (DBA::isResult($r)) {
1260 $identities = array_merge($identities, DBA::toArray($r));
1267 * Returns statistical information about the current users of this node
1273 public static function getStatistics()
1277 'active_users_halfyear' => 0,
1278 'active_users_monthly' => 0,
1279 'active_users_weekly' => 0,
1282 $userStmt = DBA::select('owner-view', ['uid', 'login_date', 'last-item'],
1283 ["`verified` AND `login_date` > ? AND NOT `blocked`
1284 AND NOT `account_removed` AND NOT `account_expired`",
1285 DBA::NULL_DATETIME]);
1286 if (!DBA::isResult($userStmt)) {
1290 $halfyear = time() - (180 * 24 * 60 * 60);
1291 $month = time() - (30 * 24 * 60 * 60);
1292 $week = time() - (7 * 24 * 60 * 60);
1294 while ($user = DBA::fetch($userStmt)) {
1295 $statistics['total_users']++;
1297 if ((strtotime($user['login_date']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1299 $statistics['active_users_halfyear']++;
1302 if ((strtotime($user['login_date']) > $month) || (strtotime($user['last-item']) > $month)
1304 $statistics['active_users_monthly']++;
1307 if ((strtotime($user['login_date']) > $week) || (strtotime($user['last-item']) > $week)
1309 $statistics['active_users_weekly']++;
1312 DBA::close($userStmt);
1318 * Get all users of the current node
1320 * @param int $start Start count (Default is 0)
1321 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1322 * @param string $type The type of users, which should get (all, bocked, removed)
1323 * @param string $order Order of the user list (Default is 'contact.name')
1324 * @param bool $descending Order direction (Default is ascending)
1326 * @return array The list of the users
1329 public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'name', bool $descending = false)
1331 $param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
1335 $condition['account_removed'] = false;
1336 $condition['blocked'] = false;
1339 $condition['blocked'] = true;
1342 $condition['account_removed'] = true;
1346 return DBA::selectToArray('owner-view', [], $condition, $param);