fix: provision api's status codes

hamza221 · hamza221 · commit 307cec7fcd81 · 2024-10-02T16:39:50.000+02:00
Signed-off-by: Hamza Mahjoubi &lt;hamzamahjoubi221@gmail.com&gt;
diff --git a/apps/provisioning_api/lib/Controller/UsersController.php b/apps/provisioning_api/lib/Controller/UsersController.php
@@ -488,7 +488,7 @@ public function addUser(
 				$group = $this->groupManager->get($groupid);
 				// Check if group exists
 				if ($group === null) {
-					throw new OCSException($this->l10n->t('Sub-admin group does not exist'), 102);
+					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') {
@@ -508,7 +508,7 @@ public function addUser(
 		}
 		if ($password === '') {
 			if ($email === '') {
-				throw new OCSException($this->l10n->t('To send a password link to the user an email address is required.'), 108);
+				throw new OCSException($this->l10n->t('An email address is required, to send a password link to the user.'), 108);
 			}
 
 			$passwordEvent = new GenerateSecurePasswordEvent();
@@ -1007,7 +1007,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 		}
 		// Check if permitted to edit this field
 		if (!in_array($key, $permittedFields)) {
-			throw new OCSException('', 103);
+			throw new OCSException('', 113);
 		}
 		// Process the edit
 		switch ($key) {
@@ -1028,14 +1028,14 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 						$quota = \OCP\Util::computerFileSize($quota);
 					}
 					if ($quota === false) {
-						throw new OCSException($this->l10n->t('Invalid quota value: %1$s', [$value]), 102);
+						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]), 102);
+							throw new OCSException($this->l10n->t('Invalid quota value. %1$s is exceeding the maximum quota', [$value]), 101);
 						}
 						$quota = \OCP\Util::humanFileSize($quota);
 					}
@@ -1044,7 +1044,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 				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'), 102);
+						throw new OCSException($this->l10n->t('Unlimited quota is forbidden on this instance'), 101);
 					}
 				}
 				$targetUser->setQuota($quota);
@@ -1055,33 +1055,33 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 			case self::USER_FIELD_PASSWORD:
 				try {
 					if (strlen($value) > IUserManager::MAX_PASSWORD_LENGTH) {
-						throw new OCSException($this->l10n->t('Invalid password value'), 102);
+						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'), 103);
+						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(), 103);
+					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'), 102);
+					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'), 102);
+					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'), 102);
+					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);
@@ -1106,14 +1106,14 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 					}
 				}
 				if (!$success) {
-					throw new OCSException('', 102);
+					throw new OCSException('', 101);
 				}
 				break;
 			case IAccountManager::PROPERTY_EMAIL:
 				if (filter_var($value, FILTER_VALIDATE_EMAIL) || $value === '') {
 					$targetUser->setEMailAddress($value);
 				} else {
-					throw new OCSException('', 102);
+					throw new OCSException('', 101);
 				}
 				break;
 			case IAccountManager::COLLECTION_EMAIL:
@@ -1122,13 +1122,13 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 					$mailCollection = $userAccount->getPropertyCollection(IAccountManager::COLLECTION_EMAIL);
 
 					if ($mailCollection->getPropertyByValue($value)) {
-						throw new OCSException('', 102);
+						throw new OCSException('', 101);
 					}
 
 					$mailCollection->addPropertyWithDefaults($value);
 					$this->accountManager->updateAccount($userAccount);
 				} else {
-					throw new OCSException('', 102);
+					throw new OCSException('', 101);
 				}
 				break;
 			case IAccountManager::PROPERTY_PHONE:
@@ -1151,7 +1151,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 								$this->knownUserService->deleteByContactUserId($targetUser->getUID());
 							}
 						} catch (InvalidArgumentException $e) {
-							throw new OCSException('Invalid ' . $e->getMessage(), 102);
+							throw new OCSException('Invalid ' . $e->getMessage(), 101);
 						}
 					}
 				} catch (PropertyDoesNotExistException $e) {
@@ -1160,7 +1160,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 				try {
 					$this->accountManager->updateAccount($userAccount);
 				} catch (InvalidArgumentException $e) {
-					throw new OCSException('Invalid ' . $e->getMessage(), 102);
+					throw new OCSException('Invalid ' . $e->getMessage(), 101);
 				}
 				break;
 			case IAccountManager::PROPERTY_PROFILE_ENABLED:
@@ -1197,12 +1197,12 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 						$userProperty->setScope($value);
 						$this->accountManager->updateAccount($userAccount);
 					} catch (InvalidArgumentException $e) {
-						throw new OCSException('Invalid ' . $e->getMessage(), 102);
+						throw new OCSException('Invalid ' . $e->getMessage(), 101);
 					}
 				}
 				break;
 			default:
-				throw new OCSException('', 103);
+				throw new OCSException('', 113);
 		}
 		return new DataResponse();
 	}
diff --git a/apps/provisioning_api/tests/Controller/UsersControllerTest.php b/apps/provisioning_api/tests/Controller/UsersControllerTest.php
@@ -1617,7 +1617,7 @@ public function testEditUserRegularUserSelfEditAddAdditionalEmailMainAddress():
 			->with($userAccount);
 
 		$this->expectException(OCSException::class);
-		$this->expectExceptionCode(102);
+		$this->expectExceptionCode(101);
 		$this->api->editUser('UserToEdit', 'additional_mail', 'demo@nextcloud.com')->getData();
 	}
 
@@ -1676,13 +1676,13 @@ public function testEditUserRegularUserSelfEditAddAdditionalEmailDuplicate(): vo
 			->with($userAccount);
 
 		$this->expectException(OCSException::class);
-		$this->expectExceptionCode(102);
+		$this->expectExceptionCode(101);
 		$this->api->editUser('UserToEdit', 'additional_mail', 'demo1@nextcloud.com')->getData();
 	}
 
 	public function testEditUserRegularUserSelfEditChangeEmailInvalid() {
 		$this->expectException(\OCP\AppFramework\OCS\OCSException::class);
-		$this->expectExceptionCode(102);
+		$this->expectExceptionCode(101);
 
 		$loggedInUser = $this->getMockBuilder(IUser::class)
 			->disableOriginalConstructor()
@@ -1914,7 +1914,7 @@ public function testEditUserRegularUserSelfEditChangePassword() {
 
 	public function testEditUserRegularUserSelfEditChangeQuota() {
 		$this->expectException(\OCP\AppFramework\OCS\OCSException::class);
-		$this->expectExceptionCode(103);
+		$this->expectExceptionCode(113);
 
 		$loggedInUser = $this->getMockBuilder(IUser::class)
 			->disableOriginalConstructor()
@@ -2001,7 +2001,7 @@ public function testEditUserAdminUserSelfEditChangeValidQuota() {
 	public function testEditUserAdminUserSelfEditChangeInvalidQuota() {
 		$this->expectException(\OCP\AppFramework\OCS\OCSException::class);
 		$this->expectExceptionMessage('Invalid quota value: ABC');
-		$this->expectExceptionCode(102);
+		$this->expectExceptionCode(101);
 
 		$loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock();
 		$loggedInUser
diff --git a/build/integration/features/provisioning-v1.feature b/build/integration/features/provisioning-v1.feature
@@ -211,7 +211,7 @@ Feature: provisioning
 		And sending "PUT" to "/cloud/users/brand-new-user" with
 			| key | additional_mail |
 			| value | no-reply@nextcloud.com |
-		And the OCS status code should be "102"
+		And the OCS status code should be "101"
 		And the HTTP status code should be "200"
 		And sending "PUT" to "/cloud/users/brand-new-user" with
 			| key | additional_mail |
@@ -222,7 +222,7 @@ Feature: provisioning
 		And sending "PUT" to "/cloud/users/brand-new-user" with
 			| key | additional_mail |
 			| value | no.reply2@nextcloud.com |
-		And the OCS status code should be "102"
+		And the OCS status code should be "101"
 		And the HTTP status code should be "200"
 		Then user "brand-new-user" has
 			| id | brand-new-user |
@@ -267,17 +267,17 @@ Feature: provisioning
 		When sending "PUT" to "/cloud/users/brand-new-user" with
 			| key | phoneScope |
 			| value | invalid |
-		Then the OCS status code should be "102"
+		Then the OCS status code should be "101"
 		And the HTTP status code should be "200"
 		When sending "PUT" to "/cloud/users/brand-new-user" with
 			| key | displaynameScope |
 			| value | v2-private |
-		Then the OCS status code should be "102"
+		Then the OCS status code should be "101"
 		And the HTTP status code should be "200"
 		When sending "PUT" to "/cloud/users/brand-new-user" with
 			| key | emailScope |
 			| value | v2-private |
-		Then the OCS status code should be "102"
+		Then the OCS status code should be "101"
 		And the HTTP status code should be "200"
 
   Scenario: Edit a user account multi-value property scopes with invalid or unsupported value
@@ -323,7 +323,7 @@ Feature: provisioning
 		When sending "PUT" to "/cloud/users/brand-new-user" with
 			| key | phoneScope |
 			| value | v2-private |
-		Then the OCS status code should be "103"
+		Then the OCS status code should be "113"
 		And the HTTP status code should be "200"
 
 	Scenario: Search by phone number

Original file line number	Diff line number	Diff line change
`@@ -488,7 +488,7 @@ public function addUser(`
`488`	`488`	`$group = $this->groupManager->get($groupid);`
`489`	`489`	`// Check if group exists`
`490`	`490`	`if ($group === null) {`
`491`		`- throw new OCSException($this->l10n->t('Sub-admin group does not exist'), 102);`
	`491`	`+ throw new OCSException($this->l10n->t('Sub-admin group does not exist'), 109);`
`492`	`492`	`}`
`493`	`493`	`// Check if trying to make subadmin of admin group`
`494`	`494`	`if ($group->getGID() === 'admin') {`
`@@ -508,7 +508,7 @@ public function addUser(`
`508`	`508`	`}`
`509`	`509`	`if ($password === '') {`
`510`	`510`	`if ($email === '') {`
`511`		`- throw new OCSException($this->l10n->t('To send a password link to the user an email address is required.'), 108);`
	`511`	`+ throw new OCSException($this->l10n->t('An email address is required, to send a password link to the user.'), 108);`
`512`	`512`	`}`
`513`	`513`
`514`	`514`	`$passwordEvent = new GenerateSecurePasswordEvent();`
`@@ -1007,7 +1007,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1007`	`1007`	`}`
`1008`	`1008`	`// Check if permitted to edit this field`
`1009`	`1009`	`if (!in_array($key, $permittedFields)) {`
`1010`		`- throw new OCSException('', 103);`
	`1010`	`+ throw new OCSException('', 113);`
`1011`	`1011`	`}`
`1012`	`1012`	`// Process the edit`
`1013`	`1013`	`switch ($key) {`
`@@ -1028,14 +1028,14 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1028`	`1028`	`$quota = \OCP\Util::computerFileSize($quota);`
`1029`	`1029`	`}`
`1030`	`1030`	`if ($quota === false) {`
`1031`		`- throw new OCSException($this->l10n->t('Invalid quota value: %1$s', [$value]), 102);`
	`1031`	`+ throw new OCSException($this->l10n->t('Invalid quota value: %1$s', [$value]), 101);`
`1032`	`1032`	`}`
`1033`	`1033`	`if ($quota === -1) {`
`1034`	`1034`	`$quota = 'none';`
`1035`	`1035`	`} else {`
`1036`	`1036`	`$maxQuota = (int) $this->config->getAppValue('files', 'max_quota', '-1');`
`1037`	`1037`	`if ($maxQuota !== -1 && $quota > $maxQuota) {`
`1038`		`- throw new OCSException($this->l10n->t('Invalid quota value. %1$s is exceeding the maximum quota', [$value]), 102);`
	`1038`	`+ throw new OCSException($this->l10n->t('Invalid quota value. %1$s is exceeding the maximum quota', [$value]), 101);`
`1039`	`1039`	`}`
`1040`	`1040`	`$quota = \OCP\Util::humanFileSize($quota);`
`1041`	`1041`	`}`
`@@ -1044,7 +1044,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1044`	`1044`	`if ($quota === 'none') {`
`1045`	`1045`	`$allowUnlimitedQuota = $this->config->getAppValue('files', 'allow_unlimited_quota', '1') === '1';`
`1046`	`1046`	`if (!$allowUnlimitedQuota) {`
`1047`		`- throw new OCSException($this->l10n->t('Unlimited quota is forbidden on this instance'), 102);`
	`1047`	`+ throw new OCSException($this->l10n->t('Unlimited quota is forbidden on this instance'), 101);`
`1048`	`1048`	`}`
`1049`	`1049`	`}`
`1050`	`1050`	`$targetUser->setQuota($quota);`
`@@ -1055,33 +1055,33 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1055`	`1055`	`case self::USER_FIELD_PASSWORD:`
`1056`	`1056`	`try {`
`1057`	`1057`	`if (strlen($value) > IUserManager::MAX_PASSWORD_LENGTH) {`
`1058`		`- throw new OCSException($this->l10n->t('Invalid password value'), 102);`
	`1058`	`+ throw new OCSException($this->l10n->t('Invalid password value'), 101);`
`1059`	`1059`	`}`
`1060`	`1060`	`if (!$targetUser->canChangePassword()) {`
`1061`		`- throw new OCSException($this->l10n->t('Setting the password is not supported by the users backend'), 103);`
	`1061`	`+ throw new OCSException($this->l10n->t('Setting the password is not supported by the users backend'), 112);`
`1062`	`1062`	`}`
`1063`	`1063`	`$targetUser->setPassword($value);`
`1064`	`1064`	`} catch (HintException $e) { // password policy error`
`1065`		`- throw new OCSException($e->getMessage(), 103);`
	`1065`	`+ throw new OCSException($e->getMessage(), 107);`
`1066`	`1066`	`}`
`1067`	`1067`	`break;`
`1068`	`1068`	`case self::USER_FIELD_LANGUAGE:`
`1069`	`1069`	`$languagesCodes = $this->l10nFactory->findAvailableLanguages();`
`1070`	`1070`	`if (!in_array($value, $languagesCodes, true) && $value !== 'en') {`
`1071`		`- throw new OCSException($this->l10n->t('Invalid language'), 102);`
	`1071`	`+ throw new OCSException($this->l10n->t('Invalid language'), 101);`
`1072`	`1072`	`}`
`1073`	`1073`	`$this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);`
`1074`	`1074`	`break;`
`1075`	`1075`	`case self::USER_FIELD_LOCALE:`
`1076`	`1076`	`if (!$this->l10nFactory->localeExists($value)) {`
`1077`		`- throw new OCSException($this->l10n->t('Invalid locale'), 102);`
	`1077`	`+ throw new OCSException($this->l10n->t('Invalid locale'), 101);`
`1078`	`1078`	`}`
`1079`	`1079`	`$this->config->setUserValue($targetUser->getUID(), 'core', 'locale', $value);`
`1080`	`1080`	`break;`
`1081`	`1081`	`case self::USER_FIELD_FIRST_DAY_OF_WEEK:`
`1082`	`1082`	`$intValue = (int)$value;`
`1083`	`1083`	`if ($intValue < -1 \|\| $intValue > 6) {`
`1084`		`- throw new OCSException($this->l10n->t('Invalid first day of week'), 102);`
	`1084`	`+ throw new OCSException($this->l10n->t('Invalid first day of week'), 101);`
`1085`	`1085`	`}`
`1086`	`1086`	`if ($intValue === -1) {`
`1087`	`1087`	`$this->config->deleteUserValue($targetUser->getUID(), 'core', AUserData::USER_FIELD_FIRST_DAY_OF_WEEK);`
`@@ -1106,14 +1106,14 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1106`	`1106`	`}`
`1107`	`1107`	`}`
`1108`	`1108`	`if (!$success) {`
`1109`		`- throw new OCSException('', 102);`
	`1109`	`+ throw new OCSException('', 101);`
`1110`	`1110`	`}`
`1111`	`1111`	`break;`
`1112`	`1112`	`case IAccountManager::PROPERTY_EMAIL:`
`1113`	`1113`	`if (filter_var($value, FILTER_VALIDATE_EMAIL) \|\| $value === '') {`
`1114`	`1114`	`$targetUser->setEMailAddress($value);`
`1115`	`1115`	`} else {`
`1116`		`- throw new OCSException('', 102);`
	`1116`	`+ throw new OCSException('', 101);`
`1117`	`1117`	`}`
`1118`	`1118`	`break;`
`1119`	`1119`	`case IAccountManager::COLLECTION_EMAIL:`
`@@ -1122,13 +1122,13 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1122`	`1122`	`$mailCollection = $userAccount->getPropertyCollection(IAccountManager::COLLECTION_EMAIL);`
`1123`	`1123`
`1124`	`1124`	`if ($mailCollection->getPropertyByValue($value)) {`
`1125`		`- throw new OCSException('', 102);`
	`1125`	`+ throw new OCSException('', 101);`
`1126`	`1126`	`}`
`1127`	`1127`
`1128`	`1128`	`$mailCollection->addPropertyWithDefaults($value);`
`1129`	`1129`	`$this->accountManager->updateAccount($userAccount);`
`1130`	`1130`	`} else {`
`1131`		`- throw new OCSException('', 102);`
	`1131`	`+ throw new OCSException('', 101);`
`1132`	`1132`	`}`
`1133`	`1133`	`break;`
`1134`	`1134`	`case IAccountManager::PROPERTY_PHONE:`
`@@ -1151,7 +1151,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1151`	`1151`	`$this->knownUserService->deleteByContactUserId($targetUser->getUID());`
`1152`	`1152`	`}`
`1153`	`1153`	`} catch (InvalidArgumentException $e) {`
`1154`		`- throw new OCSException('Invalid ' . $e->getMessage(), 102);`
	`1154`	`+ throw new OCSException('Invalid ' . $e->getMessage(), 101);`
`1155`	`1155`	`}`
`1156`	`1156`	`}`
`1157`	`1157`	`} catch (PropertyDoesNotExistException $e) {`
`@@ -1160,7 +1160,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1160`	`1160`	`try {`
`1161`	`1161`	`$this->accountManager->updateAccount($userAccount);`
`1162`	`1162`	`} catch (InvalidArgumentException $e) {`
`1163`		`- throw new OCSException('Invalid ' . $e->getMessage(), 102);`
	`1163`	`+ throw new OCSException('Invalid ' . $e->getMessage(), 101);`
`1164`	`1164`	`}`
`1165`	`1165`	`break;`
`1166`	`1166`	`case IAccountManager::PROPERTY_PROFILE_ENABLED:`
`@@ -1197,12 +1197,12 @@ public function editUser(string $userId, string $key, string $value): DataRespon`
`1197`	`1197`	`$userProperty->setScope($value);`
`1198`	`1198`	`$this->accountManager->updateAccount($userAccount);`
`1199`	`1199`	`} catch (InvalidArgumentException $e) {`
`1200`		`- throw new OCSException('Invalid ' . $e->getMessage(), 102);`
	`1200`	`+ throw new OCSException('Invalid ' . $e->getMessage(), 101);`
`1201`	`1201`	`}`
`1202`	`1202`	`}`
`1203`	`1203`	`break;`
`1204`	`1204`	`default:`
`1205`		`- throw new OCSException('', 103);`
	`1205`	`+ throw new OCSException('', 113);`
`1206`	`1206`	`}`
`1207`	`1207`	`return new DataResponse();`
`1208`	`1208`	`}`