123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656 |
- <?php
- declare(strict_types=1);
- /**
- * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-only
- */
- namespace OCA\Provisioning_API\Controller;
- use InvalidArgumentException;
- use OC\Authentication\Token\RemoteWipe;
- use OC\KnownUser\KnownUserService;
- use OC\User\Backend;
- use OCA\Provisioning_API\ResponseDefinitions;
- use OCA\Settings\Mailer\NewUserMailHelper;
- use OCA\Settings\Settings\Admin\Users;
- use OCP\Accounts\IAccountManager;
- use OCP\Accounts\IAccountProperty;
- use OCP\Accounts\PropertyDoesNotExistException;
- use OCP\AppFramework\Http;
- use OCP\AppFramework\Http\Attribute\AuthorizedAdminSetting;
- use OCP\AppFramework\Http\Attribute\NoAdminRequired;
- use OCP\AppFramework\Http\Attribute\PasswordConfirmationRequired;
- use OCP\AppFramework\Http\Attribute\UserRateLimit;
- use OCP\AppFramework\Http\DataResponse;
- use OCP\AppFramework\OCS\OCSException;
- use OCP\AppFramework\OCS\OCSForbiddenException;
- use OCP\AppFramework\OCS\OCSNotFoundException;
- use OCP\AppFramework\OCSController;
- use OCP\EventDispatcher\IEventDispatcher;
- use OCP\Group\ISubAdmin;
- use OCP\HintException;
- use OCP\IConfig;
- use OCP\IGroup;
- use OCP\IGroupManager;
- use OCP\IL10N;
- use OCP\IPhoneNumberUtil;
- use OCP\IRequest;
- use OCP\IURLGenerator;
- use OCP\IUser;
- use OCP\IUserManager;
- use OCP\IUserSession;
- use OCP\L10N\IFactory;
- use OCP\Security\Events\GenerateSecurePasswordEvent;
- use OCP\Security\ISecureRandom;
- use OCP\User\Backend\ISetDisplayNameBackend;
- use OCP\Util;
- use Psr\Log\LoggerInterface;
- /**
- * @psalm-import-type Provisioning_APIUserDetails from ResponseDefinitions
- */
- class UsersController extends AUserData {
- private IL10N $l10n;
- public function __construct(
- string $appName,
- IRequest $request,
- IUserManager $userManager,
- IConfig $config,
- IGroupManager $groupManager,
- IUserSession $userSession,
- IAccountManager $accountManager,
- ISubAdmin $subAdminManager,
- IFactory $l10nFactory,
- private IURLGenerator $urlGenerator,
- private LoggerInterface $logger,
- private NewUserMailHelper $newUserMailHelper,
- private ISecureRandom $secureRandom,
- private RemoteWipe $remoteWipe,
- private KnownUserService $knownUserService,
- private IEventDispatcher $eventDispatcher,
- private IPhoneNumberUtil $phoneNumberUtil,
- ) {
- parent::__construct(
- $appName,
- $request,
- $userManager,
- $config,
- $groupManager,
- $userSession,
- $accountManager,
- $subAdminManager,
- $l10nFactory
- );
- $this->l10n = $l10nFactory->get($appName);
- }
- /**
- * Get a list of users
- *
- * @param string $search Text to search for
- * @param int|null $limit Limit the amount of groups returned
- * @param int $offset Offset for searching for groups
- * @return DataResponse<Http::STATUS_OK, array{users: list<string>}, array{}>
- *
- * 200: Users returned
- */
- #[NoAdminRequired]
- public function getUsers(string $search = '', ?int $limit = null, int $offset = 0): DataResponse {
- $user = $this->userSession->getUser();
- $users = [];
- // Admin? Or SubAdmin?
- $uid = $user->getUID();
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($uid);
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($uid);
- if ($isAdmin || $isDelegatedAdmin) {
- $users = $this->userManager->search($search, $limit, $offset);
- } elseif ($subAdminManager->isSubAdmin($user)) {
- $subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
- foreach ($subAdminOfGroups as $key => $group) {
- $subAdminOfGroups[$key] = $group->getGID();
- }
- $users = [];
- foreach ($subAdminOfGroups as $group) {
- $users = array_merge($users, $this->groupManager->displayNamesInGroup($group, $search, $limit, $offset));
- }
- }
- /** @var list<string> $users */
- $users = array_keys($users);
- return new DataResponse([
- 'users' => $users
- ]);
- }
- /**
- * Get a list of users and their details
- *
- * @param string $search Text to search for
- * @param int|null $limit Limit the amount of groups returned
- * @param int $offset Offset for searching for groups
- * @return DataResponse<Http::STATUS_OK, array{users: array<string, Provisioning_APIUserDetails|array{id: string}>}, array{}>
- *
- * 200: Users details returned
- */
- #[NoAdminRequired]
- public function getUsersDetails(string $search = '', ?int $limit = null, int $offset = 0): DataResponse {
- $currentUser = $this->userSession->getUser();
- $users = [];
- // Admin? Or SubAdmin?
- $uid = $currentUser->getUID();
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($uid);
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($uid);
- if ($isAdmin || $isDelegatedAdmin) {
- $users = $this->userManager->search($search, $limit, $offset);
- $users = array_keys($users);
- } elseif ($subAdminManager->isSubAdmin($currentUser)) {
- $subAdminOfGroups = $subAdminManager->getSubAdminsGroups($currentUser);
- foreach ($subAdminOfGroups as $key => $group) {
- $subAdminOfGroups[$key] = $group->getGID();
- }
- $users = [];
- foreach ($subAdminOfGroups as $group) {
- $users[] = array_keys($this->groupManager->displayNamesInGroup($group, $search, $limit, $offset));
- }
- $users = array_merge(...$users);
- }
- $usersDetails = [];
- foreach ($users as $userId) {
- $userId = (string)$userId;
- try {
- $userData = $this->getUserData($userId);
- } catch (OCSNotFoundException $e) {
- // We still want to return all other accounts, but this one was removed from the backends
- // yet they are still in our database. Might be a LDAP remnant.
- $userData = null;
- $this->logger->warning('Found one enabled account that is removed from its backend, but still exists in Nextcloud database', ['accountId' => $userId]);
- }
- // Do not insert empty entry
- if ($userData !== null) {
- $usersDetails[$userId] = $userData;
- } else {
- // Logged user does not have permissions to see this user
- // only showing its id
- $usersDetails[$userId] = ['id' => $userId];
- }
- }
- return new DataResponse([
- 'users' => $usersDetails
- ]);
- }
- /**
- * Get the list of disabled users and their details
- *
- * @param string $search Text to search for
- * @param ?int $limit Limit the amount of users returned
- * @param int $offset Offset
- * @return DataResponse<Http::STATUS_OK, array{users: array<string, Provisioning_APIUserDetails|array{id: string}>}, array{}>
- *
- * 200: Disabled users details returned
- */
- #[NoAdminRequired]
- public function getDisabledUsersDetails(string $search = '', ?int $limit = null, int $offset = 0): DataResponse {
- $currentUser = $this->userSession->getUser();
- if ($currentUser === null) {
- return new DataResponse(['users' => []]);
- }
- if ($limit !== null && $limit < 0) {
- throw new InvalidArgumentException("Invalid limit value: $limit");
- }
- if ($offset < 0) {
- throw new InvalidArgumentException("Invalid offset value: $offset");
- }
- $users = [];
- // Admin? Or SubAdmin?
- $uid = $currentUser->getUID();
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($uid);
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($uid);
- if ($isAdmin || $isDelegatedAdmin) {
- $users = $this->userManager->getDisabledUsers($limit, $offset, $search);
- $users = array_map(fn (IUser $user): string => $user->getUID(), $users);
- } elseif ($subAdminManager->isSubAdmin($currentUser)) {
- $subAdminOfGroups = $subAdminManager->getSubAdminsGroups($currentUser);
- $users = [];
- /* We have to handle offset ourselve for correctness */
- $tempLimit = ($limit === null ? null : $limit + $offset);
- foreach ($subAdminOfGroups as $group) {
- $users = array_unique(array_merge(
- $users,
- array_map(
- fn (IUser $user): string => $user->getUID(),
- array_filter(
- $group->searchUsers($search),
- fn (IUser $user): bool => !$user->isEnabled()
- )
- )
- ));
- if (($tempLimit !== null) && (count($users) >= $tempLimit)) {
- break;
- }
- }
- $users = array_slice($users, $offset, $limit);
- }
- $usersDetails = [];
- foreach ($users as $userId) {
- try {
- $userData = $this->getUserData($userId);
- } catch (OCSNotFoundException $e) {
- // We still want to return all other accounts, but this one was removed from the backends
- // yet they are still in our database. Might be a LDAP remnant.
- $userData = null;
- $this->logger->warning('Found one disabled account that was removed from its backend, but still exists in Nextcloud database', ['accountId' => $userId]);
- }
- // Do not insert empty entry
- if ($userData !== null) {
- $usersDetails[$userId] = $userData;
- } else {
- // Currently logged in user does not have permissions to see this user
- // only showing its id
- $usersDetails[$userId] = ['id' => $userId];
- }
- }
- return new DataResponse([
- 'users' => $usersDetails
- ]);
- }
- /**
- * Gets the list of users sorted by lastLogin, from most recent to least recent
- *
- * @param string $search Text to search for
- * @param ?int $limit Limit the amount of users returned
- * @param int $offset Offset
- * @return DataResponse<Http::STATUS_OK, array{users: array<string, Provisioning_APIUserDetails|array{id: string}>}, array{}>
- *
- * 200: Users details returned based on last logged in information
- */
- #[AuthorizedAdminSetting(settings:Users::class)]
- public function getLastLoggedInUsers(string $search = '',
- ?int $limit = null,
- int $offset = 0,
- ): DataResponse {
- $currentUser = $this->userSession->getUser();
- if ($currentUser === null) {
- return new DataResponse(['users' => []]);
- }
- if ($limit !== null && $limit < 0) {
- throw new InvalidArgumentException("Invalid limit value: $limit");
- }
- if ($offset < 0) {
- throw new InvalidArgumentException("Invalid offset value: $offset");
- }
- $users = [];
- // For Admin alone user sorting based on lastLogin. For sub admin and groups this is not supported
- $users = $this->userManager->getLastLoggedInUsers($limit, $offset, $search);
- $usersDetails = [];
- foreach ($users as $userId) {
- try {
- $userData = $this->getUserData($userId);
- } catch (OCSNotFoundException $e) {
- // We still want to return all other accounts, but this one was removed from the backends
- // yet they are still in our database. Might be a LDAP remnant.
- $userData = null;
- $this->logger->warning('Found one account that was removed from its backend, but still exists in Nextcloud database', ['accountId' => $userId]);
- }
- // Do not insert empty entry
- if ($userData !== null) {
- $usersDetails[$userId] = $userData;
- } else {
- // Currently logged-in user does not have permissions to see this user
- // only showing its id
- $usersDetails[$userId] = ['id' => $userId];
- }
- }
- return new DataResponse([
- 'users' => $usersDetails
- ]);
- }
- /**
- * @NoSubAdminRequired
- *
- * Search users by their phone numbers
- *
- * @param string $location Location of the phone number (for country code)
- * @param array<string, list<string>> $search Phone numbers to search for
- * @return DataResponse<Http::STATUS_OK, array<string, string>, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, list<empty>, array{}>
- *
- * 200: Users returned
- * 400: Invalid location
- */
- #[NoAdminRequired]
- public function searchByPhoneNumbers(string $location, array $search): DataResponse {
- if ($this->phoneNumberUtil->getCountryCodeForRegion($location) === null) {
- // Not a valid region code
- return new DataResponse([], Http::STATUS_BAD_REQUEST);
- }
- /** @var IUser $user */
- $user = $this->userSession->getUser();
- $knownTo = $user->getUID();
- $defaultPhoneRegion = $this->config->getSystemValueString('default_phone_region');
- $normalizedNumberToKey = [];
- foreach ($search as $key => $phoneNumbers) {
- foreach ($phoneNumbers as $phone) {
- $normalizedNumber = $this->phoneNumberUtil->convertToStandardFormat($phone, $location);
- if ($normalizedNumber !== null) {
- $normalizedNumberToKey[$normalizedNumber] = (string)$key;
- }
- if ($defaultPhoneRegion !== '' && $defaultPhoneRegion !== $location && str_starts_with($phone, '0')) {
- // If the number has a leading zero (no country code),
- // we also check the default phone region of the instance,
- // when it's different to the user's given region.
- $normalizedNumber = $this->phoneNumberUtil->convertToStandardFormat($phone, $defaultPhoneRegion);
- if ($normalizedNumber !== null) {
- $normalizedNumberToKey[$normalizedNumber] = (string)$key;
- }
- }
- }
- }
- $phoneNumbers = array_keys($normalizedNumberToKey);
- if (empty($phoneNumbers)) {
- return new DataResponse();
- }
- // Cleanup all previous entries and only allow new matches
- $this->knownUserService->deleteKnownTo($knownTo);
- $userMatches = $this->accountManager->searchUsers(IAccountManager::PROPERTY_PHONE, $phoneNumbers);
- if (empty($userMatches)) {
- return new DataResponse();
- }
- $cloudUrl = rtrim($this->urlGenerator->getAbsoluteURL('/'), '/');
- if (strpos($cloudUrl, 'http://') === 0) {
- $cloudUrl = substr($cloudUrl, strlen('http://'));
- } elseif (strpos($cloudUrl, 'https://') === 0) {
- $cloudUrl = substr($cloudUrl, strlen('https://'));
- }
- $matches = [];
- foreach ($userMatches as $phone => $userId) {
- // Not using the ICloudIdManager as that would run a search for each contact to find the display name in the address book
- $matches[$normalizedNumberToKey[$phone]] = $userId . '@' . $cloudUrl;
- $this->knownUserService->storeIsKnownToUser($knownTo, $userId);
- }
- return new DataResponse($matches);
- }
- /**
- * @throws OCSException
- */
- private function createNewUserId(): string {
- $attempts = 0;
- do {
- $uidCandidate = $this->secureRandom->generate(10, ISecureRandom::CHAR_HUMAN_READABLE);
- if (!$this->userManager->userExists($uidCandidate)) {
- return $uidCandidate;
- }
- $attempts++;
- } while ($attempts < 10);
- throw new OCSException($this->l10n->t('Could not create non-existing user ID'), 111);
- }
- /**
- * Create a new user
- *
- * @param string $userid ID of the user
- * @param string $password Password of the user
- * @param string $displayName Display name of the user
- * @param string $email Email of the user
- * @param list<string> $groups Groups of the user
- * @param list<string> $subadmin Groups where the user is subadmin
- * @param string $quota Quota of the user
- * @param string $language Language of the user
- * @param ?string $manager Manager of the user
- * @return DataResponse<Http::STATUS_OK, array{id: string}, array{}>
- * @throws OCSException
- * @throws OCSForbiddenException Missing permissions to make user subadmin
- *
- * 200: User added successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function addUser(
- string $userid,
- string $password = '',
- string $displayName = '',
- string $email = '',
- array $groups = [],
- array $subadmin = [],
- string $quota = '',
- string $language = '',
- ?string $manager = null,
- ): DataResponse {
- $user = $this->userSession->getUser();
- $isAdmin = $this->groupManager->isAdmin($user->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($user->getUID());
- $subAdminManager = $this->groupManager->getSubAdmin();
- if (empty($userid) && $this->config->getAppValue('core', 'newUser.generateUserID', 'no') === 'yes') {
- $userid = $this->createNewUserId();
- }
- if ($this->userManager->userExists($userid)) {
- $this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
- throw new OCSException($this->l10n->t('User already exists'), 102);
- }
- if ($groups !== []) {
- foreach ($groups as $group) {
- if (!$this->groupManager->groupExists($group)) {
- throw new OCSException($this->l10n->t('Group %1$s does not exist', [$group]), 104);
- }
- if (!$isAdmin && !($isDelegatedAdmin && $group !== 'admin') && !$subAdminManager->isSubAdminOfGroup($user, $this->groupManager->get($group))) {
- throw new OCSException($this->l10n->t('Insufficient privileges for group %1$s', [$group]), 105);
- }
- }
- } else {
- if (!$isAdmin && !$isDelegatedAdmin) {
- throw new OCSException($this->l10n->t('No group specified (required for sub-admins)'), 106);
- }
- }
- $subadminGroups = [];
- if ($subadmin !== []) {
- foreach ($subadmin as $groupid) {
- $group = $this->groupManager->get($groupid);
- // Check if group exists
- if ($group === null) {
- throw new OCSException($this->l10n->t('Sub-admin group does not exist'), 109);
- }
- // Check if trying to make subadmin of admin group
- if ($group->getGID() === 'admin') {
- throw new OCSException($this->l10n->t('Cannot create sub-admins for admin group'), 103);
- }
- // Check if has permission to promote subadmins
- if (!$subAdminManager->isSubAdminOfGroup($user, $group) && !$isAdmin && !$isDelegatedAdmin) {
- throw new OCSForbiddenException($this->l10n->t('No permissions to promote sub-admins'));
- }
- $subadminGroups[] = $group;
- }
- }
- $generatePasswordResetToken = false;
- if (strlen($password) > IUserManager::MAX_PASSWORD_LENGTH) {
- throw new OCSException($this->l10n->t('Invalid password value'), 101);
- }
- if ($password === '') {
- if ($email === '') {
- throw new OCSException($this->l10n->t('An email address is required, to send a password link to the user.'), 108);
- }
- $passwordEvent = new GenerateSecurePasswordEvent();
- $this->eventDispatcher->dispatchTyped($passwordEvent);
- $password = $passwordEvent->getPassword();
- if ($password === null) {
- // Fallback: ensure to pass password_policy in any case
- $password = $this->secureRandom->generate(10)
- . $this->secureRandom->generate(1, ISecureRandom::CHAR_UPPER)
- . $this->secureRandom->generate(1, ISecureRandom::CHAR_LOWER)
- . $this->secureRandom->generate(1, ISecureRandom::CHAR_DIGITS)
- . $this->secureRandom->generate(1, ISecureRandom::CHAR_SYMBOLS);
- }
- $generatePasswordResetToken = true;
- }
- if ($email === '' && $this->config->getAppValue('core', 'newUser.requireEmail', 'no') === 'yes') {
- throw new OCSException($this->l10n->t('Required email address was not provided'), 110);
- }
- try {
- $newUser = $this->userManager->createUser($userid, $password);
- $this->logger->info('Successful addUser call with userid: ' . $userid, ['app' => 'ocs_api']);
- foreach ($groups as $group) {
- $this->groupManager->get($group)->addUser($newUser);
- $this->logger->info('Added userid ' . $userid . ' to group ' . $group, ['app' => 'ocs_api']);
- }
- foreach ($subadminGroups as $group) {
- $subAdminManager->createSubAdmin($newUser, $group);
- }
- if ($displayName !== '') {
- try {
- $this->editUser($userid, self::USER_FIELD_DISPLAYNAME, $displayName);
- } catch (OCSException $e) {
- if ($newUser instanceof IUser) {
- $newUser->delete();
- }
- throw $e;
- }
- }
- if ($quota !== '') {
- $this->editUser($userid, self::USER_FIELD_QUOTA, $quota);
- }
- if ($language !== '') {
- $this->editUser($userid, self::USER_FIELD_LANGUAGE, $language);
- }
- /**
- * null -> nothing sent
- * '' -> unset manager
- * else -> set manager
- */
- if ($manager !== null) {
- $this->editUser($userid, self::USER_FIELD_MANAGER, $manager);
- }
- // Send new user mail only if a mail is set
- if ($email !== '') {
- $newUser->setEMailAddress($email);
- if ($this->config->getAppValue('core', 'newUser.sendEmail', 'yes') === 'yes') {
- try {
- $emailTemplate = $this->newUserMailHelper->generateTemplate($newUser, $generatePasswordResetToken);
- $this->newUserMailHelper->sendMail($newUser, $emailTemplate);
- } catch (\Exception $e) {
- // Mail could be failing hard or just be plain not configured
- // Logging error as it is the hardest of the two
- $this->logger->error(
- "Unable to send the invitation mail to $email",
- [
- 'app' => 'ocs_api',
- 'exception' => $e,
- ]
- );
- }
- }
- }
- return new DataResponse(['id' => $userid]);
- } catch (HintException $e) {
- $this->logger->warning(
- 'Failed addUser attempt with hint exception.',
- [
- 'app' => 'ocs_api',
- 'exception' => $e,
- ]
- );
- throw new OCSException($e->getHint(), 107);
- } catch (OCSException $e) {
- $this->logger->warning(
- 'Failed addUser attempt with ocs exception.',
- [
- 'app' => 'ocs_api',
- 'exception' => $e,
- ]
- );
- throw $e;
- } catch (InvalidArgumentException $e) {
- $this->logger->error(
- 'Failed addUser attempt with invalid argument exception.',
- [
- 'app' => 'ocs_api',
- 'exception' => $e,
- ]
- );
- throw new OCSException($e->getMessage(), 101);
- } catch (\Exception $e) {
- $this->logger->error(
- 'Failed addUser attempt with exception.',
- [
- 'app' => 'ocs_api',
- 'exception' => $e
- ]
- );
- throw new OCSException('Bad request', 101);
- }
- }
- /**
- * @NoSubAdminRequired
- *
- * Get the details of a user
- *
- * @param string $userId ID of the user
- * @return DataResponse<Http::STATUS_OK, Provisioning_APIUserDetails, array{}>
- * @throws OCSException
- *
- * 200: User returned
- */
- #[NoAdminRequired]
- public function getUser(string $userId): DataResponse {
- $includeScopes = false;
- $currentUser = $this->userSession->getUser();
- if ($currentUser && $currentUser->getUID() === $userId) {
- $includeScopes = true;
- }
- $data = $this->getUserData($userId, $includeScopes);
- // getUserData returns null if not enough permissions
- if ($data === null) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- return new DataResponse($data);
- }
- /**
- * @NoSubAdminRequired
- *
- * Get the details of the current user
- *
- * @return DataResponse<Http::STATUS_OK, Provisioning_APIUserDetails, array{}>
- * @throws OCSException
- *
- * 200: Current user returned
- */
- #[NoAdminRequired]
- public function getCurrentUser(): DataResponse {
- $user = $this->userSession->getUser();
- if ($user) {
- /** @var Provisioning_APIUserDetails $data */
- $data = $this->getUserData($user->getUID(), true);
- return new DataResponse($data);
- }
- throw new OCSException('', OCSController::RESPOND_UNAUTHORISED);
- }
- /**
- * @NoSubAdminRequired
- *
- * Get a list of fields that are editable for the current user
- *
- * @return DataResponse<Http::STATUS_OK, list<string>, array{}>
- * @throws OCSException
- *
- * 200: Editable fields returned
- */
- #[NoAdminRequired]
- public function getEditableFields(): DataResponse {
- $currentLoggedInUser = $this->userSession->getUser();
- if (!$currentLoggedInUser instanceof IUser) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- return $this->getEditableFieldsForUser($currentLoggedInUser->getUID());
- }
- /**
- * @NoSubAdminRequired
- *
- * Get a list of fields that are editable for a user
- *
- * @param string $userId ID of the user
- * @return DataResponse<Http::STATUS_OK, list<string>, array{}>
- * @throws OCSException
- *
- * 200: Editable fields for user returned
- */
- #[NoAdminRequired]
- public function getEditableFieldsForUser(string $userId): DataResponse {
- $currentLoggedInUser = $this->userSession->getUser();
- if (!$currentLoggedInUser instanceof IUser) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- $permittedFields = [];
- if ($userId !== $currentLoggedInUser->getUID()) {
- $targetUser = $this->userManager->get($userId);
- if (!$targetUser instanceof IUser) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($currentLoggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID());
- if (
- !($isAdmin || $isDelegatedAdmin)
- && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
- ) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- } else {
- $targetUser = $currentLoggedInUser;
- }
- // Editing self (display, email)
- if ($this->config->getSystemValue('allow_user_to_change_display_name', true) !== false) {
- if (
- $targetUser->getBackend() instanceof ISetDisplayNameBackend
- || $targetUser->getBackend()->implementsActions(Backend::SET_DISPLAYNAME)
- ) {
- $permittedFields[] = IAccountManager::PROPERTY_DISPLAYNAME;
- }
- $permittedFields[] = IAccountManager::PROPERTY_EMAIL;
- }
- $permittedFields[] = IAccountManager::COLLECTION_EMAIL;
- $permittedFields[] = IAccountManager::PROPERTY_PHONE;
- $permittedFields[] = IAccountManager::PROPERTY_ADDRESS;
- $permittedFields[] = IAccountManager::PROPERTY_WEBSITE;
- $permittedFields[] = IAccountManager::PROPERTY_TWITTER;
- $permittedFields[] = IAccountManager::PROPERTY_FEDIVERSE;
- $permittedFields[] = IAccountManager::PROPERTY_ORGANISATION;
- $permittedFields[] = IAccountManager::PROPERTY_ROLE;
- $permittedFields[] = IAccountManager::PROPERTY_HEADLINE;
- $permittedFields[] = IAccountManager::PROPERTY_BIOGRAPHY;
- $permittedFields[] = IAccountManager::PROPERTY_PROFILE_ENABLED;
- $permittedFields[] = IAccountManager::PROPERTY_PRONOUNS;
- return new DataResponse($permittedFields);
- }
- /**
- * @NoSubAdminRequired
- *
- * Update multiple values of the user's details
- *
- * @param string $userId ID of the user
- * @param string $collectionName Collection to update
- * @param string $key Key that will be updated
- * @param string $value New value for the key
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User values edited successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- #[UserRateLimit(limit: 5, period: 60)]
- public function editUserMultiValue(
- string $userId,
- string $collectionName,
- string $key,
- string $value,
- ): DataResponse {
- $currentLoggedInUser = $this->userSession->getUser();
- if ($currentLoggedInUser === null) {
- throw new OCSException('', OCSController::RESPOND_UNAUTHORISED);
- }
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID());
- $isAdminOrSubadmin = $this->groupManager->isAdmin($currentLoggedInUser->getUID())
- || $subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser);
- $permittedFields = [];
- if ($targetUser->getUID() === $currentLoggedInUser->getUID()) {
- // Editing self (display, email)
- $permittedFields[] = IAccountManager::COLLECTION_EMAIL;
- $permittedFields[] = IAccountManager::COLLECTION_EMAIL . self::SCOPE_SUFFIX;
- } else {
- // Check if admin / subadmin
- if ($isAdminOrSubadmin || $isDelegatedAdmin && !$this->groupManager->isInGroup($targetUser->getUID(), 'admin')) {
- // They have permissions over the user
- $permittedFields[] = IAccountManager::COLLECTION_EMAIL;
- } else {
- // No rights
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- }
- // Check if permitted to edit this field
- if (!in_array($collectionName, $permittedFields)) {
- throw new OCSException('', 103);
- }
- switch ($collectionName) {
- case IAccountManager::COLLECTION_EMAIL:
- $userAccount = $this->accountManager->getAccount($targetUser);
- $mailCollection = $userAccount->getPropertyCollection(IAccountManager::COLLECTION_EMAIL);
- $mailCollection->removePropertyByValue($key);
- if ($value !== '') {
- $mailCollection->addPropertyWithDefaults($value);
- $property = $mailCollection->getPropertyByValue($key);
- if ($isAdminOrSubadmin && $property) {
- // admin set mails are auto-verified
- $property->setLocallyVerified(IAccountManager::VERIFIED);
- }
- }
- $this->accountManager->updateAccount($userAccount);
- if ($value === '' && $key === $targetUser->getPrimaryEMailAddress()) {
- $targetUser->setPrimaryEMailAddress('');
- }
- break;
- case IAccountManager::COLLECTION_EMAIL . self::SCOPE_SUFFIX:
- $userAccount = $this->accountManager->getAccount($targetUser);
- $mailCollection = $userAccount->getPropertyCollection(IAccountManager::COLLECTION_EMAIL);
- $targetProperty = null;
- foreach ($mailCollection->getProperties() as $property) {
- if ($property->getValue() === $key) {
- $targetProperty = $property;
- break;
- }
- }
- if ($targetProperty instanceof IAccountProperty) {
- try {
- $targetProperty->setScope($value);
- $this->accountManager->updateAccount($userAccount);
- } catch (InvalidArgumentException $e) {
- throw new OCSException('', 102);
- }
- } else {
- throw new OCSException('', 102);
- }
- break;
- default:
- throw new OCSException('', 103);
- }
- return new DataResponse();
- }
- /**
- * @NoSubAdminRequired
- *
- * Update a value of the user's details
- *
- * @param string $userId ID of the user
- * @param string $key Key that will be updated
- * @param string $value New value for the key
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User value edited successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- #[UserRateLimit(limit: 50, period: 60)]
- public function editUser(string $userId, string $key, string $value): DataResponse {
- $currentLoggedInUser = $this->userSession->getUser();
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- $permittedFields = [];
- if ($targetUser->getUID() === $currentLoggedInUser->getUID()) {
- // Editing self (display, email)
- if ($this->config->getSystemValue('allow_user_to_change_display_name', true) !== false) {
- if (
- $targetUser->getBackend() instanceof ISetDisplayNameBackend
- || $targetUser->getBackend()->implementsActions(Backend::SET_DISPLAYNAME)
- ) {
- $permittedFields[] = self::USER_FIELD_DISPLAYNAME;
- $permittedFields[] = IAccountManager::PROPERTY_DISPLAYNAME;
- }
- $permittedFields[] = IAccountManager::PROPERTY_EMAIL;
- }
- $permittedFields[] = IAccountManager::PROPERTY_DISPLAYNAME . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_EMAIL . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::COLLECTION_EMAIL;
- $permittedFields[] = self::USER_FIELD_PASSWORD;
- $permittedFields[] = self::USER_FIELD_NOTIFICATION_EMAIL;
- if (
- $this->config->getSystemValue('force_language', false) === false ||
- $this->groupManager->isAdmin($currentLoggedInUser->getUID()) ||
- $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID())
- ) {
- $permittedFields[] = self::USER_FIELD_LANGUAGE;
- }
- if (
- $this->config->getSystemValue('force_locale', false) === false ||
- $this->groupManager->isAdmin($currentLoggedInUser->getUID()) ||
- $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID())
- ) {
- $permittedFields[] = self::USER_FIELD_LOCALE;
- $permittedFields[] = self::USER_FIELD_FIRST_DAY_OF_WEEK;
- }
- $permittedFields[] = IAccountManager::PROPERTY_PHONE;
- $permittedFields[] = IAccountManager::PROPERTY_ADDRESS;
- $permittedFields[] = IAccountManager::PROPERTY_WEBSITE;
- $permittedFields[] = IAccountManager::PROPERTY_TWITTER;
- $permittedFields[] = IAccountManager::PROPERTY_FEDIVERSE;
- $permittedFields[] = IAccountManager::PROPERTY_ORGANISATION;
- $permittedFields[] = IAccountManager::PROPERTY_ROLE;
- $permittedFields[] = IAccountManager::PROPERTY_HEADLINE;
- $permittedFields[] = IAccountManager::PROPERTY_BIOGRAPHY;
- $permittedFields[] = IAccountManager::PROPERTY_PROFILE_ENABLED;
- $permittedFields[] = IAccountManager::PROPERTY_BIRTHDATE;
- $permittedFields[] = IAccountManager::PROPERTY_PRONOUNS;
- $permittedFields[] = IAccountManager::PROPERTY_PHONE . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_ADDRESS . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_WEBSITE . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_TWITTER . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_FEDIVERSE . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_ORGANISATION . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_ROLE . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_HEADLINE . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_BIOGRAPHY . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_PROFILE_ENABLED . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_BIRTHDATE . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_AVATAR . self::SCOPE_SUFFIX;
- $permittedFields[] = IAccountManager::PROPERTY_PRONOUNS . self::SCOPE_SUFFIX;
- // If admin they can edit their own quota and manager
- $isAdmin = $this->groupManager->isAdmin($currentLoggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID());
- if ($isAdmin || $isDelegatedAdmin) {
- $permittedFields[] = self::USER_FIELD_QUOTA;
- $permittedFields[] = self::USER_FIELD_MANAGER;
- }
- } else {
- // Check if admin / subadmin
- $subAdminManager = $this->groupManager->getSubAdmin();
- if (
- $this->groupManager->isAdmin($currentLoggedInUser->getUID()) ||
- $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID()) && !$this->groupManager->isInGroup($targetUser->getUID(), 'admin')
- || $subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
- ) {
- // They have permissions over the user
- if (
- $targetUser->getBackend() instanceof ISetDisplayNameBackend
- || $targetUser->getBackend()->implementsActions(Backend::SET_DISPLAYNAME)
- ) {
- $permittedFields[] = self::USER_FIELD_DISPLAYNAME;
- $permittedFields[] = IAccountManager::PROPERTY_DISPLAYNAME;
- }
- $permittedFields[] = IAccountManager::PROPERTY_EMAIL;
- $permittedFields[] = IAccountManager::COLLECTION_EMAIL;
- $permittedFields[] = self::USER_FIELD_PASSWORD;
- $permittedFields[] = self::USER_FIELD_LANGUAGE;
- $permittedFields[] = self::USER_FIELD_LOCALE;
- $permittedFields[] = self::USER_FIELD_FIRST_DAY_OF_WEEK;
- $permittedFields[] = IAccountManager::PROPERTY_PHONE;
- $permittedFields[] = IAccountManager::PROPERTY_ADDRESS;
- $permittedFields[] = IAccountManager::PROPERTY_WEBSITE;
- $permittedFields[] = IAccountManager::PROPERTY_TWITTER;
- $permittedFields[] = IAccountManager::PROPERTY_FEDIVERSE;
- $permittedFields[] = IAccountManager::PROPERTY_ORGANISATION;
- $permittedFields[] = IAccountManager::PROPERTY_ROLE;
- $permittedFields[] = IAccountManager::PROPERTY_HEADLINE;
- $permittedFields[] = IAccountManager::PROPERTY_BIOGRAPHY;
- $permittedFields[] = IAccountManager::PROPERTY_PROFILE_ENABLED;
- $permittedFields[] = IAccountManager::PROPERTY_PRONOUNS;
- $permittedFields[] = self::USER_FIELD_QUOTA;
- $permittedFields[] = self::USER_FIELD_NOTIFICATION_EMAIL;
- $permittedFields[] = self::USER_FIELD_MANAGER;
- } else {
- // No rights
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- }
- // Check if permitted to edit this field
- if (!in_array($key, $permittedFields)) {
- throw new OCSException('', 113);
- }
- // Process the edit
- switch ($key) {
- case self::USER_FIELD_DISPLAYNAME:
- case IAccountManager::PROPERTY_DISPLAYNAME:
- try {
- $targetUser->setDisplayName($value);
- } catch (InvalidArgumentException $e) {
- throw new OCSException($e->getMessage(), 101);
- }
- break;
- case self::USER_FIELD_QUOTA:
- $quota = $value;
- if ($quota !== 'none' && $quota !== 'default') {
- if (is_numeric($quota)) {
- $quota = (float)$quota;
- } else {
- $quota = Util::computerFileSize($quota);
- }
- if ($quota === false) {
- throw new OCSException($this->l10n->t('Invalid quota value: %1$s', [$value]), 101);
- }
- if ($quota === -1) {
- $quota = 'none';
- } else {
- $maxQuota = (int)$this->config->getAppValue('files', 'max_quota', '-1');
- if ($maxQuota !== -1 && $quota > $maxQuota) {
- throw new OCSException($this->l10n->t('Invalid quota value. %1$s is exceeding the maximum quota', [$value]), 101);
- }
- $quota = Util::humanFileSize($quota);
- }
- }
- // no else block because quota can be set to 'none' in previous if
- if ($quota === 'none') {
- $allowUnlimitedQuota = $this->config->getAppValue('files', 'allow_unlimited_quota', '1') === '1';
- if (!$allowUnlimitedQuota) {
- throw new OCSException($this->l10n->t('Unlimited quota is forbidden on this instance'), 101);
- }
- }
- $targetUser->setQuota($quota);
- break;
- case self::USER_FIELD_MANAGER:
- $targetUser->setManagerUids([$value]);
- break;
- case self::USER_FIELD_PASSWORD:
- try {
- if (strlen($value) > IUserManager::MAX_PASSWORD_LENGTH) {
- throw new OCSException($this->l10n->t('Invalid password value'), 101);
- }
- if (!$targetUser->canChangePassword()) {
- throw new OCSException($this->l10n->t('Setting the password is not supported by the users backend'), 112);
- }
- $targetUser->setPassword($value);
- } catch (HintException $e) { // password policy error
- throw new OCSException($e->getMessage(), 107);
- }
- break;
- case self::USER_FIELD_LANGUAGE:
- $languagesCodes = $this->l10nFactory->findAvailableLanguages();
- if (!in_array($value, $languagesCodes, true) && $value !== 'en') {
- throw new OCSException($this->l10n->t('Invalid language'), 101);
- }
- $this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);
- break;
- case self::USER_FIELD_LOCALE:
- if (!$this->l10nFactory->localeExists($value)) {
- throw new OCSException($this->l10n->t('Invalid locale'), 101);
- }
- $this->config->setUserValue($targetUser->getUID(), 'core', 'locale', $value);
- break;
- case self::USER_FIELD_FIRST_DAY_OF_WEEK:
- $intValue = (int)$value;
- if ($intValue < -1 || $intValue > 6) {
- throw new OCSException($this->l10n->t('Invalid first day of week'), 101);
- }
- if ($intValue === -1) {
- $this->config->deleteUserValue($targetUser->getUID(), 'core', AUserData::USER_FIELD_FIRST_DAY_OF_WEEK);
- } else {
- $this->config->setUserValue($targetUser->getUID(), 'core', AUserData::USER_FIELD_FIRST_DAY_OF_WEEK, $value);
- }
- break;
- case self::USER_FIELD_NOTIFICATION_EMAIL:
- $success = false;
- if ($value === '' || filter_var($value, FILTER_VALIDATE_EMAIL)) {
- try {
- $targetUser->setPrimaryEMailAddress($value);
- $success = true;
- } catch (InvalidArgumentException $e) {
- $this->logger->info(
- 'Cannot set primary email, because provided address is not verified',
- [
- 'app' => 'provisioning_api',
- 'exception' => $e,
- ]
- );
- }
- }
- if (!$success) {
- throw new OCSException('', 101);
- }
- break;
- case IAccountManager::PROPERTY_EMAIL:
- if (filter_var($value, FILTER_VALIDATE_EMAIL) || $value === '') {
- $targetUser->setEMailAddress($value);
- } else {
- throw new OCSException('', 101);
- }
- break;
- case IAccountManager::COLLECTION_EMAIL:
- if (filter_var($value, FILTER_VALIDATE_EMAIL) && $value !== $targetUser->getSystemEMailAddress()) {
- $userAccount = $this->accountManager->getAccount($targetUser);
- $mailCollection = $userAccount->getPropertyCollection(IAccountManager::COLLECTION_EMAIL);
- if ($mailCollection->getPropertyByValue($value)) {
- throw new OCSException('', 101);
- }
- $mailCollection->addPropertyWithDefaults($value);
- $this->accountManager->updateAccount($userAccount);
- } else {
- throw new OCSException('', 101);
- }
- break;
- case IAccountManager::PROPERTY_PHONE:
- case IAccountManager::PROPERTY_ADDRESS:
- case IAccountManager::PROPERTY_WEBSITE:
- case IAccountManager::PROPERTY_TWITTER:
- case IAccountManager::PROPERTY_FEDIVERSE:
- case IAccountManager::PROPERTY_ORGANISATION:
- case IAccountManager::PROPERTY_ROLE:
- case IAccountManager::PROPERTY_HEADLINE:
- case IAccountManager::PROPERTY_BIOGRAPHY:
- case IAccountManager::PROPERTY_BIRTHDATE:
- case IAccountManager::PROPERTY_PRONOUNS:
- $userAccount = $this->accountManager->getAccount($targetUser);
- try {
- $userProperty = $userAccount->getProperty($key);
- if ($userProperty->getValue() !== $value) {
- try {
- $userProperty->setValue($value);
- if ($userProperty->getName() === IAccountManager::PROPERTY_PHONE) {
- $this->knownUserService->deleteByContactUserId($targetUser->getUID());
- }
- } catch (InvalidArgumentException $e) {
- throw new OCSException('Invalid ' . $e->getMessage(), 101);
- }
- }
- } catch (PropertyDoesNotExistException $e) {
- $userAccount->setProperty($key, $value, IAccountManager::SCOPE_PRIVATE, IAccountManager::NOT_VERIFIED);
- }
- try {
- $this->accountManager->updateAccount($userAccount);
- } catch (InvalidArgumentException $e) {
- throw new OCSException('Invalid ' . $e->getMessage(), 101);
- }
- break;
- case IAccountManager::PROPERTY_PROFILE_ENABLED:
- $userAccount = $this->accountManager->getAccount($targetUser);
- try {
- $userProperty = $userAccount->getProperty($key);
- if ($userProperty->getValue() !== $value) {
- $userProperty->setValue($value);
- }
- } catch (PropertyDoesNotExistException $e) {
- $userAccount->setProperty($key, $value, IAccountManager::SCOPE_LOCAL, IAccountManager::NOT_VERIFIED);
- }
- $this->accountManager->updateAccount($userAccount);
- break;
- case IAccountManager::PROPERTY_DISPLAYNAME . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_EMAIL . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_PHONE . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_ADDRESS . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_WEBSITE . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_TWITTER . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_FEDIVERSE . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_ORGANISATION . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_ROLE . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_HEADLINE . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_BIOGRAPHY . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_PROFILE_ENABLED . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_BIRTHDATE . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_AVATAR . self::SCOPE_SUFFIX:
- case IAccountManager::PROPERTY_PRONOUNS . self::SCOPE_SUFFIX:
- $propertyName = substr($key, 0, strlen($key) - strlen(self::SCOPE_SUFFIX));
- $userAccount = $this->accountManager->getAccount($targetUser);
- $userProperty = $userAccount->getProperty($propertyName);
- if ($userProperty->getScope() !== $value) {
- try {
- $userProperty->setScope($value);
- $this->accountManager->updateAccount($userAccount);
- } catch (InvalidArgumentException $e) {
- throw new OCSException('Invalid ' . $e->getMessage(), 101);
- }
- }
- break;
- default:
- throw new OCSException('', 113);
- }
- return new DataResponse();
- }
- /**
- * Wipe all devices of a user
- *
- * @param string $userId ID of the user
- *
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- *
- * @throws OCSException
- *
- * 200: Wiped all user devices successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function wipeUserDevices(string $userId): DataResponse {
- /** @var IUser $currentLoggedInUser */
- $currentLoggedInUser = $this->userSession->getUser();
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- if ($targetUser->getUID() === $currentLoggedInUser->getUID()) {
- throw new OCSException('', 101);
- }
- // If not permitted
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($currentLoggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID());
- if (!$isAdmin && !($isDelegatedAdmin && !$this->groupManager->isInGroup($targetUser->getUID(), 'admin')) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- $this->remoteWipe->markAllTokensForWipe($targetUser);
- return new DataResponse();
- }
- /**
- * Delete a user
- *
- * @param string $userId ID of the user
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User deleted successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function deleteUser(string $userId): DataResponse {
- $currentLoggedInUser = $this->userSession->getUser();
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- if ($targetUser->getUID() === $currentLoggedInUser->getUID()) {
- throw new OCSException('', 101);
- }
- // If not permitted
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($currentLoggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID());
- if (!$isAdmin && !($isDelegatedAdmin && !$this->groupManager->isInGroup($targetUser->getUID(), 'admin')) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- // Go ahead with the delete
- if ($targetUser->delete()) {
- return new DataResponse();
- } else {
- throw new OCSException('', 101);
- }
- }
- /**
- * Disable a user
- *
- * @param string $userId ID of the user
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User disabled successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function disableUser(string $userId): DataResponse {
- return $this->setEnabled($userId, false);
- }
- /**
- * Enable a user
- *
- * @param string $userId ID of the user
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User enabled successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function enableUser(string $userId): DataResponse {
- return $this->setEnabled($userId, true);
- }
- /**
- * @param string $userId
- * @param bool $value
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- */
- private function setEnabled(string $userId, bool $value): DataResponse {
- $currentLoggedInUser = $this->userSession->getUser();
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
- throw new OCSException('', 101);
- }
- // If not permitted
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($currentLoggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID());
- if (!$isAdmin && !($isDelegatedAdmin && !$this->groupManager->isInGroup($targetUser->getUID(), 'admin')) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- // enable/disable the user now
- $targetUser->setEnabled($value);
- return new DataResponse();
- }
- /**
- * @NoSubAdminRequired
- *
- * Get a list of groups the user belongs to
- *
- * @param string $userId ID of the user
- * @return DataResponse<Http::STATUS_OK, array{groups: list<string>}, array{}>
- * @throws OCSException
- *
- * 200: Users groups returned
- */
- #[NoAdminRequired]
- public function getUsersGroups(string $userId): DataResponse {
- $loggedInUser = $this->userSession->getUser();
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- $isAdmin = $this->groupManager->isAdmin($loggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($loggedInUser->getUID());
- if ($targetUser->getUID() === $loggedInUser->getUID() || $isAdmin || $isDelegatedAdmin) {
- // Self lookup or admin lookup
- return new DataResponse([
- 'groups' => $this->groupManager->getUserGroupIds($targetUser)
- ]);
- } else {
- $subAdminManager = $this->groupManager->getSubAdmin();
- // Looking up someone else
- if ($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
- // Return the group that the method caller is subadmin of for the user in question
- $groups = array_values(array_intersect(
- array_map(static fn (IGroup $group) => $group->getGID(), $subAdminManager->getSubAdminsGroups($loggedInUser)),
- $this->groupManager->getUserGroupIds($targetUser)
- ));
- return new DataResponse(['groups' => $groups]);
- } else {
- // Not permitted
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- }
- }
- /**
- * Add a user to a group
- *
- * @param string $userId ID of the user
- * @param string $groupid ID of the group
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User added to group successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function addToGroup(string $userId, string $groupid = ''): DataResponse {
- if ($groupid === '') {
- throw new OCSException('', 101);
- }
- $group = $this->groupManager->get($groupid);
- $targetUser = $this->userManager->get($userId);
- if ($group === null) {
- throw new OCSException('', 102);
- }
- if ($targetUser === null) {
- throw new OCSException('', 103);
- }
- // If they're not an admin, check they are a subadmin of the group in question
- $loggedInUser = $this->userSession->getUser();
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($loggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($loggedInUser->getUID());
- if (!$isAdmin && !($isDelegatedAdmin && $groupid !== 'admin') && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
- throw new OCSException('', 104);
- }
- // Add user to group
- $group->addUser($targetUser);
- return new DataResponse();
- }
- /**
- * Remove a user from a group
- *
- * @param string $userId ID of the user
- * @param string $groupid ID of the group
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User removed from group successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function removeFromGroup(string $userId, string $groupid): DataResponse {
- $loggedInUser = $this->userSession->getUser();
- if ($groupid === null || trim($groupid) === '') {
- throw new OCSException('', 101);
- }
- $group = $this->groupManager->get($groupid);
- if ($group === null) {
- throw new OCSException('', 102);
- }
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null) {
- throw new OCSException('', 103);
- }
- // If they're not an admin, check they are a subadmin of the group in question
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($loggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($loggedInUser->getUID());
- if (!$isAdmin && !($isDelegatedAdmin && $groupid !== 'admin') && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
- throw new OCSException('', 104);
- }
- // Check they aren't removing themselves from 'admin' or their 'subadmin; group
- if ($targetUser->getUID() === $loggedInUser->getUID()) {
- if ($isAdmin || $isDelegatedAdmin) {
- if ($group->getGID() === 'admin') {
- throw new OCSException($this->l10n->t('Cannot remove yourself from the admin group'), 105);
- }
- } else {
- // Not an admin, so the user must be a subadmin of this group, but that is not allowed.
- throw new OCSException($this->l10n->t('Cannot remove yourself from this group as you are a sub-admin'), 105);
- }
- } elseif (!($isAdmin || $isDelegatedAdmin)) {
- /** @var IGroup[] $subAdminGroups */
- $subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
- $subAdminGroups = array_map(function (IGroup $subAdminGroup) {
- return $subAdminGroup->getGID();
- }, $subAdminGroups);
- $userGroups = $this->groupManager->getUserGroupIds($targetUser);
- $userSubAdminGroups = array_intersect($subAdminGroups, $userGroups);
- if (count($userSubAdminGroups) <= 1) {
- // Subadmin must not be able to remove a user from all their subadmin groups.
- throw new OCSException($this->l10n->t('Not viable to remove user from the last group you are sub-admin of'), 105);
- }
- }
- // Remove user from group
- $group->removeUser($targetUser);
- return new DataResponse();
- }
- /**
- * Make a user a subadmin of a group
- *
- * @param string $userId ID of the user
- * @param string $groupid ID of the group
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User added as group subadmin successfully
- */
- #[AuthorizedAdminSetting(settings:Users::class)]
- #[PasswordConfirmationRequired]
- public function addSubAdmin(string $userId, string $groupid): DataResponse {
- $group = $this->groupManager->get($groupid);
- $user = $this->userManager->get($userId);
- // Check if the user exists
- if ($user === null) {
- throw new OCSException($this->l10n->t('User does not exist'), 101);
- }
- // Check if group exists
- if ($group === null) {
- throw new OCSException($this->l10n->t('Group does not exist'), 102);
- }
- // Check if trying to make subadmin of admin group
- if ($group->getGID() === 'admin') {
- throw new OCSException($this->l10n->t('Cannot create sub-admins for admin group'), 103);
- }
- $subAdminManager = $this->groupManager->getSubAdmin();
- // We cannot be subadmin twice
- if ($subAdminManager->isSubAdminOfGroup($user, $group)) {
- return new DataResponse();
- }
- // Go
- $subAdminManager->createSubAdmin($user, $group);
- return new DataResponse();
- }
- /**
- * Remove a user from the subadmins of a group
- *
- * @param string $userId ID of the user
- * @param string $groupid ID of the group
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: User removed as group subadmin successfully
- */
- #[AuthorizedAdminSetting(settings:Users::class)]
- #[PasswordConfirmationRequired]
- public function removeSubAdmin(string $userId, string $groupid): DataResponse {
- $group = $this->groupManager->get($groupid);
- $user = $this->userManager->get($userId);
- $subAdminManager = $this->groupManager->getSubAdmin();
- // Check if the user exists
- if ($user === null) {
- throw new OCSException($this->l10n->t('User does not exist'), 101);
- }
- // Check if the group exists
- if ($group === null) {
- throw new OCSException($this->l10n->t('Group does not exist'), 101);
- }
- // Check if they are a subadmin of this said group
- if (!$subAdminManager->isSubAdminOfGroup($user, $group)) {
- throw new OCSException($this->l10n->t('User is not a sub-admin of this group'), 102);
- }
- // Go
- $subAdminManager->deleteSubAdmin($user, $group);
- return new DataResponse();
- }
- /**
- * Get the groups a user is a subadmin of
- *
- * @param string $userId ID if the user
- * @return DataResponse<Http::STATUS_OK, list<string>, array{}>
- * @throws OCSException
- *
- * 200: User subadmin groups returned
- */
- #[AuthorizedAdminSetting(settings:Users::class)]
- public function getUserSubAdminGroups(string $userId): DataResponse {
- $groups = $this->getUserSubAdminGroupsData($userId);
- return new DataResponse($groups);
- }
- /**
- * Resend the welcome message
- *
- * @param string $userId ID if the user
- * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
- * @throws OCSException
- *
- * 200: Resent welcome message successfully
- */
- #[PasswordConfirmationRequired]
- #[NoAdminRequired]
- public function resendWelcomeMessage(string $userId): DataResponse {
- $currentLoggedInUser = $this->userSession->getUser();
- $targetUser = $this->userManager->get($userId);
- if ($targetUser === null) {
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- // Check if admin / subadmin
- $subAdminManager = $this->groupManager->getSubAdmin();
- $isAdmin = $this->groupManager->isAdmin($currentLoggedInUser->getUID());
- $isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentLoggedInUser->getUID());
- if (
- !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
- && !($isAdmin || $isDelegatedAdmin)
- ) {
- // No rights
- throw new OCSException('', OCSController::RESPOND_NOT_FOUND);
- }
- $email = $targetUser->getEMailAddress();
- if ($email === '' || $email === null) {
- throw new OCSException($this->l10n->t('Email address not available'), 101);
- }
- try {
- if ($this->config->getUserValue($targetUser->getUID(), 'core', 'lostpassword')) {
- $emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, true);
- } else {
- $emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
- }
- $this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
- } catch (\Exception $e) {
- $this->logger->error(
- "Can't send new user mail to $email",
- [
- 'app' => 'settings',
- 'exception' => $e,
- ]
- );
- throw new OCSException($this->l10n->t('Sending email failed'), 102);
- }
- return new DataResponse();
- }
- }
|