files: support videos as additional files

Author: zubeydecivelek

Bruno Collection - CDS Videos Publish Video.json

@@ -79,7 +79,7 @@
         "params": [],
         "body": {
           "mode": "json",
-          "json": "{\n    \"$schema\": \"https://localhost:5000/schemas/deposits/records/videos/project/project-v1.0.0.json\",\n    \"_access\": {\n          \"update\": [\n          \"admin@test.ch\",\n          \"your-egroup@cern.ch\"\n        ],\n      \"read\": [ // If you want to restrict the project, add access read\n            \"your-egroup@cern.ch\"\n        ]\n    },\n    // Add category and type\n    \"category\": \"ATLAS\",\n    \"type\": \"VIDEO\"\n}",
+          "json": "{\n    \"_access\": {\n          \"update\": [\n          \"admin@test.ch\",\n          \"your-egroup@cern.ch\"\n        ],\n      \"read\": [ // If you want to restrict the project, add access read\n            \"your-egroup@cern.ch\"\n        ]\n    },\n    // Add category and type\n    \"category\": \"ATLAS\",\n    \"type\": \"VIDEO\"\n}",
           "formUrlEncoded": [],
           "multipartForm": []
         },
@@ -111,7 +111,7 @@
         "params": [],
         "body": {
           "mode": "json",
-          "json": "{\n   \"$schema\":\"https://localhost:5000/schemas/deposits/records/videos/video/video-v1.0.0.json\",\n   \"_project_id\":\"{{project_id}}\",\n   \"title\":\n      {\n         \"title\":\"your_title\"\n      },\n   \"_access\": {\n      \"read\": [\n            \"your-egroup@cern.ch\"\n      ]\n   },\n   \"vr\": false,\n   \"featured\": false,\n   \"language\": \"en\",\n   \"contributors\": [\n         {\n            \"name\": \"Surname, Name\",\n            \"ids\": [\n               {\n                     \"value\": \"cern id\",\n                     \"source\": \"cern\"\n               }\n            ],\n            \"email\": \"test@cern.ch\",\n            \"role\": \"Co-Producer\"\n         }\n   ],\n   \"description\": \"Description\",\n   \"date\": \"2024-11-12\",\n   \"keywords\":[\n      {\n         \"name\": \"keyword\",\n         \"value\": {\n               \"name\": \"keyword\"\n         }\n      },\n      {\n         \"name\": \"keyword2\",\n         \"value\": {\n               \"name\": \"keyword2\"\n         }\n      }\n   ],\n   \"related_links\":[\n      {\n         \"name\": \"related link\",\n         \"url\": \"https://relatedlink\"\n      }\n   ]\n}",
+          "json": "{\n   \"_project_id\":\"{{project_id}}\",\n   \"language\":\"en\",\n      \"title\":\n      {\n         \"title\":\"your_title\"\n      },\n   \"_access\": {\n      \"read\": [\n            \"your-egroup@cern.ch\"\n      ]\n   },\n   \"vr\": false,\n   \"featured\": false,\n   \"language\": \"en\",\n   \"contributors\": [\n         {\n            \"name\": \"Surname, Name\",\n            \"ids\": [\n               {\n                     \"value\": \"cern id\",\n                     \"source\": \"cern\"\n               }\n            ],\n            \"email\": \"test@cern.ch\",\n            \"role\": \"Co-Producer\"\n         }\n   ],\n   \"description\": \"Description\",\n   \"date\": \"2024-11-12\",\n   \"keywords\":[\n      {\n         \"name\": \"keyword\",\n         \"value\": {\n               \"name\": \"keyword\"\n         }\n      },\n      {\n         \"name\": \"keyword2\",\n         \"value\": {\n               \"name\": \"keyword2\"\n         }\n      }\n   ],\n   \"related_links\":[\n      {\n         \"name\": \"related link\",\n         \"url\": \"https://relatedlink\"\n      }\n   ]\n}",
           "formUrlEncoded": [],
           "multipartForm": []
         },
@@ -200,7 +200,13 @@
       "request": {
         "url": "{{baseURL}}/api/files/{{bucket_id}}/{{additional_file}}",
         "method": "PUT",
-        "headers": [],
+        "headers": [
+          {
+            "name": "X-Invenio-File-Tags",
+            "value": "context_type=additional_file",
+            "enabled": true
+          }
+        ],
         "params": [],
         "body": {
           "mode": "json",
@@ -284,9 +290,6 @@
         "allow": true
       }
     },
-    "ignore": [
-      "node_modules",
-      ".git"
-    ]
+    "ignore": ["node_modules", ".git"]
   }
-}
+}

README.rst

@@ -258,11 +258,6 @@ Step 1: Create a Project
      - **Location**
      - **Description**
      - **Required/Optional**
-   * - **$schema**
-     - string
-     - body
-     - Schema URL for the project creation.
-     - Required
    * - **category**
      - string
      - body
@@ -307,7 +302,6 @@ To restrict the project, add ``_access/read``:
 .. code-block:: json
 
    {
-      "$schema": "https://localhost:5000/schemas/deposits/records/videos/project/project-v1.0.0.json",
       "_access": {
             "update": [
             "admin@test.ch",
@@ -379,11 +373,6 @@ Step 2: Create a Video
      - **Location**
      - **Description**
      - **Required/Optional**
-   * - **$schema**
-     - string
-     - body
-     - Schema URL for video creation.
-     - Required
    * - **_project_id**
      - string
      - body
@@ -423,7 +412,7 @@ Step 2: Create a Video
      - string
      - body
      - Language of the video.
-     - Optional
+     - Required
    * - **featured**
      - boolean
      - body
@@ -447,7 +436,6 @@ To restrict the video, add ``_access/read``. The ``_access/update`` will be the
 .. code-block:: json
 
    {
-      "$schema":"https://localhost:5000/schemas/deposits/records/videos/video/video-v1.0.0.json",
       "_project_id":"{{project_id}}",
       "title":
          {
@@ -495,7 +483,8 @@ To restrict the video, add ``_access/read``. The ``_access/update`` will be the
             "name": "related link",
             "url": "https://relatedlink"
          }
-      ]
+      ],
+      "language": "en"
    }
 
 **Response:**  
@@ -605,6 +594,10 @@ Step 5: (Optional) Upload Additional File
 
 ``PUT`` ``{{baseURL}}/api/files/{{bucket_id}}/{{additional_file}}``
 
+**Headers:**  
+
+- ``X-Invenio-File-Tags: context_type=additional_file``
+
 **Parameters:**
 
 .. list-table:: 

cds/modules/deposit/api.py

@@ -862,15 +862,7 @@ def _rename_subtitles(self):
                 subtitle_obj_key = "{}_{}.vtt".format(
                     self["report_number"][0], match.group("iso_lang")
                 )
-                obj = ObjectVersion.create(
-                    bucket=subtitle_obj.bucket,
-                    key=subtitle_obj_key,
-                    _file_id=subtitle_obj.file_id,
-                )
-                # copy tags to the newly created object version
-                for tag in subtitle_obj.tags:
-                    tag.object_version = obj
-                subtitle_obj.remove()
+                subtitle_obj.key = subtitle_obj_key
 
     def _rename_master_file(self, master_file):
         """Rename master file."""

cds/modules/deposit/ext.py

@@ -25,11 +25,13 @@
 """CDSDeposit app for Webhook receivers."""
 
 import re
+import mimetypes
 
 from invenio_base.signals import app_loaded
 from invenio_db import db
 from invenio_files_rest.models import ObjectVersionTag
 from invenio_files_rest.signals import file_uploaded
+from invenio_files_rest.errors import InvalidKeyError
 from invenio_indexer.signals import before_record_index
 from invenio_records_files.utils import sorted_files_from_bucket
 
@@ -45,38 +47,37 @@
 
 def _create_tags(obj):
     """Create additional tags for file."""
-    # Subtitle file
-    pattern = re.compile(".*_([a-zA-Z]{2})\.vtt$")
+    pattern_subtitle = re.compile(r".*_([a-zA-Z]{2})\.vtt$")
+    pattern_poster = re.compile(r"^poster\.(jpg|png)$")
+    
+    # Get the media_type and content_type(file ext)
+    file_name = obj.key
+    mimetypes.add_type("subtitle/vtt", ".vtt")
+    guessed_type = mimetypes.guess_type(file_name)[0]
+    if guessed_type is None:        
+        raise InvalidKeyError(description=f"Unsupported File: {file_name}")
+
+    media_type = guessed_type.split("/")[0]
+    file_ext = guessed_type.split("/")[1]
+
     with db.session.begin_nested():
-        # language tag
-        found = pattern.findall(obj.key)
-        if len(found) == 1:
-            lang = found[0]
-            ObjectVersionTag.create_or_update(obj, "language", lang)
-        else:
-            # clean to be sure there is no some previous value
-            ObjectVersionTag.delete(obj, "language")
-        # other tags
-        ObjectVersionTag.create_or_update(obj, "content_type", "vtt")
-        ObjectVersionTag.create_or_update(obj, "context_type", "subtitle")
-        ObjectVersionTag.create_or_update(obj, "media_type", "subtitle")
-        # refresh object
-        db.session.add(obj)
+        ObjectVersionTag.create_or_update(obj, "content_type", file_ext)
+        ObjectVersionTag.create_or_update(obj, "media_type", media_type)
+        if file_ext == "vtt":
+            # language tag
+            match = pattern_subtitle.search(file_name)
+            if match:
+                ObjectVersionTag.create_or_update(obj, "language", match.group(1))
+            else:
+                ObjectVersionTag.delete(obj, "language")
+            # other tags
+            ObjectVersionTag.create_or_update(obj, "content_type", "vtt")
+            ObjectVersionTag.create_or_update(obj, "context_type", "subtitle")
+        # poster tag 
+        elif pattern_poster.match(file_name):
+            ObjectVersionTag.create_or_update(obj, "context_type", "poster")
 
-        # Poster frame
-        pattern = re.compile("^poster\.(jpg|png)$")
-        try:
-            poster = pattern.findall(obj.key)
-            if poster:
-                ext = pattern.findall(poster.key)[0]
-                # frame tags
-                ObjectVersionTag.create_or_update(poster, "content_type", ext)
-                ObjectVersionTag.create_or_update(poster, "context_type", "poster")
-                ObjectVersionTag.create_or_update(poster, "media_type", "image")
-                # refresh object
-                db.session.add(poster)
-        except IndexError:
-            return
+        db.session.add(obj)
 
 
 def create_tags_on_file_upload(sender, obj):

cds/modules/deposit/static/templates/cds_deposit/deposits.html

@@ -39,6 +39,7 @@ <h5 class="text-muted"><strong>Tips</strong></h5>
                     <h3>Click here to select videos to upload</h3>
                   </div>
                   <p class="cds-deposit-box-upload-description">You can also <strong>Drag & Drop</strong> video files here</p>
+                  <p class="text-muted mt-20">supported files <mark>{{ $ctrl.videoExtensions }}</mark></p>
                 </div>
               </div>
             </div>

cds/modules/deposit/static/templates/cds_deposit/types/video/uploader.html

@@ -9,7 +9,7 @@
 <!-- Master video and subformats -->
 <div ng-show="$ctrl.files.length > 0" class="panel panel-default">
   <div class="panel-heading">
-    Master & Subformats files
+    Main & Subformats files
   </div>
   <table class="table">
     <tr>
@@ -224,12 +224,12 @@ <h5 class="text-muted"><strong>Tips and suggestions</strong></h5>
   </table>
 </div>
 <!-- Subtitles -->
-<!-- Other -->
-<div ng-show="($ctrl.files | removeBy:'context_type':'poster' |removeBy:'context_type':'master' | removeBy:'context_type':'subtitle' || []).length > 0" class="panel panel-default">
+<!-- Additional files -->
+<div class="panel panel-default">
   <div class="panel-heading">
-    Other files
+    Additional files
   </div>
-  <div class="panel-heading">
+  <div ng-show="($ctrl.files | removeBy:'context_type':'poster' |removeBy:'context_type':'master' | removeBy:'context_type':'subtitle' || []).length > 0"  class="panel-heading">
     <div class="row">
       <div class="col-sm-6">
         <p ng-show="$ctrl.files.length > 0" class="text-muted">
@@ -242,7 +242,7 @@ <h5 class="text-muted"><strong>Tips and suggestions</strong></h5>
       </div>
     </div>
   </div>
-  <table class="table">
+  <table ng-show="($ctrl.files | removeBy:'context_type':'poster' |removeBy:'context_type':'master' | removeBy:'context_type':'subtitle' || []).length > 0" class="table">
     <tr>
       <th>Filename</th>
       <th>Size</th>
@@ -271,6 +271,31 @@ <h5 class="text-muted"><strong>Tips and suggestions</strong></h5>
       </td>
     </tr>
   </table>
+  <!-- Upload Additional files -->
+  <div class="panel-body">
+    <div class="cds-deposit-box" ng-if="!$ctrl.cdsDepositCtrl.isPublished()">
+      <div 
+        ngf-drag-over-class="'cds-deposit-dragover'"
+        ngf-drop=""
+        ngf-change="$ctrl.addFiles($newFiles, $invalidFiles)"
+        ngf-select=""
+        ngf-model-options="{allowInvalid: false}"
+        ngf-max-size="500GB"
+        ngf-multiple="true"
+      >
+        <div class="pa-10 cds-deposit-box-upload-wrapper text-center">
+          <p class="cds-deposit-box-upload-icon mb-20">
+            <i class="fa fa-3x fa-files-o" aria-hidden="true"></i>
+          </p>
+          <div class="cds-deposit-box-upload-content">
+            <h4>Upload complimentary files for this video</h4>
+            <p class="cds-deposit-box-upload-description">Or Drag & Drop files</p>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+  <!-- Upload Additional files -->
 </div>
 <hr class="my-20" />
 <!-- Error alert -->
@@ -283,39 +308,43 @@ <h5 class="text-muted"><strong>Tips and suggestions</strong></h5>
   </ul>
 </div>
 <!-- Error alert -->
-<div class="cds-deposit-box" ng-if="!$ctrl.cdsDepositCtrl.isPublished()">
-  <div
-       ngf-drag-over-class="'cds-deposit-dragover'"
-       ngf-drop=""
-       ngf-change="$ctrl.addFiles($newFiles, $invalidFiles)"
-       ngf-select=""
-       ngf-model-options="{allowInvalid: false}"
-       ngf-max-size="500GB"
-       ngf-multiple="true"
-  >
-    <div class="pa-10 cds-deposit-box-upload-wrapper text-center">
-      <p class="cds-deposit-box-upload-icon mb-20">
-        <i class="fa fa-3x fa-files-o" aria-hidden="true"></i>
-      </p>
-      <div class="cds-deposit-box-upload-content">
-        <div class="cds-deposit-box-upload-title">
-          <h4>Upload complimentary files for this video</h4>
+
+<!-- Replacing Master Video File -->
+<div class="panel panel-default" ng-if="!$ctrl.cdsDepositCtrl.isPublished()">
+  <div class="panel-heading panel-heading-warning">
+    <i class="fa fa-exclamation-triangle" aria-hidden="true"></i> Replace Video File
+  </div>
+  <div class="panel-body">
+    <div class="cds-deposit-box" >
+      <div 
+        ngf-drag-over-class="{accept: 'cds-deposit-dragover', delay:100}"
+        ngf-drop=""
+        ngf-change="$ctrl.replaceMasterFile($newFiles, $invalidFiles)"
+        ngf-select=""
+        ngf-model-options="{allowInvalid: false}"
+        ngf-max-size="500GB"
+        ngf-multiple="true"
+        ngf-accept="'{{$ctrl.cdsDepositsCtrl.videoExtensions}}'"
+        ngf-pattern="'{{$ctrl.cdsDepositsCtrl.videoExtensions}}'"
+      >
+        <div class="pa-10 cds-deposit-box-upload-wrapper text-center">
+          <p class="cds-deposit-box-upload-icon mb-20">
+            <i class="fa fa-2x fa-video-camera" aria-hidden="true"></i>
+          </p>
+          <div class="cds-deposit-box-upload-content">
+            <h4>To replace the video file, just upload a video here.</h4>
+            <p class="cds-deposit-box-upload-description">Or Drag & Drop files</p>
+          </div>
         </div>
-        <p class="cds-deposit-box-upload-description"> Or Drag & Drop files</p>
       </div>
     </div>
   </div>
-  <hr class="my-10" />
-  <div class="text-muted">
-    <h5 class="text-muted"><strong>Tips and suggestions</strong></h5>
-    <ul>
-      <li>To replace the video file, just upload another video.</li>
-    </ul>
-  </div>
 </div>
+
+
 <div ng-if="$ctrl.cdsDepositCtrl.isPublished()" class="cds-deposit-box text-muted">
   <h5 class="text-muted"><strong>Tips and suggestions</strong></h5>
   <ul>
     <li>Click the <strong>Edit</strong> button on the top right corner to add more files.</li>
   </ul>
-</div>
+</div>