Feat/download via share link

client/components/modals/ShareModal.vue

@@ -48,6 +48,15 @@
         </div>
         <p class="text-sm text-gray-300 py-1 px-1" v-html="$getString('MessageShareURLWillBe', [demoShareUrl])" />
         <p class="text-sm text-gray-300 py-1 px-1" v-html="$getString('MessageShareExpirationWillBe', [expirationDateString])" />
+        <div class="flex items-center w-full md:w-1/2">
+          <p class="text-sm text-gray-300 py-1 px-1">{{ $strings.LabelDownloadable }}</p>
+          <ui-toggle-switch size="sm" v-model="isDownloadable" />
+          <ui-tooltip :text="$strings.LabelShareDownloadableHelp">
+            <p class="pl-4 text-sm">
+              <span class="material-symbols icon-text text-sm">info</span>
+            </p>
+          </ui-tooltip>
+        </div>
       </template>
       <div class="flex items-center pt-6">
         <div class="flex-grow" />
@@ -81,7 +90,8 @@ export default {
           text: this.$strings.LabelDays,
           value: 'days'
         }
-      ]
+      ],
+      isDownloadable: false
     }
   },
   watch: {
@@ -172,7 +182,8 @@ export default {
         slug: this.newShareSlug,
         mediaItemType: 'book',
         mediaItemId: this.libraryItem.media.id,
-        expiresAt: this.expireDurationSeconds ? Date.now() + this.expireDurationSeconds * 1000 : 0
+        expiresAt: this.expireDurationSeconds ? Date.now() + this.expireDurationSeconds * 1000 : 0,
+        isDownloadable: this.isDownloadable
       }
       this.processing = true
       this.$axios

client/pages/share/_slug.vue

@@ -12,6 +12,10 @@
         <div class="w-full pt-16">
           <player-ui ref="audioPlayer" :chapters="chapters" :current-chapter="currentChapter" :paused="isPaused" :loading="!hasLoaded" :is-podcast="false" hide-bookmarks hide-sleep-timer @playPause="playPause" @jumpForward="jumpForward" @jumpBackward="jumpBackward" @setVolume="setVolume" @setPlaybackRate="setPlaybackRate" @seek="seek" />
         </div>
+
+        <ui-tooltip v-if="mediaItemShare.isDownloadable" direction="bottom" :text="$strings.LabelDownload" class="absolute top-0 left-0 m-4">
+          <button aria-label="Download" class="text-gray-300 hover:text-white" @click="downloadShareItem"><span class="material-symbols text-2xl sm:text-3xl">download</span></button>
+        </ui-tooltip>
       </div>
     </div>
   </div>
@@ -63,6 +67,9 @@ export default {
       if (!this.playbackSession.coverPath) return `${this.$config.routerBasePath}/book_placeholder.jpg`
       return `${this.$config.routerBasePath}/public/share/${this.mediaItemShare.slug}/cover`
     },
+    downloadUrl() {
+      return `${process.env.serverUrl}/api/items/${this.playbackSession.libraryItemId}/download?share=${this.mediaItemShare.slug}`
+    },
     audioTracks() {
       return (this.playbackSession.audioTracks || []).map((track) => {
         track.relativeContentUrl = track.contentUrl
@@ -247,6 +254,9 @@ export default {
     },
     playerFinished() {
       console.log('Player finished')
+    },
+    downloadShareItem() {
+      this.$downloadFile(this.downloadUrl)
     }
   },
   mounted() {

client/strings/en-us.json

@@ -297,6 +297,7 @@
   "LabelDiscover": "Discover",
   "LabelDownload": "Download",
   "LabelDownloadNEpisodes": "Download {0} episodes",
+  "LabelDownloadable": "Downloadable",
   "LabelDuration": "Duration",
   "LabelDurationComparisonExactMatch": "(exact match)",
   "LabelDurationComparisonLonger": "({0} longer)",
@@ -584,6 +585,7 @@
   "LabelSettingsStoreMetadataWithItemHelp": "By default metadata files are stored in /metadata/items, enabling this setting will store metadata files in your library item folders",
   "LabelSettingsTimeFormat": "Time Format",
   "LabelShare": "Share",
+  "LabelShareDownloadableHelp": "Allows users with the share link to download a zip file of the library item.",
   "LabelShareOpen": "Share Open",
   "LabelShareURL": "Share URL",
   "LabelShowAll": "Show All",

server/controllers/LibraryItemController.js

@@ -157,33 +157,49 @@ class LibraryItemController {
    * @param {Response} res
    */
   async download(req, res) {
-    if (!req.user.canDownload) {
-      Logger.warn(`User "${req.user.username}" attempted to download without permission`)
-      return res.sendStatus(403)
+    const handleDownload = async (req, res) => {
+      const libraryItemPath = req.libraryItem.path
+      const itemTitle = req.libraryItem.media.metadata.title
+
+      Logger.info(`[LibraryItemController] User "${req.user.username}" requested download for item "${itemTitle}" at "${libraryItemPath}"`)
+
+      try {
+        // If library item is a single file in root dir then no need to zip
+        if (req.libraryItem.isFile) {
+          // Express does not set the correct mimetype for m4b files so use our defined mimetypes if available
+          const audioMimeType = getAudioMimeTypeFromExtname(Path.extname(libraryItemPath))
+          if (audioMimeType) {
+            res.setHeader('Content-Type', audioMimeType)
+          }
+          await new Promise((resolve, reject) => res.download(libraryItemPath, req.libraryItem.relPath, (error) => (error ? reject(error) : resolve())))
+        } else {
+          const filename = `${itemTitle}.zip`
+          await zipHelpers.zipDirectoryPipe(libraryItemPath, filename, res)
+        }
+        Logger.info(`[LibraryItemController] Downloaded item "${itemTitle}" at "${libraryItemPath}"`)
+      } catch (error) {
+        Logger.error(`[LibraryItemController] Download failed for item "${itemTitle}" at "${libraryItemPath}"`, error)
+        res.status(500).send('Failed to download the item')
+      }
     }
-    const libraryItemPath = req.libraryItem.path
-    const itemTitle = req.libraryItem.media.metadata.title
-
-    Logger.info(`[LibraryItemController] User "${req.user.username}" requested download for item "${itemTitle}" at "${libraryItemPath}"`)
 
-    try {
-      // If library item is a single file in root dir then no need to zip
-      if (req.libraryItem.isFile) {
-        // Express does not set the correct mimetype for m4b files so use our defined mimetypes if available
-        const audioMimeType = getAudioMimeTypeFromExtname(Path.extname(libraryItemPath))
-        if (audioMimeType) {
-          res.setHeader('Content-Type', audioMimeType)
+    if (req.query.share) {
+      // Find matching MediaItemShare based on slug
+      const mediaItemShare = await ShareManager.findBySlug(req.query.share)
+      if (mediaItemShare) {
+        // If the isDownloadable bool is true, download the file
+        if (mediaItemShare.isDownloadable) {
+          return handleDownload(req, res)
         }
-        await new Promise((resolve, reject) => res.download(libraryItemPath, req.libraryItem.relPath, (error) => (error ? reject(error) : resolve())))
-      } else {
-        const filename = `${itemTitle}.zip`
-        await zipHelpers.zipDirectoryPipe(libraryItemPath, filename, res)
       }
-      Logger.info(`[LibraryItemController] Downloaded item "${itemTitle}" at "${libraryItemPath}"`)
-    } catch (error) {
-      Logger.error(`[LibraryItemController] Download failed for item "${itemTitle}" at "${libraryItemPath}"`, error)
-      LibraryItemController.handleDownloadError(error, res)
     }
+
+    if (!req.user.canDownload) {
+      Logger.warn(`User "${req.user.username}" attempted to download without permission`)
+      return res.sendStatus(403)
+    }
+
+    return handleDownload(req, res)
   }
 
   /**

server/controllers/ShareController.js

@@ -259,7 +259,7 @@ class ShareController {
       return res.sendStatus(403)
     }
 
-    const { slug, expiresAt, mediaItemType, mediaItemId } = req.body
+    const { slug, expiresAt, mediaItemType, mediaItemId, isDownloadable } = req.body
 
     if (!slug?.trim?.() || typeof mediaItemType !== 'string' || typeof mediaItemId !== 'string') {
       return res.status(400).send('Missing or invalid required fields')
@@ -298,7 +298,8 @@ class ShareController {
         expiresAt: expiresAt || null,
         mediaItemId,
         mediaItemType,
-        userId: req.user.id
+        userId: req.user.id,
+        isDownloadable
       })
 
       ShareManager.openMediaItemShare(mediaItemShare)

server/migrations/v2.17.3-share-add-isdownloadable.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const { DataTypes } = require('sequelize')
+
+/**
+ * @typedef MigrationContext
+ * @property {import('sequelize').QueryInterface} queryInterface - a Sequelize QueryInterface object.
+ * @property {import('../Logger')} logger - a Logger object.
+ *
+ * @typedef MigrationOptions
+ * @property {MigrationContext} context - an object containing the migration context.
+ */
+
+/**
+ * This migration script adds the isDownloadable column to the mediaItemShares table.
+ *
+ * @param {MigrationOptions} options - an object containing the migration context.
+ * @returns {Promise<void>} - A promise that resolves when the migration is complete.
+ */
+module.exports = {
+  up: async ({ context: { queryInterface, logger } }) => {
+    await queryInterface.addColumn('mediaItemShares', 'isDownloadable', {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+      allowNull: false
+    })
+  },
+
+  down: async ({ context: { queryInterface, logger } }) => {
+    await queryInterface.removeColumn('mediaItemShares', 'isDownloadable')
+  }
+}

server/models/MediaItemShare.js

@@ -12,6 +12,7 @@ const { DataTypes, Model } = require('sequelize')
  * @property {Object} extraData
  * @property {Date} createdAt
  * @property {Date} updatedAt
+ * @property {boolean} isDownloadable
  *
  * @typedef {MediaItemShareObject & MediaItemShare} MediaItemShareModel
  */
@@ -25,6 +26,7 @@ const { DataTypes, Model } = require('sequelize')
  * @property {Date} expiresAt
  * @property {Date} createdAt
  * @property {Date} updatedAt
+ * @property {boolean} isDownloadable
  */
 
 class MediaItemShare extends Model {
@@ -40,7 +42,8 @@ class MediaItemShare extends Model {
       slug: this.slug,
       expiresAt: this.expiresAt,
       createdAt: this.createdAt,
-      updatedAt: this.updatedAt
+      updatedAt: this.updatedAt,
+      isDownloadable: this.isDownloadable
     }
   }
 
@@ -114,7 +117,8 @@ class MediaItemShare extends Model {
         slug: DataTypes.STRING,
         pash: DataTypes.STRING,
         expiresAt: DataTypes.DATE,
-        extraData: DataTypes.JSON
+        extraData: DataTypes.JSON,
+        isDownloadable: DataTypes.BOOLEAN
       },
       {
         sequelize,

test/server/migrations/v2.17.3-share-add-isdownloadable.test.js

@@ -0,0 +1,42 @@
+const chai = require('chai')
+const sinon = require('sinon')
+const { expect } = chai
+
+const { DataTypes } = require('sequelize')
+
+const { up, down } = require('../../../server/migrations/v2.17.3-share-add-isdownloadable')
+
+describe('Migration v2.17.3-share-add-isDownloadable', () => {
+  let queryInterface
+
+  beforeEach(() => {
+    queryInterface = {
+      addColumn: sinon.stub().resolves(),
+      removeColumn: sinon.stub().resolves()
+    }
+  })
+
+  describe('up', () => {
+    it('should add the isDownloadable column to mediaItemShares table', async () => {
+      await up({ context: { queryInterface } })
+
+      expect(queryInterface.addColumn.calledOnce).to.be.true
+      expect(
+        queryInterface.addColumn.calledWith('mediaItemShares', 'isDownloadable', {
+          type: DataTypes.BOOLEAN,
+          defaultValue: false,
+          allowNull: false
+        })
+      ).to.be.true
+    })
+  })
+
+  describe('down', () => {
+    it('should remove the isDownloadable column from mediaItemShares table', async () => {
+      await down({ context: { queryInterface } })
+
+      expect(queryInterface.removeColumn.calledOnce).to.be.true
+      expect(queryInterface.removeColumn.calledWith('mediaItemShares', 'isDownloadable')).to.be.true
+    })
+  })
+})