Merge pull request #348 from ldgallery/p_viewer_epub

viewer: render EPUB ebooks

11 files changed, 534 insertions, 6 deletions

diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md
index 46509fb..afdaec5 100644
--- a/viewer/ldgallery-viewer.7.md
+++ b/viewer/ldgallery-viewer.7.md
@@ -2,7 +2,7 @@
 pagetitle: Viewer user manual - ldgallery
 title: LDGALLERY-VIEWER(7) ldgallery
 author: Pacien TRAN-GIRARD, Guillaume FOUET
-date: 2022-10-26 (v2.1-SNAPSHOT)
+date: 2022-10-30 (v2.1-SNAPSHOT)
 ---
 
 
@@ -37,8 +37,8 @@ Items of the following formats can be opened and visualised within the web appli
 * Pictures (Bitmap, JPEG, PNG, TIFF, HDR, GIF)
 * Videos (OGV, WebM, Matroska, MPEG-4)
 * Audio files (WAV, Opus, FLAC, MP3, MPEG-4)
-* Plain text files (`.txt`)
-* PDFs
+* Text files (TXT, Markdown)
+* Ebooks (PDF, EPUB)
 
 Formats which are not listed above or which are not supported by the user's web browser are offered for download instead of being directly displayed in the same window.
 The item being visualised can be downloaded using the download button at the top-left corner.
diff --git a/viewer/package.json b/viewer/package.json
index f5ac5e3..61ea287 100644
--- a/viewer/package.json
+++ b/viewer/package.json
@@ -14,6 +14,7 @@
     "@fortawesome/vue-fontawesome": "3.0.1",
     "@vueuse/core": "9.3.1",
     "core-js": "3.25.0",
+    "epubjs": "0.3.93",
     "hammerjs": "2.0.8",
     "marked": "4.1.1",
     "mosha-vue-toastify": "1.0.23",
diff --git a/viewer/src/@types/gallery.ts b/viewer/src/@types/gallery.ts
index 8c0f177..6960de2 100644
--- a/viewer/src/@types/gallery.ts
+++ b/viewer/src/@types/gallery.ts
@@ -64,6 +64,9 @@ export interface MarkdownProperties extends Downloadable {
 export interface PDFProperties extends Downloadable {
   type: ItemType.PDF;
 }
+export interface EPUBProperties extends Downloadable {
+  type: ItemType.EPUB;
+}
 export interface VideoProperties extends Downloadable {
   type: ItemType.VIDEO;
 }
@@ -107,6 +110,9 @@ export interface MarkdownItem extends Item {
 export interface PDFItem extends Item {
   properties: PDFProperties;
 }
+export interface EPUBItem extends Item {
+  properties: EPUBProperties;
+}
 export interface VideoItem extends Item {
   properties: VideoProperties;
 }
diff --git a/viewer/src/@types/itemType.ts b/viewer/src/@types/itemType.ts
index ecab05c..8528728 100644
--- a/viewer/src/@types/itemType.ts
+++ b/viewer/src/@types/itemType.ts
@@ -23,6 +23,7 @@ export enum ItemType {
   PLAINTEXT = 'plaintext',
   MARKDOWN = 'markdown',
   PDF = 'pdf',
+  EPUB = 'epub',
   VIDEO = 'video',
   AUDIO = 'audio',
   DIRECTORY = 'directory',
diff --git a/viewer/src/assets/scss/theme.scss b/viewer/src/assets/scss/theme.scss
index 63febbf..6622fa5 100644
--- a/viewer/src/assets/scss/theme.scss
+++ b/viewer/src/assets/scss/theme.scss
@@ -41,6 +41,8 @@ $dropdown-item-color: $palette-600;
 $dropdown-item-hover-color: $palette-500;
 $panel-top-bgcolor: $palette-800;
 $panel-top-txtcolor: $primary;
+$panel-bottom-bgcolor: $palette-800;
+$panel-bottom-txtcolor: $primary;
 $panel-left-bgcolor: $palette-800;
 $panel-left-txtcolor: $primary;
 $command-buttons-bgcolor: $palette-700;
@@ -55,6 +57,7 @@ $thumbnail-other-size: $body-line-height * 7em;
 $proposed-category-bgcolor: $palette-700;
 $viewer-text: $palette-000;
 $viewer-text-background: $palette-900;
+$viewer-epub-background: $palette-000;
 
 // Layout
 
diff --git a/viewer/src/locales/en.yml b/viewer/src/locales/en.yml
index 86ecd49..280f18b 100644
--- a/viewer/src/locales/en.yml
+++ b/viewer/src/locales/en.yml
@@ -15,6 +15,9 @@ directory:
   no-results: Empty directory
 download:
   download-file-fmt: Download {0}
+epubViewer:
+  previousSection: Previous section
+  nextSection: Next section
 gallery:
   resource-loading-error: Error loading resource
   unknown-resource: Resource not found
diff --git a/viewer/src/services/navigation.ts b/viewer/src/services/navigation.ts
index b2e807b..fb01169 100644
--- a/viewer/src/services/navigation.ts
+++ b/viewer/src/services/navigation.ts
@@ -19,7 +19,18 @@
 
 import { DirectoryItem, DownloadableItem, Item } from '@/@types/gallery';
 import { ItemType } from '@/@types/itemType';
-import { faFile, faFileAlt, faFileAudio, faFilePdf, faFileVideo, faFolder, faHome, faImage, IconDefinition } from '@fortawesome/free-solid-svg-icons';
+import {
+  faFile,
+  faFileAlt,
+  faFileAudio,
+  faFilePdf,
+  faBook,
+  faFileVideo,
+  faFolder,
+  faHome,
+  faImage,
+  IconDefinition,
+} from '@fortawesome/free-solid-svg-icons';
 import { isDirectory } from './itemGuards';
 
 const ICON_BY_TYPE: Record<ItemType, IconDefinition> = {
@@ -28,6 +39,7 @@ const ICON_BY_TYPE: Record<ItemType, IconDefinition> = {
   plaintext: faFileAlt,
   markdown: faFileAlt,
   pdf: faFilePdf,
+  epub: faBook,
   video: faFileVideo,
   audio: faFileAudio,
   other: faFile,
diff --git a/viewer/src/views/GalleryNavigation.vue b/viewer/src/views/GalleryNavigation.vue
index 0869aaf..b342c52 100644
--- a/viewer/src/views/GalleryNavigation.vue
+++ b/viewer/src/views/GalleryNavigation.vue
@@ -44,6 +44,7 @@ import { computedEager } from '@vueuse/shared';
 import { computed, watchEffect } from 'vue';
 import { useI18n } from 'vue-i18n';
 import GallerySearch from './GallerySearch.vue';
+import { EpubViewer } from './item_handlers/async';
 import AudioViewer from './item_handlers/AudioViewer.vue';
 import DirectoryViewer from './item_handlers/DirectoryViewer.vue';
 import DownloadViewer from './item_handlers/DownloadViewer.vue';
@@ -67,6 +68,7 @@ const COMPONENT_BY_TYPE: Record<ItemType, unknown> = {
   plaintext: PlainTextViewer,
   markdown: MarkdownViewer,
   pdf: PdfViewer,
+  epub: EpubViewer,
   video: VideoViewer,
   audio: AudioViewer,
   other: DownloadViewer,
diff --git a/viewer/src/views/item_handlers/async/AsyncEpubViewer.vue b/viewer/src/views/item_handlers/async/AsyncEpubViewer.vue
new file mode 100644
index 0000000..b5c0cb4
--- /dev/null
+++ b/viewer/src/views/item_handlers/async/AsyncEpubViewer.vue
@@ -0,0 +1,180 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2022  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="$style.container">
+    <div
+      ref="view"
+      :class="$style.epubView"
+      class="scrollbar"
+    />
+
+    <ul
+      v-if="prevSection || nextSection"
+      :class="$style.navBar"
+    >
+      <li>
+        <LdLink
+          v-if="prevSection"
+          @click="goToPrevSection"