* fix(ebooks): fold author hint into metadata search query
The ebook enricher loaded each item's author but buildEbookSearchQuery
dropped it, and metadata.SearchQuery had no field to carry it — so the
plugin only ever received the title. Title-only searches collide or miss,
leaving items without metadata or a cover.
Add SearchQuery.Author and fold it into the plugin search query text
(the SearchMetadataRequest contract carries a single free-text Query, so
no proto change is needed). Gated to callers that set Author (ebooks);
movie/TV search is unchanged.
Verified live against OpenLibrary/GoogleBooks: improves disambiguation on
clean titles. Note: messy filename-derived titles (series prefixes,
trailing "(… Book N)") still need title normalization, and a large tail
of niche/self-published ebooks is simply absent from the free sources —
neither is addressed here.
AI-use disclosure: authored with Claude Code.
(cherry picked from commit ba1265909c4fb87e1a8eab64b0b0c183aa95acc1)
* feat(scanner): extract MOBI/AZW/AZW3 metadata from EXTH headers
These formats previously had no parser — parseEbookFile returned only the
format string, so title fell back to the filename with no author and no
ISBN, leaving ~21k books unmatchable by the metadata enricher.
Parse the Palm Database container (PDB header → record 0 → PalmDOC +
MOBI header → EXTH block) and extract title, authors, ISBN, publisher,
and language. EXTH is located by its magic rather than the header flag,
and field offsets (encoding @12, full-name @0x44/0x48) were verified
against real .mobi/.azw3 files.
Verified live against real library files:
azw3 → title "The Sea", author "A H Lee"
mobi → title "Brotherband 3: The Hunters", author "John Flanagan",
ISBN 9781742750637
AI-use disclosure: authored with Claude Code.
(cherry picked from commit 7af194b711de97bc79855f08a9a4f9732c49db74)
* fix(ebooks): recover author from path and clean provider search title
- ebookAuthorFromPath: recover an author for ".../<Author>/<Title>/<Title> -
<Author>.ext" layouts when the file embeds none, gated on two agreeing
path signals (grandparent dir == filename suffix) so magazines/courses
never get a junk author; strip the suffix from a path-derived title.
- cleanEbookSearchTitle: normalize filesystem-mangled titles before search
(underscore->space, drop trailing " - <author>") to lift hit rate.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
(cherry picked from commit 36a16cb58c3e5276aa4c0bdf8577008070f6abea)
* fix(scanner): gate path-author on person-name shape
ebookAuthorFromPath's grandparent==suffix corroboration also matched
inverted layouts ("<Title>/<Author>/<Author> - <Title>"), assigning the
title as the author. Require the candidate directory to look like a person
name (comma form, or all-capitalized tokens plus name particles) so series
and title folders ("De legenden van de Alfen") are rejected, and return the
canonical directory form for proper casing.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
(cherry picked from commit ff720bd268a23bff0e94c70f15cb7ecfb8efcb1f)
* fix(ebooks): strip series/book-number parentheticals from search title
cleanEbookSearchTitle now peels trailing "(... Book N)", "[#3]", "(2019)"
groups that don't belong in a provider title query, while leaving
meaningful parentheticals ("(Illustrated)") intact. Enrichment-side only.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
(cherry picked from commit 2273636c04fd9ef483003a9558972a2104fdd3a6)
* fix(ebooks): keep volume number in search title and dedup provider IDs
Two distinct ebooks (e.g. series volumes named only by series + book
number) were collapsing onto a single provider work, then fighting over
the same media_item_provider_ids row:
- cleanEbookSearchTitle stripped trailing "(... Book N)" / "[#3]" groups
entirely, so every volume of a series searched as the bare series name
and matched the same provider work. The plugin search contract carries
only a single free-text Query, so the volume number is now UNWRAPPED
into the query (brackets dropped, words kept) instead of discarded,
giving distinct volumes distinct searches. Bare-year groups are still
dropped (SearchQuery.Year carries them); meaningful parentheticals
("(Illustrated)") still survive.
- collectEbookMetadata now consults FindContentIDByProviderIDs before
accumulating a search-result provider ID. An ID already owned by a
different content item is skipped, so the loser is not mis-tagged with
the winner's metadata and ReplaceByContentID no longer violates the
(provider, provider_id, item_type) unique constraint. The previous
behavior logged duplicate-key errors every sweep and re-enriched the
failing item forever (CPU/RAM churn). A failed ownership check is
surfaced as a provider error so the item retries rather than terminally
stamping as "no match".
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 942fdef6cb0e167b2d9223e9a968b3010b7b3ec8)
* fix(ebooks): address CodeRabbit review on PR #185
- cleanEbookSearchTitle: anchor author-suffix strip to a trailing match
(optionally followed by a series/volume parenthetical) so a mid-title
" - <token>" no longer truncates valid title text
- ebook scan: strip the recovered author suffix using normalized comparison
so case/spacing variants (e.g. "a. f. carter") don't leave a duplicate
- parseMOBIEXTH: bound parsing to the declared EXTH length so a corrupt
record count can't read full-text bytes as junk metadata
- add regression test for a non-trailing " - <token>" in the title
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 0f45af8143e04dfd5b4a5ee3e949dcd943eedbd1)
* fix(audiobooks): pass author in search query and retry on provider errors
Set SearchQuery.Author so the host adapter folds author into the
plugin free-text query (parity with ebooks). Track provider errors
during enrichment; when nothing matched and a provider errored, return
an error without stamping last_refreshed so the sweep retries instead
of terminally burning the item on a transient failure.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit f45dd2104c5d6415324e80f91f6684bc39858459)
* fix(scanner): consolidate fragmented multi-file audiobook content_ids on rescan
audiobookFolderShouldSkip used ListByObservedRootPath which returns all
files for a root path regardless of content_id. When a multi-file audiobook
had files fragmented across multiple content_ids (e.g. from concurrent
refreshes), the file count matched disk so the skip check returned true
and the reconcile never ran to merge them.
Now verifies all DB files share the same content_id before skipping; any
fragmentation forces a full reconcile which consolidates to one content_id
via FindContentIDByRootPath → upsertAudiobookMediaFiles.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
(cherry picked from commit e91c33e88a7d09e802e6afd8af246c6c954d0498)
* fix(ingest): skip concurrent match drainer for audiobook/podcast/ebook/manga libraries
The concurrent scoped match drainer ran during scan for all library types.
For audiobook libraries, the scanner assigns content_ids by folder root
(one item per multi-file folder). Running the drainer concurrently caused
it to process files with content_id=NULL (cleared by complete refresh)
as individual items, creating one media_item per file instead of one per
folder. This manifested as 41-file audiobooks fragmenting into dozens of
orphaned single-file content_ids on every refresh.
These library types use scanner-driven grouping; the post-scan drain step
handles them correctly. Returning nil matchScopes skips the concurrent
drainer entirely for these types.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
(cherry picked from commit 93ae9d22ce315874fa22a958b88ca1766075695f)
* fix(abs): match real audiobookshelf auth + session-sync contract
Align the ABS-compat auth flow with real audiobookshelf (v2.26+) so
third-party clients (yaabsa, Plappa, native iOS) authenticate and sync
playback correctly:
- login/refresh: always emit user.accessToken; x-return-tokens gates
only the refresh token (body vs HttpOnly refresh_token cookie)
- /auth/refresh returns the full login envelope (was a thin token map)
- /me returns the full user object (toOldJSONForBrowser), shared with
login/authorize via a single absUserObject() builder
- /logout returns 200 {redirect_url:null} and clears the cookie (was 204)
- add POST /session/{sid}/sync (real ABS heartbeat path); it was
PATCH-only, so the official client's sync POST 404'd and playback
progress never synced
Verified against advplyr/audiobookshelf server/{Auth.js,models/User.js,
controllers,routers}. Unit tests updated/added; full abs suite green.
Not yet live-verified.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 336e932471d4be021d82299106a120611783836a)
* fix(abs): conform browse/list items to real audiobookshelf minified shape
Strict ABS clients (yaabsa, Plappa) crash or drop items when the browse
list shape only approximates real audiobookshelf. Match the serializers:
- add media.id + media.libraryItemId (= ContentID) to LibraryItemMedia;
yaabsa BookMedia.id is required non-null and was missing → the whole
item failed to parse ("Null is not a subtype of String")
- rebuild the minified list shape to LibraryItem.toOldJSONMinified +
Book.toOldJSONMinified + oldMetadataToJSONMinified key-for-key (ino,
path, isFile, numFiles/size, media.{id,tags,numTracks,numAudioFiles,
numChapters,size,ebookFormat}, flat author/series metadata)
- force media.numTracks/numAudioFiles >= 1 in the browse projection so
Plappa doesn't drop items reporting 0 audio files
- default /items list to minified (real ABS list is always minified);
minified=0 opts into the full shape
Verified against advplyr/audiobookshelf models/{Book,LibraryItem}.js.
Adds minified_test.go key-set conformance guards; abs suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 6c9387a8c4b60be3dbe541049ed8c06344b10717)
* fix(abs): conform /items/{id} detail to real audiobookshelf expanded shape
Match real audiobookshelf LibraryItem.toOldJSONExpanded +
Book.toOldJSONExpanded + oldMetadataToJSONExpanded so strict clients
decode the item-detail page with the same model they use elsewhere:
- add expanded outer keys to LibraryItem (oldLibraryItemId, lastScan,
scanVersion, libraryFiles, size) and populate libraryFiles + summed
size from the item's media files in the detail builder
- add media.size (Book.toOldJSONExpanded)
- make the typed Metadata the full expanded superset: subtitle,
titleIgnorePrefix, authorName, authorNameLF, narratorName, seriesName,
descriptionPlain, publishedDate, asin, language, abridged; drop the
omitempty that previously dropped description/publishedYear/isbn/
publisher when empty (a missing key crashes strict clients)
Verified against advplyr/audiobookshelf models/Book.js + LibraryItem.js.
Adds items_detail_test.go expanded key-set guard; abs suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 8bd485f0291e9db9f32e13a68609a68ee8a945ec)
* fix(abs): conform authors/series endpoints to real audiobookshelf shapes
Match the real audiobookshelf serializers so strict clients decode the
authors/series browse + detail responses:
- GET /libraries/{id}/authors now branches like LibraryController.getAuthors:
bare { authors: [...] } when not paginated, paged { results, total, ... }
only when limit+page are present (was always paged → clients keying on
`authors` got keyNotFound)
- author objects carry the full Author.toOldJSON key set (id, asin, name,
description, imagePath, libraryId, addedAt, updatedAt, numBooks); silo has
no analog for asin/description/imagePath/timestamps so they are null/0
- series objects carry the full Series.toOldJSON key set (adds
nameIgnorePrefix, description, libraryId, addedAt, updatedAt)
- series/author books are now FULL minified library items (real ABS shape)
instead of thin {id,media:{metadata:{title}}} stubs that crash Plappa;
author items moved to the real-ABS `libraryItems` key
Verified against advplyr/audiobookshelf controllers/LibraryController.js and
models/{Author,Series}.js. Tests updated + envelope-branch guard added; abs
suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 8a22eb0900ed881d500ded315a508e1a07da14f3)
* fix(abs): add libraryId to collection/playlist objects (real ABS shape)
Real audiobookshelf Collection.toOldJSON and Playlist.toOldJSON both carry
a libraryId; silo's emitters omitted it, so a strict client modeling the
object with a required libraryId crashed. silo collections/playlists are
cross-library user-personal, so emit the virtual audiobook library id.
The books[]/items[] entries already carry the full LibraryItem shape and
inherit the browse-conformance fixes (media.id etc.). Envelopes were
already correct (paged for library-scoped, {collections}/{playlists} for
global).
Verified against advplyr/audiobookshelf models/{Collection,Playlist}.js.
Envelope key-set tests updated; abs suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit f7d2ff0565f05c3a6ef7f36f2b1f252bd373fa7a)
* fix(abs): conform library object + /libraries/{id} to real audiobookshelf
The library object was only {id,name,mediaType}; real audiobookshelf
Library.toOldJSON has 12 keys, so a strict client decoding the library
model crashed on the missing ones. Also GET /libraries/{id} always wrapped
the object in { library: ... }, but real ABS returns it directly unless
?include=filterdata is requested.
- audiobookLibraryMap now emits the full Library.toOldJSON shape (folders[]
as LibraryFolder.toOldJSON, displayOrder, icon, provider, settings,
lastScan, lastScanVersion, createdAt, lastUpdate). This also enriches the
libraries[] on the login envelope, which shares the builder.
- handleLibraryDetail returns the library object DIRECTLY without include,
and wraps in { filterdata, issues, numUserPlaylists,
customMetadataProviders, library } (adds the missing
customMetadataProviders) with include=filterdata.
GET /libraries already returned { libraries: [...] } (correct). Verified
against advplyr/audiobookshelf models/Library.js +
controllers/LibraryController.js. Adds libraries_shape_test.go; abs suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit d05a2f2af1caf21a4ad04577a4787ba02cff091c)
* fix(abs): conform personalized recent-series shelf to real ABS series shape
The /libraries/{id}/personalized "Recent Series" shelf emitted thin
{id,name,numBooks,libraryId,books:[]} entities with an always-empty cover
stack. Emit the full real-ABS series object (seriesObjectABS, adds
nameIgnorePrefix/description/addedAt/updatedAt) with minified book items
(seriesBookMinified) — the same shape as /libraries/{id}/series so the
shelf card decodes identically and shows real covers.
Book shelves already used full minified items; the shelves array is a bare
array (matches real ABS getUserPersonalizedShelves). abs suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 7c586f8c923cbc481f6f94e304af48dee379a999)
* fix(abs): conform listening-sessions to real audiobookshelf PlaybackSession shape
silo's /me/listening-sessions returned a thin 5-field session object
(id, libraryItemId, userId, timeListening, currentTime) wrapped in the
generic pagedEnvelope shape ({results,sortBy,filterBy,minified}). Real
audiobookshelf clients (Flutter/Swift strict decoders) expect the
MeController.getListeningSessions envelope
({total,numPages,page,itemsPerPage,sessions}) and each session to carry
the full PlaybackSession.toJSON() key set, so the missing keys (notably
mediaType, mediaMetadata, displayTitle, displayAuthor, coverPath,
duration, chapters, deviceInfo, playMethod, mediaPlayer, serverVersion,
date, dayOfWeek, startTime, startedAt, updatedAt, libraryId, bookId,
episodeId) crashed with keyNotFound errors.
Both handleListeningSessions and handleListeningSessionDetail now build
the response via a shared sessionToABS() that reuses
buildSiloPlayMediaMetadata (already used by /play) to hydrate
mediaMetadata/displayTitle/displayAuthor from MediaStore, batching
lookups via GetAudiobooksByIDs for the list endpoint. Lookups are
best-effort: a missing/inaccessible item falls back to a stub
MediaItem so every key is still emitted, never a crash.
Verified against advplyr/audiobookshelf server/controllers/MeController.js
(getListeningSessions) and server/objects/PlaybackSession.js (toJSON())
on GitHub master.
Known placeholders (real ABS fields we can't populate without extra
cost): chapters (empty array — would require a per-session media-files
fetch), duration (0 — total book duration isn't tracked on the session
row), startTime (0 — not persisted separately from currentTime),
deviceInfo (static "unknown" device, matching the /play endpoint's
existing placeholder — no device info is persisted per session).
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 9471497c99b96c8d3defc6c8112c913f7c55924b)
* feat(abs): add offline session sync endpoints (/session/local, /session/local-all)
The official ABS mobile app records playback while offline and POSTs those
PlaybackSession objects back on reconnect via SessionController.syncLocal and
syncLocalSessions. silo was missing both endpoints, so offline listening
progress was silently lost. Add them to the bearerAuth-protected session group
(both /abs/api and /api prefixes) alongside /session/{sid}/sync and /close.
POST /session/local decodes one PlaybackSession and updates the caller's resume
position via ProgressStore.UpdateProgressPosition (the same call handleSessionSync
uses), emitting user_item_progress_updated. POST /session/local-all decodes
{sessions:[...]} and loops each robustly — a malformed or unknown item marks that
one result failed without sinking the batch — returning {results:[...]}. No new
store persistence or migration; podcast/episode sessions are accepted as no-ops.
Verified against advplyr/audiobookshelf server/controllers/SessionController.js
and server/managers/PlaybackSessionManager.js.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 008a4df948d855a4bfe62b24f89bfc484f088033)
* fix(abs): conform library search + items-in-progress to real audiobookshelf
Real ABS's libraryItemsBookFilters.search() (delegated from
LibraryController.search) returns { book, narrators, tags, genres,
series, authors } with no "podcast" key for a book library, and each
book entry is only { libraryItem } — no matchKey/matchText, which our
handler was inventing. Search now matches those keys, drops the
fabricated matchKey/matchText fields, and best-effort populates
authors/series buckets via client-side substring filtering over the
existing aggregate listers (narrators/tags/genres stay empty-but-present
since silo has no backing aggregation query for them yet).
MeController.getAllLibraryItemsInProgress wraps items as
{ ...libraryItem.toOldJSONMinified(), progressLastUpdate }; our handler
was emitting a hand-rolled subset of fields plus a nested
userMediaProgress object that doesn't exist in the real response.
items-in-progress now reuses the existing Minify() projection and merges
a flat progressLastUpdate (ms) field to match.
Verified against advplyr/audiobookshelf controllers/{Library,Me}Controller.js
and server/utils/queries/{libraryItemsBookFilters,authorFilters}.js.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 998ff55f3cf27d504f0e5aec8c7c29fa57f10247)
* fix(abs): /ping returns success:true and /status carries authMethods
The ABS apps validate a server address by reading response.success from
GET /ping; silo returned {pong:true,...} with no `success`, so the app
reported "unable to reach" even though the server responded 200. Also
/status was missing authMethods/authFormData, which the app reads to render
the login form.
- /ping now includes {"success": true} (pong/server/version kept as extras)
- /status now returns {app,serverVersion,isInit,language,authMethods,
authFormData} matching real audiobookshelf Server.js
Verified against advplyr/audiobookshelf server/Server.js. Adds
ping_status_test.go; abs suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit df732d09355303608bc4d5fc2138555e37497a02)
* fix(abs): mount login + auth/refresh under /api prefix
Clients that post to /api/login (and /api/auth/refresh) got a 404 because
login/refresh were only mounted at root and /abs/api — while the rest of the
authenticated ABS surface (/api/me, /api/authorize, /api/libraries, covers)
is served under both /api and /abs/api. The 404 surfaced in the client as a
generic "unknown error occurred" on sign-in.
Mount /login and /auth/refresh under all three prefixes ("", /api, /abs/api),
matching the authenticated groups.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 18071e180b02131cda354303eadd1ff3a0708065)
* fix(abs): accept form-encoded login bodies (not just JSON)
Real audiobookshelf (express body-parser + passport local) accepts both
application/json and application/x-www-form-urlencoded credential bodies.
Silo only json-decoded the body, so a form-encoded client got 400 "invalid
request body" — surfaced in the app as a generic "unknown error" on sign-in
(confirmed live: JSON creds -> 200, identical form-encoded creds -> 400).
Buffer the body once, try JSON, then fall back to url.ParseQuery for the
form-encoded case.
Adds login_body_test.go (form + JSON both reach the validator). abs suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 408dc33debb7a7ee363778094511ccfdd1ee70d2)
* fix(abs): emit full real-ABS serverSettings (OpenID/auth fields)
silo's login/authorize serverSettings omitted the auth + OpenID fields that
real audiobookshelf ServerSettings.toJSONForBrowser includes
(authLoginCustomMessage, authOpenID*, rateLimitLogin*, backupPath,
allowedOrigins). OIDC-aware strict clients (Prologue, iOS/Swift) decode
serverSettings into a model that requires those keys, so their absence throws
keyNotFound and the ENTIRE login response fails to decode — the client stays
on the login screen with a generic "unknown error" even though the server
returned 200. Simpler clients that don't model OpenID were unaffected.
Emit real ABS's OIDC-disabled defaults; authActiveAuthMethods still advertises
only "local" so no client initiates the OpenID flow.
Diagnosed from a packet capture (Prologue posts /login? with X-Return-Tokens
and gets a 200 it can't decode) + real ABS ServerSettings.js. Verified against
advplyr/audiobookshelf.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 283826c952824e97233e46e057f37385ddc3054b)
* fix(abs): GET /me returns the real display username, not the userID
/me built its user object from the token claims and passed the numeric
userID as the username, so clients saw "98" instead of "puksthepirate".
Login gets the display name from the credential validator, but /me only has
the token, so it needs a lookup.
Add an optional UsernameResolver to the abs Dependencies; wire it from the
concrete SiloCredValidator (which holds the pgx pool) via a new
ResolveUsername method that mirrors Validate's display-name logic — the
profile name when a profile is set and named, else the account username.
handleMe uses it and falls back to the userID when unresolved.
abs package compiles + tests pass; the audiobooks package (service.go,
cred_validator.go) could not be linked locally (pre-existing bimg/libvips
pkg-config gap) and is validated at the Docker build.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 39ff3e3350aad087757f7fb0e94d5a7f10c08ae5)
* fix(abs): always emit AudioTrack keys + correct media.duration
Two item-detail issues that made Prologue report "Unable to load book
contents" (can't press Start Listening):
- AudioTrack used omitempty on chapters/metaTags/format/bitRate/codec/
metadata/etc, so empty values dropped those keys. Real ABS AudioFile/
AudioTrack always emit them; strict clients (Prologue, yaabsa) decode
tracks into a required-field model and throw keyNotFound on the missing
keys, failing the whole track decode. Removed omitempty and emit
chapters/metaTags as [] / {} (non-nil) in both track builders.
- media.duration used the item's Runtime, which is often stale/mis-scanned
(e.g. 222s for a 3.7h book) and desyncs the player scrubber. Now sum the
track durations (real ABS: sum of audio file durations), falling back to
Runtime only when there are no tracks.
Verified against advplyr/audiobookshelf models/Book.js (AudioFile/AudioTrack)
via a live packet capture of Prologue's item-detail decode failure. abs
suite green.
AI-use: implemented with Claude Code (Opus 4.8).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 8210ed2fc63e782f158b4168ef693e671ae19638)
* perf(abs): push down library browse filters + author counts MV
The ABS audiobook library-serving path was slow on large libraries
(~255k items): /libraries/{id}/items?filter=authors.{id} loaded and
hydrated the whole library into Go before filtering (~4.8s each), and
/libraries/{id}/authors ran a full GroupAggregate + COUNT(DISTINCT)
per page (~53s full sync) — slow enough to trip ABS client sync
timeouts (e.g. Prologue).
- Push author/series/narrator/no-series filters into indexed SQL
EXISTS predicates in ListAudiobooks; paginate + COUNT in SQL.
Semantically equivalent to the prior Go-side filter (kind=7 author,
kind=8 narrator, exact-case match, no-series sentinel).
- Add covering index media_items(content_id, type) so the count/list
type check runs index-only (CONCURRENTLY, NO TRANSACTION — no
write-lock on the live table).
- Serve /authors from a materialized view (abs_audiobook_author_counts)
refreshed every 15min, with a live-query fallback when the view is
empty/unrefreshed so the endpoint never blanks on a fresh deploy.
Conformance preserved: keeps authorObjectABS/seriesObjectABS shapes and
the limit&&page envelope decision; adds a regression test for the
bare {authors:[...]} envelope on limit-only requests.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 0d55754051dd3ad016b3cec6a0921307071d3219)
* perf(abs): index-back audiobook search via trigram GIN
SearchAudiobooks matched the raw media_items.title with ILIKE '%q%'
OR'd with an author/narrator EXISTS. The un-indexed raw-title column
plus the OR forced a full seq scan of the ~255k-item library on every
search (~560ms on library 18).
Reshape into a UNION of two index-driven arms that reuse the search
infrastructure the rest of the catalog already relies on: the title arm
matches media_items.title_normalized (idx_media_items_title_normalized_trgm)
via the shared normalize_search_text(), the people arm matches people.name
(idx_people_name_trgm). GROUP BY content_id keeps the best rank when an
item matches both; a normalize_search_text($2) <> '' guard stops a
punctuation-only query from degenerating into ILIKE '%%'.
No new index or migration — the trigram indexes already existed and were
simply unused. ~560ms -> ~35ms, both indexes engaged, no seq scan.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 98bbd1712719ecd03e4db87f840774cec788f177)
* perf(abs): index-ordered item paging + cached library count
The unfiltered /libraries/{id}/items path that ABS clients page through
to sync a library recomputed COUNT(*) over the whole library on every
page (~150ms each) and ordered by LOWER(sort_title), LOWER(title) — an
expression matching no index, forcing a full in-memory sort of all
~255k rows per page (~324ms shallow, ~543ms deep). A full sync is
thousands of pages, so both costs dominated indexing time.
- Order by lower(coalesce(nullif(btrim(sort_title),''), title)),
content_id so the page is served by an ordered index scan on the
existing idx_media_items_sort_key (~324ms -> ~1ms). content_id (PK)
is a stable tiebreaker, making sequential pagination deterministic —
the prior ordering could skip/repeat rows when sort keys collided.
- Memoize the per-page COUNT in a 60s TTL cache keyed on the fully
rendered count SQL + bound args, so it covers every input the WHERE
depends on (library, pushed-down filter, all access predicates) and
can't drift as access logic evolves. Expired entries swept on write.
No new index or migration — reuses idx_media_items_sort_key.
total may lag up to 60s during an active scan; clients re-sync.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit 32e26c2f99a1ffc071f600071c2ea7ddcd3397b4)
* fix(abs): address PR review — access-aware authors, offline progress create, cookie refresh, body limits
- media_store: ListLibraryAuthors bypassed per-item access when reading the
author materialized view (keyed by library only), leaking authors of books
hidden by a content-rating cap or excluded media types. Take the access-aware
live path whenever the filter carries an item-level predicate.
- session_local: offline sync used UPDATE-only UpdateProgressPosition, so a book
listened to entirely offline (no progress row yet) had its position silently
dropped while still reporting progressSynced. Create the row via UpsertProgress
when none exists; keep the monotonic update path for existing rows.
- login: handleRefresh never read the refresh_token cookie, so cookie-flow ABS
clients got 400 refreshToken required once the access token expired. Read the
cookie as a third source after header and body.
- session_local: cap /session/local and /session/local-all request bodies at
1 MiB via io.LimitReader, matching the rest of the package.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
785 lines
35 KiB
Go
785 lines
35 KiB
Go
// Package abs implements the Audiobookshelf-mobile-app compatibility surface.
|
|
// It mints self-contained JWTs signed with a per-deployment secret and serves
|
|
// the /abs/api/* and /abs/public/* routes, as well as the canonical
|
|
// root-level paths real ABS clients build against (e.g. /login, /api/items).
|
|
//
|
|
// Stage 1 lands the package skeleton: Handler struct, interface stubs for
|
|
// silo-side dependencies, and an empty Mount() method. Real route handlers
|
|
// are added in subsequent stages (auth, file serving, progress, browse).
|
|
package abs
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"log/slog"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/catalog"
|
|
"github.com/Silo-Server/silo-server/internal/models"
|
|
)
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Dependency interfaces
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// AudiobookLibrary is the narrow library view the ABS handlers expose.
|
|
// The production adapter (Stage 7) builds these from media_folders WHERE
|
|
// type = 'audiobooks'.
|
|
type AudiobookLibrary struct {
|
|
ID int64
|
|
Name string
|
|
Type string // always "audiobooks" for this surface
|
|
}
|
|
|
|
// MediaStore is the slice of silo's catalog the ABS handler reads.
|
|
// Real impl: catalog.ItemRepository + scanner.FileRepository wrapped in
|
|
// a small adapter struct added in a later stage.
|
|
type MediaStore interface {
|
|
GetAudiobookByID(ctx context.Context, contentID string, access catalog.AccessFilter) (*models.MediaItem, error)
|
|
// GetAudiobooksByIDs batch-fetches audiobooks by content_id (people + series
|
|
// hydrated once), keyed by content_id, for list/shelf handlers.
|
|
GetAudiobooksByIDs(ctx context.Context, contentIDs []string, access catalog.AccessFilter) (map[string]*models.MediaItem, error)
|
|
// ListAudiobooks returns a page of audiobooks. When libraryID is non-zero
|
|
// it filters to items in that media_folder; 0 means all audiobook items.
|
|
// filter optionally pushes an authors/series/narrators predicate into the
|
|
// query (Filter{} for none) so per-author syncs avoid a full-library scan.
|
|
ListAudiobooks(ctx context.Context, libraryID int64, limit, offset int, access catalog.AccessFilter, filter Filter) ([]*models.MediaItem, int, error)
|
|
GetMediaFiles(ctx context.Context, contentID string, access catalog.AccessFilter) ([]*models.MediaFile, error)
|
|
// GetMediaFileByID fetches a single media file by its integer PK.
|
|
// Used by the ABS file-streaming handler when a caller supplies a
|
|
// raw file ID instead of an ino.
|
|
GetMediaFileByID(ctx context.Context, fileID int) (*models.MediaFile, error)
|
|
// ListAudiobookLibraries returns media_folder rows with type='audiobooks'.
|
|
ListAudiobookLibraries(ctx context.Context, access catalog.AccessFilter) ([]AudiobookLibrary, error)
|
|
// SearchAudiobooks does a fuzzy title/author/narrator match for the ABS
|
|
// /libraries/{id}/search endpoint. Hydrates People so the mapper has
|
|
// author/narrator names.
|
|
SearchAudiobooks(ctx context.Context, libraryID int64, query string, limit int, access catalog.AccessFilter) ([]*models.MediaItem, error)
|
|
// ListContinueListening returns books that the given user has progress
|
|
// on but hasn't finished — feeds the Home tab's continue shelf.
|
|
ListContinueListening(ctx context.Context, userID, profileID string, libraryID int64, limit int, access catalog.AccessFilter) ([]*models.MediaItem, error)
|
|
// ListRecentlyAdded returns the most recently added audiobooks for the
|
|
// Home tab's recently-added shelf.
|
|
ListRecentlyAdded(ctx context.Context, libraryID int64, limit int, access catalog.AccessFilter) ([]*models.MediaItem, error)
|
|
// ListDiscover returns a randomized sampling of audiobooks for the
|
|
// Home tab's discover shelf (helps new users browse the library).
|
|
ListDiscover(ctx context.Context, libraryID int64, limit int, access catalog.AccessFilter) ([]*models.MediaItem, error)
|
|
// ListLibraryAuthors returns one page of distinct audiobook authors (from a
|
|
// precomputed materialized view) plus the total author count. sortBy is one
|
|
// of "name" (default), "addedAt", or "numBooks"; limit<=0 returns all.
|
|
ListLibraryAuthors(ctx context.Context, libraryID int64, limit, offset int, sortBy string, sortDesc bool, access catalog.AccessFilter) ([]AuthorSummary, int, error)
|
|
// ListLibrarySeries returns one SQL-paginated page of distinct series (from
|
|
// audiobook_series) in the library plus the total series count. limit<=0
|
|
// returns all.
|
|
ListLibrarySeries(ctx context.Context, libraryID int64, limit, offset int, access catalog.AccessFilter) ([]SeriesSummary, int, error)
|
|
// GetAuthorByID returns the author with the given people.id plus
|
|
// their audiobook list, sorted by title. Returns ErrNotFound when
|
|
// no people row matches.
|
|
GetAuthorByID(ctx context.Context, authorID string, access catalog.AccessFilter) (Author, error)
|
|
// GetSeriesByName returns the canonical series (case-insensitive
|
|
// match on audiobook_series.series_name) with its books ordered
|
|
// by series_index ASC (NULLS LAST), title fallback. Returns
|
|
// ErrNotFound when no rows match.
|
|
GetSeriesByName(ctx context.Context, seriesName string, access catalog.AccessFilter) (Series, error)
|
|
}
|
|
|
|
// AuthorSummary is an aggregated author entry for /libraries/{id}/authors.
|
|
type AuthorSummary struct {
|
|
ID string
|
|
Name string
|
|
NumBooks int
|
|
}
|
|
|
|
// SeriesSummary is an aggregated series entry for /libraries/{id}/series.
|
|
//
|
|
// Books carries up to ~4 cover-preview entries for the LazySeriesCard
|
|
// GroupCover stack — the ABS mobile client reads
|
|
// `series.books[i].media.coverPath` to render each cover, and a card
|
|
// with no books renders only the series name as a fallback.
|
|
type SeriesSummary struct {
|
|
ID string
|
|
Name string
|
|
NumBooks int
|
|
Books []SeriesBookPreview
|
|
}
|
|
|
|
// SeriesBookPreview is a single book id+title pair returned alongside
|
|
// each SeriesSummary. The /libraries/{id}/series handler expands these
|
|
// into full minified LibraryItem entries (with cover URLs) on the wire.
|
|
type SeriesBookPreview struct {
|
|
ContentID string
|
|
Title string
|
|
UpdatedAt time.Time
|
|
}
|
|
|
|
// Author is the detail-shape author with embedded books list.
|
|
type Author struct {
|
|
ID string
|
|
Name string
|
|
PosterPath string // resolved via CoverResolver on emit
|
|
Books []*models.MediaItem
|
|
}
|
|
|
|
// Series is the detail-shape series with books ordered by series_index.
|
|
type Series struct {
|
|
ID string // lowercased series_name
|
|
Name string // canonical series_name
|
|
Books []*models.MediaItem
|
|
}
|
|
|
|
// TokenStore persists and validates the ABS JWT JTIs that back the
|
|
// revocable-token surface (login, refresh, logout, bearerAuth).
|
|
// Real impl: a thin repo over the abs_tokens table added in Stage 2.
|
|
type TokenStore interface {
|
|
// InsertToken persists a newly minted JTI.
|
|
InsertToken(ctx context.Context, tok ABSToken) error
|
|
// GetTokenByJTI looks up a token by its JTI; returns ErrNotFound if absent.
|
|
GetTokenByJTI(ctx context.Context, jti string) (ABSToken, error)
|
|
// RevokeTokenByJTI marks a JTI as revoked (sets revoked_at).
|
|
RevokeTokenByJTI(ctx context.Context, jti string) error
|
|
// RevokeTokenIfActive atomically marks an unrevoked token as revoked and
|
|
// returns its previous row. Returns ErrNotFound when the token is absent or
|
|
// was already revoked.
|
|
RevokeTokenIfActive(ctx context.Context, jti string) (ABSToken, error)
|
|
// RevokeTokensForPrincipal revokes every active access/refresh token for a
|
|
// user profile. Logout uses this to invalidate refresh tokens as well as the
|
|
// presented access token.
|
|
RevokeTokensForPrincipal(ctx context.Context, userID, profileID string) error
|
|
// TouchToken extends last_seen_at for active-session bookkeeping.
|
|
TouchToken(ctx context.Context, jti string) error
|
|
}
|
|
|
|
// ABSToken is the in-memory representation of a persisted JTI row.
|
|
type ABSToken struct {
|
|
ID string
|
|
UserID string
|
|
ProfileID string
|
|
Type string
|
|
JTI string
|
|
ExpiresAt time.Time
|
|
RevokedAt *time.Time
|
|
}
|
|
|
|
// ProfileCredentialValidator validates a (username, password) pair against
|
|
// silo's auth backend. Implemented by an adapter over internal/auth in a
|
|
// later stage.
|
|
type ProfileCredentialValidator interface {
|
|
Validate(ctx context.Context, username, password string) (userID string, profileID string, displayName string, err error)
|
|
}
|
|
|
|
// AccessResolver resolves the ABS-authenticated user/profile into the same
|
|
// effective catalog access filter used by silo's native API.
|
|
type AccessResolver interface {
|
|
ResolveABSAccess(ctx context.Context, userID, profileID string) (catalog.AccessFilter, error)
|
|
}
|
|
|
|
// EventPublisher delivers a realtime event to Socket.io clients. May be nil;
|
|
// handlers guard with publish/broadcast nil-safe wrappers.
|
|
type EventPublisher interface {
|
|
Publish(userID, event string, payload any)
|
|
Broadcast(event string, payload any)
|
|
}
|
|
|
|
// SocketIOServer exposes the Socket.io HTTP handler. The concrete
|
|
// implementation lives in internal/audiobooks/abssocket. Keeping the
|
|
// interface here avoids a circular import: handler.go uses it, abssocket
|
|
// imports abs for ParseToken/EventPublisher, and the wiring is done by the
|
|
// caller (service.go or main.go) that imports both packages.
|
|
type SocketIOServer interface {
|
|
Handler() http.Handler
|
|
}
|
|
|
|
// Recommender powers /items/{id}/similar. nil → route returns an empty list.
|
|
type Recommender interface {
|
|
Similar(ctx context.Context, contentID string, limit int) ([]string, error)
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Config provider
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// ConfigProvider supplies runtime config values the ABS handler needs.
|
|
// Keeps the handler decoupled from any particular settings-store shape.
|
|
type ConfigProvider interface {
|
|
// JWTSecret returns the HMAC-SHA256 signing secret for ABS JWTs.
|
|
JWTSecret(ctx context.Context) ([]byte, error)
|
|
// AccessTTL / RefreshTTL are the default token lifetimes; zero means
|
|
// "use built-in default (24 h / 30 d)".
|
|
AccessTTL(ctx context.Context) (time.Duration, error)
|
|
RefreshTTL(ctx context.Context) (time.Duration, error)
|
|
// StandaloneLoginEnabled reports whether body-creds login is permitted
|
|
// (i.e., operator has not disabled it in settings).
|
|
StandaloneLoginEnabled(ctx context.Context) (bool, error)
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Dependencies + Handler
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// Dependencies bundles everything the Handler needs at construction time.
|
|
type Dependencies struct {
|
|
MediaStore MediaStore
|
|
TokenStore TokenStore
|
|
CredValidator ProfileCredentialValidator
|
|
AccessResolver AccessResolver
|
|
// UsernameResolver returns the display username for an ABS principal
|
|
// (userID, profileID) without re-authenticating. Optional; GET /me falls
|
|
// back to the userID when this is nil or returns "". Login gets the
|
|
// display name from the credential validator, but /me only has the token
|
|
// claims, so it needs this to show the real username instead of the id.
|
|
UsernameResolver func(ctx context.Context, userID, profileID string) string
|
|
Config ConfigProvider
|
|
Publisher EventPublisher // may be nil
|
|
Recommender Recommender // may be nil
|
|
LoginLimiter *LoginLimiter // may be nil — one is created if absent
|
|
// InstallID returns the current plugin install ID for building
|
|
// host-proxy-routable URLs. Defaults to "silo.audiobooks" when nil.
|
|
InstallID func() string
|
|
// ProgressStore provides access to user_watch_progress for ABS
|
|
// progress endpoints. May be nil; handlers degrade gracefully.
|
|
ProgressStore ProgressStore
|
|
// PlaybackSessionStore persists abs_playback_sessions rows
|
|
// (migration 143) for /session/{sid}/sync and /session/{sid}/close.
|
|
// May be nil; handlers degrade gracefully.
|
|
PlaybackSessionStore ABSPlaybackSessionStore
|
|
// BookmarkStore persists ABS bookmark rows (migration 148) for the
|
|
// POST/PATCH/DELETE /me/item/{itemId}/bookmark endpoints. May be
|
|
// nil; handlers respond 503 when unset.
|
|
BookmarkStore BookmarkStore
|
|
// CollectionStore persists ABS user-collection rows (migrations 149 + 150).
|
|
// May be nil; handlers respond 503 when unset.
|
|
CollectionStore CollectionStore
|
|
// PlaylistStore persists ABS playlist rows (migrations 151 + 152).
|
|
// May be nil; handlers respond 503 when unset.
|
|
PlaylistStore PlaylistStore
|
|
// SmartCollectionStore persists user_personal_collections rows with
|
|
// collection_type='smart' (migration 156 unified the old
|
|
// abs_smart_collections table into the canonical store).
|
|
// May be nil; handlers respond 503 when unset.
|
|
SmartCollectionStore SmartCollectionStore
|
|
// RSSFeedStore persists abs_rss_feeds rows (migration 155).
|
|
// May be nil; handlers respond 503 when unset.
|
|
RSSFeedStore RSSFeedStore
|
|
// SocketIO is the Socket.io server mounted at /abs/socket.io/. May be nil;
|
|
// the route is only registered when a non-nil value is supplied.
|
|
SocketIO SocketIOServer
|
|
// NativeSessions mirrors ABS playback into Silo's native playback session
|
|
// manager so shared live-session views, limits, and stale-session cleanup
|
|
// see Audiobookshelf-compatible clients. May be nil; ABS playback still
|
|
// functions, but admin live-session visibility is unavailable.
|
|
NativeSessions PlaybackSessionManager
|
|
// NativeSessionSyncer flushes native session-manager state into the shared
|
|
// admin live-session table after ABS play/sync/close events.
|
|
NativeSessionSyncer PlaybackSessionSyncer
|
|
// CoverResolver translates a raw silo poster path (e.g.
|
|
// "local/audiobooks/.../original.webp") into a fully-qualified URL
|
|
// the ABS client can fetch. Optional; when nil, /api/items/{id}/cover
|
|
// 404s rather than redirecting to an unreachable relative path.
|
|
CoverResolver func(ctx context.Context, path, variant string) string
|
|
}
|
|
|
|
// Handler wires the /abs/api/* and canonical ABS-client paths.
|
|
type Handler struct {
|
|
deps Dependencies
|
|
}
|
|
|
|
// New constructs an ABS Handler. Sensible defaults are applied for optional
|
|
// fields (LoginLimiter, InstallID).
|
|
//
|
|
// MediaStore is required: many handlers (libraries, items, me, play) deref
|
|
// it unconditionally on the request hot path, and a nil store would panic
|
|
// the first time a real request hits them. Fail fast at construction so
|
|
// misconfigured deployments break at startup rather than silently passing
|
|
// /login and crashing on the next request.
|
|
func New(deps Dependencies) *Handler {
|
|
if deps.MediaStore == nil {
|
|
panic("abs.New: MediaStore is required")
|
|
}
|
|
if deps.LoginLimiter == nil {
|
|
deps.LoginLimiter = NewLoginLimiter()
|
|
}
|
|
if deps.InstallID == nil {
|
|
deps.InstallID = func() string { return "silo.audiobooks" }
|
|
}
|
|
return &Handler{deps: deps}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Mount
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// Mount registers the ABS-compatible routes on r. Stage 1 registers an empty
|
|
// /abs group with the access-log middleware attached; subsequent stages add
|
|
// real route handlers.
|
|
//
|
|
// The dual-mount design (routes at both /abs/api/* and /* roots) is preserved
|
|
// here so stage-by-stage handlers land in the right places without needing to
|
|
// revisit Mount later.
|
|
func (h *Handler) Mount(parent chi.Router) {
|
|
parent.Group(func(r chi.Router) {
|
|
r.Use(h.accessLog)
|
|
h.mountRoutes(r)
|
|
})
|
|
}
|
|
|
|
func (h *Handler) mountRoutes(r chi.Router) {
|
|
// Discovery + auth endpoints: real ABS exposes these at server ROOT
|
|
// (no /api or /abs/api prefix). Mobile clients do `${addr}/ping`,
|
|
// `${addr}/login`, etc. Designed to be mounted on a dedicated listener
|
|
// so the routes don't collide with silo's SPA catch-all.
|
|
for _, prefix := range []string{"", "/abs/api"} {
|
|
r.Get(prefix+"/ping", h.handleABSPing)
|
|
r.Get(prefix+"/healthcheck", h.handleABSPing) // same body as /ping
|
|
r.Get(prefix+"/init", h.handleABSInit)
|
|
r.Get(prefix+"/status", h.handleABSStatus)
|
|
}
|
|
|
|
// Stage 2: login (body credentials). Real ABS serves /login at root, but
|
|
// clients differ on the prefix — some POST /api/login or /abs/api/login.
|
|
// The rest of the authenticated surface is mounted under both /api and
|
|
// /abs/api, so mount login+refresh under the same set; a client posting
|
|
// /api/login otherwise 404s and surfaces a generic "unknown error".
|
|
for _, prefix := range []string{"", "/api", "/abs/api"} {
|
|
r.Post(prefix+"/login", h.handleLogin)
|
|
// Token rotation — mobile clients call this every ~22h to avoid the
|
|
// 24h access-token interactive re-login trap.
|
|
r.Post(prefix+"/auth/refresh", h.handleRefresh)
|
|
}
|
|
// Logout is mounted OUTSIDE bearerAuth so an expired-access client can
|
|
// still sign out (the primary "sign out" UX moment). The handler parses
|
|
// the bearer locally, revokes the JTI if parseable, and always returns
|
|
// 204 — matches the canonical continuum-plugin behavior.
|
|
r.Post("/logout", h.handleLogout)
|
|
r.Post("/api/logout", h.handleLogout)
|
|
r.Post("/abs/api/logout", h.handleLogout)
|
|
r.Post("/abs/api/auth/logout", h.handleLogout) // legacy path
|
|
|
|
// Unauthenticated cover + author-image routes. Real ABS serves covers
|
|
// without auth (getDoesServerImagesRequireToken returns false for our
|
|
// version), so mounting these outside bearerAuth avoids 401s.
|
|
for _, prefix := range []string{"/abs/api", "/api"} {
|
|
r.Get(prefix+"/items/{id}/cover", h.handleItemCover)
|
|
r.Get(prefix+"/authors/{id}/image", h.handleAuthorImage)
|
|
}
|
|
|
|
// Session-scoped audio streaming (ABS v2.22.0+ DirectPlay). The Android
|
|
// and iOS clients call this WITHOUT a bearer token — the session ID is
|
|
// the capability. Mounted at both /public/session and /abs/public/session
|
|
// for compatibility with clients that pin either prefix.
|
|
for _, prefix := range []string{"", "/abs"} {
|
|
r.Get(prefix+"/public/session/{sid}/track/{idx}", h.handlePublicTrack)
|
|
r.Head(prefix+"/public/session/{sid}/track/{idx}", h.handlePublicTrack)
|
|
}
|
|
|
|
// Public RSS feed routes — slug is the capability token, no auth.
|
|
r.Get("/feed/{slug}.xml", h.handlePublicFeed)
|
|
r.Get("/feed/{slug}", h.handlePublicFeed)
|
|
r.Get("/feed/{slug}/file/{ino}", h.handlePublicFeedFile)
|
|
|
|
// Server discovery — unauthenticated. Mounted at both /api and the
|
|
// canonical root so curl-style network probes, the official ABS app's
|
|
// connect-server flow, and AudioBooth's saved-server liveness check
|
|
// all land on the same response.
|
|
for _, prefix := range []string{"/abs", "/api"} {
|
|
r.Get(prefix+"/ping", h.handlePing)
|
|
r.Get(prefix+"/healthcheck", h.handleHealthcheck)
|
|
r.Get(prefix+"/init", h.handleInit)
|
|
r.Get(prefix+"/auth-settings", h.handleAuthSettings)
|
|
}
|
|
|
|
// Stage 3: playback session + file routes, registered under both the
|
|
// legacy /abs/api prefix and the canonical /api prefix that the official
|
|
// ABS mobile client builds against (no /abs prefix at server root).
|
|
r.Group(func(r chi.Router) {
|
|
r.Use(h.bearerAuth)
|
|
for _, prefix := range []string{"/abs/api", "/api"} {
|
|
// POST /api/items/{libraryItemId}/play — start a play session,
|
|
// get back a stream URL + ABS-shaped manifest.
|
|
r.Post(prefix+"/items/{libraryItemId}/play", h.handlePlayStart)
|
|
|
|
// GET /api/items/{libraryItemId}/file/{ino} — stream a specific audio file.
|
|
// /download variant is the same handler; Content-Disposition is set when
|
|
// the path ends in /download.
|
|
r.Get(prefix+"/items/{libraryItemId}/file/{ino}", h.handleFileStream)
|
|
r.Get(prefix+"/items/{libraryItemId}/file/{ino}/download", h.handleFileStream)
|
|
}
|
|
})
|
|
|
|
// Stage 4: progress + session tracking — requires bearerAuth.
|
|
r.Group(func(r chi.Router) {
|
|
r.Use(h.bearerAuth)
|
|
for _, prefix := range []string{"/abs/api", "/api"} {
|
|
// GET /me/progress — all audiobook progress for the caller
|
|
r.Get(prefix+"/me/progress", h.handleGetMyProgress)
|
|
// GET /me/progress/{id} — progress for one item
|
|
r.Get(prefix+"/me/progress/{libraryItemId}", h.handleGetItemProgress)
|
|
// POST /me/progress/{id} — set / update progress (ABS PATCH semantics)
|
|
r.Post(prefix+"/me/progress/{libraryItemId}", h.handleSetItemProgress)
|
|
// PATCH alias — AudioBooth and the canonical ABS server use
|
|
// PATCH for the same write; route both methods to the handler.
|
|
r.Patch(prefix+"/me/progress/{libraryItemId}", h.handleSetItemProgress)
|
|
// DELETE /me/progress/{id} — clear progress (Reset Progress)
|
|
r.Delete(prefix+"/me/progress/{libraryItemId}", h.handleDeleteItemProgress)
|
|
// PATCH /me/progress/{id}/{episodeId} — podcast episode
|
|
// progress; audiobook-only catalog, so this is a stub.
|
|
r.Patch(prefix+"/me/progress/{libraryItemId}/{episodeId}", h.handleSetEpisodeProgress)
|
|
// POST /session/{sid}/sync — real ABS heartbeat path
|
|
// (SessionController.sync). The official ABS mobile/web clients
|
|
// POST here; missing it means playback progress never syncs.
|
|
r.Post(prefix+"/session/{sid}/sync", h.handleSessionSync)
|
|
// PATCH /session/{sid} — silo-native heartbeat alias
|
|
// (kept additive for silo's own clients).
|
|
r.Patch(prefix+"/session/{sid}", h.handleSessionSync)
|
|
// POST /session/{sid}/close — finalise the play session
|
|
r.Post(prefix+"/session/{sid}/close", h.handleSessionClose)
|
|
// POST /session/local — sync one offline-recorded session
|
|
r.Post(prefix+"/session/local", h.handleSyncLocalSession)
|
|
// POST /session/local-all — batch-sync offline-recorded sessions
|
|
r.Post(prefix+"/session/local-all", h.handleSyncLocalSessions)
|
|
// Bookmarks — POST/PATCH both upsert; DELETE is idempotent.
|
|
r.Post(prefix+"/me/item/{itemId}/bookmark", h.handleUpsertBookmark("bookmark_created"))
|
|
r.Patch(prefix+"/me/item/{itemId}/bookmark", h.handleUpsertBookmark("bookmark_updated"))
|
|
r.Delete(prefix+"/me/item/{itemId}/bookmark/{time}", h.handleDeleteBookmark)
|
|
// Collections — owner-gated CRUD with cross-user public reads.
|
|
r.Get(prefix+"/collections", h.handleListCollections)
|
|
// Per-library collections list — bookshelf "Collections" tab
|
|
// hits this. Paged envelope with full-shape entries (books[]
|
|
// included) so the cover stack renders.
|
|
r.Get(prefix+"/libraries/{libraryId}/collections", h.handleListLibraryCollections)
|
|
r.Post(prefix+"/collections", h.handleCreateCollection)
|
|
r.Get(prefix+"/collections/{id}", h.handleGetCollection)
|
|
r.Patch(prefix+"/collections/{id}", h.handleUpdateCollection)
|
|
r.Delete(prefix+"/collections/{id}", h.handleDeleteCollection)
|
|
r.Post(prefix+"/collections/{id}/book/{bookId}", h.handleAddCollectionBook)
|
|
r.Delete(prefix+"/collections/{id}/book/{bookId}", h.handleRemoveCollectionBook)
|
|
// Playlists — owner-gated CRUD with cross-user public reads,
|
|
// realtime events on every mutation, batch endpoints.
|
|
r.Get(prefix+"/playlists", h.handleListPlaylists)
|
|
// Per-library playlist list — mobile create-playlist modal
|
|
// loads from here before opening the form. Emits
|
|
// `{results: [...]}` with full-shape entries.
|
|
r.Get(prefix+"/libraries/{libraryId}/playlists", h.handleListLibraryPlaylists)
|
|
r.Post(prefix+"/playlists", h.handleCreatePlaylist)
|
|
r.Get(prefix+"/playlists/{id}", h.handleGetPlaylist)
|
|
r.Patch(prefix+"/playlists/{id}", h.handleUpdatePlaylist)
|
|
r.Delete(prefix+"/playlists/{id}", h.handleDeletePlaylist)
|
|
r.Post(prefix+"/playlists/{id}/item", h.handleAddPlaylistItem)
|
|
r.Post(prefix+"/playlists/{id}/batch/add", h.handleBatchAddPlaylistItems)
|
|
r.Post(prefix+"/playlists/{id}/batch/remove", h.handleBatchRemovePlaylistItems)
|
|
r.Delete(prefix+"/playlists/{id}/item/{libraryItemId}", h.handleRemovePlaylistItem)
|
|
r.Delete(prefix+"/playlists/{id}/item/{libraryItemId}/{episodeId}", h.handleRemovePlaylistEpisode)
|
|
// Smart collections — rule-based dynamic groupings.
|
|
r.Get(prefix+"/me/smart-collections", h.handleListSmartCollections)
|
|
r.Post(prefix+"/me/smart-collections", h.handleCreateSmartCollection)
|
|
r.Get(prefix+"/me/smart-collections/{id}", h.handleGetSmartCollection)
|
|
r.Get(prefix+"/me/smart-collections/{id}/items", h.handleSmartCollectionItems)
|
|
r.Patch(prefix+"/me/smart-collections/{id}", h.handleUpdateSmartCollection)
|
|
r.Delete(prefix+"/me/smart-collections/{id}", h.handleDeleteSmartCollection)
|
|
// Phase 1 close-out: listening stats / author+series / continue / RSS auth.
|
|
r.Get(prefix+"/me/listening-stats", h.handleListeningStats)
|
|
r.Get(prefix+"/me/listening-sessions", h.handleListeningSessions)
|
|
r.Get(prefix+"/me/listening-sessions/{sid}", h.handleListeningSessionDetail)
|
|
r.Get(prefix+"/authors/{id}", h.handleAuthorDetail)
|
|
r.Get(prefix+"/series/{id}", h.handleSeriesDetail)
|
|
r.Get(prefix+"/me/progress/{itemId}/remove-from-continue-listening", h.handleRemoveFromContinueListening)
|
|
r.Get(prefix+"/me/progress/{itemId}/readd-to-continue-listening", h.handleReaddToContinueListening)
|
|
r.Get(prefix+"/feeds", h.handleListRSSFeeds)
|
|
r.Post(prefix+"/feeds/item/{itemId}/open", h.handleOpenItemFeed)
|
|
r.Post(prefix+"/feeds/{id}/close", h.handleCloseFeed)
|
|
// Year-in-review stats — AudioBooth's "Year Stats" widget on the
|
|
// profile screen. Synthesized from AggregateStats today.
|
|
r.Get(prefix+"/me/stats/year/{year}", h.handleYearStats)
|
|
// Ebook surface — stubs until the ebook scanner lands.
|
|
// Mobile clients call these but degrade cleanly on empty/404.
|
|
r.Get(prefix+"/items/{id}/ebook/{fileid}", h.handleEbookFile)
|
|
r.Patch(prefix+"/items/{id}/ebook/{fileid}/status", h.handleEbookStatus)
|
|
// E-reader devices + ebook email delivery — empty list / 503
|
|
// until SMTP integration is wired.
|
|
r.Get(prefix+"/me/ereader-devices", h.handleListEreaderDevices)
|
|
r.Post(prefix+"/emails/send-ebook-to-device", h.handleSendEbookToDevice)
|
|
// Podcast stubs — audiobook-only catalog in v1. Endpoints
|
|
// return empty-but-well-formed shapes so the mobile UI doesn't
|
|
// crash on the podcast surfaces.
|
|
r.Post(prefix+"/podcasts/feed", h.handlePodcastFeed)
|
|
r.Post(prefix+"/items/{libraryItemId}/play/{episodeId}", h.handlePlayEpisode)
|
|
r.Get(prefix+"/libraries/{libraryId}/recent-episodes", h.handleRecentEpisodes)
|
|
r.Get(prefix+"/search/podcast", h.handleSearchPodcast)
|
|
}
|
|
})
|
|
|
|
// Stage 5: browse routes (libraries, items, item detail, me, similar,
|
|
// continue-listening) + author/series/search/personalized stubs.
|
|
// Requires bearerAuth.
|
|
r.Group(func(r chi.Router) {
|
|
r.Use(h.bearerAuth)
|
|
for _, prefix := range []string{"/abs/api", "/api"} {
|
|
// Current user object.
|
|
r.Get(prefix+"/me", h.handleMe)
|
|
// Real-ABS /authorize: validates the bearer and re-mints the
|
|
// /me envelope so the client can resume without retyping creds.
|
|
r.Post(prefix+"/authorize", h.handleABSAuthorize)
|
|
// Continue Listening shelf.
|
|
r.Get(prefix+"/me/items-in-progress", h.handleItemsInProgress)
|
|
// Library list + detail.
|
|
r.Get(prefix+"/libraries", h.handleLibraries)
|
|
r.Get(prefix+"/libraries/{libraryId}", h.handleLibraryDetail)
|
|
// Browse items in a library.
|
|
r.Get(prefix+"/libraries/{libraryId}/items", h.handleLibraryItems)
|
|
// Author / series / search / personalized — stubbed.
|
|
r.Get(prefix+"/libraries/{libraryId}/authors", h.handleLibraryAuthors)
|
|
r.Get(prefix+"/libraries/{libraryId}/series", h.handleLibrarySeries)
|
|
r.Get(prefix+"/libraries/{libraryId}/search", h.handleLibrarySearch)
|
|
r.Get(prefix+"/libraries/{libraryId}/personalized", h.handlePersonalized)
|
|
// Single item detail.
|
|
r.Get(prefix+"/items/{id}", h.handleItem)
|
|
// Similar items (optional Recommender; empty list when nil).
|
|
r.Get(prefix+"/items/{id}/similar", h.handleSimilarItems)
|
|
}
|
|
})
|
|
|
|
// Stage 6: Socket.io realtime endpoint.
|
|
if h.deps.SocketIO != nil {
|
|
r.Mount("/socket.io", h.deps.SocketIO.Handler())
|
|
r.Mount("/abs/socket.io", h.deps.SocketIO.Handler())
|
|
}
|
|
|
|
// TODO: social / collection routes (bookmarks, smart-collections,
|
|
// collections, playlists, RSS feeds, author/series detail, listening stats)
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Auth context helpers (used by bearerAuth middleware + handlers)
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// ctxKey is the unexported ABS auth context key.
|
|
type ctxKey struct{}
|
|
|
|
// ctxAuth carries the decoded ABS JWT claims for the lifetime of a request.
|
|
type ctxAuth struct {
|
|
UserID string
|
|
ProfileID string
|
|
JTI string
|
|
Token string // raw bearer token
|
|
}
|
|
|
|
// absAuthFrom extracts ABS auth from the request context. Returns (zero, false)
|
|
// when bearerAuth middleware hasn't run (unauthenticated routes).
|
|
func absAuthFrom(r *http.Request) (ctxAuth, bool) {
|
|
a, ok := r.Context().Value(ctxKey{}).(ctxAuth)
|
|
return a, ok
|
|
}
|
|
|
|
func (h *Handler) accessFilterForAuth(ctx context.Context, a ctxAuth) (catalog.AccessFilter, error) {
|
|
if h.deps.AccessResolver != nil {
|
|
return h.deps.AccessResolver.ResolveABSAccess(ctx, a.UserID, a.ProfileID)
|
|
}
|
|
filter := catalog.AccessFilter{ProfileID: a.ProfileID}
|
|
if uid, err := strconv.Atoi(a.UserID); err == nil {
|
|
filter.UserID = uid
|
|
}
|
|
return filter, nil
|
|
}
|
|
|
|
func (h *Handler) accessFilterFromRequest(r *http.Request) (catalog.AccessFilter, bool, error) {
|
|
a, ok := absAuthFrom(r)
|
|
if !ok || a.UserID == "" {
|
|
return catalog.AccessFilter{}, false, nil
|
|
}
|
|
filter, err := h.accessFilterForAuth(r.Context(), a)
|
|
return filter, true, err
|
|
}
|
|
|
|
func emptyAccessFilter() catalog.AccessFilter {
|
|
return catalog.AccessFilter{}
|
|
}
|
|
|
|
func sameABSPrincipal(a ctxAuth, userID, profileID string) bool {
|
|
return a.UserID == userID && a.ProfileID == profileID
|
|
}
|
|
|
|
// bearerAuth is the authentication middleware for protected ABS routes.
|
|
// It reads the bearer token from the Authorization header or ?token= query
|
|
// param, validates the JWT, checks the JTI isn't revoked, and injects
|
|
// ctxAuth into the request context.
|
|
//
|
|
// Placeholder implementation — full validation logic lands in Stage 2 when
|
|
// TokenStore and ConfigProvider are wired to real backing stores.
|
|
func (h *Handler) bearerAuth(next http.Handler) http.Handler {
|
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
raw := strings.TrimPrefix(r.Header.Get("Authorization"), "Bearer ")
|
|
if raw == "" {
|
|
raw = r.URL.Query().Get("token")
|
|
}
|
|
if raw == "" {
|
|
slog.Debug("abs bearerAuth: no token", "path", r.URL.Path, "remote", r.RemoteAddr)
|
|
http.Error(w, "unauthenticated", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if h.deps.Config == nil || h.deps.TokenStore == nil {
|
|
slog.Warn("abs bearerAuth: deps not wired",
|
|
"have_config", h.deps.Config != nil,
|
|
"have_token_store", h.deps.TokenStore != nil,
|
|
"path", r.URL.Path)
|
|
http.Error(w, "auth not configured", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
secret, err := h.deps.Config.JWTSecret(r.Context())
|
|
if err != nil {
|
|
slog.Error("abs bearerAuth: jwt secret fetch failed", "err", err, "path", r.URL.Path)
|
|
http.Error(w, "config unavailable", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
claims, err := ParseToken(secret, raw)
|
|
if err != nil {
|
|
slog.Debug("abs bearerAuth: parse failed", "err", err, "path", r.URL.Path)
|
|
http.Error(w, "invalid token", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if claims.Type != "access" {
|
|
slog.Debug("abs bearerAuth: wrong token type", "type", claims.Type, "path", r.URL.Path)
|
|
http.Error(w, "invalid token", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
row, err := h.deps.TokenStore.GetTokenByJTI(r.Context(), claims.JTI)
|
|
if err != nil {
|
|
slog.Debug("abs bearerAuth: jti lookup failed",
|
|
"jti", claims.JTI, "err", err, "path", r.URL.Path)
|
|
http.Error(w, "token revoked", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if row.RevokedAt != nil {
|
|
slog.Debug("abs bearerAuth: jti revoked", "jti", claims.JTI, "path", r.URL.Path)
|
|
http.Error(w, "token revoked", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if row.UserID != "" && row.UserID != claims.UserID {
|
|
slog.Debug("abs bearerAuth: token user mismatch", "jti", claims.JTI, "path", r.URL.Path)
|
|
http.Error(w, "invalid token", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if row.ProfileID != "" && row.ProfileID != claims.ProfileID {
|
|
slog.Debug("abs bearerAuth: token profile mismatch", "jti", claims.JTI, "path", r.URL.Path)
|
|
http.Error(w, "invalid token", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if row.Type != "" && row.Type != "access" {
|
|
slog.Debug("abs bearerAuth: persisted token type mismatch", "type", row.Type, "path", r.URL.Path)
|
|
http.Error(w, "invalid token", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if !row.ExpiresAt.IsZero() && time.Now().After(row.ExpiresAt) {
|
|
slog.Debug("abs bearerAuth: persisted token expired", "jti", claims.JTI, "path", r.URL.Path)
|
|
http.Error(w, "token expired", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
_ = h.deps.TokenStore.TouchToken(r.Context(), claims.JTI)
|
|
ctx := context.WithValue(r.Context(), ctxKey{}, ctxAuth{
|
|
UserID: claims.UserID,
|
|
ProfileID: claims.ProfileID,
|
|
JTI: claims.JTI,
|
|
Token: raw,
|
|
})
|
|
next.ServeHTTP(w, r.WithContext(ctx))
|
|
})
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Publisher nil-safe wrappers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
func (h *Handler) publish(userID, event string, payload any) {
|
|
if h.deps.Publisher == nil {
|
|
return
|
|
}
|
|
h.deps.Publisher.Publish(userID, event, payload)
|
|
}
|
|
|
|
func (h *Handler) broadcast(event string, payload any) {
|
|
if h.deps.Publisher == nil {
|
|
return
|
|
}
|
|
h.deps.Publisher.Broadcast(event, payload)
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// URL helpers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// absBaseURL returns the server address prefix ABS clients should use to
|
|
// resolve response-embedded URLs.
|
|
//
|
|
// - Host-proxied (X-Silo-User-Id header present): returns the plugin-proxy
|
|
// path "<scheme>://<host>/api/v1/plugins/<installID>".
|
|
// - Standalone listener: returns "<scheme>://<host>" — origin only.
|
|
//
|
|
// Honors X-Forwarded-Proto / X-Forwarded-Host for TLS-terminating proxies.
|
|
func (h *Handler) absBaseURL(r *http.Request) string {
|
|
scheme := r.Header.Get("X-Forwarded-Proto")
|
|
if scheme == "" {
|
|
if r.TLS != nil {
|
|
scheme = "https"
|
|
} else {
|
|
scheme = "http"
|
|
}
|
|
}
|
|
host := r.Header.Get("X-Forwarded-Host")
|
|
if host == "" {
|
|
host = r.Host
|
|
}
|
|
if r.Header.Get("X-Silo-User-Id") != "" {
|
|
return scheme + "://" + host + "/api/v1/plugins/" + h.deps.InstallID()
|
|
}
|
|
return scheme + "://" + host
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Shared response helpers (used by handlers across multiple stages)
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// writeJSON serialises v as JSON and writes it with the given HTTP status.
|
|
func writeJSON(w http.ResponseWriter, status int, v any) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.WriteHeader(status)
|
|
_ = json.NewEncoder(w).Encode(v)
|
|
}
|
|
|
|
// readPagedQuery extracts `limit` and `page` from query params. Real ABS
|
|
// treats limit=0 as "return all" (not "return zero rows") — we surface that
|
|
// intent and let callers short-circuit pagination.
|
|
func readPagedQuery(r *http.Request, defaultLimit int) (limit, page int) {
|
|
limit = defaultLimit
|
|
if v := r.URL.Query().Get("limit"); v != "" {
|
|
if n, err := strconv.Atoi(v); err == nil && n >= 0 {
|
|
limit = n
|
|
}
|
|
}
|
|
if v := r.URL.Query().Get("page"); v != "" {
|
|
if n, err := strconv.Atoi(v); err == nil && n >= 0 {
|
|
page = n
|
|
}
|
|
}
|
|
return limit, page
|
|
}
|
|
|
|
// pagedEnvelope builds the standard ABS pagination response shape. All eight
|
|
// fields are always emitted (no omitempty) because ABS clients branch on
|
|
// their presence (sortBy, filterBy, minified).
|
|
func pagedEnvelope(results any, total, limit, page int, sortBy string, sortDesc bool, filterBy string, minified bool, include string) map[string]any {
|
|
return map[string]any{
|
|
"results": results,
|
|
"total": total,
|
|
"limit": limit,
|
|
"page": page,
|
|
"sortBy": sortBy,
|
|
"sortDesc": sortDesc,
|
|
"filterBy": filterBy,
|
|
"minified": minified,
|
|
"include": include,
|
|
}
|
|
}
|