Modifying user-invite endpoint to search for users with the same name first.

Author: krulis-martin

app/V1Module/presenters/RegistrationPresenter.php

@@ -286,17 +286,32 @@ public function actionCreateInvitation()
 
         // gather data
         $instanceId = $format->instanceId;
-        $instance = $this->getInstance($instanceId);
-        $titlesBeforeName = $format->titlesBeforeName === null ? "" : $format->titlesBeforeName;
-        $titlesAfterName = $format->titlesAfterName === null ? "" : $format->titlesAfterName;
+        $instance = $this->getInstance($instanceId); // we don't need it, just to check it exists
+        $titlesBeforeName = $format->titlesBeforeName === null ? "" : trim($format->titlesBeforeName);
+        $titlesAfterName = $format->titlesAfterName === null ? "" : trim($format->titlesAfterName);
+        $firstName = trim($format->firstName);
+        $lastName = trim($format->lastName);
+        if (!$firstName || !$lastName) {
+            throw new BadRequestException("The user's full name must be filled in.");
+        }
+
+        // Check for name collisions, unless the request explicitly says to ignore them.
+        if (!$format->ignoreNameCollision) {
+            $sameName = $this->users->findByName($instance, $firstName, $lastName);
+            if ($sameName) {
+                // let's report the colliding users
+                $this->sendSuccessResponse($this->userViewFactory->getUsers($sameName));
+                return;
+            }
+        }
 
         // create the token and send it via email
         try {
             $this->invitationHelper->invite(
                 $instanceId,
                 $email,
-                $format->firstName,
-                $format->lastName,
+                $firstName,
+                $lastName,
                 $titlesBeforeName,
                 $titlesAfterName,
                 $groupsIds,

app/helpers/MetaFormats/FormatDefinitions/UserFormat.php

@@ -4,10 +4,9 @@
 
 use App\Helpers\MetaFormats\Attributes\Format;
 use App\Helpers\MetaFormats\MetaFormat;
-use App\Helpers\MetaFormats\Attributes\FormatParameterAttribute;
 use App\Helpers\MetaFormats\Attributes\FPost;
-use App\Helpers\MetaFormats\Type;
 use App\Helpers\MetaFormats\Validators\VArray;
+use App\Helpers\MetaFormats\Validators\VBool;
 use App\Helpers\MetaFormats\Validators\VEmail;
 use App\Helpers\MetaFormats\Validators\VString;
 use App\Helpers\MetaFormats\Validators\VUuid;
@@ -41,4 +40,7 @@ class UserFormat extends MetaFormat
 
     #[FPost(new VString(2, 2), "Language used in the invitation email (en by default).", required: false)]
     public ?string $locale;
+
+    #[FPost(new VBool(), "If a use with the same name exists, this needs to be set to true.", required: false)]
+    public ?bool $ignoreNameCollision;
 }

app/model/repository/Users.php

@@ -5,6 +5,7 @@
 use App\Helpers\Pagination;
 use App\Model\Helpers\PaginationDbHelper;
 use App\Model\Entity\User;
+use App\Model\Entity\Instance;
 use DateTime;
 use Doctrine\ORM\EntityManagerInterface;
 
@@ -75,7 +76,7 @@ public function getPaginated(Pagination $pagination, &$totalCount): array
 
 
     /**
-     * Search users first names and surnames based on given string.
+     * Search users first names and surnames based on given (sub)string.
      * @param string|null $search
      * @return User[]
      */
@@ -93,6 +94,21 @@ public function findByRoles(string ...$roles): array
         return $this->findBy(["role" => $roles]);
     }
 
+    /**
+     * Find users by exact match of the whole name.
+     * @param Instance $instance
+     * @param string $firstName
+     * @param string $lastName
+     * @return User[]
+     */
+    public function findByName(Instance $instance, string $firstName, string $lastName): array
+    {
+        $users = $this->findBy(["firstName" => $firstName, "lastName" => $lastName]);
+        return array_filter($users, function (User $user) use ($instance) {
+            return $user->belongsTo($instance);
+        });
+    }
+
     /**
      * Find all users who have not authenticated to the system for some time.
      * @param DateTime|null $before Only users with last activity before given date