From 00510820a2794efcadbc83f7f8b54318fe198ecb Mon Sep 17 00:00:00 2001
From: Zéro~Informatique
Date: Tue, 26 Jul 2022 08:44:34 +0200
Subject: viewer: migrate to vue 3, general refactoring and cleanup

Non-exhaustive list of fixes and improvements done at the same time:

- html default background to grey (avoids white flash during init)
- unified links behavior
- added more theme variables
- removed the flex-expand transition (it wasn't working) and replaced it
  with a slide
- fixed LdLoading not centered on the content
- title on removable tags
- fixed an issue with encoded URI from vue-router
- unified Item resource URLs
- removed the iframe for PlainTextViewer (it wasn't working properly)
  and replaced it with a pre
- fixed clear and search buttons tabindex
- fixed the information panel bumping up during the fade animation of
  tag's dropdown
- fixed some focus outlines not appearing correctly
- moved CSS variables to the :root context
- Code cleaning

GitHub: closes #217
GitHub: closes #300
GitHub: closes #297
GitHub: closes #105
GitHub: closes #267
GitHub: closes #275
GitHub: closes #228
GitHub: closes #215
GitHub: closes #112
---
 viewer/src/views/item_handlers/AudioViewer.vue     |  65 +++++++++++
 viewer/src/views/item_handlers/DirectoryViewer.vue |  42 +++++++
 viewer/src/views/item_handlers/DownloadViewer.vue  |  66 +++++++++++
 viewer/src/views/item_handlers/MarkdownViewer.vue  |  50 ++++++++
 viewer/src/views/item_handlers/PdfViewer.vue       |  48 ++++++++
 viewer/src/views/item_handlers/PictureViewer.vue   | 129 +++++++++++++++++++++
 viewer/src/views/item_handlers/PlainTextViewer.vue |  69 +++++++++++
 viewer/src/views/item_handlers/VideoViewer.vue     |  47 ++++++++
 8 files changed, 516 insertions(+)
 create mode 100644 viewer/src/views/item_handlers/AudioViewer.vue
 create mode 100644 viewer/src/views/item_handlers/DirectoryViewer.vue
 create mode 100644 viewer/src/views/item_handlers/DownloadViewer.vue
 create mode 100644 viewer/src/views/item_handlers/MarkdownViewer.vue
 create mode 100644 viewer/src/views/item_handlers/PdfViewer.vue
 create mode 100644 viewer/src/views/item_handlers/PictureViewer.vue
 create mode 100644 viewer/src/views/item_handlers/PlainTextViewer.vue
 create mode 100644 viewer/src/views/item_handlers/VideoViewer.vue

(limited to 'viewer/src/views/item_handlers')

diff --git a/viewer/src/views/item_handlers/AudioViewer.vue b/viewer/src/views/item_handlers/AudioViewer.vue
new file mode 100644
index 0000000..da9579f
--- /dev/null
+++ b/viewer/src/views/item_handlers/AudioViewer.vue
@@ -0,0 +1,65 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2020  Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <div class="flex-column container-vh-centering">
+    <ItemThumbnail :item="item" />
+    <audio
+      :class="$style.player"
+      :src="itemResourceUrl"
+      preload="auto"
+      controls
+    >
+      <a
+        :download="itemFileName"
+        :href="itemResourceUrl"
+        v-text="t('download.download-file-fmt', [itemFileName])"
+      />
+    </audio>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { AudioItem } from '@/@types/gallery';
+import { useNavigation } from '@/services/navigation';
+import { useItemResource } from '@/services/ui/ldItemResourceUrl';
+import { computed, PropType } from 'vue';
+import { useI18n } from 'vue-i18n';
+import ItemThumbnail from '../ItemThumbnail.vue';
+
+const props = defineProps({
+  item: { type: Object as PropType<AudioItem>, required: true },
+});
+
+const { t } = useI18n();
+const navigation = useNavigation();
+
+const { itemResourceUrl } = useItemResource(props.item);
+const itemFileName = computed(() => navigation.getFileName(props.item));
+</script>
+
+<style lang="scss" module>
+.player {
+  width: 100%;
+  max-width: 500px;
+  margin-top: 1em;
+  text-align: center; // for fallback download link
+}
+</style>
diff --git a/viewer/src/views/item_handlers/DirectoryViewer.vue b/viewer/src/views/item_handlers/DirectoryViewer.vue
new file mode 100644
index 0000000..9b52fa8
--- /dev/null
+++ b/viewer/src/views/item_handlers/DirectoryViewer.vue
@@ -0,0 +1,42 @@
+<!-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2022  Guillaume FOUET
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <GalleryTiles
+    :items="props.item.properties.items"
+    :noresult-message="t('directory.no-results')"
+  />
+</template>
+
+<script setup lang="ts">
+import { DirectoryItem } from '@/@types/gallery';
+import { useUiStore } from '@/store/uiStore';
+import GalleryTiles from '@/views/GalleryTiles.vue';
+import { PropType } from 'vue';
+import { useI18n } from 'vue-i18n';
+
+const props = defineProps({
+  item: { type: Object as PropType<DirectoryItem>, required: true },
+});
+
+const { t } = useI18n();
+const uiStore = useUiStore();
+
+uiStore.toggleFullscreen(false);
+</script>
diff --git a/viewer/src/views/item_handlers/DownloadViewer.vue b/viewer/src/views/item_handlers/DownloadViewer.vue
new file mode 100644
index 0000000..6562bee
--- /dev/null
+++ b/viewer/src/views/item_handlers/DownloadViewer.vue
@@ -0,0 +1,66 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2020  Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <div class="container-vh-centering">
+    <a
+      :class="$style.content"
+      :download="itemFileName"
+      :href="itemResourceUrl"
+    >
+      <!-- TODO: show thumbnail instead of this generic file download icon? -->
+      <fa-icon
+        :class="$style.icon"
+        :icon="faFileDownload"
+        size="6x"
+      />
+      <div>{{ t("download.download-file-fmt", [itemFileName]) }}</div>
+    </a>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { DownloadableItem } from '@/@types/gallery';
+import { useNavigation } from '@/services/navigation';
+import { useItemResource } from '@/services/ui/ldItemResourceUrl';
+import { faFileDownload } from '@fortawesome/free-solid-svg-icons';
+import { computed, PropType } from 'vue';
+import { useI18n } from 'vue-i18n';
+
+const props = defineProps({
+  item: { type: Object as PropType<DownloadableItem>, required: true },
+});
+
+const { t } = useI18n();
+const navigation = useNavigation();
+
+const itemFileName = computed(() => navigation.getFileName(props.item));
+const { itemResourceUrl } = useItemResource(props.item);
+</script>
+
+<style lang="scss" module>
+.content {
+  text-align: center;
+}
+
+.icon {
+  margin-bottom: 0.15em;
+}
+</style>
diff --git a/viewer/src/views/item_handlers/MarkdownViewer.vue b/viewer/src/views/item_handlers/MarkdownViewer.vue
new file mode 100644
index 0000000..d5ac7e2
--- /dev/null
+++ b/viewer/src/views/item_handlers/MarkdownViewer.vue
@@ -0,0 +1,50 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2021  Guillaume FOUET
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <LdLoading v-if="isFetching" />
+  <LdMarkdown
+    v-else-if="!error && data"
+    :class="$style.container"
+    :markdown="data"
+  />
+</template>
+
+<script setup lang="ts">
+import { MarkdownItem } from '@/@types/gallery';
+import { LdMarkdown } from '@/components/async';
+import LdLoading from '@/components/LdLoading.vue';
+import { useLdFetch } from '@/services/api/ldFetch';
+import { useItemResource } from '@/services/ui/ldItemResourceUrl';
+import { PropType } from 'vue';
+
+const props = defineProps({
+  item: { type: Object as PropType<MarkdownItem>, required: true },
+});
+
+const { itemResourceUrl } = useItemResource(props.item);
+const { isFetching, data, error } = useLdFetch(itemResourceUrl).text();
+</script>
+
+<style lang="scss" module>
+.container {
+  padding: 8px;
+}
+</style>
diff --git a/viewer/src/views/item_handlers/PdfViewer.vue b/viewer/src/views/item_handlers/PdfViewer.vue
new file mode 100644
index 0000000..29f8033
--- /dev/null
+++ b/viewer/src/views/item_handlers/PdfViewer.vue
@@ -0,0 +1,48 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2020  Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <!-- intermediate container necessary to eliminate the double scrollbar -->
+  <div class="fill no-scroll">
+    <!-- prefer native browser PDF viewer if available -->
+    <object
+      class="fill"
+      :data="itemResourceUrl"
+      type="application/pdf"
+    >
+      <!-- TODO: fallback to PDF.js (https://github.com/pacien/ldgallery/issues/212) -->
+      <DownloadViewer :item="item" />
+    </object>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { PDFItem } from '@/@types/gallery';
+import { useItemResource } from '@/services/ui/ldItemResourceUrl';
+import { PropType } from 'vue';
+import DownloadViewer from './DownloadViewer.vue';
+
+const props = defineProps({
+  item: { type: Object as PropType<PDFItem>, required: true },
+});
+
+const { itemResourceUrl } = useItemResource(props.item);
+
+</script>
diff --git a/viewer/src/views/item_handlers/PictureViewer.vue b/viewer/src/views/item_handlers/PictureViewer.vue
new file mode 100644
index 0000000..10055fd
--- /dev/null
+++ b/viewer/src/views/item_handlers/PictureViewer.vue
@@ -0,0 +1,129 @@
+<!-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2022  Guillaume FOUET
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <div
+    ref="containerElement"
+    v-dragscroll
+    class="scrollbar"
+    :class="$style.pictureContainer"
+    @dblclick="uiStore.toggleFullscreen()"
+  >
+    <img
+      v-if="!error"
+      ref="imageElement"
+      :src="itemResourceUrl"
+      :class="[$style.pictureElement, $style.slowLoading]"
+      :style="imageStyle"
+      @load="clearSlowLoading"
+      @error="onError"
+    >
+    <LdLoading v-if="loader" />
+  </div>
+</template>
+
+<script setup lang="ts">
+import { PictureItem } from '@/@types/gallery';
+import LdLoading from '@/components/LdLoading.vue';
+import { useItemResource } from '@/services/ui/ldItemResourceUrl';
+import { useLdZoom } from '@/services/ui/ldZoom';
+import { useUiStore } from '@/store/uiStore';
+import { unrefElement, VueInstance } from '@vueuse/core';
+import { createToast } from 'mosha-vue-toastify';
+import { CSSProperties, onMounted, onUnmounted, PropType, ref } from 'vue';
+import { useI18n } from 'vue-i18n';
+
+const props = defineProps({
+  item: { type: Object as PropType<PictureItem>, required: true },
+});
+
+const { t } = useI18n();
+const uiStore = useUiStore();
+
+const imageStyle = ref<CSSProperties>({});
+const error = ref(false);
+const loader = ref(false);
+
+const containerElement = ref<HTMLDivElement>();
+const imageElement = ref<VueInstance>();
+
+const { itemResourceUrl, thumbnailResourceUrl } = useItemResource(props.item);
+
+onMounted(() => {
+  generateSlowLoadingStyle();
+  if (!containerElement.value) return;
+  useLdZoom(
+    imageStyle,
+    containerElement.value,
+    unrefElement(imageElement) as HTMLImageElement,
+    props.item.properties,
+  );
+});
+
+onUnmounted(() => {
+  clearSlowLoading();
+});
+
+function clearSlowLoading() {
+  imageStyle.value.backgroundImage = undefined;
+  loader.value = false;
+}
+
+function generateSlowLoadingStyle() {
+  clearSlowLoading();
+  loader.value = true;
+  if (thumbnailResourceUrl.value) {
+    imageStyle.value.backgroundImage = `url('${thumbnailResourceUrl.value}')`;
+  }
+}
+
+function onError() {
+  clearSlowLoading();
+  error.value = true;
+  createToast(t('gallery.resource-loading-error'), {
+    type: 'danger',
+    position: 'top-center',
+    timeout: 10000,
+    showIcon: true,
+  });
+}
+</script>
+
+<style lang="scss" module>
+@import "~@/assets/scss/theme";
+
+.pictureContainer {
+  height: 100%;
+}
+
+.pictureElement {
+  max-width: unset;
+  max-height: unset;
+  cursor: grab;
+}
+
+.slowLoading {
+  background-repeat: no-repeat;
+  background-position: center;
+  background-size: contain;
+  background-color: $content-bgcolor;
+  background-blend-mode: soft-light;
+  opacity: 1 !important;
+}
+</style>
diff --git a/viewer/src/views/item_handlers/PlainTextViewer.vue b/viewer/src/views/item_handlers/PlainTextViewer.vue
new file mode 100644
index 0000000..d386437
--- /dev/null
+++ b/viewer/src/views/item_handlers/PlainTextViewer.vue
@@ -0,0 +1,69 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2020  Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <!-- Outer div necessary for the resize handle to appear on Firefox. -->
+  <div
+    :class="$style.content"
+    class="fill"
+  >
+    <pre
+      v-if="isFinished"
+      v-text="data"
+    />
+    <LdLoading v-else />
+  </div>
+</template>
+
+<script setup lang="ts">
+import { PlainTextItem } from '@/@types/gallery';
+import LdLoading from '@/components/LdLoading.vue';
+import { useItemResource } from '@/services/ui/ldItemResourceUrl';
+import { useFetch } from '@vueuse/core';
+import { PropType } from 'vue';
+
+const props = defineProps({
+  item: { type: Object as PropType<PlainTextItem>, required: true },
+});
+
+const { itemResourceUrl } = useItemResource(props.item);
+const { isFinished, data } = useFetch(itemResourceUrl).text();
+</script>
+
+<style lang="scss" module>
+@import "~@/assets/scss/theme";
+
+.content {
+  display: flex;
+  justify-content: center;
+  background: $viewer-text-background;
+  color: $viewer-text;
+
+  > pre {
+    width: 100%;
+    max-width: 100%; // Forbid overflow when resizing.
+    margin: 1em; // Necessary for the resize handle to be selectable on qutebrowser.
+    border: none;
+    white-space: pre-wrap;
+    resize: horizontal; // Allow the user to adjust the width of the text view for easier column reading.
+    overflow: hidden; // Necessary for the resize handle to be shown in Chromium.
+  }
+}
+</style>
diff --git a/viewer/src/views/item_handlers/VideoViewer.vue b/viewer/src/views/item_handlers/VideoViewer.vue
new file mode 100644
index 0000000..7d17367
--- /dev/null
+++ b/viewer/src/views/item_handlers/VideoViewer.vue
@@ -0,0 +1,47 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2020  Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <!-- intermediate container necessary to eliminate the scrollbar -->
+  <div class="fill no-scroll">
+    <video
+      class="fill"
+      :src="itemResourceUrl"
+      :poster="thumbnailResourceUrl"
+      preload="auto"
+      controls
+    >
+      <DownloadViewer :item="item" />
+    </video>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { VideoItem } from '@/@types/gallery';
+import { useItemResource } from '@/services/ui/ldItemResourceUrl';
+import { PropType } from 'vue';
+import DownloadViewer from './DownloadViewer.vue';
+
+const props = defineProps({
+  item: { type: Object as PropType<VideoItem>, required: true },
+});
+
+const { itemResourceUrl, thumbnailResourceUrl } = useItemResource(props.item);
+</script>
-- 
cgit v1.2.3