3 * @copyright Copyright (C) 2010-2021, 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\System;
34 use Friendica\Core\Worker;
35 use Friendica\Database\DBA;
37 use Friendica\Security\TwoFactor\Model\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\Proxy;
45 use Friendica\Util\Strings;
46 use Friendica\Worker\Delivery;
51 * This class handles User related functions
58 * PAGE_FLAGS_NORMAL is a typical personal profile account
59 * PAGE_FLAGS_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
60 * PAGE_FLAGS_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
61 * write access to wall and comments (no email and not included in page owner's ACL lists)
62 * PAGE_FLAGS_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
66 const PAGE_FLAGS_NORMAL = 0;
67 const PAGE_FLAGS_SOAPBOX = 1;
68 const PAGE_FLAGS_COMMUNITY = 2;
69 const PAGE_FLAGS_FREELOVE = 3;
70 const PAGE_FLAGS_BLOG = 4;
71 const PAGE_FLAGS_PRVGROUP = 5;
79 * ACCOUNT_TYPE_PERSON - the account belongs to a person
80 * Associated page types: PAGE_FLAGS_NORMAL, PAGE_FLAGS_SOAPBOX, PAGE_FLAGS_FREELOVE
82 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
83 * Associated page type: PAGE_FLAGS_SOAPBOX
85 * ACCOUNT_TYPE_NEWS - the account is a news reflector
86 * Associated page type: PAGE_FLAGS_SOAPBOX
88 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
89 * Associated page types: PAGE_COMMUNITY, PAGE_FLAGS_PRVGROUP
91 * ACCOUNT_TYPE_RELAY - the account is a relay
92 * This will only be assigned to contacts, not to user accounts
95 const ACCOUNT_TYPE_PERSON = 0;
96 const ACCOUNT_TYPE_ORGANISATION = 1;
97 const ACCOUNT_TYPE_NEWS = 2;
98 const ACCOUNT_TYPE_COMMUNITY = 3;
99 const ACCOUNT_TYPE_RELAY = 4;
100 const ACCOUNT_TYPE_DELETED = 127;
105 private static $owner;
108 * Returns the numeric account type by their string
110 * @param string $accounttype as string constant
111 * @return int|null Numeric account type - or null when not set
113 public static function getAccountTypeByString(string $accounttype)
115 switch ($accounttype) {
117 return User::ACCOUNT_TYPE_PERSON;
119 return User::ACCOUNT_TYPE_ORGANISATION;
121 return User::ACCOUNT_TYPE_NEWS;
123 return User::ACCOUNT_TYPE_COMMUNITY;
131 * Fetch the system account
133 * @return array system account
135 public static function getSystemAccount()
137 $system = Contact::selectFirst([], ['self' => true, 'uid' => 0]);
138 if (!DBA::isResult($system)) {
139 self::createSystemAccount();
140 $system = Contact::selectFirst([], ['self' => true, 'uid' => 0]);
141 if (!DBA::isResult($system)) {
146 $system['sprvkey'] = $system['uprvkey'] = $system['prvkey'];
147 $system['spubkey'] = $system['upubkey'] = $system['pubkey'];
148 $system['nickname'] = $system['nick'];
150 // Ensure that the user contains data
151 $user = DBA::selectFirst('user', ['prvkey'], ['uid' => 0]);
152 if (empty($user['prvkey'])) {
154 'username' => $system['name'],
155 'nickname' => $system['nick'],
156 'register_date' => $system['created'],
157 'pubkey' => $system['pubkey'],
158 'prvkey' => $system['prvkey'],
159 'spubkey' => $system['spubkey'],
160 'sprvkey' => $system['sprvkey'],
162 'page-flags' => User::PAGE_FLAGS_SOAPBOX,
163 'account-type' => User::ACCOUNT_TYPE_RELAY,
166 DBA::update('user', $fields, ['uid' => 0]);
173 * Create the system account
177 private static function createSystemAccount()
179 $system_actor_name = self::getActorName();
180 if (empty($system_actor_name)) {
184 $keys = Crypto::newKeypair(4096);
185 if ($keys === false) {
186 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
191 $system['created'] = DateTimeFormat::utcNow();
192 $system['self'] = true;
193 $system['network'] = Protocol::ACTIVITYPUB;
194 $system['name'] = 'System Account';
195 $system['addr'] = $system_actor_name . '@' . DI::baseUrl()->getHostname();
196 $system['nick'] = $system_actor_name;
197 $system['url'] = DI::baseUrl() . '/friendica';
199 $system['avatar'] = $system['photo'] = Contact::getDefaultAvatar($system, Proxy::SIZE_SMALL);
200 $system['thumb'] = Contact::getDefaultAvatar($system, Proxy::SIZE_THUMB);
201 $system['micro'] = Contact::getDefaultAvatar($system, Proxy::SIZE_MICRO);
203 $system['nurl'] = Strings::normaliseLink($system['url']);
204 $system['pubkey'] = $keys['pubkey'];
205 $system['prvkey'] = $keys['prvkey'];
206 $system['blocked'] = 0;
207 $system['pending'] = 0;
208 $system['contact-type'] = Contact::TYPE_RELAY; // In AP this is translated to 'Application'
209 $system['name-date'] = DateTimeFormat::utcNow();
210 $system['uri-date'] = DateTimeFormat::utcNow();
211 $system['avatar-date'] = DateTimeFormat::utcNow();
212 $system['closeness'] = 0;
213 $system['baseurl'] = DI::baseUrl();
214 $system['gsid'] = GServer::getID($system['baseurl']);
215 DBA::insert('contact', $system);
219 * Detect a usable actor name
221 * @return string actor account name
223 public static function getActorName()
225 $system_actor_name = DI::config()->get('system', 'actor_name');
226 if (!empty($system_actor_name)) {
227 $self = Contact::selectFirst(['nick'], ['uid' => 0, 'self' => true]);
228 if (!empty($self['nick'])) {
229 if ($self['nick'] != $system_actor_name) {
230 // Reset the actor name to the already used name
231 DI::config()->set('system', 'actor_name', $self['nick']);
232 $system_actor_name = $self['nick'];
235 return $system_actor_name;
238 // List of possible actor names
239 $possible_accounts = ['friendica', 'actor', 'system', 'internal'];
240 foreach ($possible_accounts as $name) {
241 if (!DBA::exists('user', ['nickname' => $name, 'account_removed' => false, 'expire' => false]) &&
242 !DBA::exists('userd', ['username' => $name])) {
243 DI::config()->set('system', 'actor_name', $name);
251 * Returns true if a user record exists with the provided id
253 * @param integer $uid
257 public static function exists($uid)
259 return DBA::exists('user', ['uid' => $uid]);
263 * @param integer $uid
264 * @param array $fields
265 * @return array|boolean User record if it exists, false otherwise
268 public static function getById($uid, array $fields = [])
270 return !empty($uid) ? DBA::selectFirst('user', $fields, ['uid' => $uid]) : [];
274 * Returns a user record based on it's GUID
276 * @param string $guid The guid of the user
277 * @param array $fields The fields to retrieve
278 * @param bool $active True, if only active records are searched
280 * @return array|boolean User record if it exists, false otherwise
283 public static function getByGuid(string $guid, array $fields = [], bool $active = true)
286 $cond = ['guid' => $guid, 'account_expired' => false, 'account_removed' => false];
288 $cond = ['guid' => $guid];
291 return DBA::selectFirst('user', $fields, $cond);
295 * @param string $nickname
296 * @param array $fields
297 * @return array|boolean User record if it exists, false otherwise
300 public static function getByNickname($nickname, array $fields = [])
302 return DBA::selectFirst('user', $fields, ['nickname' => $nickname]);
306 * Returns the user id of a given profile URL
310 * @return integer user id
313 public static function getIdForURL(string $url)
315 // Avoid any database requests when the hostname isn't even part of the url.
316 if (!strpos($url, DI::baseUrl()->getHostname())) {
320 $self = Contact::selectFirst(['uid'], ['self' => true, 'nurl' => Strings::normaliseLink($url)]);
321 if (!empty($self['uid'])) {
325 $self = Contact::selectFirst(['uid'], ['self' => true, 'addr' => $url]);
326 if (!empty($self['uid'])) {
330 $self = Contact::selectFirst(['uid'], ['self' => true, 'alias' => [$url, Strings::normaliseLink($url)]]);
331 if (!empty($self['uid'])) {
339 * Get a user based on its email
341 * @param string $email
342 * @param array $fields
344 * @return array|boolean User record if it exists, false otherwise
348 public static function getByEmail($email, array $fields = [])
350 return DBA::selectFirst('user', $fields, ['email' => $email]);
354 * Fetch the user array of the administrator. The first one if there are several.
356 * @param array $fields
359 public static function getFirstAdmin(array $fields = [])
361 if (!empty(DI::config()->get('config', 'admin_nickname'))) {
362 return self::getByNickname(DI::config()->get('config', 'admin_nickname'), $fields);
363 } elseif (!empty(DI::config()->get('config', 'admin_email'))) {
364 $adminList = explode(',', str_replace(' ', '', DI::config()->get('config', 'admin_email')));
365 return self::getByEmail($adminList[0], $fields);
372 * Get owner data by user id
375 * @param boolean $repairMissing Repair the owner data if it's missing
376 * @return boolean|array
379 public static function getOwnerDataById(int $uid, bool $repairMissing = true)
382 return self::getSystemAccount();
385 if (!empty(self::$owner[$uid])) {
386 return self::$owner[$uid];
389 $owner = DBA::selectFirst('owner-view', [], ['uid' => $uid]);
390 if (!DBA::isResult($owner)) {
391 if (!DBA::exists('user', ['uid' => $uid]) || !$repairMissing) {
394 Contact::createSelfFromUserId($uid);
395 $owner = self::getOwnerDataById($uid, false);
398 if (empty($owner['nickname'])) {
402 if (!$repairMissing || $owner['account_expired']) {
406 // Check if the returned data is valid, otherwise fix it. See issue #6122
408 // Check for correct url and normalised nurl
409 $url = DI::baseUrl() . '/profile/' . $owner['nickname'];
410 $repair = ($owner['url'] != $url) || ($owner['nurl'] != Strings::normaliseLink($owner['url']));
413 // Check if "addr" is present and correct
414 $addr = $owner['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
415 $repair = ($addr != $owner['addr']) || empty($owner['prvkey']) || empty($owner['pubkey']);
419 // Check if the avatar field is filled and the photo directs to the correct path
420 $avatar = Photo::selectFirst(['resource-id'], ['uid' => $uid, 'profile' => true]);
421 if (DBA::isResult($avatar)) {
422 $repair = empty($owner['avatar']) || !strpos($owner['photo'], $avatar['resource-id']);
427 Contact::updateSelfFromUserID($uid);
428 // Return the corrected data and avoid a loop
429 $owner = self::getOwnerDataById($uid, false);
432 self::$owner[$uid] = $owner;
437 * Get owner data by nick name
440 * @return boolean|array
443 public static function getOwnerDataByNick($nick)
445 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
447 if (!DBA::isResult($user)) {
451 return self::getOwnerDataById($user['uid']);
455 * Returns the default group for a given user and network
457 * @param int $uid User id
458 * @param string $network network name
460 * @return int group id
463 public static function getDefaultGroup($uid, $network = '')
467 if ($network == Protocol::OSTATUS) {
468 $default_group = DI::pConfig()->get($uid, "ostatus", "default_group");
471 if ($default_group != 0) {
472 return $default_group;
475 $user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
477 if (DBA::isResult($user)) {
478 $default_group = $user["def_gid"];
481 return $default_group;
486 * Authenticate a user with a clear text password
488 * @param mixed $user_info
489 * @param string $password
490 * @param bool $third_party
491 * @return int|boolean
492 * @deprecated since version 3.6
493 * @see User::getIdFromPasswordAuthentication()
495 public static function authenticate($user_info, $password, $third_party = false)
498 return self::getIdFromPasswordAuthentication($user_info, $password, $third_party);
499 } catch (Exception $ex) {
505 * Authenticate a user with a clear text password
507 * Returns the user id associated with a successful password authentication
509 * @param mixed $user_info
510 * @param string $password
511 * @param bool $third_party
512 * @return int User Id if authentication is successful
513 * @throws HTTPException\ForbiddenException
514 * @throws HTTPException\NotFoundException
516 public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
518 // Addons registered with the "authenticate" hook may create the user on the
519 // fly. `getAuthenticationInfo` will fail if the user doesn't exist yet. If
520 // the user doesn't exist, we should give the addons a chance to create the
521 // user in our database, if applicable, before re-throwing the exception if
524 $user = self::getAuthenticationInfo($user_info);
525 } catch (Exception $e) {
526 if (is_string($user_info)) {
527 return self::getIdFromAuthenticateHooks($user_info, $password);
533 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
534 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
535 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
538 } elseif (strpos($user['password'], '$') === false) {
539 //Legacy hash that has not been replaced by a new hash yet
540 if (self::hashPasswordLegacy($password) === $user['password']) {
541 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
545 } elseif (!empty($user['legacy_password'])) {
546 //Legacy hash that has been double-hashed and not replaced by a new hash yet
547 //Warning: `legacy_password` is not necessary in sync with the content of `password`
548 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
549 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
553 } elseif (password_verify($password, $user['password'])) {
555 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
556 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
561 return self::getIdFromAuthenticateHooks($user['nickname'], $password); // throws
564 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
568 * Try to obtain a user ID via "authenticate" hook addons
570 * Returns the user id associated with a successful password authentication
572 * @param string $username
573 * @param string $password
574 * @return int User Id if authentication is successful
575 * @throws HTTPException\ForbiddenException
577 public static function getIdFromAuthenticateHooks($username, $password) {
579 'username' => $username,
580 'password' => $password,
581 'authenticated' => 0,
582 'user_record' => null
586 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
587 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
588 * and later addons should not interfere with an earlier one that succeeded.
590 Hook::callAll('authenticate', $addon_auth);
592 if ($addon_auth['authenticated'] && $addon_auth['user_record']) {
596 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
600 * Returns authentication info from various parameters types
602 * User info can be any of the following:
605 * - User email or username or nickname
606 * - User array with at least the uid and the hashed password
608 * @param mixed $user_info
610 * @throws HTTPException\NotFoundException
612 public static function getAuthenticationInfo($user_info)
616 if (is_object($user_info) || is_array($user_info)) {
617 if (is_object($user_info)) {
618 $user = (array) $user_info;
625 || !isset($user['password'])
626 || !isset($user['legacy_password'])
628 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
630 } elseif (is_int($user_info) || is_string($user_info)) {
631 if (is_int($user_info)) {
632 $user = DBA::selectFirst(
634 ['uid', 'nickname', 'password', 'legacy_password'],
638 'account_expired' => 0,
639 'account_removed' => 0,
644 $fields = ['uid', 'nickname', 'password', 'legacy_password'];
646 "(`email` = ? OR `username` = ? OR `nickname` = ?)
647 AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
648 $user_info, $user_info, $user_info
650 $user = DBA::selectFirst('user', $fields, $condition);
653 if (!DBA::isResult($user)) {
654 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
662 * Generates a human-readable random password
667 public static function generateNewPassword()
669 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
673 * Checks if the provided plaintext password has been exposed or not
675 * @param string $password
679 public static function isPasswordExposed($password)
681 $cache = new CacheItemPool();
682 $cache->changeConfig([
683 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
687 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
689 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
690 } catch (Exception $e) {
691 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
692 'code' => $e->getCode(),
693 'file' => $e->getFile(),
694 'line' => $e->getLine(),
695 'trace' => $e->getTraceAsString()
703 * Legacy hashing function, kept for password migration purposes
705 * @param string $password
708 private static function hashPasswordLegacy($password)
710 return hash('whirlpool', $password);
714 * Global user password hashing function
716 * @param string $password
720 public static function hashPassword($password)
722 if (!trim($password)) {
723 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
726 return password_hash($password, PASSWORD_DEFAULT);
730 * Updates a user row with a new plaintext password
733 * @param string $password
737 public static function updatePassword($uid, $password)
739 $password = trim($password);
741 if (empty($password)) {
742 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
745 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
746 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
749 $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
751 if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
752 throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
755 return self::updatePasswordHashed($uid, self::hashPassword($password));
759 * Updates a user row with a new hashed password.
760 * Empties the password reset token field just in case.
763 * @param string $pasword_hashed
767 private static function updatePasswordHashed($uid, $pasword_hashed)
770 'password' => $pasword_hashed,
772 'pwdreset_time' => null,
773 'legacy_password' => false
775 return DBA::update('user', $fields, ['uid' => $uid]);
779 * Checks if a nickname is in the list of the forbidden nicknames
781 * Check if a nickname is forbidden from registration on the node by the
782 * admin. Forbidden nicknames (e.g. role namess) can be configured in the
785 * @param string $nickname The nickname that should be checked
786 * @return boolean True is the nickname is blocked on the node
788 public static function isNicknameBlocked($nickname)
790 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
791 if (!empty($forbidden_nicknames)) {
792 $forbidden = explode(',', $forbidden_nicknames);
793 $forbidden = array_map('trim', $forbidden);
798 // Add the name of the internal actor to the "forbidden" list
799 $actor_name = self::getActorName();
800 if (!empty($actor_name)) {
801 $forbidden[] = $actor_name;
804 if (empty($forbidden)) {
808 // check if the nickname is in the list of blocked nicknames
809 if (in_array(strtolower($nickname), $forbidden)) {
818 * Catch-all user creation function
820 * Creates a user from the provided data array, either form fields or OpenID.
821 * Required: { username, nickname, email } or { openid_url }
823 * Performs the following:
824 * - Sends to the OpenId auth URL (if relevant)
825 * - Creates new key pairs for crypto
826 * - Create self-contact
827 * - Create profile image
831 * @throws ErrorException
832 * @throws HTTPException\InternalServerErrorException
833 * @throws ImagickException
836 public static function create(array $data)
838 $return = ['user' => null, 'password' => ''];
840 $using_invites = DI::config()->get('system', 'invitation_only');
842 $invite_id = !empty($data['invite_id']) ? Strings::escapeTags(trim($data['invite_id'])) : '';
843 $username = !empty($data['username']) ? Strings::escapeTags(trim($data['username'])) : '';
844 $nickname = !empty($data['nickname']) ? Strings::escapeTags(trim($data['nickname'])) : '';
845 $email = !empty($data['email']) ? Strings::escapeTags(trim($data['email'])) : '';
846 $openid_url = !empty($data['openid_url']) ? Strings::escapeTags(trim($data['openid_url'])) : '';
847 $photo = !empty($data['photo']) ? Strings::escapeTags(trim($data['photo'])) : '';
848 $password = !empty($data['password']) ? trim($data['password']) : '';
849 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
850 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
851 $blocked = !empty($data['blocked']);
852 $verified = !empty($data['verified']);
853 $language = !empty($data['language']) ? Strings::escapeTags(trim($data['language'])) : 'en';
855 $netpublish = $publish = !empty($data['profile_publish_reg']);
857 if ($password1 != $confirm) {
858 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
859 } elseif ($password1 != '') {
860 $password = $password1;
863 if ($using_invites) {
865 throw new Exception(DI::l10n()->t('An invitation is required.'));
868 if (!Register::existsByHash($invite_id)) {
869 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
873 /// @todo Check if this part is really needed. We should have fetched all this data in advance
874 if (empty($username) || empty($email) || empty($nickname)) {
876 if (!Network::isUrlValid($openid_url)) {
877 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
879 $_SESSION['register'] = 1;
880 $_SESSION['openid'] = $openid_url;
882 $openid = new LightOpenID(DI::baseUrl()->getHostname());
883 $openid->identity = $openid_url;
884 $openid->returnUrl = DI::baseUrl() . '/openid';
885 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
886 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
888 $authurl = $openid->authUrl();
889 } catch (Exception $e) {
890 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);
892 System::externalRedirect($authurl);
896 throw new Exception(DI::l10n()->t('Please enter the required information.'));
899 if (!Network::isUrlValid($openid_url)) {
903 // collapse multiple spaces in name
904 $username = preg_replace('/ +/', ' ', $username);
906 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
907 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
909 if ($username_min_length > $username_max_length) {
910 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);
911 $tmp = $username_min_length;
912 $username_min_length = $username_max_length;
913 $username_max_length = $tmp;
916 if (mb_strlen($username) < $username_min_length) {
917 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
920 if (mb_strlen($username) > $username_max_length) {
921 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
924 // So now we are just looking for a space in the full name.
925 $loose_reg = DI::config()->get('system', 'no_regfullname');
927 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
928 if (strpos($username, ' ') === false) {
929 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
933 if (!Network::isEmailDomainAllowed($email)) {
934 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
937 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
938 throw new Exception(DI::l10n()->t('Not a valid email address.'));
940 if (self::isNicknameBlocked($nickname)) {
941 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
944 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
945 throw new Exception(DI::l10n()->t('Cannot use that email.'));
948 // Disallow somebody creating an account using openid that uses the admin email address,
949 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
950 if (DI::config()->get('config', 'admin_email') && strlen($openid_url)) {
951 $adminlist = explode(',', str_replace(' ', '', strtolower(DI::config()->get('config', 'admin_email'))));
952 if (in_array(strtolower($email), $adminlist)) {
953 throw new Exception(DI::l10n()->t('Cannot use that email.'));
957 $nickname = $data['nickname'] = strtolower($nickname);
959 if (!preg_match('/^[a-z0-9][a-z0-9_]*$/', $nickname)) {
960 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
963 // Check existing and deleted accounts for this nickname.
965 DBA::exists('user', ['nickname' => $nickname])
966 || DBA::exists('userd', ['username' => $nickname])
968 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
971 $new_password = strlen($password) ? $password : User::generateNewPassword();
972 $new_password_encoded = self::hashPassword($new_password);
974 $return['password'] = $new_password;
976 $keys = Crypto::newKeypair(4096);
977 if ($keys === false) {
978 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
981 $prvkey = $keys['prvkey'];
982 $pubkey = $keys['pubkey'];
984 // Create another keypair for signing/verifying salmon protocol messages.
985 $sres = Crypto::newKeypair(512);
986 $sprvkey = $sres['prvkey'];
987 $spubkey = $sres['pubkey'];
989 $insert_result = DBA::insert('user', [
990 'guid' => System::createUUID(),
991 'username' => $username,
992 'password' => $new_password_encoded,
994 'openid' => $openid_url,
995 'nickname' => $nickname,
998 'spubkey' => $spubkey,
999 'sprvkey' => $sprvkey,
1000 'verified' => $verified,
1001 'blocked' => $blocked,
1002 'language' => $language,
1003 'timezone' => 'UTC',
1004 'register_date' => DateTimeFormat::utcNow(),
1005 'default-location' => ''
1008 if ($insert_result) {
1009 $uid = DBA::lastInsertId();
1010 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1012 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1016 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1019 // if somebody clicked submit twice very quickly, they could end up with two accounts
1020 // due to race condition. Remove this one.
1021 $user_count = DBA::count('user', ['nickname' => $nickname]);
1022 if ($user_count > 1) {
1023 DBA::delete('user', ['uid' => $uid]);
1025 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
1028 $insert_result = DBA::insert('profile', [
1030 'name' => $username,
1031 'photo' => DI::baseUrl() . "/photo/profile/{$uid}.jpg",
1032 'thumb' => DI::baseUrl() . "/photo/avatar/{$uid}.jpg",
1033 'publish' => $publish,
1034 'net-publish' => $netpublish,
1036 if (!$insert_result) {
1037 DBA::delete('user', ['uid' => $uid]);
1039 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
1042 // Create the self contact
1043 if (!Contact::createSelfFromUserId($uid)) {
1044 DBA::delete('user', ['uid' => $uid]);
1046 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
1049 // Create a group with no members. This allows somebody to use it
1050 // right away as a default group for new contacts.
1051 $def_gid = Group::create($uid, DI::l10n()->t('Friends'));
1053 DBA::delete('user', ['uid' => $uid]);
1055 throw new Exception(DI::l10n()->t('An error occurred creating your default contact group. Please try again.'));
1058 $fields = ['def_gid' => $def_gid];
1059 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
1060 $fields['allow_gid'] = '<' . $def_gid . '>';
1063 DBA::update('user', $fields, ['uid' => $uid]);
1065 // if we have no OpenID photo try to look up an avatar
1066 if (!strlen($photo)) {
1067 $photo = Network::lookupAvatarByEmail($email);
1070 // unless there is no avatar-addon loaded
1071 if (strlen($photo)) {
1072 $photo_failure = false;
1074 $filename = basename($photo);
1075 $curlResult = DI::httpRequest()->get($photo);
1076 if ($curlResult->isSuccess()) {
1077 $img_str = $curlResult->getBody();
1078 $type = $curlResult->getContentType();
1084 $type = Images::getMimeTypeByData($img_str, $photo, $type);
1086 $Image = new Image($img_str, $type);
1087 if ($Image->isValid()) {
1088 $Image->scaleToSquare(300);
1090 $resource_id = Photo::newResource();
1092 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 4);
1095 $photo_failure = true;
1098 $Image->scaleDown(80);
1100 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 5);
1103 $photo_failure = true;
1106 $Image->scaleDown(48);
1108 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 6);
1111 $photo_failure = true;
1114 if (!$photo_failure) {
1115 Photo::update(['profile' => 1], ['resource-id' => $resource_id]);
1120 Hook::callAll('register_account', $uid);
1122 $return['user'] = $user;
1127 * Sets block state for a given user
1129 * @param int $uid The user id
1130 * @param bool $block Block state (default is true)
1132 * @return bool True, if successfully blocked
1136 public static function block(int $uid, bool $block = true)
1138 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
1142 * Allows a registration based on a hash
1144 * @param string $hash
1146 * @return bool True, if the allow was successful
1148 * @throws HTTPException\InternalServerErrorException
1151 public static function allow(string $hash)
1153 $register = Register::getByHash($hash);
1154 if (!DBA::isResult($register)) {
1158 $user = User::getById($register['uid']);
1159 if (!DBA::isResult($user)) {
1163 Register::deleteByHash($hash);
1165 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
1167 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
1169 if (DBA::isResult($profile) && $profile['net-publish'] && DI::config()->get('system', 'directory')) {
1170 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
1171 Worker::add(PRIORITY_LOW, "Directory", $url);
1174 $l10n = DI::l10n()->withLang($register['language']);
1176 return User::sendRegisterOpenEmail(
1179 DI::config()->get('config', 'sitename'),
1180 DI::baseUrl()->get(),
1181 ($register['password'] ?? '') ?: 'Sent in a previous email'
1186 * Denys a pending registration
1188 * @param string $hash The hash of the pending user
1190 * This does not have to go through user_remove() and save the nickname
1191 * permanently against re-registration, as the person was not yet
1192 * allowed to have friends on this system
1194 * @return bool True, if the deny was successfull
1197 public static function deny(string $hash)
1199 $register = Register::getByHash($hash);
1200 if (!DBA::isResult($register)) {
1204 $user = User::getById($register['uid']);
1205 if (!DBA::isResult($user)) {
1209 // Delete the avatar
1210 Photo::delete(['uid' => $register['uid']]);
1212 return DBA::delete('user', ['uid' => $register['uid']]) &&
1213 Register::deleteByHash($register['hash']);
1217 * Creates a new user based on a minimal set and sends an email to this user
1219 * @param string $name The user's name
1220 * @param string $email The user's email address
1221 * @param string $nick The user's nick name
1222 * @param string $lang The user's language (default is english)
1224 * @return bool True, if the user was created successfully
1225 * @throws HTTPException\InternalServerErrorException
1226 * @throws ErrorException
1227 * @throws ImagickException
1229 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
1234 throw new HTTPException\InternalServerErrorException('Invalid arguments.');
1237 $result = self::create([
1238 'username' => $name,
1240 'nickname' => $nick,
1245 $user = $result['user'];
1246 $preamble = Strings::deindent(DI::l10n()->t('
1248 the administrator of %2$s has set up an account for you.'));
1249 $body = Strings::deindent(DI::l10n()->t('
1250 The login details are as follows:
1256 You may change your password from your account "Settings" page after logging
1259 Please take a few moments to review the other account settings on that page.
1261 You may also wish to add some basic information to your default profile
1262 (on the "Profiles" page) so that other people can easily find you.
1264 We recommend setting your full name, adding a profile photo,
1265 adding some profile "keywords" (very useful in making new friends) - and
1266 perhaps what country you live in; if you do not wish to be more specific
1269 We fully respect your right to privacy, and none of these items are necessary.
1270 If you are new and do not know anybody here, they may help
1271 you to make some new and interesting friends.
1273 If you ever want to delete your account, you can do so at %1$s/removeme
1275 Thank you and welcome to %4$s.'));
1277 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1278 $body = sprintf($body, DI::baseUrl()->get(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1280 $email = DI::emailer()
1282 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1284 ->withRecipient($user['email'])
1286 return DI::emailer()->send($email);
1290 * Sends pending registration confirmation email
1292 * @param array $user User record array
1293 * @param string $sitename
1294 * @param string $siteurl
1295 * @param string $password Plaintext password
1296 * @return NULL|boolean from notification() and email() inherited
1297 * @throws HTTPException\InternalServerErrorException
1299 public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
1301 $body = Strings::deindent(DI::l10n()->t(
1304 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1306 Your login details are as follows:
1319 $email = DI::emailer()
1321 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1323 ->withRecipient($user['email'])
1325 return DI::emailer()->send($email);
1329 * Sends registration confirmation
1331 * It's here as a function because the mail is sent from different parts
1333 * @param L10n $l10n The used language
1334 * @param array $user User record array
1335 * @param string $sitename
1336 * @param string $siteurl
1337 * @param string $password Plaintext password
1339 * @return NULL|boolean from notification() and email() inherited
1340 * @throws HTTPException\InternalServerErrorException
1342 public static function sendRegisterOpenEmail(L10n $l10n, $user, $sitename, $siteurl, $password)
1344 $preamble = Strings::deindent($l10n->t(
1347 Thank you for registering at %2$s. Your account has been created.
1352 $body = Strings::deindent($l10n->t(
1354 The login details are as follows:
1360 You may change your password from your account "Settings" page after logging
1363 Please take a few moments to review the other account settings on that page.
1365 You may also wish to add some basic information to your default profile
1366 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1368 We recommend setting your full name, adding a profile photo,
1369 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
1370 perhaps what country you live in; if you do not wish to be more specific
1373 We fully respect your right to privacy, and none of these items are necessary.
1374 If you are new and do not know anybody here, they may help
1375 you to make some new and interesting friends.
1377 If you ever want to delete your account, you can do so at %3$s/removeme
1379 Thank you and welcome to %2$s.',
1387 $email = DI::emailer()
1389 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1391 ->withRecipient($user['email'])
1393 return DI::emailer()->send($email);
1397 * @param int $uid user to remove
1399 * @throws HTTPException\InternalServerErrorException
1401 public static function remove(int $uid)
1407 Logger::log('Removing user: ' . $uid);
1409 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1411 Hook::callAll('remove_user', $user);
1413 // save username (actually the nickname as it is guaranteed
1414 // unique), so it cannot be re-registered in the future.
1415 DBA::insert('userd', ['username' => $user['nickname']]);
1417 // Remove all personal settings, especially connector settings
1418 DBA::delete('pconfig', ['uid' => $uid]);
1420 // The user and related data will be deleted in Friendica\Worker\ExpireAndRemoveUsers
1421 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1422 Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1424 // Send an update to the directory
1425 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1426 Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
1428 // Remove the user relevant data
1429 Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1435 * Return all identities to a user
1437 * @param int $uid The user id
1438 * @return array All identities for this user
1440 * Example for a return:
1444 * 'username' => 'maxmuster',
1445 * 'nickname' => 'Max Mustermann'
1449 * 'username' => 'johndoe',
1450 * 'nickname' => 'John Doe'
1455 public static function identities($uid)
1459 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid]);
1460 if (!DBA::isResult($user)) {
1464 if ($user['parent-uid'] == 0) {
1465 // First add our own entry
1467 'uid' => $user['uid'],
1468 'username' => $user['username'],
1469 'nickname' => $user['nickname']
1472 // Then add all the children
1475 ['uid', 'username', 'nickname'],
1476 ['parent-uid' => $user['uid'], 'account_removed' => false]
1478 if (DBA::isResult($r)) {
1479 $identities = array_merge($identities, DBA::toArray($r));
1482 // First entry is our parent
1485 ['uid', 'username', 'nickname'],
1486 ['uid' => $user['parent-uid'], 'account_removed' => false]
1488 if (DBA::isResult($r)) {
1489 $identities = DBA::toArray($r);
1492 // Then add all siblings
1495 ['uid', 'username', 'nickname'],
1496 ['parent-uid' => $user['parent-uid'], 'account_removed' => false]
1498 if (DBA::isResult($r)) {
1499 $identities = array_merge($identities, DBA::toArray($r));
1504 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1506 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1507 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
1510 if (DBA::isResult($r)) {
1511 $identities = array_merge($identities, DBA::toArray($r));
1518 * Returns statistical information about the current users of this node
1524 public static function getStatistics()
1528 'active_users_halfyear' => 0,
1529 'active_users_monthly' => 0,
1530 'active_users_weekly' => 0,
1533 $userStmt = DBA::select('owner-view', ['uid', 'login_date', 'last-item'],
1534 ["`verified` AND `login_date` > ? AND NOT `blocked`
1535 AND NOT `account_removed` AND NOT `account_expired`",
1536 DBA::NULL_DATETIME]);
1537 if (!DBA::isResult($userStmt)) {
1541 $halfyear = time() - (180 * 24 * 60 * 60);
1542 $month = time() - (30 * 24 * 60 * 60);
1543 $week = time() - (7 * 24 * 60 * 60);
1545 while ($user = DBA::fetch($userStmt)) {
1546 $statistics['total_users']++;
1548 if ((strtotime($user['login_date']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1550 $statistics['active_users_halfyear']++;
1553 if ((strtotime($user['login_date']) > $month) || (strtotime($user['last-item']) > $month)
1555 $statistics['active_users_monthly']++;
1558 if ((strtotime($user['login_date']) > $week) || (strtotime($user['last-item']) > $week)
1560 $statistics['active_users_weekly']++;
1563 DBA::close($userStmt);
1569 * Get all users of the current node
1571 * @param int $start Start count (Default is 0)
1572 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1573 * @param string $type The type of users, which should get (all, bocked, removed)
1574 * @param string $order Order of the user list (Default is 'contact.name')
1575 * @param bool $descending Order direction (Default is ascending)
1577 * @return array The list of the users
1580 public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'name', bool $descending = false)
1582 $param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
1586 $condition['account_removed'] = false;
1587 $condition['blocked'] = false;
1590 $condition['account_removed'] = false;
1591 $condition['blocked'] = true;
1592 $condition['verified'] = true;
1595 $condition['account_removed'] = true;
1599 return DBA::selectToArray('owner-view', [], $condition, $param);