✨ feat: add segment disable/enable API for translation cancel requests

lib/Controller/API/App/SetTranslationController.php

@@ -6,6 +6,7 @@
 use Controller\API\Commons\Exceptions\AuthenticationError;
 use Controller\API\Commons\Validators\LoginValidator;
 use Controller\Traits\APISourcePageGuesserTrait;
+use Controller\Traits\SegmentDisabledTrait;
 use Exception;
 use InvalidArgumentException;
 use Matecat\ICU\MessagePatternComparator;
@@ -57,7 +58,7 @@
 
 class SetTranslationController extends AbstractStatefulKleinController
 {
-
+    use SegmentDisabledTrait;
     use APISourcePageGuesserTrait;
     use ICUSourceSegmentChecker;
 
@@ -137,6 +138,7 @@ public function translate(): void
 
         try {
             $this->data = $this->validateTheRequest();
+            $this->checkIfSegmentIsNotDisabled();
             $this->setSubFilteringBehavior();
             $this->checkSegmentSplitData();
             $this->initVersionHandler();
@@ -408,6 +410,7 @@ public function translate(): void
             $this->response->json($result);
         } catch (Exception $exception) {
             $db->rollback();
+            $this->logger->error($exception->getMessage());
             throw $exception;
         }
     }
@@ -554,6 +557,26 @@ private function validateTheRequest(): array
         return $data;
     }
 
+    /**
+     * checkIfIsNotDisabled
+     *
+     * Determines whether the segment associated with a specific job and segment ID
+     * is disabled by checking cached information. If the segment is found to be disabled,
+     * an exception is thrown.
+     *
+     * @return void
+     * @throws Exception If the segment is disabled.
+     */
+    private function checkIfSegmentIsNotDisabled(): void
+    {
+        $id_job = $this->data['id_job'];
+        $id_segment = $this->data['id_segment'];
+
+        if ($this->isSegmentDisabled((int)$id_job, (int)$id_segment)) {
+            throw new RuntimeException("Segment #".$id_segment." is disabled", -5);
+        }
+}
+
     /**
      * @return bool
      */

lib/Controller/API/V3/CancelRequestController.php

@@ -0,0 +1,191 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: vincenzoruffa
+ * Date: 13/09/2018
+ * Time: 13:03
+ */
+
+namespace Controller\API\V3;
+
+use Controller\Abstracts\KleinController;
+use Controller\API\Commons\Validators\LoginValidator;
+use Controller\Traits\ChunkNotFoundHandlerTrait;
+use Controller\Traits\RateLimiterTrait;
+use Controller\Traits\SegmentDisabledTrait;
+use Exception;
+use Klein\Response;
+use Model\DataAccess\DaoCacheTrait;
+use Model\Exceptions\NotFoundException;
+use Model\Segments\SegmentMetadataDao;
+use Model\Translations\SegmentTranslationDao;
+use Model\Translations\SegmentTranslationStruct;
+use Utils\Constants\TranslationStatus;
+use Utils\Tools\Utils;
+
+class CancelRequestController extends KleinController
+{
+    use DaoCacheTrait;
+    use RateLimiterTrait;
+    use SegmentDisabledTrait;
+    use ChunkNotFoundHandlerTrait;
+
+    protected function afterConstruct(): void
+    {
+        $this->appendValidator(new LoginValidator($this));
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function enableRequest(): void
+    {
+        $rawIdJob = $this->request->param('id_job');
+        $password = $this->request->param('password');
+        $rawIdSegment = $this->request->param('id_segment');
+        $id_job = filter_var($rawIdJob, FILTER_VALIDATE_INT);
+        $id_segment = filter_var($rawIdSegment, FILTER_VALIDATE_INT);
+        $route = '/api/v3/jobs/'.$id_job.'/'.$password.'/segment/enable/'.$id_segment;
+
+        $this->performChecks($id_job, $password, $id_segment, $route);
+
+        if ($this->response->code() === 429) {
+            return;
+        }
+
+        if($this->isSegmentDisabled($id_job, $id_segment)){
+            $this->destroySegmentDisabledCache($id_job, $id_segment);
+        }
+
+        $this->response->json([
+            'id_segment' => $id_segment,
+        ]);
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function cancelRequest(): void
+    {
+        $rawIdJob = $this->request->param('id_job');
+        $password = $this->request->param('password');
+        $rawIdSegment = $this->request->param('id_segment');
+        $id_job = filter_var($rawIdJob, FILTER_VALIDATE_INT);
+        $id_segment = filter_var($rawIdSegment, FILTER_VALIDATE_INT);
+        $route = '/api/v3/jobs/'.$id_job.'/'.$password.'/segment/disable/'.$id_segment;
+
+        $this->performChecks($id_job, $password, $id_segment, $route);
+
+        if ($this->response->code() === 429) {
+            return;
+        }
+
+        // If the cache is empty, it means that the segment is not already disabled, so we can proceed with disabling it and
+        // setting the cache to avoid multiple disable requests for the same segment in a short time frame
+        if (!$this->isSegmentDisabled($id_job, $id_segment)) {
+            SegmentMetadataDao::destroyGetAllCache($id_segment);
+            SegmentMetadataDao::setTranslationDisabled($id_segment);
+            $this->saveSegmentDisabledInCache($id_job, $id_segment);
+        }
+
+        $this->response->json([
+            'id_segment' => $id_segment,
+        ]);
+    }
+
+    /**
+     * Performs several validation checks and rate limit handling for disabling a segment in a job.
+     *
+     * @param int $id_job The unique identifier of the job.
+     * @param string $password The password associated with the job for authentication.
+     * @param int $id_segment The unique identifier of the segment to be validated.
+     * @param string $route The API route being accessed.
+     *
+     * @throws NotFoundException If the job or segment is not found.
+     * @throws Exception If the user is not the owner or part of the team, or if the segment status is not "new".
+     */
+    private function performChecks(int $id_job, string $password, int $id_segment, string $route): void
+    {
+        $userEmail = $this->user->email ?? "BLANK_EMAIL";
+        $userIp = Utils::getRealIpAddr() ?? "127.0.0.1";
+
+        // 1. check rate limit
+        $checkRateLimitEmail = $this->checkRateLimitResponse($this->response, $userEmail, $route, 5);
+        $checkRateLimitIp = $this->checkRateLimitResponse($this->response, $userIp, $route, 5);
+
+        if ($checkRateLimitIp instanceof Response) {
+            $this->response = $checkRateLimitIp;
+
+            return;
+        }
+
+        if ($checkRateLimitEmail instanceof Response) {
+            $this->response = $checkRateLimitEmail;
+
+            return;
+        }
+
+        // 2. check job id and password
+        $job = $this->getJob($id_job, $password);
+
+        if (null === $job) {
+            $this->incrementRateLimitCounter($userEmail, $route);
+            $this->incrementRateLimitCounter($userIp, $route);
+
+            throw new NotFoundException('Job not found.');
+        }
+
+        // 3. check segment translation
+        $segmentTranslation = $this->findSegmentTranslation($id_segment, $id_job);
+
+        if (empty($segmentTranslation)) {
+            $this->incrementRateLimitCounter($userEmail, $route);
+            $this->incrementRateLimitCounter($userIp, $route);
+
+            throw new NotFoundException('Segment not found');
+        }
+
+        // 4. check is user is the owner of the segment
+        $team = $job->getProject()->getTeam();
+
+        if(empty($team)){
+            $this->incrementRateLimitCounter($userEmail, $route);
+            $this->incrementRateLimitCounter($userIp, $route);
+
+            throw new NotFoundException('Team not found');
+        }
+
+        if(!empty($this->getUser()->uid) && $team->created_by != $this->getUser()->uid){
+
+            // check if user is part of the team
+            if (!$team->hasUser($this->getUser()->uid)){
+                $this->incrementRateLimitCounter($userEmail, $route);
+                $this->incrementRateLimitCounter($userIp, $route);
+
+                throw new Exception('User is not part of the team');
+            }
+        }
+
+        // 5. check segment status
+        if ($segmentTranslation->status !== TranslationStatus::STATUS_NEW) {
+            $this->incrementRateLimitCounter($userEmail, $route);
+            $this->incrementRateLimitCounter($userIp, $route);
+
+            throw new Exception('Segment is not in "new" status and cannot be disabled');
+        }
+
+        $this->incrementRateLimitCounter($userEmail, $route);
+        $this->incrementRateLimitCounter($userIp, $route);
+    }
+
+    /**
+     * @param int $id_segment
+     * @param int $id_job
+     *
+     * @return ?SegmentTranslationStruct
+     */
+    protected function findSegmentTranslation(int $id_segment, int $id_job): ?SegmentTranslationStruct
+    {
+        return SegmentTranslationDao::findBySegmentAndJob($id_segment, $id_job);
+    }
+}

lib/Controller/API/V3/SegmentAnalysisController.php

@@ -4,6 +4,7 @@
 
 use Controller\Abstracts\KleinController;
 use Controller\API\Commons\Validators\LoginValidator;
+use Controller\Traits\SegmentDisabledTrait;
 use Exception;
 use Matecat\SubFiltering\MateCatFilter;
 use Model\Analysis\Constants\ConstantsInterface;
@@ -29,6 +30,7 @@
 
 class SegmentAnalysisController extends KleinController
 {
+    use SegmentDisabledTrait;
 
     const int MAX_PER_PAGE = 200;
 
@@ -346,6 +348,8 @@ private function formatSegment(
             $metadataDao->getProjectStaticSubfilteringCustomHandlers($jobStruct->id_project)
         );
 
+        $disabled = $this->isSegmentDisabled($segmentForAnalysis->id_job, $segmentForAnalysis->id);
+
         return [
             'id_segment' => (int)$segmentForAnalysis->id,
             'id_chunk' => (int)$segmentForAnalysis->id_job,
@@ -366,6 +370,7 @@ private function formatSegment(
             'notes' => (!empty($notesAggregate[$segmentForAnalysis->id]) ? $notesAggregate[$segmentForAnalysis->id] : []),
             'status' => $this->getStatusObject($segmentForAnalysis),
             'last_edit' => ($segmentForAnalysis->last_edit !== null) ? date(DATE_ATOM, strtotime($segmentForAnalysis->last_edit)) : null,
+            'disabled' => $disabled,
         ];
     }
 

lib/Controller/Traits/ChunkNotFoundHandlerTrait.php

@@ -22,7 +22,7 @@ trait ChunkNotFoundHandlerTrait
      * @return ?JobStruct
      * @throws ReflectionException
      */
-    protected function getJob($id_job, $password): ?JobStruct
+    protected function getJob(int $id_job, string $password): ?JobStruct
     {
         $job = JobDao::getByIdAndPassword($id_job, $password);
 

lib/Controller/Traits/RateLimiterTrait.php

@@ -93,6 +93,6 @@ private function getTtl(): int
         $date = new DateTime();
         $ttl = 60 - $date->format("s");
 
-        return 60 + $ttl;
+        return 60 + (int)$ttl;
     }
 }