Merge pull request #230 from openeuropa/EWPP-3721

EWPP-3721: CircaBC integration.
openeuropa · May 30, 2024 · afab1dc · afab1dc
2 parents d7477c3 + 351ab17
commit afab1dc
Show file tree

Hide file tree

Showing 35 changed files with 2,555 additions and 51 deletions.
diff --git a/.drone.yml b/.drone.yml
@@ -19,12 +19,12 @@ services:
       - COMPOSERVER=--2
       - DOCUMENT_ROOT=/test/oe_media
   mysql:
-    image: registry.fpfis.eu/fpfis/sql:percona-5.7
+    image: git.fpfis.tech.ec.europa.eu/fpfis/dependency_proxy/containers/percona:5.7
     command: --innodb-log-file-size=1G --max_allowed_packet=1G --innodb-buffer-pool-size=512M --wait_timeout=3000 --net_write_timeout=3000 --log_error_verbosity=3
     environment:
       - MYSQL_ALLOW_EMPTY_PASSWORD=yes
   selenium:
-    image: registry.fpfis.eu/fpfis/selenium:standalone-chrome-4.1.3-20220405
+    image: git.fpfis.tech.ec.europa.eu/fpfis/dependency_proxy/containers/selenium/standalone-chrome:4.1.3-20220405
     environment:
       - DISPLAY=:99
       - SCREEN_WIDTH=1440

diff --git a/composer.json b/composer.json
@@ -55,6 +55,7 @@
         "psr-4": {
             "Drupal\\Tests\\oe_media\\": "./tests/src",
             "Drupal\\Tests\\oe_media_embed\\": "./modules/oe_media_embed/tests/src",
+            "Drupal\\Tests\\oe_media_circabc\\": "./modules/oe_media_circabc/tests/src",
             "Drupal\\Tests\\oe_link_lists\\": "./build/modules/contrib/oe_link_lists/tests/src",
             "Drupal\\Tests\\oe_link_lists_manual_source\\": "./build/modules/contrib/oe_link_lists/modules/oe_link_lists_manual_source/tests/src",
             "Drupal\\FunctionalJavascriptTests\\": "./build/core/tests/Drupal/FunctionalJavascriptTests"

diff --git a/config/install/core.entity_form_display.media.document.default.yml b/config/install/core.entity_form_display.media.document.default.yml
@@ -15,7 +15,7 @@ bundle: document
 mode: default
 content:
   oe_media_file_type:
-    weight: 1
+    weight: 0
     settings: {  }
     third_party_settings: {  }
     type: options_select
@@ -30,7 +30,7 @@ content:
     region: content
   name:
     type: string_textfield
-    weight: 0
+    weight: 1
     region: content
     settings:
       size: 60

diff --git a/modules/oe_media_circabc/README.md b/modules/oe_media_circabc/README.md
@@ -0,0 +1,18 @@
+# Open Europa Media CircaBC
+
+This module integrates with CircaBC to create Document media based on CircaBC
+documents. It does so by adding a third option to the Document media file type field, next to Local and Remote.
+
+## Installation
+
+* Install the module
+* Add the settings configuration that contains the URL of the CircaBC instance. For example:
+
+```
+$settings['circabc'] = [
+  'url' => 'https://webgate.acceptance.ec.europa.eu/circabc-ewpp',
+];
+```
+
+* Add the CircaBC ID field to the Document media form display. It will not be visible, but it's required on the form.
+* Move the `File type` field to the top on the Document media form display.
diff --git a/...oe_media_circabc/config/install/field.field.media.document.oe_media_circabc_reference.yml b/...oe_media_circabc/config/install/field.field.media.document.oe_media_circabc_reference.yml
@@ -0,0 +1,20 @@
+langcode: en
+status: true
+dependencies:
+  config:
+    - field.storage.media.oe_media_circabc_reference
+    - media.type.document
+  module:
+    - oe_media_circabc
+id: media.document.oe_media_circabc_reference
+field_name: oe_media_circabc_reference
+entity_type: media
+bundle: document
+label: 'CircaBC Reference'
+description: ''
+required: false
+translatable: false
+default_value: {  }
+default_value_callback: ''
+settings: {  }
+field_type: oe_media_circabc_circabc_reference
diff --git a/modules/oe_media_circabc/config/install/field.storage.media.oe_media_circabc_reference.yml b/modules/oe_media_circabc/config/install/field.storage.media.oe_media_circabc_reference.yml
@@ -0,0 +1,18 @@
+langcode: en
+status: true
+dependencies:
+  module:
+    - media
+    - oe_media_circabc
+id: media.oe_media_circabc_reference
+field_name: oe_media_circabc_reference
+entity_type: media
+type: oe_media_circabc_circabc_reference
+settings: {  }
+module: oe_media_circabc
+locked: false
+cardinality: 1
+translatable: true
+indexes: {  }
+persist_with_no_fields: false
+custom_storage: false
diff --git a/modules/oe_media_circabc/config/schema/oe_media_circabc.schema.yml b/modules/oe_media_circabc/config/schema/oe_media_circabc.schema.yml
@@ -0,0 +1,19 @@
+field.value.oe_media_circabc_circabc_reference:
+  type: mapping
+  label: Default value
+  mapping:
+    uuid:
+      type: uuid
+      label: UUID
+    size:
+      type: integer
+      label: Size
+    mime:
+      type: string
+      label: Mime type
+    filename:
+      type: string
+      label: File name
+
+field.widget.settings.oe_media_circabc_default_widget:
+  type: field.widget.settings.string_textfield
diff --git a/...bc/modules/oe_media_circabc_mock/fixtures/nodes/5d634abd-fec1-452a-ae0b-62e4cf080506.json b/...bc/modules/oe_media_circabc_mock/fixtures/nodes/5d634abd-fec1-452a-ae0b-62e4cf080506.json
@@ -0,0 +1,76 @@
+{
+    "id": "5d634abd-fec1-452a-ae0b-62e4cf080506",
+    "name": "sample_pdf_FR.pdf",
+    "type": "{http://www.alfresco.org/model/content/1.0}content",
+    "service": "library",
+    "parentId": "de048a2c-b350-45eb-a8aa-c5e5d4ba8335",
+    "properties": {
+        "modifier": "test_user",
+        "initialVersion": "true",
+        "expiration_date": "",
+        "title": "",
+        "locale": "fr",
+        "content": "contentUrl=store://2023/10/25/7/55/8424044c-2e13-454c-b6bf-9eeb4a921511.bin|mimetype=null|size=3028|encoding=UTF-8|locale=en_GB_|id=3759",
+        "reference": "",
+        "issue_date": "2023-12-06T19:04Z",
+        "security_ranking": "NORMAL",
+        "translations": "2",
+        "modified": "2023-12-07T08:50Z",
+        "locked": "false",
+        "store-identifier": "SpacesStore",
+        "multilingual": "true",
+        "creator": "test_user",
+        "autoVersion": "true",
+        "node-uuid": "5d634abd-fec1-452a-ae0b-62e4cf080506",
+        "created": "2023-10-25T05:55Z",
+        "author": "",
+        "autoVersionOnUpdateProps": "false",
+        "isVersion": "false",
+        "workingCopy": "false",
+        "encoding": "UTF-8",
+        "store-protocol": "workspace",
+        "currentUserHasAccess": "true",
+        "versionLabel": "1.5",
+        "originalContainerId": "de048a2c-b350-45eb-a8aa-c5e5d4ba8335",
+        "size": "3028",
+        "name": "sample_pdf_FR.pdf",
+        "mimetype": "application/pdf",
+        "mimetypeName": "",
+        "status": "DRAFT",
+        "node-dbid": "4641"
+    },
+    "title": {
+        "de": "",
+        "fi": "",
+        "pt": "",
+        "bg": "",
+        "lt": "",
+        "lv": "",
+        "hr": "",
+        "fr": "Test sample file FR",
+        "hu": "",
+        "sk": "",
+        "sl": "",
+        "ga": "",
+        "sv": "",
+        "mt": "",
+        "el": "",
+        "en": "",
+        "it": "",
+        "es": "",
+        "et": "",
+        "cs": "",
+        "pl": "",
+        "da": "",
+        "ro": "",
+        "nl": ""
+    },
+    "description": {},
+    "permissions": {
+        "LibAccess": "ALLOWED"
+    },
+    "notifications": "inherit",
+    "favourite": false,
+    "hasSubFolders": false,
+    "hasGuestAccess": true
+}
diff --git a/...bc/modules/oe_media_circabc_mock/fixtures/nodes/e74e3bc0-a639-4e04-a839-3bbd60ed5688.json b/...bc/modules/oe_media_circabc_mock/fixtures/nodes/e74e3bc0-a639-4e04-a839-3bbd60ed5688.json
@@ -0,0 +1,75 @@
+{
+    "id": "e74e3bc0-a639-4e04-a839-3bbd60ed5688",
+    "name": "sample_pdf.pdf",
+    "type": "{http://www.alfresco.org/model/content/1.0}content",
+    "service": "library",
+    "parentId": "de048a2c-b350-45eb-a8aa-c5e5d4ba8335",
+    "properties": {
+        "modifier": "test_user",
+        "initialVersion": "true",
+        "title": "",
+        "locale": "en",
+        "content": "contentUrl=store://2023/10/25/7/55/b8524c7c-3dea-4a62-a038-69f0ebf6c39b.bin|mimetype=application/pdf|size=3028|encoding=UTF-8|locale=en_GB_|id=2895",
+        "security_ranking": "PUBLIC",
+        "translations": "2",
+        "modified": "2023-10-25T05:55Z",
+        "keyword": "[]",
+        "locked": "false",
+        "store-identifier": "SpacesStore",
+        "multilingual": "true",
+        "owner": "test_user",
+        "creator": "test_user",
+        "autoVersion": "true",
+        "node-uuid": "e74e3bc0-a639-4e04-a839-3bbd60ed5688",
+        "created": "2023-10-25T05:55Z",
+        "author": "",
+        "autoVersionOnUpdateProps": "false",
+        "isVersion": "false",
+        "workingCopy": "false",
+        "encoding": "UTF-8",
+        "store-protocol": "workspace",
+        "currentUserHasAccess": "true",
+        "versionLabel": "1.0",
+        "originalContainerId": "de048a2c-b350-45eb-a8aa-c5e5d4ba8335",
+        "size": "3028",
+        "name": "sample_pdf.pdf",
+        "mimetype": "application/pdf",
+        "mimetypeName": "Adobe PDF Document",
+        "status": "FINAL",
+        "node-dbid": "4630"
+    },
+    "title": {
+        "de": "",
+        "fi": "",
+        "pt": "",
+        "bg": "",
+        "lt": "",
+        "lv": "",
+        "hr": "",
+        "fr": "",
+        "hu": "",
+        "sk": "",
+        "sl": "",
+        "ga": "",
+        "sv": "",
+        "mt": "",
+        "el": "",
+        "en": "Test sample file",
+        "it": "",
+        "es": "",
+        "et": "",
+        "cs": "",
+        "pl": "",
+        "da": "",
+        "ro": "",
+        "nl": ""
+    },
+    "description": {},
+    "permissions": {
+        "LibAccess": "ALLOWED"
+    },
+    "notifications": "inherit",
+    "favourite": false,
+    "hasSubFolders": false,
+    "hasGuestAccess": true
+}