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
---
 .../src/components/item_handlers/LdAudioViewer.vue |  56 ---------
 .../components/item_handlers/LdDirectoryViewer.vue |  41 -------
 .../components/item_handlers/LdDownloadViewer.vue  |  58 ----------
 .../components/item_handlers/LdMarkdownViewer.vue  |  76 ------------
 .../src/components/item_handlers/LdPdfViewer.vue   |  44 -------
 .../components/item_handlers/LdPictureViewer.vue   | 128 ---------------------
 .../components/item_handlers/LdPlainTextViewer.vue |  56 ---------
 .../src/components/item_handlers/LdVideoViewer.vue |  46 --------
 8 files changed, 505 deletions(-)
 delete mode 100644 viewer/src/components/item_handlers/LdAudioViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdDirectoryViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdDownloadViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdMarkdownViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdPdfViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdPictureViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdPlainTextViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdVideoViewer.vue

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

diff --git a/viewer/src/components/item_handlers/LdAudioViewer.vue b/viewer/src/components/item_handlers/LdAudioViewer.vue
deleted file mode 100644
index 559b10a..0000000
--- a/viewer/src/components/item_handlers/LdAudioViewer.vue
+++ /dev/null
@@ -1,56 +0,0 @@
-<!--
--- 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">
-    <ld-thumbnail :item="item" />
-    <audio :class="$style.player" :src="itemResourceUrl" preload="auto" controls>
-      <a :download="itemFileName" :href="itemResourceUrl">{{ $t("download.download-file-fmt", [itemFileName]) }}</a>
-    </audio>
-  </div>
-</template>
-
-<script lang="ts">
-import { AudioItem } from "@/@types/gallery";
-import Navigation from "@/services/navigation";
-import { Component, Prop, Vue } from "vue-property-decorator";
-
-@Component
-export default class LdAudioViewer extends Vue {
-  @Prop({ required: true }) readonly item!: AudioItem;
-
-  get itemResourceUrl(): string {
-    return this.$galleryStore.resourceRoot + this.item.properties.resource;
-  }
-
-  get itemFileName(): string {
-    return Navigation.getFileName(this.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/components/item_handlers/LdDirectoryViewer.vue b/viewer/src/components/item_handlers/LdDirectoryViewer.vue
deleted file mode 100644
index 2259f12..0000000
--- a/viewer/src/components/item_handlers/LdDirectoryViewer.vue
+++ /dev/null
@@ -1,41 +0,0 @@
-<!-- ldgallery - A static generator which turns a collection of tagged
---             pictures into a searchable web gallery.
---
--- Copyright (C) 2019-2020  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>
-  <ld-gallery :items="orderedItems" :noresult="$t('directory.no-results')" />
-</template>
-
-<script lang="ts">
-import { DirectoryItem } from "@/@types/gallery";
-import Navigation from "@/services/navigation";
-import { Component, Prop, Vue } from "vue-property-decorator";
-
-@Component
-export default class LdDirectoryViewer extends Vue {
-  @Prop({ required: true }) readonly item!: DirectoryItem;
-
-  mounted() {
-    this.$uiStore.toggleFullscreen(false);
-  }
-
-  get orderedItems() {
-    return Navigation.directoriesFirst(this.item.properties.items);
-  }
-}
-</script>
diff --git a/viewer/src/components/item_handlers/LdDownloadViewer.vue b/viewer/src/components/item_handlers/LdDownloadViewer.vue
deleted file mode 100644
index 60c7c49..0000000
--- a/viewer/src/components/item_handlers/LdDownloadViewer.vue
+++ /dev/null
@@ -1,58 +0,0 @@
-<!--
--- 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="itemDownloadUrl">
-      <!-- TODO: show thumbnail instead of this generic file download icon? -->
-      <fa-icon :class="$style.icon" icon="file-download" size="6x" />
-      <div>{{ $t("download.download-file-fmt", [itemFileName]) }}</div>
-    </a>
-  </div>
-</template>
-
-<script lang="ts">
-import { OtherItem } from "@/@types/gallery";
-import Navigation from "@/services/navigation";
-import { Component, Prop, Vue } from "vue-property-decorator";
-
-@Component
-export default class LdDownloadViewer extends Vue {
-  @Prop({ required: true }) readonly item!: OtherItem;
-
-  get itemFileName(): string {
-    return Navigation.getFileName(this.item);
-  }
-
-  get itemDownloadUrl(): string {
-    return this.$galleryStore.resourceRoot + this.item.properties.resource;
-  }
-}
-</script>
-
-<style lang="scss" module>
-.content {
-  text-align: center;
-}
-
-.icon {
-  margin-bottom: 0.15em;
-}
-</style>
diff --git a/viewer/src/components/item_handlers/LdMarkdownViewer.vue b/viewer/src/components/item_handlers/LdMarkdownViewer.vue
deleted file mode 100644
index 3b9a8d6..0000000
--- a/viewer/src/components/item_handlers/LdMarkdownViewer.vue
+++ /dev/null
@@ -1,76 +0,0 @@
-<!--
--- 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>
-  <b-loading v-if="isLoading" active />
-  <Markdown v-else-if="markdown" :class="$style.container" :markdown="markdown" />
-</template>
-
-<script lang="ts">
-import { MarkdownItem } from "@/@types/gallery";
-import { Markdown } from "@/components/async";
-import FetchWithCheck from "@/services/fetchWithCheck";
-import { Component, Prop, Vue } from "vue-property-decorator";
-
-@Component({
-  components: {
-    Markdown,
-  },
-})
-export default class LdMarkdownViewer extends Vue {
-  @Prop({ required: true }) readonly item!: MarkdownItem;
-
-  isLoading: boolean = true;
-  markdown: string | null = null;
-
-  created() {
-    this.fetchMarkdown();
-  }
-
-  get itemResourceUrl(): string {
-    return this.$galleryStore.resourceRoot + this.item.properties.resource;
-  }
-
-  // TODO: Identical to SplashScreen.vue, use composition with Vue3.
-  fetchMarkdown() {
-    FetchWithCheck.get(this.itemResourceUrl)
-      .then(response => response.text())
-      .then(text => (this.markdown = text))
-      .finally(() => (this.isLoading = false))
-      .catch(this.displayError);
-  }
-
-  displayError(reason: any) {
-    this.$buefy.snackbar.open({
-      message: `${reason}`,
-      actionText: this.$t("snack.retry"),
-      position: "is-top",
-      type: "is-warning",
-      onAction: this.fetchMarkdown,
-    });
-  }
-}
-</script>
-
-<style lang="scss" module>
-.container {
-  padding: 8px;
-}
-</style>
diff --git a/viewer/src/components/item_handlers/LdPdfViewer.vue b/viewer/src/components/item_handlers/LdPdfViewer.vue
deleted file mode 100644
index 04cba0c..0000000
--- a/viewer/src/components/item_handlers/LdPdfViewer.vue
+++ /dev/null
@@ -1,44 +0,0 @@
-<!--
--- 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) -->
-      <ld-download-viewer :item="item" />
-    </object>
-  </div>
-</template>
-
-<script lang="ts">
-import { PDFItem } from "@/@types/gallery";
-import { Component, Prop, Vue } from "vue-property-decorator";
-
-@Component
-export default class LdPdfViewer extends Vue {
-  @Prop({ required: true }) readonly item!: PDFItem;
-
-  get itemResourceUrl(): string {
-    return this.$galleryStore.resourceRoot + this.item.properties.resource;
-  }
-}
-</script>
diff --git a/viewer/src/components/item_handlers/LdPictureViewer.vue b/viewer/src/components/item_handlers/LdPictureViewer.vue
deleted file mode 100644
index 003ffe9..0000000
--- a/viewer/src/components/item_handlers/LdPictureViewer.vue
+++ /dev/null
@@ -1,128 +0,0 @@
-<!-- ldgallery - A static generator which turns a collection of tagged
---             pictures into a searchable web gallery.
---
--- Copyright (C) 2019-2020  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>
-  <!-- FIXME: v-dragscroll interferes with pinch-to-zoom -->
-  <div
-    ref="containerElement"
-    v-dragscroll
-    class="scrollbar ld-picture-container"
-    @click.capture="e => dragScrollClickFix.onClickCapture(e)"
-    @dblclick="$uiStore.toggleFullscreen()"
-    @dragstart.prevent
-    @dragscrollstart="dragScrollClickFix.onDragScrollStart()"
-    @dragscrollend="dragScrollClickFix.onDragScrollEnd()"
-  >
-    <v-lazy-image
-      ref="imageElement"
-      :src="pictureSrc(item.properties.resource)"
-      class="ld-picture-element"
-      :class="{ 'slow-loading': Boolean(slowLoadingStyle) }"
-      :style="slowLoadingStyle"
-      @load="clearSlowLoading"
-    />
-    <b-loading :active="loader" :is-full-page="false" class="ld-picture-loader" />
-  </div>
-</template>
-
-<script lang="ts">
-import { PictureItem } from "@/@types/gallery";
-import DragScrollClickFix from "@/services/dragscrollclickfix";
-import LdZoom from "@/services/ldzoom";
-import { Component, Prop, Ref, Vue } from "vue-property-decorator";
-
-@Component
-export default class LdPictureViewer extends Vue {
-  @Prop({ required: true }) readonly item!: PictureItem;
-  @Ref() readonly containerElement!: HTMLDivElement;
-  @Ref() readonly imageElement!: Vue;
-
-  readonly SLOW_LOADING_TIMEOUT_MS: number = 1500;
-  readonly dragScrollClickFix = new DragScrollClickFix();
-
-  slowLoadingStyle: string | null = null;
-  loader: boolean = false;
-  timer: NodeJS.Timeout | null = null;
-
-  mounted() {
-    this.timer = setTimeout(this.generateSlowLoadingStyle, this.SLOW_LOADING_TIMEOUT_MS);
-    new LdZoom(
-      this.containerElement,
-      this.imageElement.$el as HTMLImageElement,
-      this.item.properties,
-      10,
-      1 / 5
-    ).install();
-  }
-
-  destroyed() {
-    this.clearSlowLoading();
-  }
-
-  clearSlowLoading() {
-    if (this.timer) clearTimeout(this.timer);
-    this.timer = null;
-    this.slowLoadingStyle = null;
-    this.loader = false;
-  }
-
-  pictureSrc(resource: string) {
-    return this.$galleryStore.resourceRoot + resource;
-  }
-
-  generateSlowLoadingStyle() {
-    this.clearSlowLoading();
-    this.loader = true;
-    if (this.item.thumbnail) {
-      const url = this.pictureSrc(this.item.thumbnail.resource);
-      this.slowLoadingStyle = `background-image: url('${url}');`;
-    }
-  }
-}
-</script>
-
-<style lang="scss">
-@import "~@/assets/scss/theme.scss";
-
-.ld-picture-container {
-  height: 100%;
-}
-
-.ld-picture-element {
-  max-width: unset;
-  max-height: unset;
-  cursor: grab;
-}
-
-.slow-loading {
-  background-repeat: no-repeat;
-  background-position: center;
-  background-size: contain;
-  background-color: $content-bgcolor;
-  background-blend-mode: soft-light;
-  opacity: 1 !important;
-}
-
-.ld-picture-loader {
-  position: relative;
-  & .loading-background {
-    background: none !important;
-  }
-}
-</style>
diff --git a/viewer/src/components/item_handlers/LdPlainTextViewer.vue b/viewer/src/components/item_handlers/LdPlainTextViewer.vue
deleted file mode 100644
index 79465d5..0000000
--- a/viewer/src/components/item_handlers/LdPlainTextViewer.vue
+++ /dev/null
@@ -1,56 +0,0 @@
-<!--
--- 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">
-    <!-- Using an iframe here to let the browser deal with content encoding detection. -->
-    <iframe class="fill" :src="itemResourceUrl" />
-  </div>
-</template>
-
-<script lang="ts">
-import { PlainTextItem } from "@/@types/gallery";
-import { Component, Prop, Vue } from "vue-property-decorator";
-
-@Component
-export default class LdPlainTextViewer extends Vue {
-  @Prop({ required: true }) readonly item!: PlainTextItem;
-
-  get itemResourceUrl(): string {
-    return this.$galleryStore.resourceRoot + this.item.properties.resource;
-  }
-}
-</script>
-
-<style lang="scss" module>
-.content {
-  margin: auto; // Old-school horizontal centering.
-
-  // Allow the user to adjust the width of the text view for easier column reading.
-  resize: horizontal;
-  max-width: 100%; // Forbid overflow when resizing.
-  overflow: hidden; // Necessary for the resize handle to be shown in Chromium.
-  padding: 0.5em; // Necessary for the resize handle to be selectable on qutebrowser.
-
-  // Re-normalise page colour.
-  background-color: white;
-}
-</style>
diff --git a/viewer/src/components/item_handlers/LdVideoViewer.vue b/viewer/src/components/item_handlers/LdVideoViewer.vue
deleted file mode 100644
index ed95bc2..0000000
--- a/viewer/src/components/item_handlers/LdVideoViewer.vue
+++ /dev/null
@@ -1,46 +0,0 @@
-<!--
--- 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>
-      <ld-download-viewer :item="item" />
-    </video>
-  </div>
-</template>
-
-<script lang="ts">
-import { VideoItem } from "@/@types/gallery";
-import { Component, Prop, Vue } from "vue-property-decorator";
-
-@Component
-export default class LdVideoViewer extends Vue {
-  @Prop({ required: true }) readonly item!: VideoItem;
-
-  get itemResourceUrl(): string {
-    return this.$galleryStore.resourceRoot + this.item.properties.resource;
-  }
-
-  get thumbnailResourceUrl(): string {
-    return this.item.thumbnail ? this.$galleryStore.resourceRoot + this.item.thumbnail.resource : "";
-  }
-}
-</script>
-- 
cgit v1.2.3