Merge pull request #111 from uclouvain/duplicate_files

Duplicate uploads and invert the editor zoom buttons

frontend/DocumentEditor.vue

@@ -31,7 +31,7 @@
           class="viewerContainer"
           tabindex="0"
       >
-        <div class="pdfViewer" />
+        <div class="pdfViewer" ref="pdfViewer" />
       </div>
     </div>
 
@@ -229,6 +229,7 @@ export default defineComponent({
           const viewer = new PDFViewer({
             container: this.$refs.viewerContainer as HTMLDivElement,
             eventBus: new EventBus(),
+            viewer: this.$refs.pdfViewer as HTMLDivElement,
           });
           viewer.setDocument(pdfDocument);
 
@@ -258,6 +259,7 @@ export default defineComponent({
     rotate(rotation: number) {
       // @ts-ignore bad typing from lib, see https://github.com/mozilla/pdf.js/pull/16362
       (this.viewer?.getPageView(this.currentPage - 1) as PDFPageView).update({rotation});
+      this.viewer?.update();  // To correctly display annotation layers after a rotation
       if (rotation !== 0) {
         this.rotations[this.currentPage - 1] = rotation;
       } else {

frontend/components/ToolbarRotation.vue

@@ -29,14 +29,14 @@
     <button
         type="button"
         class="btn btn-default"
-        @click="$emit('onRotate', (currentRotation - 90) % 360)"
+        @click="$emit('onRotate', ((currentRotation - 90) % 360 + 360) % 360)"
     >
       <span class="fas fa-rotate-left" />
     </button>
     <button
         type="button"
         class="btn btn-default"
-        @click="$emit('onRotate', (currentRotation + 90) % 360)"
+        @click="$emit('onRotate', ((currentRotation + 90) % 360 + 360) % 360)"
     >
       <span class="fas fa-rotate-right" />
     </button>

frontend/components/ToolbarZoom.test.ts

@@ -48,10 +48,10 @@ it('should emit events', async () => {
     },
   });
   await wrapper.findAll('button')[0].trigger('click');
-  expect(wrapper.emitted()).toHaveProperty('onZoomIn');
+  expect(wrapper.emitted()).toHaveProperty('onZoomOut');
 
   await wrapper.findAll('button')[2].trigger('click');
-  expect(wrapper.emitted()).toHaveProperty('onZoomOut');
+  expect(wrapper.emitted()).toHaveProperty('onZoomIn');
 
   await wrapper.findAll('li a')[2].trigger('click');
   expect(wrapper.emitted()).toHaveProperty('onSetScale.0.0', 'page-fit');

frontend/components/ToolbarZoom.vue

@@ -29,9 +29,9 @@
     <button
         class="btn btn-default"
         type="button"
-        @click="$emit('onZoomIn')"
+        @click="$emit('onZoomOut')"
     >
-      <span class="fas fa-magnifying-glass-plus" />
+      <span class="fas fa-magnifying-glass-minus" />
     </button>
     <div
         class="btn-group dropup"
@@ -66,9 +66,9 @@
     <button
         class="btn btn-default"
         type="button"
-        @click="$emit('onZoomOut')"
+        @click="$emit('onZoomIn')"
     >
-      <span class="fas fa-magnifying-glass-minus" />
+      <span class="fas fa-magnifying-glass-plus" />
     </button>
   </div>
 </template>

frontend/components/ViewEntry.vue

@@ -340,7 +340,6 @@ export default defineComponent({
         }
       }
       this.loading = false;
-      console.log('loading est false');
     },
     getProgressPostProcessing :async function(){
       /* istanbul ignore if -- @preserve */

frontend/components/__snapshots__/ToolbarZoom.test.ts.snap

@@ -1,7 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`should mount 1`] = `
-"<div class=\\"btn-group\\"><button class=\\"btn btn-default\\" type=\\"button\\"><span class=\\"fas fa-magnifying-glass-plus\\"></span></button>
+"<div class=\\"btn-group\\"><button class=\\"btn btn-default\\" type=\\"button\\"><span class=\\"fas fa-magnifying-glass-minus\\"></span></button>
   <div class=\\"btn-group dropup\\" role=\\"group\\"><button type=\\"button\\" class=\\"btn btn-default dropdown-toggle\\" data-toggle=\\"dropdown\\" aria-haspopup=\\"true\\" aria-expanded=\\"false\\">editor.zoom.auto <span class=\\"caret\\"></span></button>
     <ul class=\\"dropdown-menu\\">
       <li class=\\"active\\" value=\\"0\\"><a href=\\"#\\">editor.zoom.auto</a></li>
@@ -17,6 +17,6 @@ exports[`should mount 1`] = `
       <li class=\\"\\" value=\\"3\\"><a href=\\"#\\">300%</a></li>
       <li class=\\"\\" value=\\"4\\"><a href=\\"#\\">400%</a></li>
     </ul>
-  </div><button class=\\"btn btn-default\\" type=\\"button\\"><span class=\\"fas fa-magnifying-glass-minus\\"></span></button>
+  </div><button class=\\"btn btn-default\\" type=\\"button\\"><span class=\\"fas fa-magnifying-glass-plus\\"></span></button>
 </div>"
 `;

osis_document/api/schema.py

@@ -33,7 +33,7 @@ def get_schema(self, *args, **kwargs):
         schema = super().get_schema(*args, **kwargs)
         schema["openapi"] = "3.0.0"
         schema["info"]["title"] = "OSIS Document Service"
-        schema["info"]["version"] = "1.0.5"
+        schema["info"]["version"] = "1.0.6"
         schema["info"]["description"] = "A set of API endpoints that allow you to get information about uploads"
         schema["servers"] = [
             {
@@ -87,6 +87,15 @@ def get_schema(self, *args, **kwargs):
                 },
             },
         }
+        schema["components"]["schemas"]["Upload"] = {
+            "type": "object",
+            "properties": {
+                "upload_id": {
+                    "type": "string",
+                    "format": "uuid",
+                },
+            }
+        }
         for path, path_content in schema['paths'].items():
             for method, method_content in path_content.items():
                 method_content['responses'].update(

osis_document/api/serializers.py

@@ -248,3 +248,26 @@ class DeclareFilesAsDeletedSerializer(serializers.Serializer):
         help_text="A list of files UUID",
         required=True,
     )
+
+
+class UploadDuplicationSerializer(serializers.Serializer):
+    uuids = serializers.ListField(
+        help_text="The list of the uuids of the documents to duplicate.",
+        required=True,
+    )
+    with_modified_upload = serializers.BooleanField(
+        help_text=(
+            "Boolean that defines if the duplication is also necessary for the modified version of the files. Note "
+            "that the uuids of the modified uploads don't must be passed and the duplicated ones are not returned."
+        ),
+        required=False,
+        default=False,
+    )
+    upload_path_by_uuid = serializers.DictField(
+        required=False,
+        help_text=(
+            "A dictionary associating for each uuid, where the duplicated file should be saved. If the path is not "
+            "specified for one file, the duplicated file will be saved in the same location as the original file."
+        ),
+        default=dict,
+    )

osis_document/api/utils.py

@@ -23,7 +23,7 @@
 #    see http://www.gnu.org/licenses/.
 #
 # ##############################################################################
-from typing import Union, List, Dict, Iterable
+from typing import Union, List, Dict, Iterable, Optional
 from urllib.parse import urlparse
 from uuid import UUID
 
@@ -36,11 +36,10 @@
 from rest_framework.views import APIView
 
 
-
-
 def get_remote_metadata(token: str) -> Union[dict, None]:
     """Given a token, return the remote metadata."""
     import requests
+
     url = "{}metadata/{}".format(settings.OSIS_DOCUMENT_BASE_URL, token)
     try:
         response = requests.get(url)
@@ -54,6 +53,7 @@ def get_remote_metadata(token: str) -> Union[dict, None]:
 def get_several_remote_metadata(tokens: List[str]) -> Dict[str, dict]:
     """Given a list of tokens, return a dictionary associating each token to upload metadata."""
     import requests
+
     url = "{}metadata".format(settings.OSIS_DOCUMENT_BASE_URL)
     try:
         response = requests.post(
@@ -82,14 +82,21 @@ def get_raw_content_remotely(token: str):
         return None
 
 
-def get_remote_token(uuid: Union[str, UUID], write_token: bool = False, wanted_post_process: str = None, custom_ttl=None, for_modified_upload: bool = False):
+def get_remote_token(
+    uuid: Union[str, UUID],
+    write_token: bool = False,
+    wanted_post_process: str = None,
+    custom_ttl=None,
+    for_modified_upload: bool = False,
+):
     """
     Given an uuid, return a writing or reading remote token.
     The custom_ttl parameter is used to define the validity period of the token
     The wanted_post_process parameter is used to specify which post-processing action you want the output files for
     (example : PostProcessingWanted.CONVERT.name)
     """
     import requests
+
     is_valid_uuid = stringify_uuid_and_check_uuid_validity(uuid_input=uuid)
     if not is_valid_uuid.get('uuid_valid'):
         return None
@@ -115,16 +122,21 @@ def get_remote_token(uuid: Union[str, UUID], write_token: bool = False, wanted_p
                 return UploadInvalidException.__class__.__name__
             json = response.json()
             if (
-                    response.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR
-                    and json.get('detail', '') == FileInfectedException.default_detail
+                response.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR
+                and json.get('detail', '') == FileInfectedException.default_detail
             ):
                 return FileInfectedException.__class__.__name__
             return json.get('token') or json
         except HTTPError:
             return None
 
 
-def get_remote_tokens(uuids: List[str], wanted_post_process=None, custom_ttl=None, for_modified_upload: bool = False) -> Dict[str, str]:
+def get_remote_tokens(
+    uuids: List[str],
+    wanted_post_process=None,
+    custom_ttl=None,
+    for_modified_upload: bool = False,
+) -> Dict[str, str]:
     """Given a list of uuids, a type of post-processing and a custom TTL in second,
     return a dictionary associating each uuid to a reading token.
     The custom_ttl parameter is used to define the validity period of the token
@@ -133,6 +145,7 @@ def get_remote_tokens(uuids: List[str], wanted_post_process=None, custom_ttl=Non
     """
     import requests
     import contextlib
+
     validated_uuids = []
     for uuid in uuids:
         is_valid_uuid = stringify_uuid_and_check_uuid_validity(uuid_input=uuid)
@@ -159,6 +172,61 @@ def get_remote_tokens(uuids: List[str], wanted_post_process=None, custom_ttl=Non
     return {}
 
 
+def documents_remote_duplicate(
+    uuids: List[str],
+    with_modified_upload: bool = False,
+    upload_path_by_uuid: Optional[Dict[str, str]] = None,
+) -> Dict[str, str]:
+    """
+    Duplicate a list of documents.
+    uuids: List of uuids of the documents to duplicate.
+    with_modified_upload: boolean to know if the duplication is also necessary for the modified uploads. Note that
+    the uuids of the modified uploads don't must be passed to the API and the duplicated ones are not returned (only
+    the original uuids must be used).
+    upload_path_by_uuid: dict {uuid: str} to specify for each uuid, where the duplicated file should be saved. If not
+    specified for one file, the duplicated file will be saved in the same location as the original file.
+    :return: dict {uuid: uuid} A dictionary associating each document uuid with the uuid of the duplicated document. If
+    an error occurs for one specific document, the uuid of this document is not returned.
+    """
+    import requests
+
+    validated_uuids = []
+
+    # Check the validity of the uuids
+    for document_uuid in uuids:
+        is_valid_uuid = stringify_uuid_and_check_uuid_validity(uuid_input=document_uuid)
+        if is_valid_uuid.get('uuid_valid'):
+            validated_uuids.append(is_valid_uuid.get('uuid_stringify'))
+
+    if len(uuids) != len(validated_uuids):
+        raise TypeError
+
+    url = "{base_url}duplicate".format(base_url=settings.OSIS_DOCUMENT_BASE_URL)
+
+    try:
+        response = requests.post(
+            url,
+            json={
+                'uuids': validated_uuids,
+                'with_modified_upload': with_modified_upload,
+                'upload_path_by_uuid': upload_path_by_uuid,
+            },
+            headers={'X-Api-Key': settings.OSIS_DOCUMENT_API_SHARED_SECRET},
+        )
+
+        if response.status_code == status.HTTP_201_CREATED:
+            return {
+                original_uuid: item['upload_id']
+                for original_uuid, item in response.json().items()
+                if 'upload_id' in item
+            }
+
+    except HTTPError:
+        pass
+
+    return {}
+
+
 def confirm_remote_upload(
     token,
     upload_to=None,
@@ -197,19 +265,20 @@ def confirm_remote_upload(
 
 
 def launch_post_processing(
-        uuid_list: List,
-        async_post_processing: bool,
-        post_processing_types: List[str],
-        post_process_params: Dict[str, Dict[str, str]]
+    uuid_list: List,
+    async_post_processing: bool,
+    post_processing_types: List[str],
+    post_process_params: Dict[str, Dict[str, str]],
 ):
     import requests
 
     url = "{}post-processing".format(settings.OSIS_DOCUMENT_BASE_URL)
-    data = {'async_post_processing': async_post_processing,
-            'post_process_types': post_processing_types,
-            'files_uuid': uuid_list,
-            'post_process_params': post_process_params
-            }
+    data = {
+        'async_post_processing': async_post_processing,
+        'post_process_types': post_processing_types,
+        'files_uuid': uuid_list,
+        'post_process_params': post_process_params,
+    }
     response = requests.post(
         url,
         json=data,
@@ -218,9 +287,7 @@ def launch_post_processing(
     return response.json() if not async_post_processing else response
 
 
-def declare_remote_files_as_deleted(
-    uuid_list: Iterable[UUID]
-):
+def declare_remote_files_as_deleted(uuid_list: Iterable[UUID]):
     import requests
 
     url = "{}declare-files-as-deleted".format(settings.OSIS_DOCUMENT_BASE_URL)
@@ -239,15 +306,15 @@ def declare_remote_files_as_deleted(
 
 def get_progress_async_post_processing(uuid: str, wanted_post_process: str = None):
     """Given an uuid and a type of post-processing,
-        returns an int corresponding to the post-processing progress percentage
-        The wanted_post_process parameter is used to specify the post-processing action you want to get progress to.
-        (example : PostProcessingType.CONVERT.name)
+    returns an int corresponding to the post-processing progress percentage
+    The wanted_post_process parameter is used to specify the post-processing action you want to get progress to.
+    (example : PostProcessingType.CONVERT.name)
     """
     import requests
 
     url = "{base_url}get-progress-async-post-processing/{uuid}".format(
         base_url=settings.OSIS_DOCUMENT_BASE_URL,
-        uuid=uuid
+        uuid=uuid,
     )
     response = requests.post(
         url,

osis_document/api/views/__init__.py

@@ -31,6 +31,7 @@
 from .security import DeclareFileAsInfectedView
 from .token import GetTokenView, GetTokenListView
 from .upload import ConfirmUploadView, RequestUploadView, DeclareFilesAsDeletedView
+from .duplicate import UploadDuplicationView
 
 __all__ = [
     "RawFileView",
@@ -47,4 +48,5 @@
     'PostProcessingView',
     "SaveEditorView",
     "GetProgressAsyncPostProcessingView",
+    "UploadDuplicationView",
 ]