diff --git a/.vscode/settings.json b/.vscode/settings.json index 75503e6a4..5f300815f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -23,5 +23,6 @@ }, "[vue]": { "editor.defaultFormatter": "octref.vetur" - } + }, + "makefile.configureOnOpen": false } \ No newline at end of file diff --git a/artifacts/2026-02-06-move-to-library-feature.md b/artifacts/2026-02-06-move-to-library-feature.md new file mode 100644 index 000000000..ad1dbd685 --- /dev/null +++ b/artifacts/2026-02-06-move-to-library-feature.md @@ -0,0 +1,115 @@ +# Move to Library Feature Documentation + +**Date:** 2026-02-06 + +## Overview + +This feature allows users to move audiobooks (and podcasts) between libraries of the same type via a context menu option. + +## API Endpoint + +``` +POST /api/items/:id/move +``` + +**Request Body:** + +```json +{ + "targetLibraryId": "uuid-of-target-library", + "targetFolderId": "uuid-of-target-folder" // optional, uses first folder if not provided +} +``` + +**Permissions:** Requires delete permission (`canDelete`) + +**Validations:** + +- Target library must exist +- Target library must have same `mediaType` as source (book ↔ book, podcast ↔ podcast) +- Cannot move to the same library +- Destination path must not already exist + +**Response:** Returns updated library item JSON on success + +--- + +## Files Modified + +### Backend + +| File | Line Range | Description | +| --------------------------------------------- | ---------- | ------------------ | +| `server/controllers/LibraryItemController.js` | ~1160-1289 | `move()` method | +| `server/routers/ApiRouter.js` | 129 | Route registration | + +### Frontend + +| File | Description | +| ------------------------------------------------------ | ---------------------------------------------------------------------- | +| `client/components/modals/item/MoveToLibraryModal.vue` | **NEW** - Modal component | +| `client/store/globals.js` | State: `showMoveToLibraryModal`, Mutation: `setShowMoveToLibraryModal` | +| `client/components/cards/LazyBookCard.vue` | Menu item `openMoveToLibraryModal` in `moreMenuItems` | +| `client/layouts/default.vue` | Added `` | +| `client/strings/en-us.json` | Localization strings | + +### Localization Strings Added + +- `ButtonMove`, `ButtonMoveToLibrary` +- `LabelMoveToLibrary`, `LabelMovingItem` +- `LabelSelectTargetLibrary`, `LabelSelectTargetFolder` +- `MessageNoCompatibleLibraries` +- `ToastItemMoved`, `ToastItemMoveFailed` + +--- + +## Implementation Details + +### Backend Flow + +1. Validate `targetLibraryId` is provided +2. Check user has delete permission +3. Fetch target library with folders +4. Validate media type matches source library +5. Select target folder (first folder if not specified) +6. Calculate new path: `targetFolder.path + itemFolderName` +7. Check destination doesn't exist +8. Move files using `fs.move(oldPath, newPath)` +9. Update database: `libraryId`, `libraryFolderId`, `path`, `relPath` +10. Update `libraryFiles` paths +11. Update `audioFiles` paths in Book model (for playback to work) +12. Update `ebookFile` path in Book model (if present) +13. Update `podcastEpisodes` audio file paths for Podcasts +14. Emit socket events: `item_removed` (old library), `item_added` (new library) +15. Reset filter data for both libraries +16. On error: rollback file move if possible + +### Frontend Flow + +1. User clicks "⋮" menu on book card +2. "Move to library" option appears (if `userCanDelete`) +3. Click triggers `openMoveToLibraryModal()` +4. Store commits: `setSelectedLibraryItem`, `setShowMoveToLibraryModal` +5. Modal shows compatible libraries (same mediaType, different id) +6. User selects library (and folder if multiple) +7. POST to `/api/items/:id/move` +8. Success: toast + close modal; Error: show error toast + +--- + +## Testing + +1. Create 2+ libraries of same type +2. Add an audiobook to one library +3. Open context menu → "Move to library" +4. Select target library → Click Move +5. Verify item moved in UI and filesystem + +--- + +## Known Limitations / Future Work + +- Does not support moving to different folder within same library +- No confirmation dialog (could be added) +- No batch move support yet +- Unit tests not yet added to `test/server/controllers/LibraryItemController.test.js` diff --git a/client/components/cards/LazyBookCard.vue b/client/components/cards/LazyBookCard.vue index 51f657dbc..77809904f 100644 --- a/client/components/cards/LazyBookCard.vue +++ b/client/components/cards/LazyBookCard.vue @@ -601,6 +601,10 @@ export default { } if (this.userCanDelete) { + items.push({ + func: 'openMoveToLibraryModal', + text: this.$strings.ButtonMoveToLibrary + }) items.push({ func: 'deleteLibraryItem', text: this.$strings.ButtonDelete @@ -904,6 +908,10 @@ export default { this.store.commit('setSelectedLibraryItem', this.libraryItem) this.store.commit('globals/setShareModal', this.mediaItemShare) }, + openMoveToLibraryModal() { + this.store.commit('setSelectedLibraryItem', this.libraryItem) + this.store.commit('globals/setShowMoveToLibraryModal', true) + }, deleteLibraryItem() { const payload = { message: this.$strings.MessageConfirmDeleteLibraryItem, diff --git a/client/components/modals/item/MoveToLibraryModal.vue b/client/components/modals/item/MoveToLibraryModal.vue new file mode 100644 index 000000000..ddac463ab --- /dev/null +++ b/client/components/modals/item/MoveToLibraryModal.vue @@ -0,0 +1,152 @@ + + + diff --git a/client/layouts/default.vue b/client/layouts/default.vue index 75753b214..ebbf8401d 100644 --- a/client/layouts/default.vue +++ b/client/layouts/default.vue @@ -21,6 +21,7 @@ + diff --git a/client/store/globals.js b/client/store/globals.js index 7b416196a..34e17371d 100644 --- a/client/store/globals.js +++ b/client/store/globals.js @@ -27,6 +27,7 @@ export const state = () => ({ isCasting: false, // Actively casting isChromecastInitialized: false, // Script loadeds showBatchQuickMatchModal: false, + showMoveToLibraryModal: false, dateFormats: [ { text: 'MM/DD/YYYY', @@ -204,6 +205,9 @@ export const mutations = { setShowBatchQuickMatchModal(state, val) { state.showBatchQuickMatchModal = val }, + setShowMoveToLibraryModal(state, val) { + state.showMoveToLibraryModal = val + }, resetSelectedMediaItems(state) { state.selectedMediaItems = [] }, diff --git a/client/strings/en-us.json b/client/strings/en-us.json index fb2bcb281..d19a4a0ad 100644 --- a/client/strings/en-us.json +++ b/client/strings/en-us.json @@ -29,6 +29,8 @@ "ButtonCreate": "Create", "ButtonCreateBackup": "Create Backup", "ButtonDelete": "Delete", + "ButtonMove": "Move", + "ButtonMoveToLibrary": "Move to library", "ButtonDownloadQueue": "Queue", "ButtonEdit": "Edit", "ButtonEditChapters": "Edit Chapters", @@ -465,6 +467,8 @@ "LabelMissing": "Missing", "LabelMissingEbook": "Has no ebook", "LabelMissingSupplementaryEbook": "Has no supplementary ebook", + "LabelMoveToLibrary": "Move to Library", + "LabelMovingItem": "Moving item", "LabelMobileRedirectURIs": "Allowed Mobile Redirect URIs", "LabelMobileRedirectURIsDescription": "This is a whitelist of valid redirect URIs for mobile apps. The default one is audiobookshelf://oauth, which you can remove or supplement with additional URIs for third-party app integration. Using an asterisk (*) as the sole entry permits any URI.", "LabelMore": "More", @@ -572,6 +576,8 @@ "LabelSelectEpisodesShowing": "Select {0} episodes showing", "LabelSelectUser": "Select user", "LabelSelectUsers": "Select users", + "LabelSelectTargetLibrary": "Select target library", + "LabelSelectTargetFolder": "Select target folder", "LabelSendEbookToDevice": "Send Ebook to...", "LabelSequence": "Sequence", "LabelSerial": "Serial", @@ -850,6 +856,7 @@ "MessageNoEpisodes": "No Episodes", "MessageNoFoldersAvailable": "No Folders Available", "MessageNoGenres": "No Genres", + "MessageNoCompatibleLibraries": "No other compatible libraries available", "MessageNoIssues": "No Issues", "MessageNoItems": "No Items", "MessageNoItemsFound": "No items found", @@ -1056,6 +1063,8 @@ "ToastItemCoverUpdateSuccess": "Item cover updated", "ToastItemDeletedFailed": "Failed to delete item", "ToastItemDeletedSuccess": "Deleted item", + "ToastItemMoved": "Item moved successfully", + "ToastItemMoveFailed": "Failed to move item", "ToastItemDetailsUpdateSuccess": "Item details updated", "ToastItemMarkedAsFinishedFailed": "Failed to mark as Finished", "ToastItemMarkedAsFinishedSuccess": "Item marked as Finished", diff --git a/server/controllers/LibraryItemController.js b/server/controllers/LibraryItemController.js index 5247dbb06..2442cddfc 100644 --- a/server/controllers/LibraryItemController.js +++ b/server/controllers/LibraryItemController.js @@ -1157,6 +1157,164 @@ class LibraryItemController { res.sendStatus(200) } + /** + * POST: /api/items/:id/move + * Move a library item to a different library + * + * @param {LibraryItemControllerRequest} req + * @param {Response} res + */ + async move(req, res) { + // Permission check - require delete permission (implies write access) + if (!req.user.canDelete) { + Logger.warn(`[LibraryItemController] User "${req.user.username}" attempted to move item without permission`) + return res.sendStatus(403) + } + + const { targetLibraryId, targetFolderId } = req.body + + if (!targetLibraryId) { + return res.status(400).send('Target library ID is required') + } + + // Get target library with folders + const targetLibrary = await Database.libraryModel.findByIdWithFolders(targetLibraryId) + if (!targetLibrary) { + return res.status(404).send('Target library not found') + } + + // Validate media type compatibility + const sourceLibrary = await Database.libraryModel.findByIdWithFolders(req.libraryItem.libraryId) + if (!sourceLibrary) { + Logger.error(`[LibraryItemController] Source library not found for item ${req.libraryItem.id}`) + return res.status(500).send('Source library not found') + } + + if (sourceLibrary.mediaType !== targetLibrary.mediaType) { + return res.status(400).send(`Cannot move ${sourceLibrary.mediaType} to ${targetLibrary.mediaType} library`) + } + + // Don't allow moving to same library + if (sourceLibrary.id === targetLibrary.id) { + return res.status(400).send('Item is already in this library') + } + + // Determine target folder + let targetFolder = null + if (targetFolderId) { + targetFolder = targetLibrary.libraryFolders.find((f) => f.id === targetFolderId) + if (!targetFolder) { + return res.status(400).send('Target folder not found in library') + } + } else { + // Use first folder if not specified + targetFolder = targetLibrary.libraryFolders[0] + } + + if (!targetFolder) { + return res.status(400).send('Target library has no folders') + } + + // Calculate new paths + const itemFolderName = Path.basename(req.libraryItem.path) + const newPath = Path.join(targetFolder.path, itemFolderName) + const newRelPath = itemFolderName + + // Check if destination already exists + const destinationExists = await fs.pathExists(newPath) + if (destinationExists) { + return res.status(400).send(`Destination already exists: ${newPath}`) + } + + const oldPath = req.libraryItem.path + const oldLibraryId = req.libraryItem.libraryId + + try { + // Move files on disk + Logger.info(`[LibraryItemController] Moving item "${req.libraryItem.media.title}" from "${oldPath}" to "${newPath}"`) + await fs.move(oldPath, newPath) + + // Update library item in database + req.libraryItem.libraryId = targetLibrary.id + req.libraryItem.libraryFolderId = targetFolder.id + req.libraryItem.path = newPath + req.libraryItem.relPath = newRelPath + req.libraryItem.changed('updatedAt', true) + await req.libraryItem.save() + + // Update library files paths + if (req.libraryItem.libraryFiles?.length) { + req.libraryItem.libraryFiles = req.libraryItem.libraryFiles.map((lf) => { + lf.metadata.path = lf.metadata.path.replace(oldPath, newPath) + return lf + }) + req.libraryItem.changed('libraryFiles', true) + await req.libraryItem.save() + } + + // Update media file paths (audioFiles, ebookFile for books; podcastEpisodes for podcasts) + if (req.libraryItem.isBook) { + // Update audioFiles paths + if (req.libraryItem.media.audioFiles?.length) { + req.libraryItem.media.audioFiles = req.libraryItem.media.audioFiles.map((af) => { + if (af.metadata?.path) { + af.metadata.path = af.metadata.path.replace(oldPath, newPath) + } + return af + }) + req.libraryItem.media.changed('audioFiles', true) + } + // Update ebookFile path + if (req.libraryItem.media.ebookFile?.metadata?.path) { + req.libraryItem.media.ebookFile.metadata.path = req.libraryItem.media.ebookFile.metadata.path.replace(oldPath, newPath) + req.libraryItem.media.changed('ebookFile', true) + } + await req.libraryItem.media.save() + } else if (req.libraryItem.isPodcast) { + // Update podcast episode audio file paths + for (const episode of req.libraryItem.media.podcastEpisodes || []) { + if (episode.audioFile?.metadata?.path) { + episode.audioFile.metadata.path = episode.audioFile.metadata.path.replace(oldPath, newPath) + episode.changed('audioFile', true) + await episode.save() + } + } + } + + // Emit socket events for UI updates + SocketAuthority.emitter('item_removed', { + id: req.libraryItem.id, + libraryId: oldLibraryId + }) + SocketAuthority.libraryItemEmitter('item_added', req.libraryItem) + + // Reset library filter data for both libraries + await Database.resetLibraryIssuesFilterData(oldLibraryId) + await Database.resetLibraryIssuesFilterData(targetLibrary.id) + + Logger.info(`[LibraryItemController] Successfully moved item "${req.libraryItem.media.title}" to library "${targetLibrary.name}"`) + + res.json({ + success: true, + libraryItem: req.libraryItem.toOldJSONExpanded() + }) + } catch (error) { + Logger.error(`[LibraryItemController] Failed to move item "${req.libraryItem.media.title}"`, error) + + // Attempt to rollback file move if database update failed + if (await fs.pathExists(newPath)) { + try { + await fs.move(newPath, oldPath) + Logger.info(`[LibraryItemController] Rolled back file move for item "${req.libraryItem.media.title}"`) + } catch (rollbackError) { + Logger.error(`[LibraryItemController] Failed to rollback file move`, rollbackError) + } + } + + return res.status(500).send('Failed to move item') + } + } + /** * * @param {RequestWithUser} req diff --git a/server/routers/ApiRouter.js b/server/routers/ApiRouter.js index db04bf5ec..4efe76e5a 100644 --- a/server/routers/ApiRouter.js +++ b/server/routers/ApiRouter.js @@ -126,6 +126,7 @@ class ApiRouter { this.router.get('/items/:id/file/:fileid/download', LibraryItemController.middleware.bind(this), LibraryItemController.downloadLibraryFile.bind(this)) this.router.get('/items/:id/ebook/:fileid?', LibraryItemController.middleware.bind(this), LibraryItemController.getEBookFile.bind(this)) this.router.patch('/items/:id/ebook/:fileid/status', LibraryItemController.middleware.bind(this), LibraryItemController.updateEbookFileStatus.bind(this)) + this.router.post('/items/:id/move', LibraryItemController.middleware.bind(this), LibraryItemController.move.bind(this)) // // User Routes