3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
24 use DivineOmega\PasswordExposed;
26 use Friendica\Content\Pager;
27 use Friendica\Core\Hook;
28 use Friendica\Core\L10n;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Protocol;
31 use Friendica\Core\System;
32 use Friendica\Core\Worker;
33 use Friendica\Database\DBA;
35 use Friendica\Model\TwoFactor\AppSpecificPassword;
36 use Friendica\Network\HTTPException\InternalServerErrorException;
37 use Friendica\Object\Image;
38 use Friendica\Util\Crypto;
39 use Friendica\Util\DateTimeFormat;
40 use Friendica\Util\Images;
41 use Friendica\Util\Network;
42 use Friendica\Util\Strings;
43 use Friendica\Worker\Delivery;
47 * This class handles User related functions
54 * PAGE_FLAGS_NORMAL is a typical personal profile account
55 * PAGE_FLAGS_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
56 * PAGE_FLAGS_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
57 * write access to wall and comments (no email and not included in page owner's ACL lists)
58 * PAGE_FLAGS_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
62 const PAGE_FLAGS_NORMAL = 0;
63 const PAGE_FLAGS_SOAPBOX = 1;
64 const PAGE_FLAGS_COMMUNITY = 2;
65 const PAGE_FLAGS_FREELOVE = 3;
66 const PAGE_FLAGS_BLOG = 4;
67 const PAGE_FLAGS_PRVGROUP = 5;
75 * ACCOUNT_TYPE_PERSON - the account belongs to a person
76 * Associated page types: PAGE_FLAGS_NORMAL, PAGE_FLAGS_SOAPBOX, PAGE_FLAGS_FREELOVE
78 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
79 * Associated page type: PAGE_FLAGS_SOAPBOX
81 * ACCOUNT_TYPE_NEWS - the account is a news reflector
82 * Associated page type: PAGE_FLAGS_SOAPBOX
84 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
85 * Associated page types: PAGE_COMMUNITY, PAGE_FLAGS_PRVGROUP
87 * ACCOUNT_TYPE_RELAY - the account is a relay
88 * This will only be assigned to contacts, not to user accounts
91 const ACCOUNT_TYPE_PERSON = 0;
92 const ACCOUNT_TYPE_ORGANISATION = 1;
93 const ACCOUNT_TYPE_NEWS = 2;
94 const ACCOUNT_TYPE_COMMUNITY = 3;
95 const ACCOUNT_TYPE_RELAY = 4;
100 private static $owner;
103 * Returns true if a user record exists with the provided id
105 * @param integer $uid
109 public static function exists($uid)
111 return DBA::exists('user', ['uid' => $uid]);
115 * @param integer $uid
116 * @param array $fields
117 * @return array|boolean User record if it exists, false otherwise
120 public static function getById($uid, array $fields = [])
122 return DBA::selectFirst('user', $fields, ['uid' => $uid]);
126 * Returns a user record based on it's GUID
128 * @param string $guid The guid of the user
129 * @param array $fields The fields to retrieve
130 * @param bool $active True, if only active records are searched
132 * @return array|boolean User record if it exists, false otherwise
135 public static function getByGuid(string $guid, array $fields = [], bool $active = true)
138 $cond = ['guid' => $guid, 'account_expired' => false, 'account_removed' => false];
140 $cond = ['guid' => $guid];
143 return DBA::selectFirst('user', $fields, $cond);
147 * @param string $nickname
148 * @param array $fields
149 * @return array|boolean User record if it exists, false otherwise
152 public static function getByNickname($nickname, array $fields = [])
154 return DBA::selectFirst('user', $fields, ['nickname' => $nickname]);
158 * Returns the user id of a given profile URL
162 * @return integer user id
165 public static function getIdForURL(string $url)
167 // Avoid any database requests when the hostname isn't even part of the url.
168 if (!strpos($url, DI::baseUrl()->getHostname())) {
172 $self = Contact::selectFirst(['uid'], ['self' => true, 'nurl' => Strings::normaliseLink($url)]);
173 if (!empty($self['uid'])) {
177 $self = Contact::selectFirst(['uid'], ['self' => true, 'addr' => $url]);
178 if (!empty($self['uid'])) {
182 $self = Contact::selectFirst(['uid'], ['self' => true, 'alias' => [$url, Strings::normaliseLink($url)]]);
183 if (!empty($self['uid'])) {
191 * Get a user based on its email
193 * @param string $email
194 * @param array $fields
196 * @return array|boolean User record if it exists, false otherwise
200 public static function getByEmail($email, array $fields = [])
202 return DBA::selectFirst('user', $fields, ['email' => $email]);
206 * Fetch the user array of the administrator. The first one if there are several.
208 * @param array $fields
211 public static function getFirstAdmin(array $fields = [])
213 if (!empty(DI::config()->get('config', 'admin_nickname'))) {
214 return self::getByNickname(DI::config()->get('config', 'admin_nickname'), $fields);
215 } elseif (!empty(DI::config()->get('config', 'admin_email'))) {
216 $adminList = explode(',', str_replace(' ', '', DI::config()->get('config', 'admin_email')));
217 return self::getByEmail($adminList[0], $fields);
224 * Get owner data by user id
227 * @param boolean $check_valid Test if data is invalid and correct it
228 * @return boolean|array
231 public static function getOwnerDataById(int $uid, bool $check_valid = true)
233 if (!empty(self::$owner[$uid])) {
234 return self::$owner[$uid];
237 $owner = DBA::selectFirst('owner-view', [], ['uid' => $uid]);
238 if (!DBA::isResult($owner)) {
239 if (!DBA::exists('user', ['uid' => $uid]) || !$check_valid) {
242 Contact::createSelfFromUserId($uid);
243 $owner = self::getOwnerDataById($uid, false);
246 if (empty($owner['nickname'])) {
254 // Check if the returned data is valid, otherwise fix it. See issue #6122
256 // Check for correct url and normalised nurl
257 $url = DI::baseUrl() . '/profile/' . $owner['nickname'];
258 $repair = ($owner['url'] != $url) || ($owner['nurl'] != Strings::normaliseLink($owner['url']));
261 // Check if "addr" is present and correct
262 $addr = $owner['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
263 $repair = ($addr != $owner['addr']);
267 // Check if the avatar field is filled and the photo directs to the correct path
268 $avatar = Photo::selectFirst(['resource-id'], ['uid' => $uid, 'profile' => true]);
269 if (DBA::isResult($avatar)) {
270 $repair = empty($owner['avatar']) || !strpos($owner['photo'], $avatar['resource-id']);
275 Contact::updateSelfFromUserID($uid);
276 // Return the corrected data and avoid a loop
277 $owner = self::getOwnerDataById($uid, false);
280 self::$owner[$uid] = $owner;
285 * Get owner data by nick name
288 * @return boolean|array
291 public static function getOwnerDataByNick($nick)
293 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
295 if (!DBA::isResult($user)) {
299 return self::getOwnerDataById($user['uid']);
303 * Returns the default group for a given user and network
305 * @param int $uid User id
306 * @param string $network network name
308 * @return int group id
309 * @throws InternalServerErrorException
311 public static function getDefaultGroup($uid, $network = '')
315 if ($network == Protocol::OSTATUS) {
316 $default_group = DI::pConfig()->get($uid, "ostatus", "default_group");
319 if ($default_group != 0) {
320 return $default_group;
323 $user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
325 if (DBA::isResult($user)) {
326 $default_group = $user["def_gid"];
329 return $default_group;
334 * Authenticate a user with a clear text password
336 * @param mixed $user_info
337 * @param string $password
338 * @param bool $third_party
339 * @return int|boolean
340 * @deprecated since version 3.6
341 * @see User::getIdFromPasswordAuthentication()
343 public static function authenticate($user_info, $password, $third_party = false)
346 return self::getIdFromPasswordAuthentication($user_info, $password, $third_party);
347 } catch (Exception $ex) {
353 * Authenticate a user with a clear text password
355 * Returns the user id associated with a successful password authentication
357 * @param mixed $user_info
358 * @param string $password
359 * @param bool $third_party
360 * @return int User Id if authentication is successful
363 public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
365 $user = self::getAuthenticationInfo($user_info);
367 if ($third_party && DI::pConfig()->get($user['uid'], '2fa', 'verified')) {
368 // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
369 if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
372 } elseif (strpos($user['password'], '$') === false) {
373 //Legacy hash that has not been replaced by a new hash yet
374 if (self::hashPasswordLegacy($password) === $user['password']) {
375 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
379 } elseif (!empty($user['legacy_password'])) {
380 //Legacy hash that has been double-hashed and not replaced by a new hash yet
381 //Warning: `legacy_password` is not necessary in sync with the content of `password`
382 if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
383 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
387 } elseif (password_verify($password, $user['password'])) {
389 if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
390 self::updatePasswordHashed($user['uid'], self::hashPassword($password));
396 throw new Exception(DI::l10n()->t('Login failed'));
400 * Returns authentication info from various parameters types
402 * User info can be any of the following:
405 * - User email or username or nickname
406 * - User array with at least the uid and the hashed password
408 * @param mixed $user_info
412 private static function getAuthenticationInfo($user_info)
416 if (is_object($user_info) || is_array($user_info)) {
417 if (is_object($user_info)) {
418 $user = (array) $user_info;
425 || !isset($user['password'])
426 || !isset($user['legacy_password'])
428 throw new Exception(DI::l10n()->t('Not enough information to authenticate'));
430 } elseif (is_int($user_info) || is_string($user_info)) {
431 if (is_int($user_info)) {
432 $user = DBA::selectFirst(
434 ['uid', 'password', 'legacy_password'],
438 'account_expired' => 0,
439 'account_removed' => 0,
444 $fields = ['uid', 'password', 'legacy_password'];
446 "(`email` = ? OR `username` = ? OR `nickname` = ?)
447 AND NOT `blocked` AND NOT `account_expired` AND NOT `account_removed` AND `verified`",
448 $user_info, $user_info, $user_info
450 $user = DBA::selectFirst('user', $fields, $condition);
453 if (!DBA::isResult($user)) {
454 throw new Exception(DI::l10n()->t('User not found'));
462 * Generates a human-readable random password
466 public static function generateNewPassword()
468 return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
472 * Checks if the provided plaintext password has been exposed or not
474 * @param string $password
478 public static function isPasswordExposed($password)
480 $cache = new \DivineOmega\DOFileCachePSR6\CacheItemPool();
481 $cache->changeConfig([
482 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
486 $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
488 return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
489 } catch (\Exception $e) {
490 Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
491 'code' => $e->getCode(),
492 'file' => $e->getFile(),
493 'line' => $e->getLine(),
494 'trace' => $e->getTraceAsString()
502 * Legacy hashing function, kept for password migration purposes
504 * @param string $password
507 private static function hashPasswordLegacy($password)
509 return hash('whirlpool', $password);
513 * Global user password hashing function
515 * @param string $password
519 public static function hashPassword($password)
521 if (!trim($password)) {
522 throw new Exception(DI::l10n()->t('Password can\'t be empty'));
525 return password_hash($password, PASSWORD_DEFAULT);
529 * Updates a user row with a new plaintext password
532 * @param string $password
536 public static function updatePassword($uid, $password)
538 $password = trim($password);
540 if (empty($password)) {
541 throw new Exception(DI::l10n()->t('Empty passwords are not allowed.'));
544 if (!DI::config()->get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
545 throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
548 $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
550 if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
551 throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
554 return self::updatePasswordHashed($uid, self::hashPassword($password));
558 * Updates a user row with a new hashed password.
559 * Empties the password reset token field just in case.
562 * @param string $pasword_hashed
566 private static function updatePasswordHashed($uid, $pasword_hashed)
569 'password' => $pasword_hashed,
571 'pwdreset_time' => null,
572 'legacy_password' => false
574 return DBA::update('user', $fields, ['uid' => $uid]);
578 * Checks if a nickname is in the list of the forbidden nicknames
580 * Check if a nickname is forbidden from registration on the node by the
581 * admin. Forbidden nicknames (e.g. role namess) can be configured in the
584 * @param string $nickname The nickname that should be checked
585 * @return boolean True is the nickname is blocked on the node
586 * @throws InternalServerErrorException
588 public static function isNicknameBlocked($nickname)
590 $forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
592 // if the config variable is empty return false
593 if (empty($forbidden_nicknames)) {
597 // check if the nickname is in the list of blocked nicknames
598 $forbidden = explode(',', $forbidden_nicknames);
599 $forbidden = array_map('trim', $forbidden);
600 if (in_array(strtolower($nickname), $forbidden)) {
609 * Catch-all user creation function
611 * Creates a user from the provided data array, either form fields or OpenID.
612 * Required: { username, nickname, email } or { openid_url }
614 * Performs the following:
615 * - Sends to the OpenId auth URL (if relevant)
616 * - Creates new key pairs for crypto
617 * - Create self-contact
618 * - Create profile image
622 * @throws \ErrorException
623 * @throws InternalServerErrorException
624 * @throws \ImagickException
627 public static function create(array $data)
629 $return = ['user' => null, 'password' => ''];
631 $using_invites = DI::config()->get('system', 'invitation_only');
633 $invite_id = !empty($data['invite_id']) ? Strings::escapeTags(trim($data['invite_id'])) : '';
634 $username = !empty($data['username']) ? Strings::escapeTags(trim($data['username'])) : '';
635 $nickname = !empty($data['nickname']) ? Strings::escapeTags(trim($data['nickname'])) : '';
636 $email = !empty($data['email']) ? Strings::escapeTags(trim($data['email'])) : '';
637 $openid_url = !empty($data['openid_url']) ? Strings::escapeTags(trim($data['openid_url'])) : '';
638 $photo = !empty($data['photo']) ? Strings::escapeTags(trim($data['photo'])) : '';
639 $password = !empty($data['password']) ? trim($data['password']) : '';
640 $password1 = !empty($data['password1']) ? trim($data['password1']) : '';
641 $confirm = !empty($data['confirm']) ? trim($data['confirm']) : '';
642 $blocked = !empty($data['blocked']);
643 $verified = !empty($data['verified']);
644 $language = !empty($data['language']) ? Strings::escapeTags(trim($data['language'])) : 'en';
646 $netpublish = $publish = !empty($data['profile_publish_reg']);
648 if ($password1 != $confirm) {
649 throw new Exception(DI::l10n()->t('Passwords do not match. Password unchanged.'));
650 } elseif ($password1 != '') {
651 $password = $password1;
654 if ($using_invites) {
656 throw new Exception(DI::l10n()->t('An invitation is required.'));
659 if (!Register::existsByHash($invite_id)) {
660 throw new Exception(DI::l10n()->t('Invitation could not be verified.'));
664 /// @todo Check if this part is really needed. We should have fetched all this data in advance
665 if (empty($username) || empty($email) || empty($nickname)) {
667 if (!Network::isUrlValid($openid_url)) {
668 throw new Exception(DI::l10n()->t('Invalid OpenID url'));
670 $_SESSION['register'] = 1;
671 $_SESSION['openid'] = $openid_url;
673 $openid = new LightOpenID(DI::baseUrl()->getHostname());
674 $openid->identity = $openid_url;
675 $openid->returnUrl = DI::baseUrl() . '/openid';
676 $openid->required = ['namePerson/friendly', 'contact/email', 'namePerson'];
677 $openid->optional = ['namePerson/first', 'media/image/aspect11', 'media/image/default'];
679 $authurl = $openid->authUrl();
680 } catch (Exception $e) {
681 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);
683 System::externalRedirect($authurl);
687 throw new Exception(DI::l10n()->t('Please enter the required information.'));
690 if (!Network::isUrlValid($openid_url)) {
694 // collapse multiple spaces in name
695 $username = preg_replace('/ +/', ' ', $username);
697 $username_min_length = max(1, min(64, intval(DI::config()->get('system', 'username_min_length', 3))));
698 $username_max_length = max(1, min(64, intval(DI::config()->get('system', 'username_max_length', 48))));
700 if ($username_min_length > $username_max_length) {
701 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);
702 $tmp = $username_min_length;
703 $username_min_length = $username_max_length;
704 $username_max_length = $tmp;
707 if (mb_strlen($username) < $username_min_length) {
708 throw new Exception(DI::l10n()->tt('Username should be at least %s character.', 'Username should be at least %s characters.', $username_min_length));
711 if (mb_strlen($username) > $username_max_length) {
712 throw new Exception(DI::l10n()->tt('Username should be at most %s character.', 'Username should be at most %s characters.', $username_max_length));
715 // So now we are just looking for a space in the full name.
716 $loose_reg = DI::config()->get('system', 'no_regfullname');
718 $username = mb_convert_case($username, MB_CASE_TITLE, 'UTF-8');
719 if (strpos($username, ' ') === false) {
720 throw new Exception(DI::l10n()->t("That doesn't appear to be your full (First Last) name."));
724 if (!Network::isEmailDomainAllowed($email)) {
725 throw new Exception(DI::l10n()->t('Your email domain is not among those allowed on this site.'));
728 if (!filter_var($email, FILTER_VALIDATE_EMAIL) || !Network::isEmailDomainValid($email)) {
729 throw new Exception(DI::l10n()->t('Not a valid email address.'));
731 if (self::isNicknameBlocked($nickname)) {
732 throw new Exception(DI::l10n()->t('The nickname was blocked from registration by the nodes admin.'));
735 if (DI::config()->get('system', 'block_extended_register', false) && DBA::exists('user', ['email' => $email])) {
736 throw new Exception(DI::l10n()->t('Cannot use that email.'));
739 // Disallow somebody creating an account using openid that uses the admin email address,
740 // since openid bypasses email verification. We'll allow it if there is not yet an admin account.
741 if (DI::config()->get('config', 'admin_email') && strlen($openid_url)) {
742 $adminlist = explode(',', str_replace(' ', '', strtolower(DI::config()->get('config', 'admin_email'))));
743 if (in_array(strtolower($email), $adminlist)) {
744 throw new Exception(DI::l10n()->t('Cannot use that email.'));
748 $nickname = $data['nickname'] = strtolower($nickname);
750 if (!preg_match('/^[a-z0-9][a-z0-9\_]*$/', $nickname)) {
751 throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
754 // Check existing and deleted accounts for this nickname.
756 DBA::exists('user', ['nickname' => $nickname])
757 || DBA::exists('userd', ['username' => $nickname])
759 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
762 $new_password = strlen($password) ? $password : User::generateNewPassword();
763 $new_password_encoded = self::hashPassword($new_password);
765 $return['password'] = $new_password;
767 $keys = Crypto::newKeypair(4096);
768 if ($keys === false) {
769 throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
772 $prvkey = $keys['prvkey'];
773 $pubkey = $keys['pubkey'];
775 // Create another keypair for signing/verifying salmon protocol messages.
776 $sres = Crypto::newKeypair(512);
777 $sprvkey = $sres['prvkey'];
778 $spubkey = $sres['pubkey'];
780 $insert_result = DBA::insert('user', [
781 'guid' => System::createUUID(),
782 'username' => $username,
783 'password' => $new_password_encoded,
785 'openid' => $openid_url,
786 'nickname' => $nickname,
789 'spubkey' => $spubkey,
790 'sprvkey' => $sprvkey,
791 'verified' => $verified,
792 'blocked' => $blocked,
793 'language' => $language,
795 'register_date' => DateTimeFormat::utcNow(),
796 'default-location' => ''
799 if ($insert_result) {
800 $uid = DBA::lastInsertId();
801 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
803 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
807 throw new Exception(DI::l10n()->t('An error occurred during registration. Please try again.'));
810 // if somebody clicked submit twice very quickly, they could end up with two accounts
811 // due to race condition. Remove this one.
812 $user_count = DBA::count('user', ['nickname' => $nickname]);
813 if ($user_count > 1) {
814 DBA::delete('user', ['uid' => $uid]);
816 throw new Exception(DI::l10n()->t('Nickname is already registered. Please choose another.'));
819 $insert_result = DBA::insert('profile', [
822 'photo' => DI::baseUrl() . "/photo/profile/{$uid}.jpg",
823 'thumb' => DI::baseUrl() . "/photo/avatar/{$uid}.jpg",
824 'publish' => $publish,
825 'net-publish' => $netpublish,
827 if (!$insert_result) {
828 DBA::delete('user', ['uid' => $uid]);
830 throw new Exception(DI::l10n()->t('An error occurred creating your default profile. Please try again.'));
833 // Create the self contact
834 if (!Contact::createSelfFromUserId($uid)) {
835 DBA::delete('user', ['uid' => $uid]);
837 throw new Exception(DI::l10n()->t('An error occurred creating your self contact. Please try again.'));
840 // Create a group with no members. This allows somebody to use it
841 // right away as a default group for new contacts.
842 $def_gid = Group::create($uid, DI::l10n()->t('Friends'));
844 DBA::delete('user', ['uid' => $uid]);
846 throw new Exception(DI::l10n()->t('An error occurred creating your default contact group. Please try again.'));
849 $fields = ['def_gid' => $def_gid];
850 if (DI::config()->get('system', 'newuser_private') && $def_gid) {
851 $fields['allow_gid'] = '<' . $def_gid . '>';
854 DBA::update('user', $fields, ['uid' => $uid]);
856 // if we have no OpenID photo try to look up an avatar
857 if (!strlen($photo)) {
858 $photo = Network::lookupAvatarByEmail($email);
861 // unless there is no avatar-addon loaded
862 if (strlen($photo)) {
863 $photo_failure = false;
865 $filename = basename($photo);
866 $curlResult = DI::httpRequest()->get($photo, true);
867 if ($curlResult->isSuccess()) {
868 $img_str = $curlResult->getBody();
869 $type = $curlResult->getContentType();
875 $type = Images::getMimeTypeByData($img_str, $photo, $type);
877 $Image = new Image($img_str, $type);
878 if ($Image->isValid()) {
879 $Image->scaleToSquare(300);
881 $resource_id = Photo::newResource();
883 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 4);
886 $photo_failure = true;
889 $Image->scaleDown(80);
891 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 5);
894 $photo_failure = true;
897 $Image->scaleDown(48);
899 $r = Photo::store($Image, $uid, 0, $resource_id, $filename, DI::l10n()->t('Profile Photos'), 6);
902 $photo_failure = true;
905 if (!$photo_failure) {
906 Photo::update(['profile' => 1], ['resource-id' => $resource_id]);
911 Hook::callAll('register_account', $uid);
913 $return['user'] = $user;
918 * Sets block state for a given user
920 * @param int $uid The user id
921 * @param bool $block Block state (default is true)
923 * @return bool True, if successfully blocked
927 public static function block(int $uid, bool $block = true)
929 return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
933 * Allows a registration based on a hash
935 * @param string $hash
937 * @return bool True, if the allow was successful
939 * @throws InternalServerErrorException
942 public static function allow(string $hash)
944 $register = Register::getByHash($hash);
945 if (!DBA::isResult($register)) {
949 $user = User::getById($register['uid']);
950 if (!DBA::isResult($user)) {
954 Register::deleteByHash($hash);
956 DBA::update('user', ['blocked' => false, 'verified' => true], ['uid' => $register['uid']]);
958 $profile = DBA::selectFirst('profile', ['net-publish'], ['uid' => $register['uid']]);
960 if (DBA::isResult($profile) && $profile['net-publish'] && DI::config()->get('system', 'directory')) {
961 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
962 Worker::add(PRIORITY_LOW, "Directory", $url);
965 $l10n = DI::l10n()->withLang($register['language']);
967 return User::sendRegisterOpenEmail(
970 DI::config()->get('config', 'sitename'),
971 DI::baseUrl()->get(),
972 ($register['password'] ?? '') ?: 'Sent in a previous email'
977 * Denys a pending registration
979 * @param string $hash The hash of the pending user
981 * This does not have to go through user_remove() and save the nickname
982 * permanently against re-registration, as the person was not yet
983 * allowed to have friends on this system
985 * @return bool True, if the deny was successfull
988 public static function deny(string $hash)
990 $register = Register::getByHash($hash);
991 if (!DBA::isResult($register)) {
995 $user = User::getById($register['uid']);
996 if (!DBA::isResult($user)) {
1000 return DBA::delete('user', ['uid' => $register['uid']]) &&
1001 Register::deleteByHash($register['hash']);
1005 * Creates a new user based on a minimal set and sends an email to this user
1007 * @param string $name The user's name
1008 * @param string $email The user's email address
1009 * @param string $nick The user's nick name
1010 * @param string $lang The user's language (default is english)
1012 * @return bool True, if the user was created successfully
1013 * @throws InternalServerErrorException
1014 * @throws \ErrorException
1015 * @throws \ImagickException
1017 public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
1022 throw new InternalServerErrorException('Invalid arguments.');
1025 $result = self::create([
1026 'username' => $name,
1028 'nickname' => $nick,
1033 $user = $result['user'];
1034 $preamble = Strings::deindent(DI::l10n()->t('
1036 the administrator of %2$s has set up an account for you.'));
1037 $body = Strings::deindent(DI::l10n()->t('
1038 The login details are as follows:
1044 You may change your password from your account "Settings" page after logging
1047 Please take a few moments to review the other account settings on that page.
1049 You may also wish to add some basic information to your default profile
1050 (on the "Profiles" page) so that other people can easily find you.
1052 We recommend setting your full name, adding a profile photo,
1053 adding some profile "keywords" (very useful in making new friends) - and
1054 perhaps what country you live in; if you do not wish to be more specific
1057 We fully respect your right to privacy, and none of these items are necessary.
1058 If you are new and do not know anybody here, they may help
1059 you to make some new and interesting friends.
1061 If you ever want to delete your account, you can do so at %1$s/removeme
1063 Thank you and welcome to %4$s.'));
1065 $preamble = sprintf($preamble, $user['username'], DI::config()->get('config', 'sitename'));
1066 $body = sprintf($body, DI::baseUrl()->get(), $user['nickname'], $result['password'], DI::config()->get('config', 'sitename'));
1068 $email = DI::emailer()
1070 ->withMessage(DI::l10n()->t('Registration details for %s', DI::config()->get('config', 'sitename')), $preamble, $body)
1072 ->withRecipient($user['email'])
1074 return DI::emailer()->send($email);
1078 * Sends pending registration confirmation email
1080 * @param array $user User record array
1081 * @param string $sitename
1082 * @param string $siteurl
1083 * @param string $password Plaintext password
1084 * @return NULL|boolean from notification() and email() inherited
1085 * @throws InternalServerErrorException
1087 public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
1089 $body = Strings::deindent(DI::l10n()->t(
1092 Thank you for registering at %2$s. Your account is pending for approval by the administrator.
1094 Your login details are as follows:
1107 $email = DI::emailer()
1109 ->withMessage(DI::l10n()->t('Registration at %s', $sitename), $body)
1111 ->withRecipient($user['email'])
1113 return DI::emailer()->send($email);
1117 * Sends registration confirmation
1119 * It's here as a function because the mail is sent from different parts
1121 * @param \Friendica\Core\L10n $l10n The used language
1122 * @param array $user User record array
1123 * @param string $sitename
1124 * @param string $siteurl
1125 * @param string $password Plaintext password
1127 * @return NULL|boolean from notification() and email() inherited
1128 * @throws InternalServerErrorException
1130 public static function sendRegisterOpenEmail(\Friendica\Core\L10n $l10n, $user, $sitename, $siteurl, $password)
1132 $preamble = Strings::deindent($l10n->t(
1135 Thank you for registering at %2$s. Your account has been created.
1140 $body = Strings::deindent($l10n->t(
1142 The login details are as follows:
1148 You may change your password from your account "Settings" page after logging
1151 Please take a few moments to review the other account settings on that page.
1153 You may also wish to add some basic information to your default profile
1154 ' . "\x28" . 'on the "Profiles" page' . "\x29" . ' so that other people can easily find you.
1156 We recommend setting your full name, adding a profile photo,
1157 adding some profile "keywords" ' . "\x28" . 'very useful in making new friends' . "\x29" . ' - and
1158 perhaps what country you live in; if you do not wish to be more specific
1161 We fully respect your right to privacy, and none of these items are necessary.
1162 If you are new and do not know anybody here, they may help
1163 you to make some new and interesting friends.
1165 If you ever want to delete your account, you can do so at %3$s/removeme
1167 Thank you and welcome to %2$s.',
1175 $email = DI::emailer()
1177 ->withMessage(DI::l10n()->t('Registration details for %s', $sitename), $preamble, $body)
1179 ->withRecipient($user['email'])
1181 return DI::emailer()->send($email);
1185 * @param int $uid user to remove
1187 * @throws InternalServerErrorException
1189 public static function remove(int $uid)
1195 Logger::log('Removing user: ' . $uid);
1197 $user = DBA::selectFirst('user', [], ['uid' => $uid]);
1199 Hook::callAll('remove_user', $user);
1201 // save username (actually the nickname as it is guaranteed
1202 // unique), so it cannot be re-registered in the future.
1203 DBA::insert('userd', ['username' => $user['nickname']]);
1205 // The user and related data will be deleted in Friendica\Worker\ExpireAndRemoveUsers
1206 DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
1207 Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
1209 // Send an update to the directory
1210 $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
1211 Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
1213 // Remove the user relevant data
1214 Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
1220 * Return all identities to a user
1222 * @param int $uid The user id
1223 * @return array All identities for this user
1225 * Example for a return:
1229 * 'username' => 'maxmuster',
1230 * 'nickname' => 'Max Mustermann'
1234 * 'username' => 'johndoe',
1235 * 'nickname' => 'John Doe'
1240 public static function identities($uid)
1244 $user = DBA::selectFirst('user', ['uid', 'nickname', 'username', 'parent-uid'], ['uid' => $uid]);
1245 if (!DBA::isResult($user)) {
1249 if ($user['parent-uid'] == 0) {
1250 // First add our own entry
1252 'uid' => $user['uid'],
1253 'username' => $user['username'],
1254 'nickname' => $user['nickname']
1257 // Then add all the children
1260 ['uid', 'username', 'nickname'],
1261 ['parent-uid' => $user['uid'], 'account_removed' => false]
1263 if (DBA::isResult($r)) {
1264 $identities = array_merge($identities, DBA::toArray($r));
1267 // First entry is our parent
1270 ['uid', 'username', 'nickname'],
1271 ['uid' => $user['parent-uid'], 'account_removed' => false]
1273 if (DBA::isResult($r)) {
1274 $identities = DBA::toArray($r);
1277 // Then add all siblings
1280 ['uid', 'username', 'nickname'],
1281 ['parent-uid' => $user['parent-uid'], 'account_removed' => false]
1283 if (DBA::isResult($r)) {
1284 $identities = array_merge($identities, DBA::toArray($r));
1289 "SELECT `user`.`uid`, `user`.`username`, `user`.`nickname`
1291 INNER JOIN `user` ON `manage`.`mid` = `user`.`uid`
1292 WHERE `user`.`account_removed` = 0 AND `manage`.`uid` = ?",
1295 if (DBA::isResult($r)) {
1296 $identities = array_merge($identities, DBA::toArray($r));
1303 * Returns statistical information about the current users of this node
1309 public static function getStatistics()
1313 'active_users_halfyear' => 0,
1314 'active_users_monthly' => 0,
1315 'active_users_weekly' => 0,
1318 $userStmt = DBA::select('owner-view', ['uid', 'login_date', 'last-item'],
1319 ["`verified` AND `login_date` > ? AND NOT `blocked`
1320 AND NOT `account_removed` AND NOT `account_expired`",
1321 DBA::NULL_DATETIME]);
1322 if (!DBA::isResult($userStmt)) {
1326 $halfyear = time() - (180 * 24 * 60 * 60);
1327 $month = time() - (30 * 24 * 60 * 60);
1328 $week = time() - (7 * 24 * 60 * 60);
1330 while ($user = DBA::fetch($userStmt)) {
1331 $statistics['total_users']++;
1333 if ((strtotime($user['login_date']) > $halfyear) || (strtotime($user['last-item']) > $halfyear)
1335 $statistics['active_users_halfyear']++;
1338 if ((strtotime($user['login_date']) > $month) || (strtotime($user['last-item']) > $month)
1340 $statistics['active_users_monthly']++;
1343 if ((strtotime($user['login_date']) > $week) || (strtotime($user['last-item']) > $week)
1345 $statistics['active_users_weekly']++;
1348 DBA::close($userStmt);
1354 * Get all users of the current node
1356 * @param int $start Start count (Default is 0)
1357 * @param int $count Count of the items per page (Default is @see Pager::ITEMS_PER_PAGE)
1358 * @param string $type The type of users, which should get (all, bocked, removed)
1359 * @param string $order Order of the user list (Default is 'contact.name')
1360 * @param bool $descending Order direction (Default is ascending)
1362 * @return array The list of the users
1365 public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'name', bool $descending = false)
1367 $param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
1371 $condition['account_removed'] = false;
1372 $condition['blocked'] = false;
1375 $condition['blocked'] = true;
1378 $condition['account_removed'] = true;
1382 return DBA::selectToArray('owner-view', [], $condition, $param);