API & Client - do not allow uploading media when file is an archive

Author: SamR1

fittrackee/tests/workouts/test_workouts_api_1_post.py

@@ -1645,7 +1645,9 @@ def test_expected_scope_is_workouts_write(
         )
 
 
-class TestPostWorkoutWithZipArchive(UserTaskMixin, WorkoutApiTestCaseMixin):
+class TestPostWorkoutWithZipArchive(
+    UserTaskMixin, WorkoutApiTestCaseMixin, MediaMixin
+):
     def test_it_adds_workouts_synchronously_with_zip_archive(
         self, app: "Flask", user_1: "User", sport_1_cycling: "Sport"
     ) -> None:
@@ -2044,6 +2046,44 @@ def test_it_adds_workouts_when_zip_contains_files_with_multiple_extensions(
         assert len(data["data"]["workouts"]) == 3
         assert Workout.query.count() == 3
 
+    def test_it_returns_400_when_media_attachments_are_provided(
+        self,
+        app: "Flask",
+        user_1: "User",
+        sport_1_cycling: "Sport",
+        gpx_file: str,
+    ) -> None:
+        media = self.create_media(user_1)
+        file_path = os.path.join(app.root_path, "tests/files/gpx_test.zip")
+        with open(file_path, "rb") as zip_file:
+            client, auth_token = self.get_test_client_and_auth_token(
+                app, user_1.email
+            )
+
+            response = client.post(
+                "/api/workouts",
+                data=dict(
+                    file=(zip_file, "gpx_test.zip"),
+                    data=(
+                        json.dumps(
+                            {
+                                "sport_id": 1,
+                                "media_attachment_ids": [media.short_id],
+                            }
+                        )
+                    ),
+                ),
+                headers=dict(
+                    content_type="multipart/form-data",
+                    Authorization=f"Bearer {auth_token}",
+                ),
+            )
+
+        self.assert_400(
+            response,
+            "media attachments can not be associated with a .zip archive",
+        )
+
 
 class TestPostAndGetWorkoutWithFile(WorkoutApiTestCaseMixin):
     def workout_assertion(

fittrackee/workouts/workouts.py

@@ -139,12 +139,16 @@ def get_string_duration_value(row_value: Optional[timedelta]) -> Optional[str]:
 
 
 def check_media_attachments(
-    workout_data: dict,
+    workout_data: dict, is_zip_archive: bool = False
 ) -> Optional["InvalidPayloadErrorResponse"]:
-    if (
-        len(workout_data.get("media_attachment_ids", []))
-        > MAX_MEDIA_ATTACHMENTS
-    ):
+    media_count = len(workout_data.get("media_attachment_ids", []))
+
+    if media_count > 0 and is_zip_archive:
+        return InvalidPayloadErrorResponse(
+            "media attachments can not be associated with a .zip archive"
+        )
+
+    if media_count > MAX_MEDIA_ATTACHMENTS:
         return InvalidPayloadErrorResponse(
             f"up to {MAX_MEDIA_ATTACHMENTS} media attachments can be "
             f"associated with a workout"
@@ -2317,6 +2321,7 @@ def post_workout(auth_user: User) -> Union[Tuple[Dict, int], HttpResponse]:
         - ``equipment with id <equipment_id> is inactive``
         - ``one or more values, entered or calculated, exceed the limits``
         - ``up to 20 media attachments can be associated with a workout``
+        - ``media attachments can not be associated with a .zip archive``
     :statuscode 401:
         - ``provide a valid auth token``
         - ``signature expired, please log in again``
@@ -2349,11 +2354,16 @@ def post_workout(auth_user: User) -> Union[Tuple[Dict, int], HttpResponse]:
     if not workout_data or workout_data.get("sport_id") is None:
         return InvalidPayloadErrorResponse()
 
-    error_response = check_media_attachments(workout_data)
+    workout_file = request.files["file"]
+    is_zip_archive = (
+        workout_file is not None
+        and workout_file.filename is not None
+        and workout_file.filename.endswith(".zip")
+    )
+    error_response = check_media_attachments(workout_data, is_zip_archive)
     if error_response:
         return error_response
 
-    workout_file = request.files["file"]
     try:
         service = WorkoutsFromFileCreationService(
             auth_user, workout_data, workout_file

fittrackee_client/src/components/Workout/WorkoutEdition.vue

@@ -436,6 +436,7 @@
                 :workout-media-attachments="
                   workout?.media_attachments ? workout.media_attachments : []
                 "
+                :is-archive="isArchive"
               />
             </div>
             <ErrorMessage :message="errorMessages" v-if="errorMessages" />
@@ -516,7 +517,7 @@
 
   const { appConfig, errorMessages } = useApp()
 
-  let workoutFile: File | null = null
+  const workoutFile: Ref<File | undefined> = ref(undefined)
 
   const workoutForm = reactive({
     sport_id: '',
@@ -573,6 +574,13 @@
       appConfig.value.file_sync_limit_import !=
       appConfig.value.file_limit_import
   )
+  const isArchive: ComputedRef<boolean> = computed(
+    () =>
+      isCreation.value &&
+      withFile.value &&
+      workoutFile.value !== undefined &&
+      workoutFile.value.name.endsWith('.zip')
+  )
   const equipments: ComputedRef<IEquipment[]> = computed(
     () => store.getters[EQUIPMENTS_STORE.GETTERS.EQUIPMENTS]
   )
@@ -651,7 +659,9 @@
   }
   function updateFile(event: Event) {
     if ((event.target as HTMLInputElement).files) {
-      workoutFile = ((event.target as HTMLInputElement).files as FileList)[0]
+      workoutFile.value = (
+        (event.target as HTMLInputElement).files as FileList
+      )[0]
     }
   }
   function formatWorkoutForm(workout: IWorkout) {
@@ -775,7 +785,7 @@
       equipment_ids: workoutForm.equipment_ids,
       title: workoutForm.title,
       workout_visibility: workoutForm.workoutVisibility,
-      media_attachment_ids: mediaAttachementIds.value,
+      media_attachment_ids: isArchive.value ? [] : mediaAttachementIds.value,
       media_visibility: workoutForm.mediaVisibility,
     }
     if (props.workout.id) {
@@ -798,12 +808,12 @@
       }
     } else {
       if (withFile.value) {
-        if (!workoutFile) {
+        if (!workoutFile.value) {
           const errorMessage = 'workouts.NO_FILE_PROVIDED'
           store.commit(ROOT_STORE.MUTATIONS.SET_ERROR_MESSAGES, errorMessage)
           return
         }
-        payload.file = workoutFile
+        payload.file = workoutFile.value
         payload.analysis_visibility = workoutForm.analysisVisibility
         payload.map_visibility = workoutForm.mapVisibility
         store.dispatch(WORKOUTS_STORE.ACTIONS.ADD_WORKOUT, payload)
@@ -858,6 +868,7 @@
   function updateSelectedEquipmentPieces(selectedIds: string[]) {
     workoutForm.equipment_ids = selectedIds
   }
+
   watch(
     () => props.workout,
     async (
@@ -898,6 +909,14 @@
       }
     }
   )
+  watch(
+    () => withFile.value,
+    async (newValue: boolean) => {
+      if (!newValue) {
+        workoutFile.value = undefined
+      }
+    }
+  )
 
   onMounted(() => {
     let element

fittrackee_client/src/components/Workout/WorkoutMediaAttachementsUpload.vue

@@ -15,6 +15,10 @@
       @change="uploadMediaAttachment"
     />
   </div>
+  <div v-if="isArchive" class="attachments-info-box info-box">
+    <i class="fa fa-info-circle" aria-hidden="true" />
+    <div>{{ $t('workouts.MEDIA_INFORMATION') }}</div>
+  </div>
   <div class="loading-media">
     <i
       v-if="mediaLoading === 'new'"
@@ -24,7 +28,7 @@
     {{ ' ' }}
     <span v-if="mediaLoading === 'new'">{{ $t('common.LOADING') }}</span>
   </div>
-  <div class="media-attachments">
+  <div class="media-attachments" v-if="!isArchive">
     <div
       v-for="media in mediaAttachments"
       :key="media.id"
@@ -88,9 +92,10 @@
   interface Props {
     loading: boolean
     workoutMediaAttachments: IMediaAttachment[]
+    isArchive: boolean
   }
   const props = defineProps<Props>()
-  const { loading, workoutMediaAttachments } = toRefs(props)
+  const { isArchive, loading, workoutMediaAttachments } = toRefs(props)
 
   const store = useStore()
 
@@ -153,6 +158,15 @@
 
 <style scoped lang="scss">
   @use '~@/scss/vars.scss' as *;
+
+  .attachments-info-box {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    gap: $default-padding * 0.5;
+    margin: $default-margin $default-margin 0;
+  }
+
   .media-attachments {
     display: flex;
     flex-direction: column;

fittrackee_client/src/locales/en/workouts.json

@@ -77,6 +77,7 @@
   "MAX_SIZE": "max. size",
   "MAX_SPEED": "max. speed",
   "MAX_SYNC_FILES_IN_ZIP": "max. number of files for synchronous upload",
+  "MEDIA_INFORMATION": "photos can not be added when uploading a .zip archive.",
   "MIN_ALTITUDE": "min. altitude",
   "ELEVATION_DATA_SOURCE": {
     "LABEL": "Elevations updated from",

fittrackee_client/src/locales/fr/workouts.json

@@ -77,6 +77,7 @@
   "MAX_SIZE": "taille max.",
   "MAX_SPEED": "vitesse max.",
   "MAX_SYNC_FILES_IN_ZIP": "nombre max. de fichiers pour un chargement synchrone ",
+  "MEDIA_INFORMATION": "les photos ne peuvent pas être ajoutées si le fichier de la séance est une archive zip",
   "MIN_ALTITUDE": "altitude min.",
   "ELEVATION_DATA_SOURCE": {
     "LABEL": "Altitudes mises à jour à partir de",