3 * @copyright Copyright (C) 2010-2023, the Friendica project
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\Search;
34 use Friendica\Core\System;
35 use Friendica\Core\Worker;
36 use Friendica\Database\DBA;
39 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
40 use Friendica\Network\HTTPException;
41 use Friendica\Object\Image;
42 use Friendica\Protocol\Delivery;
43 use Friendica\Security\TwoFactor\Model\AppSpecificPassword;
44 use Friendica\Util\Crypto;
45 use Friendica\Util\DateTimeFormat;
46 use Friendica\Util\Images;
47 use Friendica\Util\Network;
48 use Friendica\Util\Proxy;
49 use Friendica\Util\Strings;
54 * This class handles User related functions
61 * PAGE_FLAGS_NORMAL is a typical personal profile account
62 * PAGE_FLAGS_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
63 * PAGE_FLAGS_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
64 * write access to wall and comments (no email and not included in page owner's ACL lists)
65 * PAGE_FLAGS_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
69 const PAGE_FLAGS_NORMAL = 0;
70 const PAGE_FLAGS_SOAPBOX = 1;
71 const PAGE_FLAGS_COMMUNITY = 2;
72 const PAGE_FLAGS_FREELOVE = 3;
73 const PAGE_FLAGS_BLOG = 4;
74 const PAGE_FLAGS_PRVGROUP = 5;
82 * ACCOUNT_TYPE_PERSON - the account belongs to a person
83 * Associated page types: PAGE_FLAGS_NORMAL, PAGE_FLAGS_SOAPBOX, PAGE_FLAGS_FREELOVE
85 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
86 * Associated page type: PAGE_FLAGS_SOAPBOX
88 * ACCOUNT_TYPE_NEWS - the account is a news reflector
89 * Associated page type: PAGE_FLAGS_SOAPBOX
91 * ACCOUNT_TYPE_COMMUNITY - the account is community group
92 * Associated page types: PAGE_COMMUNITY, PAGE_FLAGS_PRVGROUP
94 * ACCOUNT_TYPE_RELAY - the account is a relay
95 * This will only be assigned to contacts, not to user accounts
98 const ACCOUNT_TYPE_PERSON = 0;
99 const ACCOUNT_TYPE_ORGANISATION = 1;
100 const ACCOUNT_TYPE_NEWS = 2;
101 const ACCOUNT_TYPE_COMMUNITY = 3;
102 const ACCOUNT_TYPE_RELAY = 4;
103 const ACCOUNT_TYPE_DELETED = 127;
108 private static $owner;
111 * Returns the numeric account type by their string
113 * @param string $accounttype as string constant
114 * @return int|null Numeric account type - or null when not set
116 public static function getAccountTypeByString(string $accounttype)
118 switch ($accounttype) {
120 return User::ACCOUNT_TYPE_PERSON;
123 return User::ACCOUNT_TYPE_ORGANISATION;
126 return User::ACCOUNT_TYPE_NEWS;
129 return User::ACCOUNT_TYPE_COMMUNITY;
135 * Get the Uri-Id of the system account
139 public static function getSystemUriId(): int
141 $system = self::getSystemAccount();
142 return $system['uri-id'] ?? 0;
146 * Fetch the system account
148 * @return array system account
150 public static function getSystemAccount(): array
152 $system = Contact::selectFirst([], ['self' => true, 'uid' => 0]);
153 if (!DBA::isResult($system)) {
154 self::createSystemAccount();
155 $system = Contact::selectFirst([], ['self' => true, 'uid' => 0]);
156 if (!DBA::isResult($system)) {
161 $system['sprvkey'] = $system['uprvkey'] = $system['prvkey'];
162 $system['spubkey'] = $system['upubkey'] = $system['pubkey'];
163 $system['nickname'] = $system['nick'];
164 $system['page-flags'] = User::PAGE_FLAGS_SOAPBOX;
165 $system['account-type'] = $system['contact-type'];
166 $system['guid'] = '';
167 $system['picdate'] = '';
168 $system['theme'] = '';
169 $system['publish'] = false;
170 $system['net-publish'] = false;
171 $system['hide-friends'] = true;
172 $system['hidewall'] = true;
173 $system['prv_keywords'] = '';
174 $system['pub_keywords'] = '';
175 $system['address'] = '';
176 $system['locality'] = '';
177 $system['region'] = '';
178 $system['postal-code'] = '';
179 $system['country-name'] = '';
180 $system['homepage'] = (string)DI::baseUrl();
181 $system['dob'] = '0000-00-00';
183 // Ensure that the user contains data
184 $user = DBA::selectFirst('user', ['prvkey', 'guid', 'language'], ['uid' => 0]);
185 if (empty($user['prvkey']) || empty($user['guid'])) {
187 'username' => $system['name'],
188 'nickname' => $system['nick'],
189 'register_date' => $system['created'],
190 'pubkey' => $system['pubkey'],
191 'prvkey' => $system['prvkey'],
192 'spubkey' => $system['spubkey'],
193 'sprvkey' => $system['sprvkey'],
194 'guid' => System::createUUID(),
196 'page-flags' => User::PAGE_FLAGS_SOAPBOX,
197 'account-type' => User::ACCOUNT_TYPE_RELAY,
200 DBA::update('user', $fields, ['uid' => 0]);
202 $system['guid'] = $fields['guid'];
204 $system['guid'] = $user['guid'];
205 $system['language'] = $user['language'];
212 * Create the system account
216 private static function createSystemAccount()
218 $system_actor_name = self::getActorName();
219 if (empty($system_actor_name)) {
223 $keys = Crypto::newKeypair(4096);
224 if ($keys === false) {
225 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
230 'created' => DateTimeFormat::utcNow(),
232 'network' => Protocol::ACTIVITYPUB,
233 'name' => 'System Account',
234 'addr' => $system_actor_name . '@' . DI::baseUrl()->getHost(),
235 'nick' => $system_actor_name,
236 'url' => DI::baseUrl() . '/friendica',
237 'pubkey' => $keys['pubkey'],
238 'prvkey' => $keys['prvkey'],
241 'contact-type' => Contact::TYPE_RELAY, // In AP this is translated to 'Application'
242 'name-date' => DateTimeFormat::utcNow(),
243 'uri-date' => DateTimeFormat::utcNow(),
244 'avatar-date' => DateTimeFormat::utcNow(),
246 'baseurl' => DI::baseUrl(),
249 $system['avatar'] = $system['photo'] = Contact::getDefaultAvatar($system, Proxy::SIZE_SMALL);
250 $system['thumb'] = Contact::getDefaultAvatar($system, Proxy::SIZE_THUMB);
251 $system['micro'] = Contact::getDefaultAvatar($system, Proxy::SIZE_MICRO);
252 $system['nurl'] = Strings::normaliseLink($system['url']);
253 $system['gsid'] = GServer::getID($system['baseurl']);
255 Contact::insert($system);
259 * Detect a usable actor name
261 * @return string actor account name
263 public static function getActorName(): string
265 $system_actor_name = DI::config()->get('system', 'actor_name');
266 if (!empty($system_actor_name)) {
267 $self = Contact::selectFirst(['nick'], ['uid' => 0, 'self' => true]);
268 if (!empty($self['nick'])) {
269 if ($self['nick'] != $system_actor_name) {
270 // Reset the actor name to the already used name
271 DI::config()->set('system', 'actor_name', $self['nick']);
272 $system_actor_name = $self['nick'];
275 return $system_actor_name;
278 // List of possible actor names
279 $possible_accounts = ['friendica', 'actor', 'system', 'internal'];
280 foreach ($possible_accounts as $name) {
281 if (!DBA::exists('user', ['nickname' => $name]) && !DBA::exists('userd', ['username' => $name])) {
282 DI::config()->set('system', 'actor_name', $name);
290 * Returns true if a user record exists with the provided id
297 public static function exists(int $uid): bool
299 return DBA::exists('user', ['uid' => $uid]);
303 * @param integer $uid
304 * @param array $fields
305 * @return array|boolean User record if it exists, false otherwise
308 public static function getById(int $uid, array $fields = [])
310 return !empty($uid) ? DBA::selectFirst('user', $fields, ['uid' => $uid]) : [];
314 * Returns a user record based on it's GUID
316 * @param string $guid The guid of the user
317 * @param array $fields The fields to retrieve
318 * @param bool $active True, if only active records are searched
320 * @return array|boolean User record if it exists, false otherwise
323 public static function getByGuid(string $guid, array $fields = [], bool $active = true)
326 $cond = ['guid' => $guid, 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false];
328 $cond = ['guid' => $guid];
331 return DBA::selectFirst('user', $fields, $cond);
335 * @param string $nickname
336 * @param array $fields
337 * @return array|boolean User record if it exists, false otherwise
340 public static function getByNickname(string $nickname, array $fields = [])
342 return DBA::selectFirst('user', $fields, ['nickname' => $nickname]);
346 * Set static settings for community user accounts
348 * @param integer $uid
351 public static function setCommunityUserSettings(int $uid)
353 $user = self::getById($uid, ['account-type', 'page-flags']);
354 if ($user['account-type'] != User::ACCOUNT_TYPE_COMMUNITY) {
358 DI::pConfig()->set($uid, 'system', 'unlisted', true);
362 'allow_gid' => $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP ? '<' . Circle::FOLLOWERS . '>' : '',
369 User::update($fields, $uid);
371 Profile::update(['hide-friends' => true], $uid);
375 * Returns the user id of a given profile URL
379 * @return integer user id
382 public static function getIdForURL(string $url): int
384 // Avoid database queries when the local node hostname isn't even part of the url.
385 if (!Contact::isLocal($url)) {
389 $self = Contact::selectFirst(['uid'], ['self' => true, 'nurl' => Strings::normaliseLink($url)]);
390 if (!empty($self['uid'])) {
394 $self = Contact::selectFirst(['uid'], ['self' => true, 'addr' => $url]);
395 if (!empty($self['uid'])) {
399 $self = Contact::selectFirst(['uid'], ['self' => true, 'alias' => [$url, Strings::normaliseLink($url)]]);
400 if (!empty($self['uid'])) {
408 * Get a user based on its email
410 * @param string $email
411 * @param array $fields
412 * @return array|boolean User record if it exists, false otherwise
415 public static function getByEmail(string $email, array $fields = [])
417 return DBA::selectFirst('user', $fields, ['email' => $email]);
421 * Fetch the user array of the administrator. The first one if there are several.
423 * @param array $fields
427 public static function getFirstAdmin(array $fields = []): array
429 if (!empty(DI::config()->get('config', 'admin_nickname'))) {
430 return self::getByNickname(DI::config()->get('config', 'admin_nickname'), $fields);
433 return self::getAdminList()[0] ?? [];
437 * Get owner data by user id
440 * @param boolean $repairMissing Repair the owner data if it's missing
441 * @return boolean|array
444 public static function getOwnerDataById(int $uid, bool $repairMissing = true)
447 return self::getSystemAccount();
450 if (!empty(self::$owner[$uid])) {
451 return self::$owner[$uid];
454 $owner = DBA::selectFirst('owner-view', [], ['uid' => $uid]);
455 if (!DBA::isResult($owner)) {
456 if (!self::exists($uid) || !$repairMissing) {
459 if (!DBA::exists('profile', ['uid' => $uid])) {
460 DBA::insert('profile', ['uid' => $uid]);
462 if (!DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
463 Contact::createSelfFromUserId($uid);
465 $owner = self::getOwnerDataById($uid, false);
468 if (empty($owner['nickname'])) {
472 if (!$repairMissing || $owner['account_expired']) {
476 // Check if the returned data is valid, otherwise fix it. See issue #6122
478 // Check for correct url and normalised nurl
479 $url = DI::baseUrl() . '/profile/' . $owner['nickname'];
480 $repair = empty($owner['network']) || ($owner['url'] != $url) || ($owner['nurl'] != Strings::normaliseLink($owner['url']));
483 // Check if "addr" is present and correct
484 $addr = $owner['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
485 $repair = ($addr != $owner['addr']) || empty($owner['prvkey']) || empty($owner['pubkey']);
489 // Check if the avatar field is filled and the photo directs to the correct path
490 $avatar = Photo::selectFirst(['resource-id'], ['uid' => $uid, 'profile' => true]);
491 if (DBA::isResult($avatar)) {
492 $repair = empty($owner['avatar']) || !strpos($owner['photo'], $avatar['resource-id']);
497 Contact::updateSelfFromUserID($uid);
498 // Return the corrected data and avoid a loop
499 $owner = self::getOwnerDataById($uid, false);
502 self::$owner[$uid] = $owner;
507 * Get owner data by nick name
510 * @return boolean|array
513 public static function getOwnerDataByNick(string $nick)
515 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
517 if (!DBA::isResult($user)) {
521 return self::getOwnerDataById($user['uid']);
525 * Returns the default circle for a given user
527 * @param int $uid User id
529 * @return int circle id
532 public static function getDefaultCircle(int $uid): int
534 $user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
535 if (DBA::isResult($user)) {
536 $default_circle = $user['def_gid'];
541 return $default_circle;
545 * Returns the default circle for groups for a given user
547 * @param int $uid User id
549 * @return int circle id
552 public static function getDefaultGroupCircle(int $uid): int
554 $default_circle = DI::pConfig()->get($uid, 'system', 'default-group-gid');
555 if (empty($default_circle)) {
556 $default_circle = self::getDefaultCircle($uid);
559 return $default_circle;
563 * Fetch the language code from the given user. If the code is invalid, return the system language
565 * @param integer $uid User-Id
568 public static function getLanguageCode(int $uid): string
570 $owner = self::getOwnerDataById($uid);
571 $language = DI::l10n()->toISO6391($owner['language']);
572 if (in_array($language, array_keys(DI::l10n()->getLanguageCodes()))) {
575 return DI::l10n()->toISO6391(DI::config()->get('system', 'language'));
579 * Get a list of all languages that are used by the users
583 public static function getLanguages(): array
585 $supported = array_keys(DI::l10n()->getLanguageCodes());
589 $condition = ["`verified` AND NOT `blocked` AND NOT `account_removed` AND NOT `account_expired` AND `uid` > ?", 0];
591 $abandon_days = intval(DI::config()->get('system', 'account_abandon_days'));
592 if (!empty($abandon_days)) {
593 $condition = DBA::mergeConditions($condition, ["`last-activity` > ?", DateTimeFormat::utc('now - ' . $abandon_days . ' days')]);
596 $users = DBA::select('user', ['uid', 'language'], $condition);
597 while ($user = DBA::fetch($users)) {
598 $uids[] = $user['uid'];
599 $code = DI::l10n()->toISO6391($user['language']);
600 if (!in_array($code, $supported)) {
603 $languages[$code] = $code;
607 $channels = DBA::select('pconfig', ['uid', 'v'], ["`cat` = ? AND `k` = ? AND `v` != ?", 'channel', 'languages', '']);
608 while ($channel = DBA::fetch($channels)) {
609 if (!in_array($channel['uid'], $uids)) {
612 $values = unserialize($channel['v']);
613 if (!empty($values) && is_array($values)) {
614 foreach ($values as $language) {
615 $language = DI::l10n()->toISO6391($language);
616 $languages[$language] = $language;
620 DBA::close($channels);
623 return array_keys($languages);
627 * Authenticate a user with a clear text password
629 * Returns the user id associated with a successful password authentication
631 * @param mixed $user_info
632 * @param string $password
633 * @param bool $third_party
634 * @return int User Id if authentication is successful
635 * @throws HTTPException\ForbiddenException
636 * @throws HTTPException\NotFoundException
638 public static function getIdFromPasswordAuthentication($user_info, string $password, bool $third_party = false): int
640 // Addons registered with the "authenticate" hook may create the user on the
641 // fly. `getAuthenticationInfo` will fail if the user doesn't exist yet. If
642 // the user doesn't exist, we should give the addons a chance to create the
643 // user in our database, if applicable, before re-throwing the exception if
646 $user = self::getAuthenticationInfo($user_info);
647 } catch (Exception $e) {
648 $username = (is_string($user_info) ? $user_info : $user_info['nickname'] ?? '');
650 // Addons can create users, and since this 'catch' branch should only
651 // execute if getAuthenticationInfo can't find an existing user, that's
652 // exactly what will happen here. Creating a numeric username would create
653 // ambiguity with user IDs, possibly opening up an attack vector.
654 // So let's be very careful about that.
655 if (empty($username) || is_numeric($username)) {
659 return self::getIdFromAuthenticateHooks($username, $password);
662 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
663 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
664 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
667 } elseif (strpos($user['password'], '$') === false) {
668 //Legacy hash that has not been replaced by a new hash yet
669 if (self::hashPasswordLegacy($password) === $user['password']) {
670 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
674 } elseif (!empty($user['legacy_password'])) {
675 //Legacy hash that has been double-hashed and not replaced by a new hash yet
676 //Warning: `legacy_password` is not necessary in sync with the content of `password`
677 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
678 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
682 } elseif (password_verify($password, $user['password'])) {
684 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
685 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
690 return self::getIdFromAuthenticateHooks($user['nickname'], $password); // throws
693 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
697 * Try to obtain a user ID via "authenticate" hook addons
699 * Returns the user id associated with a successful password authentication
701 * @param string $username
702 * @param string $password
703 * @return int User Id if authentication is successful
704 * @throws HTTPException\ForbiddenException
706 public static function getIdFromAuthenticateHooks(string $username, string $password): int
709 'username' => $username,
710 'password' => $password,
711 'authenticated' => 0,
712 'user_record' => null
716 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
717 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
718 * and later addons should not interfere with an earlier one that succeeded.
720 Hook::callAll('authenticate', $addon_auth);
722 if ($addon_auth['authenticated'] && $addon_auth['user_record']) {
723 return $addon_auth['user_record']['uid'];
726 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
730 * Returns authentication info from various parameters types
732 * User info can be any of the following:
735 * - User email or username or nickname
736 * - User array with at least the uid and the hashed password
738 * @param mixed $user_info
739 * @return array|null Null if not found/determined
740 * @throws HTTPException\NotFoundException
742 public static function getAuthenticationInfo($user_info)
746 if (is_object($user_info) || is_array($user_info)) {
747 if (is_object($user_info)) {
748 $user = (array) $user_info;
755 || !isset($user['password'])
756 || !isset($user['legacy_password'])
758 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
760 } elseif (is_int($user_info) || is_string($user_info)) {
761 if (is_int($user_info)) {
762 $user = DBA::selectFirst(
764 ['uid', 'nickname', 'password', 'legacy_password'],
768 'account_expired' => 0,
769 'account_removed' => 0,
774 $fields = ['uid', 'nickname', 'password', 'legacy_password'];
776 "(`email` = ? OR `username` = ? OR `nickname` = ?)
777 AND `verified` AND NOT `blocked` AND NOT `account_removed` AND NOT `account_expired`",
778 $user_info, $user_info, $user_info
780 $user = DBA::selectFirst('user', $fields, $condition);
783 if (!DBA::isResult($user)) {
784 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
792 * Update the day of the last activity of the given user
794 * @param integer $uid
797 public static function updateLastActivity(int $uid)
803 $user = User::getById($uid, ['last-activity']);
808 $current_day = DateTimeFormat::utcNow('Y-m-d');
810 if ($user['last-activity'] != $current_day) {
811 User::update(['last-activity' => $current_day], $uid);
812 // Set the last activity for all identities of the user
813 DBA::update('user', ['last-activity' => $current_day], ['parent-uid' => $uid, 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false]);
818 * Generates a human-readable random password
823 public static function generateNewPassword(): string
825 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
829 * Checks if the provided plaintext password has been exposed or not
831 * @param string $password
835 public static function isPasswordExposed(string $password): bool
837 $cache = new CacheItemPool();
838 $cache->changeConfig([
839 'cacheDirectory' => System::getTempPath() . '/password-exposed-cache/',
843 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
845 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
846 } catch (Exception $e) {
847 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
848 'code' => $e->getCode(),
849 'file' => $e->getFile(),
850 'line' => $e->getLine(),
851 'trace' => $e->getTraceAsString()
859 * Legacy hashing function, kept for password migration purposes
861 * @param string $password
864 private static function hashPasswordLegacy(string $password): string
866 return hash('whirlpool', $password);
870 * Global user password hashing function
872 * @param string $password
876 public static function hashPassword(string $password): string
878 if (!trim($password)) {
879 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
882 return password_hash($password, PASSWORD_DEFAULT);
886 * Allowed characters are a-z, A-Z, 0-9 and special characters except white spaces and accentuated letters.
888 * Password length is limited to 72 characters if the current default password hashing algorithm is Blowfish.
889 * From the manual: "Using the PASSWORD_BCRYPT as the algorithm, will result in the password parameter being
890 * truncated to a maximum length of 72 bytes."
892 * @see https://www.php.net/manual/en/function.password-hash.php#refsect1-function.password-hash-parameters
894 * @param string|null $delimiter Whether the regular expression is meant to be wrapper in delimiter characters
897 public static function getPasswordRegExp(string $delimiter = null): string
899 $allowed_characters = ':!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
902 $allowed_characters = preg_quote($allowed_characters, $delimiter);
905 return '^[a-zA-Z0-9' . $allowed_characters . ']' . (PASSWORD_DEFAULT === PASSWORD_BCRYPT ? '{1,72}' : '+') . '$';
909 * Updates a user row with a new plaintext password
912 * @param string $password
916 public static function updatePassword(int $uid, string $password): bool
918 $password = trim($password);
920 if (empty($password)) {
921 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
924 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
925 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
928 if (PASSWORD_DEFAULT === PASSWORD_BCRYPT && strlen($password) > 72) {
929 throw new Exception(DI::l10n()->t('The password length is limited to 72 characters.'));
932 if (!preg_match('/' . self::getPasswordRegExp('/') . '/', $password)) {
933 throw new Exception(DI::l10n()->t("The password can't contain white spaces nor accentuated letters"));
936 return self::updatePasswordHashed($uid, self::hashPassword($password));
940 * Updates a user row with a new hashed password.
941 * Empties the password reset token field just in case.
944 * @param string $password_hashed
948 private static function updatePasswordHashed(int $uid, string $password_hashed): bool
951 'password' => $password_hashed,
953 'pwdreset_time' => null,
954 'legacy_password' => false
956 return DBA::update('user', $fields, ['uid' => $uid]);
960 * Returns if the given uid is valid and in the admin list
967 public static function isSiteAdmin(int $uid): bool
969 return DBA::exists('user', [
971 'email' => self::getAdminEmailList()
976 * Returns if the given uid is valid and a moderator
983 public static function isModerator(int $uid): bool
985 // @todo Replace with a moderator check in the future
986 return self::isSiteAdmin($uid);
990 * Checks if a nickname is in the list of the forbidden nicknames
992 * Check if a nickname is forbidden from registration on the node by the
993 * admin. Forbidden nicknames (e.g. role names) can be configured in the
996 * @param string $nickname The nickname that should be checked
997 * @return boolean True is the nickname is blocked on the node
999 public static function isNicknameBlocked(string $nickname): bool
1001 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
1002 if (!empty($forbidden_nicknames)) {
1003 $forbidden = explode(',', $forbidden_nicknames);
1004 $forbidden = array_map('trim', $forbidden);
1009 // Add the name of the internal actor to the "forbidden" list
1010 $actor_name = self::getActorName();
1011 if (!empty($actor_name)) {
1012 $forbidden[] = $actor_name;
1015 if (empty($forbidden)) {
1019 // check if the nickname is in the list of blocked nicknames
1020 if (in_array(strtolower($nickname), $forbidden)) {
1024 // else return false
1029 * Get avatar link for given user
1031 * @param array $user
1032 * @param string $size One of the Proxy::SIZE_* constants
1033 * @return string avatar link
1036 public static function getAvatarUrl(array $user, string $size = ''): string
1038 if (empty($user['nickname'])) {
1039 DI::logger()->warning('Missing user nickname key');
1042 $url = DI::baseUrl() . '/photo/';
1045 case Proxy::SIZE_MICRO:
1049 case Proxy::SIZE_THUMB:
1062 $photo = Photo::selectFirst(['type', 'created', 'edited', 'updated'], ["scale" => $scale, 'uid' => $user['uid'], 'profile' => true]);
1063 if (!empty($photo)) {
1064 $updated = max($photo['created'], $photo['edited'], $photo['updated']);
1065 $mimetype = $photo['type'];
1068 return $url . $user['nickname'] . Images::getExtensionByMimeType($mimetype) . ($updated ? '?ts=' . strtotime($updated) : '');
1072 * Get banner link for given user
1074 * @param array $user
1075 * @return string banner link
1078 public static function getBannerUrl(array $user): string
1080 if (empty($user['nickname'])) {
1081 DI::logger()->warning('Missing user nickname key');
1084 $url = DI::baseUrl() . '/photo/banner/';
1089 $photo = Photo::selectFirst(['type', 'created', 'edited', 'updated'], ["scale" => 3, 'uid' => $user['uid'], 'photo-type' => Photo::USER_BANNER]);
1090 if (!empty($photo)) {
1091 $updated = max($photo['created'], $photo['edited'], $photo['updated']);
1092 $mimetype = $photo['type'];
1094 // Only for the RC phase: Don't return an image link for the default picture
1098 return $url . $user['nickname'] . Images::getExtensionByMimeType($mimetype) . ($updated ? '?ts=' . strtotime($updated) : '');
1102 * Catch-all user creation function
1104 * Creates a user from the provided data array, either form fields or OpenID.
1105 * Required: { username, nickname, email } or { openid_url }
1107 * Performs the following:
1108 * - Sends to the OpenId auth URL (if relevant)
1109 * - Creates new key pairs for crypto
1110 * - Create self-contact
1111 * - Create profile image
1113 * @param array $data
1115 * @throws ErrorException
1116 * @throws HTTPException\InternalServerErrorException
1117 * @throws ImagickException
1120 public static function create(array $data): array
1122 $return = ['user' => null, 'password' => ''];
1124 $using_invites = DI::config()->get('system', 'invitation_only');
1126 $invite_id = !empty($data['invite_id']) ? trim($data['invite_id']) : '';
1127 $username = !empty($data['username']) ? trim($data['username']) : '';
1128 $nickname = !empty($data['nickname']) ? trim($data['nickname']) : '';
1129 $email = !empty($data['email']) ? trim($data['email']) : '';
1130 $openid_url = !empty($data['openid_url']) ? trim($data['openid_url']) : '';
1131 $photo = !empty($data['photo']) ? trim($data['photo']) : '';
1132 $password = !empty($data['password']) ? trim($data['password']) : '';
1133 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
1134 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
1135 $blocked = !empty($data['blocked']);
1136 $verified = !empty($data['verified']);
1137 $language = !empty($data['language']) ? trim($data['language']) : 'en';
1139 $netpublish = $publish = !empty($data['profile_publish_reg']);
1141 if ($password1 != $confirm) {
1142 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
1143 } elseif ($password1 != '') {
1144 $password = $password1;
1147 if ($using_invites) {
1149 throw new Exception(DI::l10n()->t('An invitation is required.'));
1152 if (!Register::existsByHash($invite_id)) {
1153 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
1157 /// @todo Check if this part is really needed. We should have fetched all this data in advance
1158 if (empty($username) || empty($email) || empty($nickname)) {
1160 if (!Network::isUrlValid($openid_url)) {
1161 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
1163 $_SESSION['register'] = 1;
1164 $_SESSION['openid'] = $openid_url;
1166 $openid = new LightOpenID(DI::baseUrl()->getHost());
1167 $openid->identity = $openid_url;
1168 $openid->returnUrl = DI::baseUrl() . '/openid';
1169 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
1170 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
1172 $authurl = $openid->authUrl();
1173 } catch (Exception $e) {
1174 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.') . '<br />' . DI::l10n()->t('The error message was:') . $e->getMessage(), 0, $e);
1176 System::externalRedirect($authurl);
1180 throw new Exception(DI::l10n()->t('Please enter the required information.'));
1183 if (!Network::isUrlValid($openid_url)) {
1187 // collapse multiple spaces in name
1188 $username = preg_replace('/ +/', ' ', $username);
1190 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
1191 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
1193 if ($username_min_length > $username_max_length) {
1194 Logger::error(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));
1195 $tmp = $username_min_length;
1196 $username_min_length = $username_max_length;
1197 $username_max_length = $tmp;
1200 if (mb_strlen($username) < $username_min_length) {
1201 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
1204 if (mb_strlen($username) > $username_max_length) {
1205 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
1208 // So now we are just looking for a space in the display name.
1209 $loose_reg = DI::config()->get('system', 'no_regfullname');
1211 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
1212 if (strpos($username, ' ') === false) {
1213 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
1217 if (!Network::isEmailDomainAllowed($email)) {
1218 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
1221 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
1222 throw new Exception(DI::l10n()->t('Not a valid email address.'));
1224 if (self::isNicknameBlocked($nickname)) {
1225 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
1228 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
1229 throw new Exception(DI::l10n()->t('Cannot use that email.'));
1232 // Disallow somebody creating an account using openid that uses the admin email address,
1233 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
1234 if (strlen($openid_url) && in_array(strtolower($email), self::getAdminEmailList())) {
1235 throw new Exception(DI::l10n()->t('Cannot use that email.'));
1238 $nickname = $data['nickname'] = strtolower($nickname);
1240 if (!preg_match('/^[a-z0-9][a-z0-9_]*$/', $nickname)) {
1241 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
1244 // Check existing and deleted accounts for this nickname.
1246 DBA::exists('user', ['nickname' => $nickname])
1247 || DBA::exists('userd', ['username' => $nickname])
1249 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
1252 $new_password = strlen($password) ? $password : User::generateNewPassword();
1253 $new_password_encoded = self::hashPassword($new_password);
1255 $return['password'] = $new_password;
1257 $keys = Crypto::newKeypair(4096);
1258 if ($keys === false) {
1259 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
1262 $prvkey = $keys['prvkey'];
1263 $pubkey = $keys['pubkey'];
1265 // Create another keypair for signing/verifying salmon protocol messages.
1266 $sres = Crypto::newKeypair(512);
1267 $sprvkey = $sres['prvkey'];
1268 $spubkey = $sres['pubkey'];
1270 $insert_result = DBA::insert('user', [
1271 'guid' => System::createUUID(),
1272 'username' => $username,
1273 'password' => $new_password_encoded,
1275 'openid' => $openid_url,
1276 'nickname' => $nickname,
1277 'pubkey' => $pubkey,
1278 'prvkey' => $prvkey,
1279 'spubkey' => $spubkey,
1280 'sprvkey' => $sprvkey,
1281 'verified' => $verified,
1282 'blocked' => $blocked,
1283 'language' => $language,
1284 'timezone' => 'UTC',
1285 'register_date' => DateTimeFormat::utcNow(),
1286 'default-location' => ''
1289 if ($insert_result) {
1290 $uid = DBA::lastInsertId();
1291 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1293 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1297 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1300 // if somebody clicked submit twice very quickly, they could end up with two accounts
1301 // due to race condition. Remove this one.
1302 $user_count = DBA::count('user', ['nickname' => $nickname]);
1303 if ($user_count > 1) {
1304 DBA::delete('user', ['uid' => $uid]);
1306 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
1309 $insert_result = DBA::insert('profile', [
1311 'name' => $username,
1312 'photo' => self::getAvatarUrl($user),
1313 'thumb' => self::getAvatarUrl($user, Proxy::SIZE_THUMB),
1314 'publish' => $publish,
1315 'net-publish' => $netpublish,
1317 if (!$insert_result) {
1318 DBA::delete('user', ['uid' => $uid]);
1320 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
1323 // Create the self contact
1324 if (!Contact::createSelfFromUserId($uid)) {
1325 DBA::delete('user', ['uid' => $uid]);
1327 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
1330 // Create a circle with no members. This allows somebody to use it
1331 // right away as a default circle for new contacts.
1332 $def_gid = Circle::create($uid, DI::l10n()->t('Friends'));
1334 DBA::delete('user', ['uid' => $uid]);
1336 throw new Exception(DI::l10n()->t('An error occurred creating your default contact circle. Please try again.'));
1339 $fields = ['def_gid' => $def_gid];
1340 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
1341 $fields['allow_gid'] = '<' . $def_gid . '>';
1344 DBA::update('user', $fields, ['uid' => $uid]);
1346 $def_gid_groups = Circle::create($uid, DI::l10n()->t('Groups'));
1347 if ($def_gid_groups) {
1348 DI::pConfig()->set($uid, 'system', 'default-group-gid', $def_gid_groups);
1351 // if we have no OpenID photo try to look up an avatar
1352 if (!strlen($photo)) {
1353 $photo = Network::lookupAvatarByEmail($email);
1356 // unless there is no avatar-addon loaded
1357 if (strlen($photo)) {
1358 $photo_failure = false;
1360 $filename = basename($photo);
1361 $curlResult = DI::httpClient()->get($photo, HttpClientAccept::IMAGE);
1362 if ($curlResult->isSuccess()) {
1363 Logger::debug('Got picture', ['Content-Type' => $curlResult->getHeader('Content-Type'), 'url' => $photo]);
1364 $img_str = $curlResult->getBody();
1365 $type = $curlResult->getContentType();
1371 $type = Images::getMimeTypeByData($img_str, $photo, $type);
1373 $image = new Image($img_str, $type);
1374 if ($image->isValid()) {
1375 $image->scaleToSquare(300);
1377 $resource_id = Photo::newResource();
1379 // Not using Photo::PROFILE_PHOTOS here, so that it is discovered as translatable string
1380 $profile_album = DI::l10n()->t('Profile Photos');
1382 $r = Photo::store($image, $uid, 0, $resource_id, $filename, $profile_album, 4);
1385 $photo_failure = true;
1388 $image->scaleDown(80);
1390 $r = Photo::store($image, $uid, 0, $resource_id, $filename, $profile_album, 5);
1393 $photo_failure = true;
1396 $image->scaleDown(48);
1398 $r = Photo::store($image, $uid, 0, $resource_id, $filename, $profile_album, 6);
1401 $photo_failure = true;
1404 if (!$photo_failure) {
1405 Photo::update(['profile' => true, 'photo-type' => Photo::USER_AVATAR], ['resource-id' => $resource_id]);
1409 Contact::updateSelfFromUserID($uid, true);
1412 Hook::callAll('register_account', $uid);
1414 self::setRegisterMethodByUserCount();
1416 $return['user'] = $user;
1421 * Update a user entry and distribute the changes if needed
1423 * @param array $fields
1424 * @param integer $uid
1428 public static function update(array $fields, int $uid): bool
1430 if (!DBA::update('user', $fields, ['uid' => $uid])) {
1434 if (Contact::updateSelfFromUserID($uid)) {
1435 Profile::publishUpdate($uid);
1442 * Sets block state for a given user
1444 * @param int $uid The user id
1445 * @param bool $block Block state (default is true)
1447 * @return bool True, if successfully blocked
1451 public static function block(int $uid, bool $block = true): bool
1453 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
1457 * Allows a registration based on a hash
1459 * @param string $hash
1461 * @return bool True, if the allow was successful
1463 * @throws HTTPException\InternalServerErrorException
1466 public static function allow(string $hash): bool
1468 $register = Register::getByHash($hash);
1469 if (!DBA::isResult($register)) {
1473 $user = User::getById($register['uid']);
1474 if (!DBA::isResult($user)) {
1478 Register::deleteByHash($hash);
1480 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
1482 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
1484 if (DBA::isResult($profile) && $profile['net-publish'] && Search::getGlobalDirectory()) {
1485 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
1486 Worker::add(Worker::PRIORITY_LOW, "Directory", $url);
1489 $l10n = DI::l10n()->withLang($register['language']);
1491 return User::sendRegisterOpenEmail(
1494 DI::config()->get('config', 'sitename'),
1496 ($register['password'] ?? '') ?: 'Sent in a previous email'
1501 * Denys a pending registration
1503 * @param string $hash The hash of the pending user
1505 * This does not have to go through user_remove() and save the nickname
1506 * permanently against re-registration, as the person was not yet
1507 * allowed to have friends on this system
1509 * @return bool True, if the deny was successful
1512 public static function deny(string $hash): bool
1514 $register = Register::getByHash($hash);
1515 if (!DBA::isResult($register)) {
1519 $user = User::getById($register['uid']);
1520 if (!DBA::isResult($user)) {
1524 // Delete the avatar
1525 Photo::delete(['uid' => $register['uid']]);
1527 return DBA::delete('user', ['uid' => $register['uid']]) &&
1528 Register::deleteByHash($register['hash']);
1532 * Creates a new user based on a minimal set and sends an email to this user
1534 * @param string $name The user's name
1535 * @param string $email The user's email address
1536 * @param string $nick The user's nick name
1537 * @param string $lang The user's language (default is english)
1538 * @return bool True, if the user was created successfully
1539 * @throws HTTPException\InternalServerErrorException
1540 * @throws ErrorException
1541 * @throws ImagickException
1543 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT): bool
1548 throw new HTTPException\InternalServerErrorException('Invalid arguments.');
1551 $result = self::create([
1552 'username' => $name,
1554 'nickname' => $nick,
1559 $user = $result['user'];
1560 $preamble = Strings::deindent(DI::l10n()->t('
1562 the administrator of %2$s has set up an account for you.'));
1563 $body = Strings::deindent(DI::l10n()->t('
1564 The login details are as follows:
1570 You may change your password from your account "Settings" page after logging
1573 Please take a few moments to review the other account settings on that page.
1575 You may also wish to add some basic information to your default profile
1576 (on the "Profiles" page) so that other people can easily find you.
1578 We recommend adding a profile photo, adding some profile "keywords"
1579 (very useful in making new friends) - and perhaps what country you live in;
1580 if you do not wish to be more specific than that.
1582 We fully respect your right to privacy, and none of these items are necessary.
1583 If you are new and do not know anybody here, they may help
1584 you to make some new and interesting friends.
1586 If you ever want to delete your account, you can do so at %1$s/settings/removeme
1588 Thank you and welcome to %4$s.'));
1590 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1591 $body = sprintf($body, DI::baseUrl(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1593 $email = DI::emailer()
1595 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1597 ->withRecipient($user['email'])
1599 return DI::emailer()->send($email);
1603 * Sends pending registration confirmation email
1605 * @param array $user User record array
1606 * @param string $sitename
1607 * @param string $siteurl
1608 * @param string $password Plaintext password
1609 * @return NULL|boolean from notification() and email() inherited
1610 * @throws HTTPException\InternalServerErrorException
1612 public static function sendRegisterPendingEmail(array $user, string $sitename, string $siteurl, string $password)
1614 $body = Strings::deindent(DI::l10n()->t(
1617 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1619 Your login details are as follows:
1632 $email = DI::emailer()
1634 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1636 ->withRecipient($user['email'])
1638 return DI::emailer()->send($email);
1642 * Sends registration confirmation
1644 * It's here as a function because the mail is sent from different parts
1646 * @param L10n $l10n The used language
1647 * @param array $user User record array
1648 * @param string $sitename
1649 * @param string $siteurl
1650 * @param string $password Plaintext password
1652 * @return NULL|boolean from notification() and email() inherited
1653 * @throws HTTPException\InternalServerErrorException
1655 public static function sendRegisterOpenEmail(L10n $l10n, array $user, string $sitename, string $siteurl, string $password)
1657 $preamble = Strings::deindent($l10n->t(
1660 Thank you for registering at %2$s. Your account has been created.
1665 $body = Strings::deindent($l10n->t(
1667 The login details are as follows:
1673 You may change your password from your account "Settings" page after logging
1676 Please take a few moments to review the other account settings on that page.
1678 You may also wish to add some basic information to your default profile
1679 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1681 We recommend adding a profile photo, adding some profile "keywords" ' . "\x28" . 'very useful
1682 in making new friends' . "\x29" . ' - and perhaps what country you live in; if you do not wish
1683 to be more specific than that.
1685 We fully respect your right to privacy, and none of these items are necessary.
1686 If you are new and do not know anybody here, they may help
1687 you to make some new and interesting friends.
1689 If you ever want to delete your account, you can do so at %3$s/settings/removeme
1691 Thank you and welcome to %2$s.',
1699 $email = DI::emailer()
1701 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1703 ->withRecipient($user['email'])
1705 return DI::emailer()->send($email);
1709 * @param int $uid user to remove
1711 * @throws HTTPException\InternalServerErrorException
1712 * @throws HTTPException\NotFoundException
1714 public static function remove(int $uid): bool
1717 throw new \InvalidArgumentException('uid needs to be greater than 0');
1720 Logger::notice('Removing user', ['user' => $uid]);
1722 $user = self::getById($uid);
1724 throw new HTTPException\NotFoundException('User not found with uid: ' . $uid);
1727 if (DBA::exists('user', ['parent-uid' => $uid])) {
1728 throw new \RuntimeException(DI::l10n()->t("User with delegates can't be removed, please remove delegate users first"));
1731 Hook::callAll('remove_user', $user);
1733 // save username (actually the nickname as it is guaranteed
1734 // unique), so it cannot be re-registered in the future.
1735 DBA::insert('userd', ['username' => $user['nickname']]);
1737 // Remove all personal settings, especially connector settings
1738 DBA::delete('pconfig', ['uid' => $uid]);
1740 // The user and related data will be deleted in Friendica\Worker\ExpireAndRemoveUsers
1741 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1742 Worker::add(Worker::PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1744 // Send an update to the directory
1745 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1746 Worker::add(Worker::PRIORITY_LOW, 'Directory', $self['url']);
1748 // Remove the user relevant data
1749 Worker::add(Worker::PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1751 self::setRegisterMethodByUserCount();
1756 * Return all identities to a user
1758 * @param int $uid The user id
1759 * @return array All identities for this user
1761 * Example for a return:
1765 * 'username' => 'maxmuster',
1766 * 'nickname' => 'Max Mustermann'
1770 * 'username' => 'johndoe',
1771 * 'nickname' => 'John Doe'
1776 public static function identities(int $uid): array
1784 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid, 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false]);
1785 if (!DBA::isResult($user)) {
1789 if (!$user['parent-uid']) {
1790 // First add our own entry
1792 'uid' => $user['uid'],
1793 'username' => $user['username'],
1794 'nickname' => $user['nickname']
1797 // Then add all the children
1800 ['uid', 'username', 'nickname'],
1801 ['parent-uid' => $user['uid'], 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false]
1803 if (DBA::isResult($r)) {
1804 $identities = array_merge($identities, DBA::toArray($r));
1807 // First entry is our parent
1810 ['uid', 'username', 'nickname'],
1811 ['uid' => $user['parent-uid'], 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false]
1813 if (DBA::isResult($r)) {
1814 $identities = DBA::toArray($r);
1817 // Then add all siblings
1820 ['uid', 'username', 'nickname'],
1821 ['parent-uid' => $user['parent-uid'], 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false]
1823 if (DBA::isResult($r)) {
1824 $identities = array_merge($identities, DBA::toArray($r));
1829 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1831 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1832 WHERE NOT `user`.`account_removed` AND `manage`.`uid` = ?",
1835 if (DBA::isResult($r)) {
1836 $identities = array_merge($identities, DBA::toArray($r));
1843 * Check if the given user id has delegations or is delegated
1848 public static function hasIdentities(int $uid): bool
1854 $user = DBA::selectFirst('user', ['parent-uid'], ['uid' => $uid, 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false]);
1855 if (!DBA::isResult($user)) {
1859 if ($user['parent-uid']) {
1863 if (DBA::exists('user', ['parent-uid' => $uid, 'verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false])) {
1867 if (DBA::exists('manage', ['uid' => $uid])) {
1875 * Returns statistical information about the current users of this node
1881 public static function getStatistics(): array
1885 'active_users_halfyear' => 0,
1886 'active_users_monthly' => 0,
1887 'active_users_weekly' => 0,
1890 $userStmt = DBA::select('owner-view', ['uid', 'last-activity', 'last-item'],
1891 ["`verified` AND `last-activity` > ? AND NOT `blocked`
1892 AND NOT `account_removed` AND NOT `account_expired`",
1893 DBA::NULL_DATETIME]);
1894 if (!DBA::isResult($userStmt)) {
1898 $halfyear = time() - (180 * 24 * 60 * 60);
1899 $month = time() - (30 * 24 * 60 * 60);
1900 $week = time() - (7 * 24 * 60 * 60);
1902 while ($user = DBA::fetch($userStmt)) {
1903 $statistics['total_users']++;
1905 if ((strtotime($user['last-activity']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1907 $statistics['active_users_halfyear']++;
1910 if ((strtotime($user['last-activity']) > $month) || (strtotime($user['last-item']) > $month)
1912 $statistics['active_users_monthly']++;
1915 if ((strtotime($user['last-activity']) > $week) || (strtotime($user['last-item']) > $week)
1917 $statistics['active_users_weekly']++;
1920 DBA::close($userStmt);
1926 * Get all users of the current node
1928 * @param int $start Start count (Default is 0)
1929 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1930 * @param string $type The type of users, which should get (all, blocked, removed)
1931 * @param string $order Order of the user list (Default is 'contact.name')
1932 * @param bool $descending Order direction (Default is ascending)
1933 * @return array|bool The list of the users
1936 public static function getList(int $start = 0, int $count = Pager::ITEMS_PER_PAGE, string $type = 'all', string $order = 'name', bool $descending = false)
1938 $param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
1942 $condition['account_removed'] = false;
1943 $condition['blocked'] = false;
1947 $condition['account_removed'] = false;
1948 $condition['blocked'] = true;
1949 $condition['verified'] = true;
1953 $condition['account_removed'] = true;
1957 return DBA::selectToArray('owner-view', [], $condition, $param);
1961 * Returns a list of lowercase admin email addresses from the comma-separated list in the config
1965 public static function getAdminEmailList(): array
1967 $adminEmails = strtolower(str_replace(' ', '', DI::config()->get('config', 'admin_email')));
1968 if (!$adminEmails) {
1972 return explode(',', $adminEmails);
1976 * Returns the complete list of admin user accounts
1978 * @param array $fields
1982 public static function getAdminList(array $fields = []): array
1985 'email' => self::getAdminEmailList(),
1986 'parent-uid' => null,
1989 'account_removed' => false,
1990 'account_expired' => false,
1993 return DBA::selectToArray('user', $fields, $condition, ['order' => ['uid']]);
1997 * Return a list of admin user accounts where each unique email address appears only once.
1999 * This method is meant for admin notifications that do not need to be sent multiple times to the same email address.
2001 * @param array $fields
2005 public static function getAdminListForEmailing(array $fields = []): array
2007 return array_filter(self::getAdminList($fields), function ($user) {
2008 static $emails = [];
2010 if (in_array($user['email'], $emails)) {
2014 $emails[] = $user['email'];
2020 public static function setRegisterMethodByUserCount()
2022 $max_registered_users = DI::config()->get('config', 'max_registered_users');
2023 if ($max_registered_users <= 0) {
2027 $register_policy = DI::config()->get('config', 'register_policy');
2028 if (!in_array($register_policy, [Module\Register::OPEN, Module\Register::CLOSED])) {
2029 Logger::debug('Unsupported register policy.', ['policy' => $register_policy]);
2033 $users = DBA::count('user', ['blocked' => false, 'account_removed' => false, 'account_expired' => false]);
2034 if (($users >= $max_registered_users) && ($register_policy == Module\Register::OPEN)) {
2035 DI::config()->set('config', 'register_policy', Module\Register::CLOSED);
2036 Logger::notice('Max users reached, registration is closed.', ['users' => $users, 'max' => $max_registered_users]);
2037 } elseif (($users < $max_registered_users) && ($register_policy == Module\Register::CLOSED)) {
2038 DI::config()->set('config', 'register_policy', Module\Register::OPEN);
2039 Logger::notice('Below maximum users, registration is opened.', ['users' => $users, 'max' => $max_registered_users]);
2041 Logger::debug('Unchanged register policy', ['policy' => $register_policy, 'users' => $users, 'max' => $max_registered_users]);