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 database queries when the local node hostname isn't even part of the url.
316 if (!Contact::isLocal($url)) {
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 if (!DBA::exists('profile', ['uid' => $uid])) {
395 DBA::insert('profile', ['uid' => $uid]);
397 if (!DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
398 Contact::createSelfFromUserId($uid);
400 $owner = self::getOwnerDataById($uid, false);
403 if (empty($owner['nickname'])) {
407 if (!$repairMissing || $owner['account_expired']) {
411 // Check if the returned data is valid, otherwise fix it. See issue #6122
413 // Check for correct url and normalised nurl
414 $url = DI::baseUrl() . '/profile/' . $owner['nickname'];
415 $repair = ($owner['url'] != $url) || ($owner['nurl'] != Strings::normaliseLink($owner['url']));
418 // Check if "addr" is present and correct
419 $addr = $owner['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
420 $repair = ($addr != $owner['addr']) || empty($owner['prvkey']) || empty($owner['pubkey']);
424 // Check if the avatar field is filled and the photo directs to the correct path
425 $avatar = Photo::selectFirst(['resource-id'], ['uid' => $uid, 'profile' => true]);
426 if (DBA::isResult($avatar)) {
427 $repair = empty($owner['avatar']) || !strpos($owner['photo'], $avatar['resource-id']);
432 Contact::updateSelfFromUserID($uid);
433 // Return the corrected data and avoid a loop
434 $owner = self::getOwnerDataById($uid, false);
437 self::$owner[$uid] = $owner;
442 * Get owner data by nick name
445 * @return boolean|array
448 public static function getOwnerDataByNick($nick)
450 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
452 if (!DBA::isResult($user)) {
456 return self::getOwnerDataById($user['uid']);
460 * Returns the default group for a given user and network
462 * @param int $uid User id
463 * @param string $network network name
465 * @return int group id
468 public static function getDefaultGroup($uid, $network = '')
472 if ($network == Protocol::OSTATUS) {
473 $default_group = DI::pConfig()->get($uid, "ostatus", "default_group");
476 if ($default_group != 0) {
477 return $default_group;
480 $user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
482 if (DBA::isResult($user)) {
483 $default_group = $user["def_gid"];
486 return $default_group;
491 * Authenticate a user with a clear text password
493 * @param mixed $user_info
494 * @param string $password
495 * @param bool $third_party
496 * @return int|boolean
497 * @deprecated since version 3.6
498 * @see User::getIdFromPasswordAuthentication()
500 public static function authenticate($user_info, $password, $third_party = false)
503 return self::getIdFromPasswordAuthentication($user_info, $password, $third_party);
504 } catch (Exception $ex) {
510 * Authenticate a user with a clear text password
512 * Returns the user id associated with a successful password authentication
514 * @param mixed $user_info
515 * @param string $password
516 * @param bool $third_party
517 * @return int User Id if authentication is successful
518 * @throws HTTPException\ForbiddenException
519 * @throws HTTPException\NotFoundException
521 public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
523 // Addons registered with the "authenticate" hook may create the user on the
524 // fly. `getAuthenticationInfo` will fail if the user doesn't exist yet. If
525 // the user doesn't exist, we should give the addons a chance to create the
526 // user in our database, if applicable, before re-throwing the exception if
529 $user = self::getAuthenticationInfo($user_info);
530 } catch (Exception $e) {
531 $username = (is_string($user_info) ? $user_info : $user_info['nickname'] ?? '');
533 // Addons can create users, and since this 'catch' branch should only
534 // execute if getAuthenticationInfo can't find an existing user, that's
535 // exactly what will happen here. Creating a numeric username would create
536 // abiguity with user IDs, possibly opening up an attack vector.
537 // So let's be very careful about that.
538 if (empty($username) || is_numeric($username)) {
542 return self::getIdFromAuthenticateHooks($username, $password);
545 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
546 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
547 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
550 } elseif (strpos($user['password'], '$') === false) {
551 //Legacy hash that has not been replaced by a new hash yet
552 if (self::hashPasswordLegacy($password) === $user['password']) {
553 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
557 } elseif (!empty($user['legacy_password'])) {
558 //Legacy hash that has been double-hashed and not replaced by a new hash yet
559 //Warning: `legacy_password` is not necessary in sync with the content of `password`
560 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
561 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
565 } elseif (password_verify($password, $user['password'])) {
567 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
568 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
573 return self::getIdFromAuthenticateHooks($user['nickname'], $password); // throws
576 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
580 * Try to obtain a user ID via "authenticate" hook addons
582 * Returns the user id associated with a successful password authentication
584 * @param string $username
585 * @param string $password
586 * @return int User Id if authentication is successful
587 * @throws HTTPException\ForbiddenException
589 public static function getIdFromAuthenticateHooks($username, $password)
592 'username' => $username,
593 'password' => $password,
594 'authenticated' => 0,
595 'user_record' => null
599 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
600 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
601 * and later addons should not interfere with an earlier one that succeeded.
603 Hook::callAll('authenticate', $addon_auth);
605 if ($addon_auth['authenticated'] && $addon_auth['user_record']) {
606 return $addon_auth['user_record']['uid'];
609 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
613 * Returns authentication info from various parameters types
615 * User info can be any of the following:
618 * - User email or username or nickname
619 * - User array with at least the uid and the hashed password
621 * @param mixed $user_info
623 * @throws HTTPException\NotFoundException
625 public static function getAuthenticationInfo($user_info)
629 if (is_object($user_info) || is_array($user_info)) {
630 if (is_object($user_info)) {
631 $user = (array) $user_info;
638 || !isset($user['password'])
639 || !isset($user['legacy_password'])
641 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
643 } elseif (is_int($user_info) || is_string($user_info)) {
644 if (is_int($user_info)) {
645 $user = DBA::selectFirst(
647 ['uid', 'nickname', 'password', 'legacy_password'],
651 'account_expired' => 0,
652 'account_removed' => 0,
657 $fields = ['uid', 'nickname', 'password', 'legacy_password'];
659 "(`email` = ? OR `username` = ? OR `nickname` = ?)
660 AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
661 $user_info, $user_info, $user_info
663 $user = DBA::selectFirst('user', $fields, $condition);
666 if (!DBA::isResult($user)) {
667 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
675 * Generates a human-readable random password
680 public static function generateNewPassword()
682 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
686 * Checks if the provided plaintext password has been exposed or not
688 * @param string $password
692 public static function isPasswordExposed($password)
694 $cache = new CacheItemPool();
695 $cache->changeConfig([
696 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
700 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
702 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
703 } catch (Exception $e) {
704 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
705 'code' => $e->getCode(),
706 'file' => $e->getFile(),
707 'line' => $e->getLine(),
708 'trace' => $e->getTraceAsString()
716 * Legacy hashing function, kept for password migration purposes
718 * @param string $password
721 private static function hashPasswordLegacy($password)
723 return hash('whirlpool', $password);
727 * Global user password hashing function
729 * @param string $password
733 public static function hashPassword($password)
735 if (!trim($password)) {
736 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
739 return password_hash($password, PASSWORD_DEFAULT);
743 * Updates a user row with a new plaintext password
746 * @param string $password
750 public static function updatePassword($uid, $password)
752 $password = trim($password);
754 if (empty($password)) {
755 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
758 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
759 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
762 $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
764 if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
765 throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
768 return self::updatePasswordHashed($uid, self::hashPassword($password));
772 * Updates a user row with a new hashed password.
773 * Empties the password reset token field just in case.
776 * @param string $pasword_hashed
780 private static function updatePasswordHashed($uid, $pasword_hashed)
783 'password' => $pasword_hashed,
785 'pwdreset_time' => null,
786 'legacy_password' => false
788 return DBA::update('user', $fields, ['uid' => $uid]);
792 * Checks if a nickname is in the list of the forbidden nicknames
794 * Check if a nickname is forbidden from registration on the node by the
795 * admin. Forbidden nicknames (e.g. role namess) can be configured in the
798 * @param string $nickname The nickname that should be checked
799 * @return boolean True is the nickname is blocked on the node
801 public static function isNicknameBlocked($nickname)
803 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
804 if (!empty($forbidden_nicknames)) {
805 $forbidden = explode(',', $forbidden_nicknames);
806 $forbidden = array_map('trim', $forbidden);
811 // Add the name of the internal actor to the "forbidden" list
812 $actor_name = self::getActorName();
813 if (!empty($actor_name)) {
814 $forbidden[] = $actor_name;
817 if (empty($forbidden)) {
821 // check if the nickname is in the list of blocked nicknames
822 if (in_array(strtolower($nickname), $forbidden)) {
831 * Catch-all user creation function
833 * Creates a user from the provided data array, either form fields or OpenID.
834 * Required: { username, nickname, email } or { openid_url }
836 * Performs the following:
837 * - Sends to the OpenId auth URL (if relevant)
838 * - Creates new key pairs for crypto
839 * - Create self-contact
840 * - Create profile image
844 * @throws ErrorException
845 * @throws HTTPException\InternalServerErrorException
846 * @throws ImagickException
849 public static function create(array $data)
851 $return = ['user' => null, 'password' => ''];
853 $using_invites = DI::config()->get('system', 'invitation_only');
855 $invite_id = !empty($data['invite_id']) ? Strings::escapeTags(trim($data['invite_id'])) : '';
856 $username = !empty($data['username']) ? Strings::escapeTags(trim($data['username'])) : '';
857 $nickname = !empty($data['nickname']) ? Strings::escapeTags(trim($data['nickname'])) : '';
858 $email = !empty($data['email']) ? Strings::escapeTags(trim($data['email'])) : '';
859 $openid_url = !empty($data['openid_url']) ? Strings::escapeTags(trim($data['openid_url'])) : '';
860 $photo = !empty($data['photo']) ? Strings::escapeTags(trim($data['photo'])) : '';
861 $password = !empty($data['password']) ? trim($data['password']) : '';
862 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
863 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
864 $blocked = !empty($data['blocked']);
865 $verified = !empty($data['verified']);
866 $language = !empty($data['language']) ? Strings::escapeTags(trim($data['language'])) : 'en';
868 $netpublish = $publish = !empty($data['profile_publish_reg']);
870 if ($password1 != $confirm) {
871 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
872 } elseif ($password1 != '') {
873 $password = $password1;
876 if ($using_invites) {
878 throw new Exception(DI::l10n()->t('An invitation is required.'));
881 if (!Register::existsByHash($invite_id)) {
882 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
886 /// @todo Check if this part is really needed. We should have fetched all this data in advance
887 if (empty($username) || empty($email) || empty($nickname)) {
889 if (!Network::isUrlValid($openid_url)) {
890 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
892 $_SESSION['register'] = 1;
893 $_SESSION['openid'] = $openid_url;
895 $openid = new LightOpenID(DI::baseUrl()->getHostname());
896 $openid->identity = $openid_url;
897 $openid->returnUrl = DI::baseUrl() . '/openid';
898 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
899 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
901 $authurl = $openid->authUrl();
902 } catch (Exception $e) {
903 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);
905 System::externalRedirect($authurl);
909 throw new Exception(DI::l10n()->t('Please enter the required information.'));
912 if (!Network::isUrlValid($openid_url)) {
916 // collapse multiple spaces in name
917 $username = preg_replace('/ +/', ' ', $username);
919 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
920 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
922 if ($username_min_length > $username_max_length) {
923 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);
924 $tmp = $username_min_length;
925 $username_min_length = $username_max_length;
926 $username_max_length = $tmp;
929 if (mb_strlen($username) < $username_min_length) {
930 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
933 if (mb_strlen($username) > $username_max_length) {
934 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
937 // So now we are just looking for a space in the full name.
938 $loose_reg = DI::config()->get('system', 'no_regfullname');
940 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
941 if (strpos($username, ' ') === false) {
942 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
946 if (!Network::isEmailDomainAllowed($email)) {
947 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
950 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
951 throw new Exception(DI::l10n()->t('Not a valid email address.'));
953 if (self::isNicknameBlocked($nickname)) {
954 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
957 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
958 throw new Exception(DI::l10n()->t('Cannot use that email.'));
961 // Disallow somebody creating an account using openid that uses the admin email address,
962 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
963 if (DI::config()->get('config', 'admin_email') && strlen($openid_url)) {
964 $adminlist = explode(',', str_replace(' ', '', strtolower(DI::config()->get('config', 'admin_email'))));
965 if (in_array(strtolower($email), $adminlist)) {
966 throw new Exception(DI::l10n()->t('Cannot use that email.'));
970 $nickname = $data['nickname'] = strtolower($nickname);
972 if (!preg_match('/^[a-z0-9][a-z0-9_]*$/', $nickname)) {
973 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
976 // Check existing and deleted accounts for this nickname.
978 DBA::exists('user', ['nickname' => $nickname])
979 || DBA::exists('userd', ['username' => $nickname])
981 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
984 $new_password = strlen($password) ? $password : User::generateNewPassword();
985 $new_password_encoded = self::hashPassword($new_password);
987 $return['password'] = $new_password;
989 $keys = Crypto::newKeypair(4096);
990 if ($keys === false) {
991 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
994 $prvkey = $keys['prvkey'];
995 $pubkey = $keys['pubkey'];
997 // Create another keypair for signing/verifying salmon protocol messages.
998 $sres = Crypto::newKeypair(512);
999 $sprvkey = $sres['prvkey'];
1000 $spubkey = $sres['pubkey'];
1002 $insert_result = DBA::insert('user', [
1003 'guid' => System::createUUID(),
1004 'username' => $username,
1005 'password' => $new_password_encoded,
1007 'openid' => $openid_url,
1008 'nickname' => $nickname,
1009 'pubkey' => $pubkey,
1010 'prvkey' => $prvkey,
1011 'spubkey' => $spubkey,
1012 'sprvkey' => $sprvkey,
1013 'verified' => $verified,
1014 'blocked' => $blocked,
1015 'language' => $language,
1016 'timezone' => 'UTC',
1017 'register_date' => DateTimeFormat::utcNow(),
1018 'default-location' => ''
1021 if ($insert_result) {
1022 $uid = DBA::lastInsertId();
1023 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1025 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1029 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1032 // if somebody clicked submit twice very quickly, they could end up with two accounts
1033 // due to race condition. Remove this one.
1034 $user_count = DBA::count('user', ['nickname' => $nickname]);
1035 if ($user_count > 1) {
1036 DBA::delete('user', ['uid' => $uid]);
1038 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
1041 $insert_result = DBA::insert('profile', [
1043 'name' => $username,
1044 'photo' => DI::baseUrl() . "/photo/profile/{$uid}.jpg",
1045 'thumb' => DI::baseUrl() . "/photo/avatar/{$uid}.jpg",
1046 'publish' => $publish,
1047 'net-publish' => $netpublish,
1049 if (!$insert_result) {
1050 DBA::delete('user', ['uid' => $uid]);
1052 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
1055 // Create the self contact
1056 if (!Contact::createSelfFromUserId($uid)) {
1057 DBA::delete('user', ['uid' => $uid]);
1059 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
1062 // Create a group with no members. This allows somebody to use it
1063 // right away as a default group for new contacts.
1064 $def_gid = Group::create($uid, DI::l10n()->t('Friends'));
1066 DBA::delete('user', ['uid' => $uid]);
1068 throw new Exception(DI::l10n()->t('An error occurred creating your default contact group. Please try again.'));
1071 $fields = ['def_gid' => $def_gid];
1072 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
1073 $fields['allow_gid'] = '<' . $def_gid . '>';
1076 DBA::update('user', $fields, ['uid' => $uid]);
1078 // if we have no OpenID photo try to look up an avatar
1079 if (!strlen($photo)) {
1080 $photo = Network::lookupAvatarByEmail($email);
1083 // unless there is no avatar-addon loaded
1084 if (strlen($photo)) {
1085 $photo_failure = false;
1087 $filename = basename($photo);
1088 $curlResult = DI::httpRequest()->get($photo);
1089 if ($curlResult->isSuccess()) {
1090 $img_str = $curlResult->getBody();
1091 $type = $curlResult->getContentType();
1097 $type = Images::getMimeTypeByData($img_str, $photo, $type);
1099 $Image = new Image($img_str, $type);
1100 if ($Image->isValid()) {
1101 $Image->scaleToSquare(300);
1103 $resource_id = Photo::newResource();
1105 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 4);
1108 $photo_failure = true;
1111 $Image->scaleDown(80);
1113 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 5);
1116 $photo_failure = true;
1119 $Image->scaleDown(48);
1121 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 6);
1124 $photo_failure = true;
1127 if (!$photo_failure) {
1128 Photo::update(['profile' => 1], ['resource-id' => $resource_id]);
1132 Contact::updateSelfFromUserID($uid, true);
1135 Hook::callAll('register_account', $uid);
1137 $return['user'] = $user;
1142 * Sets block state for a given user
1144 * @param int $uid The user id
1145 * @param bool $block Block state (default is true)
1147 * @return bool True, if successfully blocked
1151 public static function block(int $uid, bool $block = true)
1153 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
1157 * Allows a registration based on a hash
1159 * @param string $hash
1161 * @return bool True, if the allow was successful
1163 * @throws HTTPException\InternalServerErrorException
1166 public static function allow(string $hash)
1168 $register = Register::getByHash($hash);
1169 if (!DBA::isResult($register)) {
1173 $user = User::getById($register['uid']);
1174 if (!DBA::isResult($user)) {
1178 Register::deleteByHash($hash);
1180 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
1182 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
1184 if (DBA::isResult($profile) && $profile['net-publish'] && DI::config()->get('system', 'directory')) {
1185 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
1186 Worker::add(PRIORITY_LOW, "Directory", $url);
1189 $l10n = DI::l10n()->withLang($register['language']);
1191 return User::sendRegisterOpenEmail(
1194 DI::config()->get('config', 'sitename'),
1195 DI::baseUrl()->get(),
1196 ($register['password'] ?? '') ?: 'Sent in a previous email'
1201 * Denys a pending registration
1203 * @param string $hash The hash of the pending user
1205 * This does not have to go through user_remove() and save the nickname
1206 * permanently against re-registration, as the person was not yet
1207 * allowed to have friends on this system
1209 * @return bool True, if the deny was successfull
1212 public static function deny(string $hash)
1214 $register = Register::getByHash($hash);
1215 if (!DBA::isResult($register)) {
1219 $user = User::getById($register['uid']);
1220 if (!DBA::isResult($user)) {
1224 // Delete the avatar
1225 Photo::delete(['uid' => $register['uid']]);
1227 return DBA::delete('user', ['uid' => $register['uid']]) &&
1228 Register::deleteByHash($register['hash']);
1232 * Creates a new user based on a minimal set and sends an email to this user
1234 * @param string $name The user's name
1235 * @param string $email The user's email address
1236 * @param string $nick The user's nick name
1237 * @param string $lang The user's language (default is english)
1239 * @return bool True, if the user was created successfully
1240 * @throws HTTPException\InternalServerErrorException
1241 * @throws ErrorException
1242 * @throws ImagickException
1244 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
1249 throw new HTTPException\InternalServerErrorException('Invalid arguments.');
1252 $result = self::create([
1253 'username' => $name,
1255 'nickname' => $nick,
1260 $user = $result['user'];
1261 $preamble = Strings::deindent(DI::l10n()->t('
1263 the administrator of %2$s has set up an account for you.'));
1264 $body = Strings::deindent(DI::l10n()->t('
1265 The login details are as follows:
1271 You may change your password from your account "Settings" page after logging
1274 Please take a few moments to review the other account settings on that page.
1276 You may also wish to add some basic information to your default profile
1277 (on the "Profiles" page) so that other people can easily find you.
1279 We recommend setting your full name, adding a profile photo,
1280 adding some profile "keywords" (very useful in making new friends) - and
1281 perhaps what country you live in; if you do not wish to be more specific
1284 We fully respect your right to privacy, and none of these items are necessary.
1285 If you are new and do not know anybody here, they may help
1286 you to make some new and interesting friends.
1288 If you ever want to delete your account, you can do so at %1$s/removeme
1290 Thank you and welcome to %4$s.'));
1292 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1293 $body = sprintf($body, DI::baseUrl()->get(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1295 $email = DI::emailer()
1297 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1299 ->withRecipient($user['email'])
1301 return DI::emailer()->send($email);
1305 * Sends pending registration confirmation email
1307 * @param array $user User record array
1308 * @param string $sitename
1309 * @param string $siteurl
1310 * @param string $password Plaintext password
1311 * @return NULL|boolean from notification() and email() inherited
1312 * @throws HTTPException\InternalServerErrorException
1314 public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
1316 $body = Strings::deindent(DI::l10n()->t(
1319 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1321 Your login details are as follows:
1334 $email = DI::emailer()
1336 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1338 ->withRecipient($user['email'])
1340 return DI::emailer()->send($email);
1344 * Sends registration confirmation
1346 * It's here as a function because the mail is sent from different parts
1348 * @param L10n $l10n The used language
1349 * @param array $user User record array
1350 * @param string $sitename
1351 * @param string $siteurl
1352 * @param string $password Plaintext password
1354 * @return NULL|boolean from notification() and email() inherited
1355 * @throws HTTPException\InternalServerErrorException
1357 public static function sendRegisterOpenEmail(L10n $l10n, $user, $sitename, $siteurl, $password)
1359 $preamble = Strings::deindent($l10n->t(
1362 Thank you for registering at %2$s. Your account has been created.
1367 $body = Strings::deindent($l10n->t(
1369 The login details are as follows:
1375 You may change your password from your account "Settings" page after logging
1378 Please take a few moments to review the other account settings on that page.
1380 You may also wish to add some basic information to your default profile
1381 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1383 We recommend setting your full name, adding a profile photo,
1384 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
1385 perhaps what country you live in; if you do not wish to be more specific
1388 We fully respect your right to privacy, and none of these items are necessary.
1389 If you are new and do not know anybody here, they may help
1390 you to make some new and interesting friends.
1392 If you ever want to delete your account, you can do so at %3$s/removeme
1394 Thank you and welcome to %2$s.',
1402 $email = DI::emailer()
1404 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1406 ->withRecipient($user['email'])
1408 return DI::emailer()->send($email);
1412 * @param int $uid user to remove
1414 * @throws HTTPException\InternalServerErrorException
1416 public static function remove(int $uid)
1422 Logger::log('Removing user: ' . $uid);
1424 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1426 Hook::callAll('remove_user', $user);
1428 // save username (actually the nickname as it is guaranteed
1429 // unique), so it cannot be re-registered in the future.
1430 DBA::insert('userd', ['username' => $user['nickname']]);
1432 // Remove all personal settings, especially connector settings
1433 DBA::delete('pconfig', ['uid' => $uid]);
1435 // The user and related data will be deleted in Friendica\Worker\ExpireAndRemoveUsers
1436 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1437 Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1439 // Send an update to the directory
1440 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1441 Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
1443 // Remove the user relevant data
1444 Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1450 * Return all identities to a user
1452 * @param int $uid The user id
1453 * @return array All identities for this user
1455 * Example for a return:
1459 * 'username' => 'maxmuster',
1460 * 'nickname' => 'Max Mustermann'
1464 * 'username' => 'johndoe',
1465 * 'nickname' => 'John Doe'
1470 public static function identities($uid)
1474 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid]);
1475 if (!DBA::isResult($user)) {
1479 if ($user['parent-uid'] == 0) {
1480 // First add our own entry
1482 'uid' => $user['uid'],
1483 'username' => $user['username'],
1484 'nickname' => $user['nickname']
1487 // Then add all the children
1490 ['uid', 'username', 'nickname'],
1491 ['parent-uid' => $user['uid'], 'account_removed' => false]
1493 if (DBA::isResult($r)) {
1494 $identities = array_merge($identities, DBA::toArray($r));
1497 // First entry is our parent
1500 ['uid', 'username', 'nickname'],
1501 ['uid' => $user['parent-uid'], 'account_removed' => false]
1503 if (DBA::isResult($r)) {
1504 $identities = DBA::toArray($r);
1507 // Then add all siblings
1510 ['uid', 'username', 'nickname'],
1511 ['parent-uid' => $user['parent-uid'], 'account_removed' => false]
1513 if (DBA::isResult($r)) {
1514 $identities = array_merge($identities, DBA::toArray($r));
1519 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1521 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1522 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
1525 if (DBA::isResult($r)) {
1526 $identities = array_merge($identities, DBA::toArray($r));
1533 * Returns statistical information about the current users of this node
1539 public static function getStatistics()
1543 'active_users_halfyear' => 0,
1544 'active_users_monthly' => 0,
1545 'active_users_weekly' => 0,
1548 $userStmt = DBA::select('owner-view', ['uid', 'login_date', 'last-item'],
1549 ["`verified` AND `login_date` > ? AND NOT `blocked`
1550 AND NOT `account_removed` AND NOT `account_expired`",
1551 DBA::NULL_DATETIME]);
1552 if (!DBA::isResult($userStmt)) {
1556 $halfyear = time() - (180 * 24 * 60 * 60);
1557 $month = time() - (30 * 24 * 60 * 60);
1558 $week = time() - (7 * 24 * 60 * 60);
1560 while ($user = DBA::fetch($userStmt)) {
1561 $statistics['total_users']++;
1563 if ((strtotime($user['login_date']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1565 $statistics['active_users_halfyear']++;
1568 if ((strtotime($user['login_date']) > $month) || (strtotime($user['last-item']) > $month)
1570 $statistics['active_users_monthly']++;
1573 if ((strtotime($user['login_date']) > $week) || (strtotime($user['last-item']) > $week)
1575 $statistics['active_users_weekly']++;
1578 DBA::close($userStmt);
1584 * Get all users of the current node
1586 * @param int $start Start count (Default is 0)
1587 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1588 * @param string $type The type of users, which should get (all, bocked, removed)
1589 * @param string $order Order of the user list (Default is 'contact.name')
1590 * @param bool $descending Order direction (Default is ascending)
1592 * @return array The list of the users
1595 public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'name', bool $descending = false)
1597 $param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
1601 $condition['account_removed'] = false;
1602 $condition['blocked'] = false;
1605 $condition['account_removed'] = false;
1606 $condition['blocked'] = true;
1607 $condition['verified'] = true;
1610 $condition['account_removed'] = true;
1614 return DBA::selectToArray('owner-view', [], $condition, $param);