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 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 $username = (is_string($user_info) ? $user_info : $user_info['nickname'] ?? '');
528 // Addons can create users, and since this 'catch' branch should only
529 // execute if getAuthenticationInfo can't find an existing user, that's
530 // exactly what will happen here. Creating a numeric username would create
531 // abiguity with user IDs, possibly opening up an attack vector.
532 // So let's be very careful about that.
533 if (empty($username) || is_numeric($username)) {
537 return self::getIdFromAuthenticateHooks($username, $password);
540 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
541 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
542 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
545 } elseif (strpos($user['password'], '$') === false) {
546 //Legacy hash that has not been replaced by a new hash yet
547 if (self::hashPasswordLegacy($password) === $user['password']) {
548 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
552 } elseif (!empty($user['legacy_password'])) {
553 //Legacy hash that has been double-hashed and not replaced by a new hash yet
554 //Warning: `legacy_password` is not necessary in sync with the content of `password`
555 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
556 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
560 } elseif (password_verify($password, $user['password'])) {
562 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
563 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
568 return self::getIdFromAuthenticateHooks($user['nickname'], $password); // throws
571 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
575 * Try to obtain a user ID via "authenticate" hook addons
577 * Returns the user id associated with a successful password authentication
579 * @param string $username
580 * @param string $password
581 * @return int User Id if authentication is successful
582 * @throws HTTPException\ForbiddenException
584 public static function getIdFromAuthenticateHooks($username, $password)
587 'username' => $username,
588 'password' => $password,
589 'authenticated' => 0,
590 'user_record' => null
594 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
595 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
596 * and later addons should not interfere with an earlier one that succeeded.
598 Hook::callAll('authenticate', $addon_auth);
600 if ($addon_auth['authenticated'] && $addon_auth['user_record']) {
601 return $addon_auth['user_record']['uid'];
604 throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
608 * Returns authentication info from various parameters types
610 * User info can be any of the following:
613 * - User email or username or nickname
614 * - User array with at least the uid and the hashed password
616 * @param mixed $user_info
618 * @throws HTTPException\NotFoundException
620 public static function getAuthenticationInfo($user_info)
624 if (is_object($user_info) || is_array($user_info)) {
625 if (is_object($user_info)) {
626 $user = (array) $user_info;
633 || !isset($user['password'])
634 || !isset($user['legacy_password'])
636 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
638 } elseif (is_int($user_info) || is_string($user_info)) {
639 if (is_int($user_info)) {
640 $user = DBA::selectFirst(
642 ['uid', 'nickname', 'password', 'legacy_password'],
646 'account_expired' => 0,
647 'account_removed' => 0,
652 $fields = ['uid', 'nickname', 'password', 'legacy_password'];
654 "(`email` = ? OR `username` = ? OR `nickname` = ?)
655 AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
656 $user_info, $user_info, $user_info
658 $user = DBA::selectFirst('user', $fields, $condition);
661 if (!DBA::isResult($user)) {
662 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
670 * Generates a human-readable random password
675 public static function generateNewPassword()
677 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
681 * Checks if the provided plaintext password has been exposed or not
683 * @param string $password
687 public static function isPasswordExposed($password)
689 $cache = new CacheItemPool();
690 $cache->changeConfig([
691 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
695 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
697 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
698 } catch (Exception $e) {
699 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
700 'code' => $e->getCode(),
701 'file' => $e->getFile(),
702 'line' => $e->getLine(),
703 'trace' => $e->getTraceAsString()
711 * Legacy hashing function, kept for password migration purposes
713 * @param string $password
716 private static function hashPasswordLegacy($password)
718 return hash('whirlpool', $password);
722 * Global user password hashing function
724 * @param string $password
728 public static function hashPassword($password)
730 if (!trim($password)) {
731 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
734 return password_hash($password, PASSWORD_DEFAULT);
738 * Updates a user row with a new plaintext password
741 * @param string $password
745 public static function updatePassword($uid, $password)
747 $password = trim($password);
749 if (empty($password)) {
750 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
753 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
754 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
757 $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
759 if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
760 throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
763 return self::updatePasswordHashed($uid, self::hashPassword($password));
767 * Updates a user row with a new hashed password.
768 * Empties the password reset token field just in case.
771 * @param string $pasword_hashed
775 private static function updatePasswordHashed($uid, $pasword_hashed)
778 'password' => $pasword_hashed,
780 'pwdreset_time' => null,
781 'legacy_password' => false
783 return DBA::update('user', $fields, ['uid' => $uid]);
787 * Checks if a nickname is in the list of the forbidden nicknames
789 * Check if a nickname is forbidden from registration on the node by the
790 * admin. Forbidden nicknames (e.g. role namess) can be configured in the
793 * @param string $nickname The nickname that should be checked
794 * @return boolean True is the nickname is blocked on the node
796 public static function isNicknameBlocked($nickname)
798 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
799 if (!empty($forbidden_nicknames)) {
800 $forbidden = explode(',', $forbidden_nicknames);
801 $forbidden = array_map('trim', $forbidden);
806 // Add the name of the internal actor to the "forbidden" list
807 $actor_name = self::getActorName();
808 if (!empty($actor_name)) {
809 $forbidden[] = $actor_name;
812 if (empty($forbidden)) {
816 // check if the nickname is in the list of blocked nicknames
817 if (in_array(strtolower($nickname), $forbidden)) {
826 * Catch-all user creation function
828 * Creates a user from the provided data array, either form fields or OpenID.
829 * Required: { username, nickname, email } or { openid_url }
831 * Performs the following:
832 * - Sends to the OpenId auth URL (if relevant)
833 * - Creates new key pairs for crypto
834 * - Create self-contact
835 * - Create profile image
839 * @throws ErrorException
840 * @throws HTTPException\InternalServerErrorException
841 * @throws ImagickException
844 public static function create(array $data)
846 $return = ['user' => null, 'password' => ''];
848 $using_invites = DI::config()->get('system', 'invitation_only');
850 $invite_id = !empty($data['invite_id']) ? Strings::escapeTags(trim($data['invite_id'])) : '';
851 $username = !empty($data['username']) ? Strings::escapeTags(trim($data['username'])) : '';
852 $nickname = !empty($data['nickname']) ? Strings::escapeTags(trim($data['nickname'])) : '';
853 $email = !empty($data['email']) ? Strings::escapeTags(trim($data['email'])) : '';
854 $openid_url = !empty($data['openid_url']) ? Strings::escapeTags(trim($data['openid_url'])) : '';
855 $photo = !empty($data['photo']) ? Strings::escapeTags(trim($data['photo'])) : '';
856 $password = !empty($data['password']) ? trim($data['password']) : '';
857 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
858 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
859 $blocked = !empty($data['blocked']);
860 $verified = !empty($data['verified']);
861 $language = !empty($data['language']) ? Strings::escapeTags(trim($data['language'])) : 'en';
863 $netpublish = $publish = !empty($data['profile_publish_reg']);
865 if ($password1 != $confirm) {
866 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
867 } elseif ($password1 != '') {
868 $password = $password1;
871 if ($using_invites) {
873 throw new Exception(DI::l10n()->t('An invitation is required.'));
876 if (!Register::existsByHash($invite_id)) {
877 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
881 /// @todo Check if this part is really needed. We should have fetched all this data in advance
882 if (empty($username) || empty($email) || empty($nickname)) {
884 if (!Network::isUrlValid($openid_url)) {
885 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
887 $_SESSION['register'] = 1;
888 $_SESSION['openid'] = $openid_url;
890 $openid = new LightOpenID(DI::baseUrl()->getHostname());
891 $openid->identity = $openid_url;
892 $openid->returnUrl = DI::baseUrl() . '/openid';
893 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
894 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
896 $authurl = $openid->authUrl();
897 } catch (Exception $e) {
898 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);
900 System::externalRedirect($authurl);
904 throw new Exception(DI::l10n()->t('Please enter the required information.'));
907 if (!Network::isUrlValid($openid_url)) {
911 // collapse multiple spaces in name
912 $username = preg_replace('/ +/', ' ', $username);
914 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
915 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
917 if ($username_min_length > $username_max_length) {
918 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);
919 $tmp = $username_min_length;
920 $username_min_length = $username_max_length;
921 $username_max_length = $tmp;
924 if (mb_strlen($username) < $username_min_length) {
925 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
928 if (mb_strlen($username) > $username_max_length) {
929 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
932 // So now we are just looking for a space in the full name.
933 $loose_reg = DI::config()->get('system', 'no_regfullname');
935 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
936 if (strpos($username, ' ') === false) {
937 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
941 if (!Network::isEmailDomainAllowed($email)) {
942 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
945 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
946 throw new Exception(DI::l10n()->t('Not a valid email address.'));
948 if (self::isNicknameBlocked($nickname)) {
949 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
952 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
953 throw new Exception(DI::l10n()->t('Cannot use that email.'));
956 // Disallow somebody creating an account using openid that uses the admin email address,
957 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
958 if (DI::config()->get('config', 'admin_email') && strlen($openid_url)) {
959 $adminlist = explode(',', str_replace(' ', '', strtolower(DI::config()->get('config', 'admin_email'))));
960 if (in_array(strtolower($email), $adminlist)) {
961 throw new Exception(DI::l10n()->t('Cannot use that email.'));
965 $nickname = $data['nickname'] = strtolower($nickname);
967 if (!preg_match('/^[a-z0-9][a-z0-9_]*$/', $nickname)) {
968 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
971 // Check existing and deleted accounts for this nickname.
973 DBA::exists('user', ['nickname' => $nickname])
974 || DBA::exists('userd', ['username' => $nickname])
976 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
979 $new_password = strlen($password) ? $password : User::generateNewPassword();
980 $new_password_encoded = self::hashPassword($new_password);
982 $return['password'] = $new_password;
984 $keys = Crypto::newKeypair(4096);
985 if ($keys === false) {
986 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
989 $prvkey = $keys['prvkey'];
990 $pubkey = $keys['pubkey'];
992 // Create another keypair for signing/verifying salmon protocol messages.
993 $sres = Crypto::newKeypair(512);
994 $sprvkey = $sres['prvkey'];
995 $spubkey = $sres['pubkey'];
997 $insert_result = DBA::insert('user', [
998 'guid' => System::createUUID(),
999 'username' => $username,
1000 'password' => $new_password_encoded,
1002 'openid' => $openid_url,
1003 'nickname' => $nickname,
1004 'pubkey' => $pubkey,
1005 'prvkey' => $prvkey,
1006 'spubkey' => $spubkey,
1007 'sprvkey' => $sprvkey,
1008 'verified' => $verified,
1009 'blocked' => $blocked,
1010 'language' => $language,
1011 'timezone' => 'UTC',
1012 'register_date' => DateTimeFormat::utcNow(),
1013 'default-location' => ''
1016 if ($insert_result) {
1017 $uid = DBA::lastInsertId();
1018 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1020 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1024 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
1027 // if somebody clicked submit twice very quickly, they could end up with two accounts
1028 // due to race condition. Remove this one.
1029 $user_count = DBA::count('user', ['nickname' => $nickname]);
1030 if ($user_count > 1) {
1031 DBA::delete('user', ['uid' => $uid]);
1033 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
1036 $insert_result = DBA::insert('profile', [
1038 'name' => $username,
1039 'photo' => DI::baseUrl() . "/photo/profile/{$uid}.jpg",
1040 'thumb' => DI::baseUrl() . "/photo/avatar/{$uid}.jpg",
1041 'publish' => $publish,
1042 'net-publish' => $netpublish,
1044 if (!$insert_result) {
1045 DBA::delete('user', ['uid' => $uid]);
1047 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
1050 // Create the self contact
1051 if (!Contact::createSelfFromUserId($uid)) {
1052 DBA::delete('user', ['uid' => $uid]);
1054 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
1057 // Create a group with no members. This allows somebody to use it
1058 // right away as a default group for new contacts.
1059 $def_gid = Group::create($uid, DI::l10n()->t('Friends'));
1061 DBA::delete('user', ['uid' => $uid]);
1063 throw new Exception(DI::l10n()->t('An error occurred creating your default contact group. Please try again.'));
1066 $fields = ['def_gid' => $def_gid];
1067 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
1068 $fields['allow_gid'] = '<' . $def_gid . '>';
1071 DBA::update('user', $fields, ['uid' => $uid]);
1073 // if we have no OpenID photo try to look up an avatar
1074 if (!strlen($photo)) {
1075 $photo = Network::lookupAvatarByEmail($email);
1078 // unless there is no avatar-addon loaded
1079 if (strlen($photo)) {
1080 $photo_failure = false;
1082 $filename = basename($photo);
1083 $curlResult = DI::httpRequest()->get($photo);
1084 if ($curlResult->isSuccess()) {
1085 $img_str = $curlResult->getBody();
1086 $type = $curlResult->getContentType();
1092 $type = Images::getMimeTypeByData($img_str, $photo, $type);
1094 $Image = new Image($img_str, $type);
1095 if ($Image->isValid()) {
1096 $Image->scaleToSquare(300);
1098 $resource_id = Photo::newResource();
1100 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 4);
1103 $photo_failure = true;
1106 $Image->scaleDown(80);
1108 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 5);
1111 $photo_failure = true;
1114 $Image->scaleDown(48);
1116 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 6);
1119 $photo_failure = true;
1122 if (!$photo_failure) {
1123 Photo::update(['profile' => 1], ['resource-id' => $resource_id]);
1127 Contact::updateSelfFromUserID($uid, true);
1130 Hook::callAll('register_account', $uid);
1132 $return['user'] = $user;
1137 * Sets block state for a given user
1139 * @param int $uid The user id
1140 * @param bool $block Block state (default is true)
1142 * @return bool True, if successfully blocked
1146 public static function block(int $uid, bool $block = true)
1148 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
1152 * Allows a registration based on a hash
1154 * @param string $hash
1156 * @return bool True, if the allow was successful
1158 * @throws HTTPException\InternalServerErrorException
1161 public static function allow(string $hash)
1163 $register = Register::getByHash($hash);
1164 if (!DBA::isResult($register)) {
1168 $user = User::getById($register['uid']);
1169 if (!DBA::isResult($user)) {
1173 Register::deleteByHash($hash);
1175 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
1177 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
1179 if (DBA::isResult($profile) && $profile['net-publish'] && DI::config()->get('system', 'directory')) {
1180 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
1181 Worker::add(PRIORITY_LOW, "Directory", $url);
1184 $l10n = DI::l10n()->withLang($register['language']);
1186 return User::sendRegisterOpenEmail(
1189 DI::config()->get('config', 'sitename'),
1190 DI::baseUrl()->get(),
1191 ($register['password'] ?? '') ?: 'Sent in a previous email'
1196 * Denys a pending registration
1198 * @param string $hash The hash of the pending user
1200 * This does not have to go through user_remove() and save the nickname
1201 * permanently against re-registration, as the person was not yet
1202 * allowed to have friends on this system
1204 * @return bool True, if the deny was successfull
1207 public static function deny(string $hash)
1209 $register = Register::getByHash($hash);
1210 if (!DBA::isResult($register)) {
1214 $user = User::getById($register['uid']);
1215 if (!DBA::isResult($user)) {
1219 // Delete the avatar
1220 Photo::delete(['uid' => $register['uid']]);
1222 return DBA::delete('user', ['uid' => $register['uid']]) &&
1223 Register::deleteByHash($register['hash']);
1227 * Creates a new user based on a minimal set and sends an email to this user
1229 * @param string $name The user's name
1230 * @param string $email The user's email address
1231 * @param string $nick The user's nick name
1232 * @param string $lang The user's language (default is english)
1234 * @return bool True, if the user was created successfully
1235 * @throws HTTPException\InternalServerErrorException
1236 * @throws ErrorException
1237 * @throws ImagickException
1239 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
1244 throw new HTTPException\InternalServerErrorException('Invalid arguments.');
1247 $result = self::create([
1248 'username' => $name,
1250 'nickname' => $nick,
1255 $user = $result['user'];
1256 $preamble = Strings::deindent(DI::l10n()->t('
1258 the administrator of %2$s has set up an account for you.'));
1259 $body = Strings::deindent(DI::l10n()->t('
1260 The login details are as follows:
1266 You may change your password from your account "Settings" page after logging
1269 Please take a few moments to review the other account settings on that page.
1271 You may also wish to add some basic information to your default profile
1272 (on the "Profiles" page) so that other people can easily find you.
1274 We recommend setting your full name, adding a profile photo,
1275 adding some profile "keywords" (very useful in making new friends) - and
1276 perhaps what country you live in; if you do not wish to be more specific
1279 We fully respect your right to privacy, and none of these items are necessary.
1280 If you are new and do not know anybody here, they may help
1281 you to make some new and interesting friends.
1283 If you ever want to delete your account, you can do so at %1$s/removeme
1285 Thank you and welcome to %4$s.'));
1287 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1288 $body = sprintf($body, DI::baseUrl()->get(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1290 $email = DI::emailer()
1292 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1294 ->withRecipient($user['email'])
1296 return DI::emailer()->send($email);
1300 * Sends pending registration confirmation email
1302 * @param array $user User record array
1303 * @param string $sitename
1304 * @param string $siteurl
1305 * @param string $password Plaintext password
1306 * @return NULL|boolean from notification() and email() inherited
1307 * @throws HTTPException\InternalServerErrorException
1309 public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
1311 $body = Strings::deindent(DI::l10n()->t(
1314 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1316 Your login details are as follows:
1329 $email = DI::emailer()
1331 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1333 ->withRecipient($user['email'])
1335 return DI::emailer()->send($email);
1339 * Sends registration confirmation
1341 * It's here as a function because the mail is sent from different parts
1343 * @param L10n $l10n The used language
1344 * @param array $user User record array
1345 * @param string $sitename
1346 * @param string $siteurl
1347 * @param string $password Plaintext password
1349 * @return NULL|boolean from notification() and email() inherited
1350 * @throws HTTPException\InternalServerErrorException
1352 public static function sendRegisterOpenEmail(L10n $l10n, $user, $sitename, $siteurl, $password)
1354 $preamble = Strings::deindent($l10n->t(
1357 Thank you for registering at %2$s. Your account has been created.
1362 $body = Strings::deindent($l10n->t(
1364 The login details are as follows:
1370 You may change your password from your account "Settings" page after logging
1373 Please take a few moments to review the other account settings on that page.
1375 You may also wish to add some basic information to your default profile
1376 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1378 We recommend setting your full name, adding a profile photo,
1379 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
1380 perhaps what country you live in; if you do not wish to be more specific
1383 We fully respect your right to privacy, and none of these items are necessary.
1384 If you are new and do not know anybody here, they may help
1385 you to make some new and interesting friends.
1387 If you ever want to delete your account, you can do so at %3$s/removeme
1389 Thank you and welcome to %2$s.',
1397 $email = DI::emailer()
1399 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1401 ->withRecipient($user['email'])
1403 return DI::emailer()->send($email);
1407 * @param int $uid user to remove
1409 * @throws HTTPException\InternalServerErrorException
1411 public static function remove(int $uid)
1417 Logger::log('Removing user: ' . $uid);
1419 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1421 Hook::callAll('remove_user', $user);
1423 // save username (actually the nickname as it is guaranteed
1424 // unique), so it cannot be re-registered in the future.
1425 DBA::insert('userd', ['username' => $user['nickname']]);
1427 // Remove all personal settings, especially connector settings
1428 DBA::delete('pconfig', ['uid' => $uid]);
1430 // The user and related data will be deleted in Friendica\Worker\ExpireAndRemoveUsers
1431 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1432 Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1434 // Send an update to the directory
1435 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1436 Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
1438 // Remove the user relevant data
1439 Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1445 * Return all identities to a user
1447 * @param int $uid The user id
1448 * @return array All identities for this user
1450 * Example for a return:
1454 * 'username' => 'maxmuster',
1455 * 'nickname' => 'Max Mustermann'
1459 * 'username' => 'johndoe',
1460 * 'nickname' => 'John Doe'
1465 public static function identities($uid)
1469 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid]);
1470 if (!DBA::isResult($user)) {
1474 if ($user['parent-uid'] == 0) {
1475 // First add our own entry
1477 'uid' => $user['uid'],
1478 'username' => $user['username'],
1479 'nickname' => $user['nickname']
1482 // Then add all the children
1485 ['uid', 'username', 'nickname'],
1486 ['parent-uid' => $user['uid'], 'account_removed' => false]
1488 if (DBA::isResult($r)) {
1489 $identities = array_merge($identities, DBA::toArray($r));
1492 // First entry is our parent
1495 ['uid', 'username', 'nickname'],
1496 ['uid' => $user['parent-uid'], 'account_removed' => false]
1498 if (DBA::isResult($r)) {
1499 $identities = DBA::toArray($r);
1502 // Then add all siblings
1505 ['uid', 'username', 'nickname'],
1506 ['parent-uid' => $user['parent-uid'], 'account_removed' => false]
1508 if (DBA::isResult($r)) {
1509 $identities = array_merge($identities, DBA::toArray($r));
1514 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1516 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1517 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
1520 if (DBA::isResult($r)) {
1521 $identities = array_merge($identities, DBA::toArray($r));
1528 * Returns statistical information about the current users of this node
1534 public static function getStatistics()
1538 'active_users_halfyear' => 0,
1539 'active_users_monthly' => 0,
1540 'active_users_weekly' => 0,
1543 $userStmt = DBA::select('owner-view', ['uid', 'login_date', 'last-item'],
1544 ["`verified` AND `login_date` > ? AND NOT `blocked`
1545 AND NOT `account_removed` AND NOT `account_expired`",
1546 DBA::NULL_DATETIME]);
1547 if (!DBA::isResult($userStmt)) {
1551 $halfyear = time() - (180 * 24 * 60 * 60);
1552 $month = time() - (30 * 24 * 60 * 60);
1553 $week = time() - (7 * 24 * 60 * 60);
1555 while ($user = DBA::fetch($userStmt)) {
1556 $statistics['total_users']++;
1558 if ((strtotime($user['login_date']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1560 $statistics['active_users_halfyear']++;
1563 if ((strtotime($user['login_date']) > $month) || (strtotime($user['last-item']) > $month)
1565 $statistics['active_users_monthly']++;
1568 if ((strtotime($user['login_date']) > $week) || (strtotime($user['last-item']) > $week)
1570 $statistics['active_users_weekly']++;
1573 DBA::close($userStmt);
1579 * Get all users of the current node
1581 * @param int $start Start count (Default is 0)
1582 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1583 * @param string $type The type of users, which should get (all, bocked, removed)
1584 * @param string $order Order of the user list (Default is 'contact.name')
1585 * @param bool $descending Order direction (Default is ascending)
1587 * @return array The list of the users
1590 public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'name', bool $descending = false)
1592 $param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
1596 $condition['account_removed'] = false;
1597 $condition['blocked'] = false;
1600 $condition['account_removed'] = false;
1601 $condition['blocked'] = true;
1602 $condition['verified'] = true;
1605 $condition['account_removed'] = true;
1609 return DBA::selectToArray('owner-view', [], $condition, $param);