Exercises' file unification

app/V1Module/presenters/AssignmentSolutionReviewsPresenter.php

@@ -347,7 +347,7 @@ public function checkEditComment(string $id, string $commentId)
         required: false,
     )]
     #[Path("id", new VUuid(), "identifier of the solution", required: true)]
-    #[Path("commentId", new VString(), "identifier of the review comment", required: true)]
+    #[Path("commentId", new VUuid(), "identifier of the review comment", required: true)]
     public function actionEditComment(string $id, string $commentId)
     {
         $solution = $this->assignmentSolutions->findOrThrow($id);
@@ -407,7 +407,7 @@ public function checkDeleteComment(string $id, string $commentId)
      * @DELETE
      */
     #[Path("id", new VUuid(), "identifier of the solution", required: true)]
-    #[Path("commentId", new VString(), "identifier of the review comment", required: true)]
+    #[Path("commentId", new VUuid(), "identifier of the review comment", required: true)]
     public function actionDeleteComment(string $id, string $commentId)
     {
         $comment = $this->reviewComments->findOrThrow($commentId);

app/V1Module/presenters/AssignmentsPresenter.php

@@ -211,7 +211,11 @@ public function checkUpdateDetail(string $id)
      */
     #[Post("version", new VInt(), "Version of the edited assignment")]
     #[Post("isPublic", new VBool(), "Is the assignment ready to be displayed to students?")]
-    #[Post("localizedTexts", new VArray(), "A description of the assignment")]
+    #[Post(
+        "localizedStudentHints",
+        new VArray(),
+        "Additional localized hint texts for students (locale => hint text)",
+    )]
     #[Post("firstDeadline", new VTimestamp(), "First deadline for submission of the assignment")]
     #[Post(
         "maxPointsBeforeFirstDeadline",
@@ -307,10 +311,6 @@ public function actionUpdateDetail(string $id)
             );
         }
 
-        // localized texts cannot be empty
-        if (count($req->getPost("localizedTexts")) == 0) {
-            throw new InvalidApiArgumentException('localizedTexts', "No entry for localized texts given.");
-        }
 
         if ($this->isRequestJson()) {
             $disabledRuntimeIds = $req->getPost("disabledRuntimeEnvironmentIds");
@@ -425,49 +425,17 @@ public function actionUpdateDetail(string $id)
             $this->solutionEvaluations->flush();
         }
 
-        // go through localizedTexts and construct database entities
-        $localizedTexts = [];
+        // go through localized hints and construct database entities
         $localizedAssignments = [];
-        foreach ($req->getPost("localizedTexts") as $localization) {
-            $lang = $localization["locale"];
-
-            if (array_key_exists($lang, $localizedTexts)) {
-                throw new InvalidApiArgumentException('localizedTexts', "Duplicate entry for language '$lang'");
-            }
-
-            // create all new localized texts
-            $assignmentExercise = $assignment->getExercise();
-            $localizedExercise = $assignmentExercise ? $assignmentExercise->getLocalizedTextByLocale($lang) : null;
-            $externalAssignmentLink = trim(Arrays::get($localization, "link", ""));
-            if ($externalAssignmentLink !== "" && !Validators::isUrl($externalAssignmentLink)) {
-                throw new InvalidApiArgumentException('link', "External assignment link is not a valid URL");
-            }
-
-            $localizedTexts[$lang] = new LocalizedExercise(
+        foreach ($req->getPost("localizedStudentHints") ?? [] as $lang => $hintText) {
+            $localizedAssignments[$lang] = new LocalizedAssignment(
                 $lang,
-                trim(Arrays::get($localization, "name", "")),
-                trim(Arrays::get($localization, "text", "")),
-                $localizedExercise ? $localizedExercise->getDescription() : "",
-                $externalAssignmentLink ?: null
+                trim($hintText)
             );
-
-            if (array_key_exists("studentHint", $localization)) {
-                $localizedAssignments[$lang] = new LocalizedAssignment(
-                    $lang,
-                    trim(Arrays::get($localization, "studentHint", ""))
-                );
-            }
-        }
-
-        // make changes to database
-        Localizations::updateCollection($assignment->getLocalizedTexts(), $localizedTexts);
-
-        foreach ($assignment->getLocalizedTexts() as $localizedText) {
-            $this->assignments->persist($localizedText, false);
         }
 
+        // save changes to database (if any)
         Localizations::updateCollection($assignment->getLocalizedAssignments(), $localizedAssignments);
-
         foreach ($assignment->getLocalizedAssignments() as $localizedAssignment) {
             $this->assignments->persist($localizedAssignment, false);
         }
@@ -501,7 +469,81 @@ public function actionUpdateDetail(string $id)
             }
         }
 
-        $this->assignments->flush();
+        $this->assignments->persist($assignment);
+        $this->sendSuccessResponse($this->assignmentViewFactory->getAssignment($assignment));
+    }
+
+    public function checkUpdateLocalizedTexts(string $id)
+    {
+        $assignment = $this->assignments->findOrThrow($id);
+        if (!$this->assignmentAcl->canUpdate($assignment)) {
+            throw new ForbiddenRequestException("You cannot update this assignment.");
+        }
+    }
+
+    /**
+     * Update (only) the localized texts of an assignment.
+     * This is a separate operations since the texts are taken over from the exercise.
+     * Updating them is an override of the exercise specification and needs to be handled carefully.
+     * @POST
+     */
+    #[Post("version", new VInt(), "Version of the edited assignment")]
+    #[Post("localizedTexts", new VArray(), "Localized texts with exercise/assignment specification")]
+    #[Path("id", new VUuid(), "Identifier of the updated assignment", required: true)]
+    public function actionUpdateLocalizedTexts(string $id)
+    {
+        $assignment = $this->assignments->findOrThrow($id);
+
+        $req = $this->getRequest();
+        $version = (int)$req->getPost("version");
+        if ($version !== $assignment->getVersion()) {
+            $newVer = $assignment->getVersion();
+            throw new BadRequestException(
+                "The assignment was edited in the meantime and the version has changed. Current version is $newVer.",
+                FrontendErrorMappings::E400_010__ENTITY_VERSION_TOO_OLD,
+                [
+                    'entity' => 'assignment',
+                    'id' => $id,
+                    'version' => $newVer
+                ]
+            );
+        }
+
+        // go through localizedTexts and construct database entities
+        $localizedTexts = [];
+        foreach ($req->getPost("localizedTexts") as $localization) {
+            $lang = $localization["locale"];
+
+            if (array_key_exists($lang, $localizedTexts)) {
+                throw new InvalidApiArgumentException('localizedTexts', "Duplicate entry for language '$lang'");
+            }
+
+            // create all new localized texts
+            $assignmentExercise = $assignment->getExercise();
+            $localizedExercise = $assignmentExercise ? $assignmentExercise->getLocalizedTextByLocale($lang) : null;
+            $externalAssignmentLink = trim(Arrays::get($localization, "link", ""));
+            if ($externalAssignmentLink !== "" && !Validators::isUrl($externalAssignmentLink)) {
+                throw new InvalidApiArgumentException('link', "External assignment link is not a valid URL");
+            }
+
+            $localizedTexts[$lang] = new LocalizedExercise(
+                $lang,
+                trim(Arrays::get($localization, "name", "")),
+                trim(Arrays::get($localization, "text", "")),
+                $localizedExercise ? $localizedExercise->getDescription() : "",
+                $externalAssignmentLink ?: null
+            );
+        }
+
+        // make changes to database
+        Localizations::updateCollection($assignment->getLocalizedTexts(), $localizedTexts);
+        foreach ($assignment->getLocalizedTexts() as $localizedText) {
+            $this->assignments->persist($localizedText, false);
+        }
+
+        $assignment->incrementVersion();
+        $assignment->updatedNow();
+        $this->assignments->persist($assignment);
         $this->sendSuccessResponse($this->assignmentViewFactory->getAssignment($assignment));
     }
 
@@ -543,8 +585,8 @@ public function actionValidate($id)
      * @throws InvalidStateException
      * @throws NotFoundException
      */
-    #[Post("exerciseId", new VMixed(), "Identifier of the exercise", nullable: true)]
-    #[Post("groupId", new VMixed(), "Identifier of the group", nullable: true)]
+    #[Post("exerciseId", new VUuid(), "Identifier of the exercise", nullable: true)]
+    #[Post("groupId", new VUuid(), "Identifier of the group", nullable: true)]
     public function actionCreate()
     {
         $req = $this->getRequest();
@@ -645,10 +687,17 @@ public function checkSyncWithExercise(string $id)
      * @throws NotFoundException
      */
     #[Path("id", new VUuid(), "Identifier of the assignment that should be synchronized", required: true)]
+    #[Post("syncOptions", new VArray(new VString(
+        1,
+        32,
+        '/^(configurationType|exerciseConfig|exerciseEnvironmentConfigs|exerciseTests|files|fileLinks|hardwareGroups'
+            . '|limits|localizedTexts|mergeJudgeLogs|runtimeEnvironments|scoreConfig)$/'
+    )), "List of options what to synchronize (if missing, everything is synchronized)", required: false)]
     public function actionSyncWithExercise($id)
     {
         $assignment = $this->assignments->findOrThrow($id);
         $exercise = $assignment->getExercise();
+        $syncOptions = $this->getRequest()->getPost("syncOptions") ?? [];
 
         if ($exercise === null) {
             throw new NotFoundException("Exercise for assignment '{$id}' was deleted");
@@ -661,7 +710,7 @@ public function actionSyncWithExercise($id)
         }
 
         $assignment->updatedNow();
-        $assignment->syncWithExercise();
+        $assignment->syncWithExercise($syncOptions);
         $this->assignments->flush();
         $this->sendSuccessResponse($this->assignmentViewFactory->getAssignment($assignment));
     }
@@ -713,7 +762,7 @@ public function checkUserSolutions(string $id, string $userId)
      * @GET
      */
     #[Path("id", new VUuid(), "Identifier of the assignment", required: true)]
-    #[Path("userId", new VString(), "Identifier of the user", required: true)]
+    #[Path("userId", new VUuid(), "Identifier of the user", required: true)]
     public function actionUserSolutions(string $id, string $userId)
     {
         $assignment = $this->assignments->findOrThrow($id);
@@ -757,7 +806,7 @@ public function checkBestSolution(string $id, string $userId)
      * @throws ForbiddenRequestException
      */
     #[Path("id", new VUuid(), "Identifier of the assignment", required: true)]
-    #[Path("userId", new VString(), "Identifier of the user", required: true)]
+    #[Path("userId", new VUuid(), "Identifier of the user", required: true)]
     public function actionBestSolution(string $id, string $userId)
     {
         $assignment = $this->assignments->findOrThrow($id);

app/V1Module/presenters/CommentsPresenter.php

@@ -180,12 +180,12 @@ public function checkTogglePrivate(string $threadId, string $commentId)
 
     /**
      * Make a private comment public or vice versa
-     * @DEPRECATED
+     * @deprecated
      * @POST
      * @throws NotFoundException
      */
-    #[Path("threadId", new VString(), "Identifier of the comment thread", required: true)]
-    #[Path("commentId", new VString(), "Identifier of the comment", required: true)]
+    #[Path("threadId", new VUuid(), "Identifier of the comment thread", required: true)]
+    #[Path("commentId", new VUuid(), "Identifier of the comment", required: true)]
     public function actionTogglePrivate(string $threadId, string $commentId)
     {
         /** @var Comment $comment */
@@ -218,8 +218,8 @@ public function checkSetPrivate(string $threadId, string $commentId)
      * @throws NotFoundException
      */
     #[Post("isPrivate", new VBool(), "True if the comment is private")]
-    #[Path("threadId", new VString(), "Identifier of the comment thread", required: true)]
-    #[Path("commentId", new VString(), "Identifier of the comment", required: true)]
+    #[Path("threadId", new VUuid(), "Identifier of the comment thread", required: true)]
+    #[Path("commentId", new VUuid(), "Identifier of the comment", required: true)]
     public function actionSetPrivate(string $threadId, string $commentId)
     {
         /** @var Comment $comment */
@@ -255,8 +255,8 @@ public function checkDelete(string $threadId, string $commentId)
      * @throws ForbiddenRequestException
      * @throws NotFoundException
      */
-    #[Path("threadId", new VString(), "Identifier of the comment thread", required: true)]
-    #[Path("commentId", new VString(), "Identifier of the comment", required: true)]
+    #[Path("threadId", new VUuid(), "Identifier of the comment thread", required: true)]
+    #[Path("commentId", new VUuid(), "Identifier of the comment", required: true)]
     public function actionDelete(string $threadId, string $commentId)
     {
         /** @var Comment $comment */

app/V1Module/presenters/EmailsPresenter.php

@@ -10,6 +10,7 @@
 use App\Exceptions\NotFoundException;
 use App\Helpers\EmailHelper;
 use App\Helpers\Emails\EmailLocalizationHelper;
+use App\Helpers\MetaFormats\Validators\VUuid;
 use App\Model\Entity\User;
 use App\Model\Repository\Groups;
 use App\Security\ACL\IEmailPermissions;
@@ -166,7 +167,7 @@ public function checkSendToGroupMembers(string $groupId)
     #[Post("toMe", new VBool(), "User wants to also receive an email")]
     #[Post("subject", new VString(1), "Subject for the soon to be sent email")]
     #[Post("message", new VString(1), "Message which will be sent, can be html code")]
-    #[Path("groupId", new VString(), required: true)]
+    #[Path("groupId", new VUuid(), required: true)]
     public function actionSendToGroupMembers(string $groupId)
     {
         $user = $this->getCurrentUser();