D8AGE-291: The translate actions.

composer.json

@@ -30,7 +30,7 @@
         "drupal/paragraphs": "^1.13",
         "drupal/typed_link": "^2.0",
         "drush/drush": "^12",
-        "openeuropa/cdt-client": "dev-D8AGE-289",
+        "openeuropa/cdt-client": "1.x-dev",
         "openeuropa/code-review": "^2.0",
         "openeuropa/epoetry-client": "1.x-dev || 2.x-dev",
         "openeuropa/oe_content": "^3.0.0-beta2",
@@ -74,6 +74,7 @@
     "autoload-dev": {
         "psr-4": {
             "Drupal\\Tests\\oe_translation\\": "./tests/src",
+            "Drupal\\Tests\\oe_translation_cdt\\": "./modules/oe_translation_cdt/tests/src",
             "Drupal\\Tests\\oe_translation_epoetry\\": "./modules/oe_translation_epoetry/tests/src",
             "Drupal\\Tests\\oe_translation_corporate_workflow\\": "./modules/oe_translation_corporate_workflow/tests/src",
             "Drupal\\Tests\\oe_translation_active_revision\\": "./modules/oe_translation_corporate_workflow/modules/oe_translation_active_revision/tests/src",

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/oe_translation_cdt_mock.module

@@ -0,0 +1,100 @@
+<?php
+
+/**
+ * @file
+ * Primary module hooks for OpenEuropa Translation CDT mock module.
+ */
+
+declare(strict_types=1);
+
+use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Url;
+use Drupal\oe_translation_cdt\Api\CdtApiWrapperInterface;
+use Drupal\oe_translation_cdt\TranslationRequestCdt;
+
+/**
+ * Implements hook_entity_ENTITY_TYPE_view_alter().
+ */
+function oe_translation_cdt_mock_oe_translation_request_view_alter(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display) {
+  if ($entity->bundle() !== 'cdt') {
+    return;
+  }
+
+  /** @var \Drupal\oe_translation_cdt\TranslationRequestCdtInterface $entity */
+  if (!isset($build['meta'])) {
+    return;
+  }
+  $row = &$build['meta']['#rows'][0];
+
+  $operations = [];
+  $all_statuses = [
+    CdtApiWrapperInterface::STATUS_REQUEST_COMPLETED => 'Completed',
+    CdtApiWrapperInterface::STATUS_REQUEST_IN_PROGRESS => 'In progress',
+    CdtApiWrapperInterface::STATUS_REQUEST_CANCELLED => 'Cancelled',
+    CdtApiWrapperInterface::STATUS_REQUEST_PENDING_APPROVAL => 'Pending approval',
+    CdtApiWrapperInterface::STATUS_REQUEST_UNDER_QUOTATION => 'Under quotation',
+  ];
+  foreach ($all_statuses as $status => $label) {
+    $operations[$status] = [
+      'title' => sprintf('Update status to %s (mock)', $label),
+      'url' => Url::fromRoute('oe_translation_cdt_mock.request_status', [
+        'translation_request' => $entity->id(),
+      ], [
+        'query' => [
+          'destination' => Url::fromRoute('<current>')->toString(),
+          'status' => $status,
+        ],
+      ]),
+    ];
+  }
+
+  if (!isset($row['cdt_operations'])) {
+    $row['cdt_operations'] = [
+      'data' => [
+        '#type' => 'operations',
+        '#links' => $operations,
+      ],
+    ];
+  }
+  else {
+    $row['cdt_operations']['data']['#links'] += $operations;
+  }
+}
+
+/**
+ * Implements template_preprocess_table__remote_language_list().
+ */
+function oe_translation_cdt_mock_preprocess_table__remote_language_list(array &$variables) {
+  $id = (string) $variables['attributes']['data-translation-request'];
+  $request = TranslationRequestCdt::load($id);
+  if (!$request || $request->bundle() !== 'cdt' || !$request->getCdtId()) {
+    return;
+  }
+
+  $all_statuses = [
+    CdtApiWrapperInterface::STATUS_JOB_COMPLETED => 'Completed',
+    CdtApiWrapperInterface::STATUS_JOB_FAILED => 'Failed',
+    CdtApiWrapperInterface::STATUS_JOB_IN_PROGRESS => 'In progress',
+    CdtApiWrapperInterface::STATUS_JOB_CANCELLED => 'Cancelled',
+    CdtApiWrapperInterface::STATUS_JOB_TO_BE_CANCELLED => 'To be cancelled',
+  ];
+  foreach ($variables['rows'] as &$row) {
+    $langcode = (string) $row['attributes']['hreflang'];
+    foreach ($all_statuses as $status => $label) {
+      $row['cells']['operations']['content']['#links'][] = [
+        'title' => sprintf('Update status to %s (mock)', $label),
+        'url' => Url::fromRoute('oe_translation_cdt_mock.job_status', [
+          'translation_request' => $id,
+          'langcode' => $langcode,
+        ], [
+          'query' => [
+            'destination' => Url::fromRoute('<current>')->toString(),
+            'status' => $status,
+          ],
+        ]),
+      ];
+    }
+
+  }
+}

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/oe_translation_cdt_mock.routing.yml

@@ -0,0 +1,25 @@
+oe_translation_cdt_mock.job_status:
+  path: '/translation-request/cdt/mock/job_status/{translation_request}/{langcode}'
+  defaults:
+    _title: 'Change job status'
+    _controller: '\Drupal\oe_translation_cdt_mock\Controller\MockController::changeJobStatus'
+  requirements:
+    _permission: 'translate any entity'
+  options:
+    parameters:
+      translation_request:
+        type: entity:oe_translation_request
+      langcode:
+        type: string
+
+oe_translation_cdt_mock.request_status:
+  path: '/translation-request/cdt/mock/request_status/{translation_request}'
+  defaults:
+    _title: 'Change request status'
+    _controller: '\Drupal\oe_translation_cdt_mock\Controller\MockController::changeRequestStatus'
+  requirements:
+    _permission: 'translate any entity'
+  options:
+    parameters:
+      translation_request:
+        type: entity:oe_translation_request

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/responses/json/reference_data_response_200.json

@@ -2,11 +2,11 @@
   "departments": [
     {
       "code": "123",
-      "description": "External Translation Unit - Contracts Execution Department"
+      "description": "Department 1"
     },
     {
       "code": "456",
-      "description": "Service Finance"
+      "description": "Department 2"
     }
   ],
   "priorities": [
@@ -309,13 +309,23 @@
   ],
   "contacts": [
     {
-      "email": "test@example.com",
-      "firstName": "DGTRAD - Ext. Transl. Unit ",
-      "lastName": "Contracts Execution Dept.",
-      "userName": "TESTUSER",
+      "email": "test1@example.com",
+      "firstName": "John",
+      "lastName": "Smith",
+      "userName": "TESTUSER1",
       "countryCode": null,
       "phoneCountryCode": null,
-      "phoneNumber": "+351234123123",
+      "phoneNumber": "+351231231231",
+      "countryName": ""
+    },
+    {
+      "email": "test2@example.com",
+      "firstName": "Jane",
+      "lastName": "Doe",
+      "userName": "TESTUSER2",
+      "countryCode": null,
+      "phoneCountryCode": null,
+      "phoneNumber": "+354564564564",
       "countryName": ""
     }
   ]

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/responses/json/status_response_200.json

@@ -12,12 +12,12 @@
   "deliveryDate": "2024-03-30T14:41:34.7045082",
   "title": "Test translation",
   "service": "Translation",
-  "department": "External Translation Unit - Contracts Execution Department",
+  "department": "Department 1",
   "contacts": [
-    "DGTRAD - Ext. Transl. Unit  Contracts Execution Dept."
+    "John Smith"
   ],
   "deliverToContacts": [
-    "DGTRAD - Ext. Transl. Unit  Contracts Execution Dept."
+    "Jane Doe"
   ],
   "sourceDocuments": [
     {

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/src/Controller/MockController.php

@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\oe_translation_cdt_mock\Controller;
+
+use Drupal\Core\Controller\ControllerBase;
+use Drupal\oe_translation_cdt\Mapper\LanguageCodeMapper;
+use Drupal\oe_translation_cdt\TranslationRequestCdtInterface;
+use Drupal\oe_translation_cdt\TranslationRequestUpdaterInterface;
+use OpenEuropa\CdtClient\Model\Callback\JobStatus;
+use OpenEuropa\CdtClient\Model\Callback\RequestStatus;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+/**
+ * Returns responses for OpenEuropa Translation CDT mock routes.
+ */
+final class MockController extends ControllerBase {
+
+  /**
+   * Constructs the controller.
+   *
+   * @param \Drupal\oe_translation_cdt\TranslationRequestUpdaterInterface $updater
+   *   The translation request updater.
+   */
+  public function __construct(
+    private readonly TranslationRequestUpdaterInterface $updater,
+  ) {}
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container): self {
+    return new static(
+      $container->get('oe_translation_cdt.translation_request_updater'),
+    );
+  }
+
+  /**
+   * Changes the translation job status by mocking.
+   *
+   * @param \Drupal\oe_translation_cdt\TranslationRequestCdtInterface $translation_request
+   *   The translation request.
+   * @param string $langcode
+   *   The language code.
+   * @param \Symfony\Component\HttpFoundation\Request $request
+   *   The request.
+   *
+   * @return \Symfony\Component\HttpFoundation\Response
+   *   The response.
+   */
+  public function changeJobStatus(TranslationRequestCdtInterface $translation_request, string $langcode, Request $request): Response {
+    $job_status = new JobStatus();
+    $job_status->setTargetLanguageCode(LanguageCodeMapper::getCdtLanguageCode($langcode, $translation_request));
+    $job_status->setStatus((string) $request->query->get('status'));
+    $job_status->setRequestIdentifier((string) $translation_request->getCdtId());
+    $this->updater->updateFromJobStatus($translation_request, $job_status);
+
+    $destination = $request->query->get('destination');
+    if (!$destination) {
+      throw new NotFoundHttpException();
+    }
+    return new RedirectResponse((string) $destination);
+  }
+
+  /**
+   * Changes the translation request status by mocking.
+   *
+   * @param \Drupal\oe_translation_cdt\TranslationRequestCdtInterface $translation_request
+   *   The translation request.
+   * @param \Symfony\Component\HttpFoundation\Request $request
+   *   The request.
+   *
+   * @return \Symfony\Component\HttpFoundation\Response
+   *   The response.
+   */
+  public function changeRequestStatus(TranslationRequestCdtInterface $translation_request, Request $request): Response {
+    $request_status = new RequestStatus();
+    $request_status->setRequestIdentifier((string) $translation_request->getCdtId());
+    $request_status->setStatus((string) $request->query->get('status'));
+    $this->updater->updateFromRequestStatus($translation_request, $request_status);
+
+    $destination = $request->query->get('destination');
+    if (!$destination) {
+      throw new NotFoundHttpException();
+    }
+    return new RedirectResponse((string) $destination);
+  }
+
+}

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/src/Plugin/ServiceMock/FileApi.php

@@ -20,7 +20,7 @@
  * @ServiceMock(
  *   id = "oe_translation_cdt_file_api",
  *   label = @Translation("CDT mocked file responses for testing."),
- *   weight = -1,
+ *   weight = -2,
  * )
  */
 class FileApi extends ServiceMockBase {
@@ -50,7 +50,7 @@ public function __construct(
     protected ModuleExtensionList $moduleExtensionList,
     protected EntityTypeManagerInterface $entityTypeManager,
     protected LoggerChannelFactoryInterface $loggerFactory,
-    protected ContentFormatterInterface $xmlFormatter
+    protected ContentFormatterInterface $xmlFormatter,
   ) {
     parent::__construct($configuration, $plugin_id, $plugin_definition, $moduleExtensionList, $entityTypeManager, $loggerFactory);
   }
@@ -92,16 +92,20 @@ public function getEndpointResponse(RequestInterface $request): ResponseInterfac
       return new Response(400, [], $this->getResponseFromFile('file_response_400.json'));
     }
 
+    // Create a duplicate of the current entity and change the text.
+    // This way, we avoid modifying the original entity, and saving it
+    // accidentally in the database.
     $data = TranslationSourceHelper::filterTranslatable($entity->getData());
+    $translated_entity = $entity->createDuplicate();
     foreach ($data as &$field) {
       $field['#text'] = sprintf(
         '%s translation of %s',
         $parameters['language'],
         $field['#text']
       );
     }
-    $entity->setData($data);
-    $xml = $this->xmlFormatter->export($entity);
+    $translated_entity->setData($data);
+    $xml = $this->xmlFormatter->export($translated_entity);
 
     $this->log('200: Returning the mocked file.', $request);
     return new Response(200, [], $xml);

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/src/Plugin/ServiceMock/IdentifierApi.php

@@ -15,7 +15,7 @@
  * @ServiceMock(
  *   id = "oe_translation_cdt_identifier_api",
  *   label = @Translation("CDT mocked identifier responses for testing."),
- *   weight = -1,
+ *   weight = -2,
  * )
  */
 class IdentifierApi extends ServiceMockBase {

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/src/Plugin/ServiceMock/MainApi.php

@@ -15,7 +15,7 @@
  * @ServiceMock(
  *   id = "oe_translation_cdt_main_api",
  *   label = @Translation("CDT mocked checkConnection responses for testing."),
- *   weight = -1,
+ *   weight = -2,
  * )
  */
 class MainApi extends ServiceMockBase {

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/src/Plugin/ServiceMock/ReferenceDataApi.php

@@ -15,7 +15,7 @@
  * @ServiceMock(
  *   id = "oe_translation_cdt_reference_data_api",
  *   label = @Translation("CDT mocked reference data responses for testing."),
- *   weight = -1,
+ *   weight = -2,
  * )
  */
 class ReferenceDataApi extends ServiceMockBase {

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/src/Plugin/ServiceMock/RequestsApi.php

@@ -15,7 +15,7 @@
  * @ServiceMock(
  *   id = "oe_translation_cdt_requests_api",
  *   label = @Translation("CDT mocked 'requests' responses for testing."),
- *   weight = -1,
+ *   weight = -2,
  * )
  */
 class RequestsApi extends ServiceMockBase {

modules/oe_translation_cdt/modules/oe_translation_cdt_mock/src/Plugin/ServiceMock/ServiceMockBase.php

@@ -42,7 +42,7 @@ public function __construct(
     $plugin_definition,
     protected ModuleExtensionList $moduleExtensionList,
     protected EntityTypeManagerInterface $entityTypeManager,
-    protected LoggerChannelFactoryInterface $loggerFactory
+    protected LoggerChannelFactoryInterface $loggerFactory,
   ) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
   }