groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2025-12-28 06:39:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Lazy bookshelf, api routes for categories and filter data

Browse source
This commit is contained in:
advplyr 2021-11-30 20:02:40 -06:00
parent 4587916c8e
commit 5c92aef048
26 changed files with 1354 additions and 332 deletions
Download patch file Download diff file Expand all files Collapse all files

146
server/ApiController.js
View file

@ -49,13 +49,17 @@ class ApiController {
//
this.router.post('/libraries', LibraryController.create.bind(this))
this.router.get('/libraries', LibraryController.findAll.bind(this))
this.router.get('/libraries/:id', LibraryController.findOne.bind(this))
this.router.patch('/libraries/:id', LibraryController.update.bind(this))
this.router.delete('/libraries/:id', LibraryController.delete.bind(this))
this.router.get('/libraries/:id', LibraryController.middleware.bind(this), LibraryController.findOne.bind(this))
this.router.patch('/libraries/:id', LibraryController.middleware.bind(this), LibraryController.update.bind(this))
this.router.delete('/libraries/:id', LibraryController.middleware.bind(this), LibraryController.delete.bind(this))
this.router.get('/libraries/:id/books/all', LibraryController.getBooksForLibrary2.bind(this))
this.router.get('/libraries/:id/books', LibraryController.getBooksForLibrary.bind(this))
this.router.get('/libraries/:id/search', LibraryController.search.bind(this))
this.router.get('/libraries/:id/books/all', LibraryController.middleware.bind(this), LibraryController.getBooksForLibrary2.bind(this))
this.router.get('/libraries/:id/books', LibraryController.middleware.bind(this), LibraryController.getBooksForLibrary.bind(this))
this.router.get('/libraries/:id/series', LibraryController.middleware.bind(this), LibraryController.getSeriesForLibrary.bind(this))
this.router.get('/libraries/:id/collections', LibraryController.middleware.bind(this), LibraryController.getCollectionsForLibrary.bind(this))
this.router.get('/libraries/:id/categories', LibraryController.middleware.bind(this), LibraryController.getLibraryCategories.bind(this))
this.router.get('/libraries/:id/filters', LibraryController.middleware.bind(this), LibraryController.getLibraryFilters.bind(this))
this.router.get('/libraries/:id/search', LibraryController.middleware.bind(this), LibraryController.search.bind(this))
this.router.patch('/libraries/order', LibraryController.reorder.bind(this))
// TEMP: Support old syntax for mobile app
@ -491,43 +495,103 @@ class ApiController {
}
decode(text) {
return Buffer.from(decodeURIComponent(text), 'base64').toString()
}
// decode(text) {
// return Buffer.from(decodeURIComponent(text), 'base64').toString()
// }
getFiltered(audiobooks, filterBy, user) {
var filtered = audiobooks
// getFiltered(audiobooks, filterBy, user) {
// var filtered = audiobooks
var searchGroups = ['genres', 'tags', 'series', 'authors', 'progress', 'narrators']
var group = searchGroups.find(_group => filterBy.startsWith(_group + '.'))
if (group) {
var filterVal = filterBy.replace(`${group}.`, '')
var filter = this.decode(filterVal)
if (group === 'genres') filtered = filtered.filter(ab => ab.book && ab.book.genres.includes(filter))
else if (group === 'tags') filtered = filtered.filter(ab => ab.tags.includes(filter))
else if (group === 'series') {
if (filter === 'No Series') filtered = filtered.filter(ab => ab.book && !ab.book.series)
else filtered = filtered.filter(ab => ab.book && ab.book.series === filter)
}
else if (group === 'authors') filtered = filtered.filter(ab => ab.book && ab.book.authorFL && ab.book.authorFL.split(', ').includes(filter))
else if (group === 'narrators') filtered = filtered.filter(ab => ab.book && ab.book.narratorFL && ab.book.narratorFL.split(', ').includes(filter))
else if (group === 'progress') {
filtered = filtered.filter(ab => {
var userAudiobook = user.getAudiobookJSON(ab.id)
var isRead = userAudiobook && userAudiobook.isRead
if (filter === 'Read' && isRead) return true
if (filter === 'Unread' && !isRead) return true
if (filter === 'In Progress' && (userAudiobook && !userAudiobook.isRead && userAudiobook.progress > 0)) return true
return false
})
}
} else if (filterBy === 'issues') {
filtered = filtered.filter(ab => {
return ab.hasMissingParts || ab.hasInvalidParts || ab.isMissing || ab.isIncomplete
})
}
// var searchGroups = ['genres', 'tags', 'series', 'authors', 'progress', 'narrators']
// var group = searchGroups.find(_group => filterBy.startsWith(_group + '.'))
// if (group) {
// var filterVal = filterBy.replace(`${group}.`, '')
// var filter = this.decode(filterVal)
// if (group === 'genres') filtered = filtered.filter(ab => ab.book && ab.book.genres.includes(filter))
// else if (group === 'tags') filtered = filtered.filter(ab => ab.tags.includes(filter))
// else if (group === 'series') {
// if (filter === 'No Series') filtered = filtered.filter(ab => ab.book && !ab.book.series)
// else filtered = filtered.filter(ab => ab.book && ab.book.series === filter)
// }
// else if (group === 'authors') filtered = filtered.filter(ab => ab.book && ab.book.authorFL && ab.book.authorFL.split(', ').includes(filter))
// else if (group === 'narrators') filtered = filtered.filter(ab => ab.book && ab.book.narratorFL && ab.book.narratorFL.split(', ').includes(filter))
// else if (group === 'progress') {
// filtered = filtered.filter(ab => {
// var userAudiobook = user.getAudiobookJSON(ab.id)
// var isRead = userAudiobook && userAudiobook.isRead
// if (filter === 'Read' && isRead) return true
// if (filter === 'Unread' && !isRead) return true
// if (filter === 'In Progress' && (userAudiobook && !userAudiobook.isRead && userAudiobook.progress > 0)) return true
// return false
// })
// }
// } else if (filterBy === 'issues') {
// filtered = filtered.filter(ab => {
// return ab.hasMissingParts || ab.hasInvalidParts || ab.isMissing || ab.isIncomplete
// })
// }
return filtered
}
// return filtered
// }
// getDistinctFilterData(audiobooks) {
// var data = {
// authors: [],
// genres: [],
// tags: [],
// series: [],
// narrators: []
// }
// audiobooks.forEach((ab) => {
// if (ab.book._authorsList.length) {
// ab.book._authorsList.forEach((author) => {
// if (author && !data.authors.includes(author)) data.authors.push(author)
// })
// }
// if (ab.book._genres.length) {
// ab.book._genres.forEach((genre) => {
// if (genre && !data.genres.includes(genre)) data.genres.push(genre)
// })
// }
// if (ab.tags.length) {
// ab.tags.forEach((tag) => {
// if (tag && !data.tags.includes(tag)) data.tags.push(tag)
// })
// }
// if (ab.book._series && !data.series.includes(ab.book._series)) data.series.push(ab.book._series)
// if (ab.book._narratorsList.length) {
// ab.book._narratorsList.forEach((narrator) => {
// if (narrator && !data.narrators.includes(narrator)) data.narrators.push(narrator)
// })
// }
// })
// return data
// }
// getBooksMostRecentlyRead(user, books, limit) {
// var booksWithProgress = books.map(book => {
// return {
// userAudiobook: user.getAudiobookJSON(book.id),
// book
// }
// }).filter((data) => data.userAudiobook && !data.userAudiobook.isRead)
// booksWithProgress.sort((a, b) => {
// return b.userAudiobook.lastUpdate - a.userAudiobook.lastUpdate
// })
// return booksWithProgress.map(b => b.book).slice(0, limit)
// }
// getBooksMostRecentlyAdded(user, books, limit) {
// var booksWithProgress = books.map(book => {
// return {
// userAudiobook: user.getAudiobookJSON(book.id),
// book
// }
// }).filter((data) => data.userAudiobook && !data.userAudiobook.isRead)
// booksWithProgress.sort((a, b) => {
// return b.userAudiobook.lastUpdate - a.userAudiobook.lastUpdate
// })
// return booksWithProgress.map(b => b.book).slice(0, limit)
// }
}
module.exports = ApiController

163
server/controllers/LibraryController.js
View file

@ -1,6 +1,7 @@
const Logger = require('../Logger')
const Library = require('../objects/Library')
const { sort } = require('fast-sort')
const libraryHelpers = require('../utils/libraryHelpers')
class LibraryController {
constructor() { }
@ -29,21 +30,19 @@ class LibraryController {
res.json(this.db.libraries.map(lib => lib.toJSON()))
}
findOne(req, res) {
if (!req.params.id) return res.status(500).send('Invalid id parameter')
var library = this.db.libraries.find(lib => lib.id === req.params.id)
if (!library) {
return res.status(404).send('Library not found')
async findOne(req, res) {
if (req.query.include && req.query.include === 'filterdata') {
var books = this.db.audiobooks.filter(ab => ab.libraryId === req.library.id)
return res.json({
filterdata: libraryHelpers.getDistinctFilterData(books),
library: req.library
})
}
return res.json(library.toJSON())
return res.json(req.library)
}
async update(req, res) {
var library = this.db.libraries.find(lib => lib.id === req.params.id)
if (!library) {
return res.status(404).send('Library not found')
}
var library = req.library
var hasUpdates = library.update(req.body)
if (hasUpdates) {
// Update watcher
@ -64,10 +63,7 @@ class LibraryController {
}
async delete(req, res) {
var library = this.db.libraries.find(lib => lib.id === req.params.id)
if (!library) {
return res.status(404).send('Library not found')
}
var library = req.library
// Remove library watcher
this.watcher.removeLibrary(library)
@ -87,11 +83,7 @@ class LibraryController {
// api/libraries/:id/books
getBooksForLibrary(req, res) {
var libraryId = req.params.id
var library = this.db.libraries.find(lib => lib.id === libraryId)
if (!library) {
return res.status(400).send('Library does not exist')
}
var libraryId = req.library.id
var audiobooks = this.db.audiobooks.filter(ab => ab.libraryId === libraryId)
// if (req.query.q) {
// audiobooks = this.db.audiobooks.filter(ab => {
@ -102,7 +94,7 @@ class LibraryController {
// }
if (req.query.filter) {
audiobooks = this.getFiltered(this.db.audiobooks, req.query.filter, req.user)
audiobooks = libraryHelpers.getFiltered(audiobooks, req.query.filter, req.user)
}
@ -126,13 +118,9 @@ class LibraryController {
res.json(audiobooks)
}
// api/libraries/:id/books/fs
// api/libraries/:id/books/all
getBooksForLibrary2(req, res) {
var libraryId = req.params.id
var library = this.db.libraries.find(lib => lib.id === libraryId)
if (!library) {
return res.status(400).send('Library does not exist')
}
var libraryId = req.library.id
var audiobooks = this.db.audiobooks.filter(ab => ab.libraryId === libraryId)
var payload = {
@ -146,7 +134,8 @@ class LibraryController {
}
if (payload.filterBy) {
audiobooks = this.getFiltered(this.db.audiobooks, payload.filterBy, req.user)
audiobooks = libraryHelpers.getFiltered(audiobooks, payload.filterBy, req.user)
payload.total = audiobooks.length
}
if (payload.sortBy) {
@ -170,6 +159,110 @@ class LibraryController {
res.json(payload)
}
// api/libraries/:id/series
async getSeriesForLibrary(req, res) {
var audiobooks = this.db.audiobooks.filter(ab => ab.libraryId === req.library.id)
var payload = {
results: [],
total: 0,
limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0,
page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0,
sortBy: req.query.sort,
sortDesc: req.query.desc === '1',
filterBy: req.query.filter
}
var series = libraryHelpers.getSeriesFromBooks(audiobooks)
payload.total = series.length
if (payload.limit) {
var startIndex = payload.page * payload.limit
series = series.slice(startIndex, startIndex + payload.limit)
}
payload.results = series
console.log('returning series', series.length)
res.json(payload)
}
// api/libraries/:id/series
async getCollectionsForLibrary(req, res) {
var audiobooks = this.db.audiobooks.filter(ab => ab.libraryId === req.library.id)
var payload = {
results: [],
total: 0,
limit: req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 0,
page: req.query.page && !isNaN(req.query.page) ? Number(req.query.page) : 0,
sortBy: req.query.sort,
sortDesc: req.query.desc === '1',
filterBy: req.query.filter
}
var collections = this.db.collections.filter(c => c.libraryId === req.library.id).map(c => c.toJSONExpanded(audiobooks))
payload.total = collections.length
if (payload.limit) {
var startIndex = payload.page * payload.limit
collections = collections.slice(startIndex, startIndex + payload.limit)
}
payload.results = collections
console.log('returning collections', collections.length)
res.json(payload)
}
// api/libraries/:id/books/filters
async getLibraryFilters(req, res) {
var library = req.library
var books = this.db.audiobooks.filter(ab => ab.libraryId === library.id)
res.json(libraryHelpers.getDistinctFilterData(books))
}
// api/libraries/:id/books/categories
async getLibraryCategories(req, res) {
var library = req.library
var books = this.db.audiobooks.filter(ab => ab.libraryId === library.id)
var limitPerShelf = req.query.limit && !isNaN(req.query.limit) ? Number(req.query.limit) : 12
var booksWithUserAb = libraryHelpers.getBooksWithUserAudiobook(req.user, books)
var series = libraryHelpers.getSeriesFromBooks(books)
var categories = [
{
id: 'continue-reading',
label: 'Continue Reading',
type: 'books',
entities: libraryHelpers.getBooksMostRecentlyRead(booksWithUserAb, limitPerShelf)
},
{
id: 'recently-added',
label: 'Recently Added',
type: 'books',
entities: libraryHelpers.getBooksMostRecentlyAdded(books, limitPerShelf)
},
{
id: 'read-again',
label: 'Read Again',
type: 'books',
entities: libraryHelpers.getBooksMostRecentlyFinished(booksWithUserAb, limitPerShelf)
},
{
id: 'recent-series',
label: 'Recent Series',
type: 'series',
entities: libraryHelpers.getSeriesMostRecentlyAdded(series, limitPerShelf)
}
].filter(cats => { // Remove categories with no items
return cats.entities.length
})
res.json(categories)
}
// PATCH: Change the order of libraries
async reorder(req, res) {
if (!req.user.isRoot) {
@ -203,10 +296,7 @@ class LibraryController {
// GET: Global library search
search(req, res) {
var library = this.db.libraries.find(lib => lib.id === req.params.id)
if (!library) {
return res.status(404).send('Library not found')
}
var library = req.library
if (!req.query.q) {
return res.status(400).send('No query string')
}
@ -268,5 +358,14 @@ class LibraryController {
series: Object.values(seriesMatches).slice(0, maxResults)
})
}
middleware(req, res, next) {
var library = this.db.libraries.find(lib => lib.id === req.params.id)
if (!library) {
return res.status(404).send('Library not found')
}
req.library = library
next()
}
}
module.exports = new LibraryController()

2
server/objects/Book.js
View file

@ -11,6 +11,7 @@ class Book {
this.authorLF = null
this.authors = []
this.narrator = null
this.narratorFL = null
this.series = null
this.volumeNumber = null
this.publishYear = null
@ -40,6 +41,7 @@ class Book {
get _author() { return this.authorFL || '' }
get _series() { return this.series || '' }
get _authorsList() { return this._author.split(', ') }
get _narratorsList() { return this._narrator.split(', ') }
get _genres() { return this.genres || [] }
get shouldSearchForCover() {

132
server/utils/libraryHelpers.js Normal file
View file

@ -0,0 +1,132 @@
const { sort } = require('fast-sort')
module.exports = {
decode(text) {
return Buffer.from(decodeURIComponent(text), 'base64').toString()
},
getFiltered(audiobooks, filterBy, user) {
var filtered = audiobooks
var searchGroups = ['genres', 'tags', 'series', 'authors', 'progress', 'narrators']
var group = searchGroups.find(_group => filterBy.startsWith(_group + '.'))
if (group) {
var filterVal = filterBy.replace(`${group}.`, '')
var filter = this.decode(filterVal)
if (group === 'genres') filtered = filtered.filter(ab => ab.book && ab.book.genres.includes(filter))
else if (group === 'tags') filtered = filtered.filter(ab => ab.tags.includes(filter))
else if (group === 'series') {
if (filter === 'No Series') filtered = filtered.filter(ab => ab.book && !ab.book.series)
else filtered = filtered.filter(ab => ab.book && ab.book.series === filter)
}
else if (group === 'authors') filtered = filtered.filter(ab => ab.book && ab.book.authorFL && ab.book.authorFL.split(', ').includes(filter))
else if (group === 'narrators') filtered = filtered.filter(ab => ab.book && ab.book.narratorFL && ab.book.narratorFL.split(', ').includes(filter))
else if (group === 'progress') {
filtered = filtered.filter(ab => {
var userAudiobook = user.getAudiobookJSON(ab.id)
var isRead = userAudiobook && userAudiobook.isRead
if (filter === 'Read' && isRead) return true
if (filter === 'Unread' && !isRead) return true
if (filter === 'In Progress' && (userAudiobook && !userAudiobook.isRead && userAudiobook.progress > 0)) return true
return false
})
}
} else if (filterBy === 'issues') {
filtered = filtered.filter(ab => {
return ab.hasMissingParts || ab.hasInvalidParts || ab.isMissing || ab.isIncomplete
})
}
return filtered
},
getDistinctFilterData(audiobooks) {
var data = {
authors: [],
genres: [],
tags: [],
series: [],
narrators: []
}
audiobooks.forEach((ab) => {
if (ab.book._authorsList.length) {
ab.book._authorsList.forEach((author) => {
if (author && !data.authors.includes(author)) data.authors.push(author)
})
}
if (ab.book._genres.length) {
ab.book._genres.forEach((genre) => {
if (genre && !data.genres.includes(genre)) data.genres.push(genre)
})
}
if (ab.tags.length) {
ab.tags.forEach((tag) => {
if (tag && !data.tags.includes(tag)) data.tags.push(tag)
})
}
if (ab.book._series && !data.series.includes(ab.book._series)) data.series.push(ab.book._series)
if (ab.book._narratorsList.length) {
ab.book._narratorsList.forEach((narrator) => {
if (narrator && !data.narrators.includes(narrator)) data.narrators.push(narrator)
})
}
})
return data
},
getSeriesFromBooks(books) {
var _series = {}
books.forEach((audiobook) => {
if (audiobook.book.series) {
if (!_series[audiobook.book.series]) {
_series[audiobook.book.series] = {
id: audiobook.book.series,
name: audiobook.book.series,
books: [audiobook.toJSONExpanded()]
}
} else {
_series[audiobook.book.series].books.push(audiobook.toJSONExpanded())
}
}
})
return Object.values(_series)
},
getBooksWithUserAudiobook(user, books) {
return books.map(book => {
return {
userAudiobook: user.getAudiobookJSON(book.id),
book
}
})
},
getBooksMostRecentlyRead(booksWithUserAb, limit) {
var booksWithProgress = booksWithUserAb.filter((data) => data.userAudiobook && !data.userAudiobook.isRead)
booksWithProgress.sort((a, b) => {
return b.userAudiobook.lastUpdate - a.userAudiobook.lastUpdate
})
return booksWithProgress.map(b => b.book).slice(0, limit)
},
getBooksMostRecentlyAdded(books, limit) {
var booksSortedByAddedAt = sort(books).desc(book => book.addedAt)
return booksSortedByAddedAt.slice(0, limit)
},
getBooksMostRecentlyFinished(booksWithUserAb, limit) {
var booksRead = booksWithUserAb.filter((data) => data.userAudiobook && data.userAudiobook.isRead)
booksRead.sort((a, b) => {
return b.userAudiobook.finishedAt - a.userAudiobook.finishedAt
})
return booksRead.map(b => b.book).slice(0, limit)
},
getSeriesMostRecentlyAdded(series, limit) {
var seriesSortedByAddedAt = sort(series).desc(_series => {
var booksSortedByMostRecent = sort(_series.books).desc(b => b.addedAt)
return booksSortedByMostRecent[0].addedAt
})
return seriesSortedByAddedAt.slice(0, limit)
}
}