fix(escape-special-characters): escape special characters in user routes (DSP-1557) (DEV-63)

.gitignore

@@ -57,5 +57,6 @@ dump.rdb
 dependencies.txt
 /client-test-data.zip
 /db_staging_dump.trig
-cleandeps.sh
+/.vscode
+/cleandeps.sh
 /.metals

webapi/scripts/expected-client-test-data.txt

@@ -137,7 +137,11 @@ test-data/admin/users/
 test-data/admin/users/add-user-to-group-response.json
 test-data/admin/users/add-user-to-project-admin-group-response.json
 test-data/admin/users/add-user-to-project-response.json
+test-data/admin/users/create-user-request-duplicate-email.json
+test-data/admin/users/create-user-request-duplicate-username.json
 test-data/admin/users/create-user-request.json
+test-data/admin/users/create-user-response-duplicate-email.json
+test-data/admin/users/create-user-response-duplicate-username.json
 test-data/admin/users/create-user-response.json
 test-data/admin/users/create-user-with-custom-Iri-request.json
 test-data/admin/users/create-user-with-custom-Iri-response.json
@@ -153,17 +157,25 @@ test-data/admin/users/get-user-response.json
 test-data/admin/users/get-users-for-ProjectAdmin-response.json
 test-data/admin/users/get-users-for-SystemAdmin-response.json
 test-data/admin/users/get-users-response.json
+test-data/admin/users/incomplete-update-user-password-request-2.json
+test-data/admin/users/incomplete-update-user-password-request.json
+test-data/admin/users/incomplete-update-user-password-response-2.json
+test-data/admin/users/incomplete-update-user-password-response.json
 test-data/admin/users/remove-user-from-group-response.json
 test-data/admin/users/remove-user-from-project-admin-group-response.json
 test-data/admin/users/remove-user-from-project-response.json
 test-data/admin/users/update-user-password-request.json
 test-data/admin/users/update-user-password-response.json
+test-data/admin/users/update-user-request-without-iri.json
 test-data/admin/users/update-user-request.json
+test-data/admin/users/update-user-response-without-iri-1.json
+test-data/admin/users/update-user-response-without-iri-2.json
 test-data/admin/users/update-user-response.json
 test-data/admin/users/update-user-status-request.json
 test-data/admin/users/update-user-status-response.json
 test-data/admin/users/update-user-system-admin-membership-request.json
 test-data/admin/users/update-user-system-admin-membership-response.json
+test-data/admin/users/user-already-member-of-project-response.json
 test-data/system/
 test-data/system/health/
 test-data/system/health/maintenance-mode-response.json

webapi/src/main/scala/org/knora/webapi/messages/admin/responder/groupsmessages/GroupsMessagesADM.scala

@@ -89,7 +89,7 @@ case class ChangeGroupApiRequestADM(name: Option[String] = None,
   if (parametersCount == 0) throw BadRequestException("No data sent in API request.")
 
   /**
-    * check that only allowed information for the 2 cases is send and not more.
+    * check that only allowed information for the 2 cases is sent and not more.
     */
   // change status case
   if (status.isDefined) {

webapi/src/main/scala/org/knora/webapi/messages/admin/responder/usersmessages/AdminEntities.scala

@@ -0,0 +1,72 @@
+package org.knora.webapi.messages.admin.responder.usersmessages
+
+import org.knora.webapi.IRI
+
+sealed trait ValidationError
+case object InvalidUsername          extends ValidationError
+case object InvalidEmail             extends ValidationError
+case object InvalidGivenOrFamilyName extends ValidationError
+case object InvalidPassword          extends ValidationError
+case object InvalidLanguageCode      extends ValidationError
+
+trait UserCreatePayloadTraitADM {
+  def create(
+    id: Option[IRI],
+    username: Username,
+    email: Email,
+    givenName: GivenName,
+    familyName: FamilyName,
+    password: Password,
+    status: Status,
+    lang: LanguageCode,
+    systemAdmin: SystemAdmin
+  ): UserCreatePayloadADM
+}
+
+/**
+ * User entity representing the payload for the create user request
+ */
+sealed abstract case class UserCreatePayloadADM(
+  id: Option[IRI],
+  username: Option[Username],
+  email: Option[Email],
+  givenName: Option[GivenName],
+  familyName: Option[FamilyName],
+  password: Option[Password],
+  status: Option[Status],
+  lang: Option[LanguageCode],
+  projects: Option[Seq[IRI]],
+  projectsAdmin: Option[Seq[IRI]],
+  groups: Option[Seq[IRI]],
+  systemAdmin: Option[SystemAdmin]
+)
+
+object UserCreatePayloadADM extends UserCreatePayloadTraitADM {
+
+  /** The create constructor needs all attributes but id which is optional */
+  override def create(
+    id: Option[IRI] = None,
+    username: Username,
+    email: Email,
+    givenName: GivenName,
+    familyName: FamilyName,
+    password: Password,
+    status: Status,
+    lang: LanguageCode,
+    systemAdmin: SystemAdmin
+  ): UserCreatePayloadADM =
+    new UserCreatePayloadADM(
+      id = id,
+      username = Some(username),
+      email = Some(email),
+      givenName = Some(givenName),
+      familyName = Some(familyName),
+      password = Some(password),
+      status = Some(status),
+      lang = Some(lang),
+      projects = None,
+      projectsAdmin = None,
+      groups = None,
+      systemAdmin = Some(systemAdmin)
+    ) {}
+}