Files
silo-server/internal/audiobooks/abs/playlists_handler.go
T
RXWatcherandClaude Opus 4.7 b231b27487 docs(abs): clean stale references to dropped abs_* tables
Comments referencing the now-dropped abs_user_collections,
abs_collection_items, abs_smart_collections, abs_playlists, and
abs_playlist_items tables. Code paths were updated in the prior
commits; only doc strings remained.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-27 14:00:30 +02:00

619 lines
22 KiB
Go

package abs
import (
"encoding/json"
"errors"
"io"
"log/slog"
"net/http"
"github.com/go-chi/chi/v5"
"github.com/oklog/ulid/v2"
)
// playlistBody is the JSON body for POST and PATCH /playlists[/{id}].
// Fields are pointers so PATCH can distinguish "field absent" from
// "field set to empty/false". The real-ABS mobile client also sends
// `items` and `libraryId` on POST — the create flow expects the
// playlist + its initial members in a single round-trip — so we
// accept (and apply) both here. PATCH ignores them.
type playlistBody struct {
Name *string `json:"name"`
Description *string `json:"description"`
CoverItem *string `json:"cover_item"`
IsPublic *bool `json:"isPublic"`
LibraryID *string `json:"libraryId"`
Items []playlistItemRef `json:"items"`
}
// playlistItemRef is the JSON body for adding/removing a single
// playlist item (and an element of the batch arrays).
type playlistItemRef struct {
LibraryItemID string `json:"libraryItemId"`
EpisodeID string `json:"episodeId"`
}
// handleCreatePlaylist — POST /playlists.
// Body: {name, description?, cover_item?, isPublic?}.
// Returns the created playlist in full-shape (empty items[]).
// Fires playlist_added on success.
func (h *Handler) handleCreatePlaylist(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist store unavailable", http.StatusServiceUnavailable)
return
}
var body playlistBody
if err := json.NewDecoder(io.LimitReader(r.Body, 1<<20)).Decode(&body); err != nil {
http.Error(w, "invalid body", http.StatusBadRequest)
return
}
if body.Name == nil || *body.Name == "" {
http.Error(w, "name required", http.StatusBadRequest)
return
}
p := Playlist{
ID: ulid.Make().String(),
UserID: a.UserID,
ProfileID: a.ProfileID,
Name: *body.Name,
}
if body.Description != nil {
p.Description = *body.Description
}
if body.CoverItem != nil {
p.CoverItem = *body.CoverItem
}
if body.IsPublic != nil {
p.IsPublic = *body.IsPublic
}
if err := h.deps.PlaylistStore.CreatePlaylist(r.Context(), p); err != nil {
slog.Error("abs playlist create failed", "err", err, "user", a.UserID)
http.Error(w, "playlist persist failed", http.StatusInternalServerError)
return
}
// Add any items the client sent on the same POST — real-ABS mobile
// builds the playlist + initial member list in one round-trip
// (see audiobookshelf-app components/modals/playlists/
// AddCreateModal.vue submitCreatePlaylist). Per-item errors are
// tolerated silently; whole-batch failure already surfaced above.
for _, it := range body.Items {
if it.LibraryItemID == "" {
continue
}
// Episode items skip audiobook MediaStore validation per the
// audiobook-only-hydration policy. Audiobook items get a
// MediaStore lookup so typos don't create orphan rows.
if it.EpisodeID == "" {
if mi, mErr := h.deps.MediaStore.GetAudiobookByID(r.Context(), it.LibraryItemID); mErr != nil || mi == nil {
slog.Debug("abs playlist create-items: skipping unknown audiobook", "id", it.LibraryItemID)
continue
}
}
if addErr := h.deps.PlaylistStore.AddPlaylistItem(r.Context(), p.ID, it.LibraryItemID, it.EpisodeID); addErr != nil {
slog.Debug("abs playlist create-items: store error", "err", addErr, "id", it.LibraryItemID)
}
}
persisted, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), p.ID)
if errors.Is(err, ErrNotFound) {
persisted = p
} else if err != nil {
persisted = p
}
h.publish(a.UserID, "playlist_added", map[string]any{"id": p.ID, "name": p.Name})
writeJSON(w, http.StatusOK, h.playlistFullShape(r, persisted))
}
// playlistFullShape renders a Playlist in full-shape, hydrating items[]
// via MediaStore for audiobook items (episode items echo bare refs).
func (h *Handler) playlistFullShape(r *http.Request, p Playlist) map[string]any {
items := h.playlistItems(r, p.ID)
return playlistToABS(p, items)
}
// playlistItems resolves items in a playlist to wire-shape entries.
// Each entry embeds a `libraryItem` block with the full LibraryItem
// shape — the ABS mobile client reads `item.libraryItem.mediaType`
// in PlaylistCover, LazyBookCard, and pages/playlist/_id.vue before
// rendering anything, so emitting bare {libraryItemId, title} causes
// "cannot read properties of undefined (reading mediaType)" on every
// playlist view. Episode items keep the bare ref shape; the official
// client treats episode rows separately via `item.episode`.
func (h *Handler) playlistItems(r *http.Request, playlistID string) []map[string]any {
if h.deps.PlaylistStore == nil {
return []map[string]any{}
}
rows, err := h.deps.PlaylistStore.ListPlaylistItems(r.Context(), playlistID)
if err != nil {
slog.Warn("abs playlist list-items failed", "err", err, "playlist", playlistID)
return []map[string]any{}
}
lib := h.resolveDefaultLibrary(r.Context())
libID := audiobookLibraryID(lib)
baseURL := h.absBaseURL(r)
out := make([]map[string]any, 0, len(rows))
for _, it := range rows {
entry := map[string]any{
"libraryItemId": it.LibraryItemID,
"position": it.Position,
}
if it.EpisodeID != "" {
entry["episodeId"] = it.EpisodeID
} else if item, err := h.deps.MediaStore.GetAudiobookByID(r.Context(), it.LibraryItemID); err == nil && item != nil {
entry["libraryId"] = libID
entry["title"] = item.Title
entry["libraryItem"] = siloItemToLibraryItem(item, lib, baseURL)
}
out = append(out, entry)
}
return out
}
// playlistURLID is a tiny shim around chi.URLParam(r, "id") to read
// uniformly with the collections handler's chiURLID.
func playlistURLID(r *http.Request) string { return chi.URLParam(r, "id") }
// handleListLibraryPlaylists — GET /libraries/{libraryId}/playlists.
//
// The ABS mobile create-playlist modal hits this endpoint BEFORE
// opening the form so it can show "already in playlist X" badges and
// the existing-playlists picker. It accesses `data.results` on the
// response (NOT `data.playlists`), and iterates `playlist.items` to
// check membership, so we emit:
// {"results": [Playlist full-shape with items[]]}
//
// The libraryId URL param is accepted but ignored — silo scopes
// playlists per (user, profile) globally rather than per-library;
// the mobile UI only needs to know which of the user's playlists
// already contain the selected item.
//
// Ref: audiobookshelf-app components/modals/playlists/AddCreateModal.vue
// loadPlaylists().
func (h *Handler) handleListLibraryPlaylists(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
writeJSON(w, http.StatusOK, map[string]any{"results": []any{}, "total": 0})
return
}
rows, err := h.deps.PlaylistStore.ListUserPlaylists(r.Context(), a.UserID, a.ProfileID)
if err != nil {
slog.Error("abs library playlist list failed", "err", err, "user", a.UserID)
http.Error(w, "playlist list failed", http.StatusInternalServerError)
return
}
out := make([]map[string]any, 0, len(rows))
for _, p := range rows {
// Full-shape (with items[]) so the modal can check
// existing-membership via playlist.items.some(...).
out = append(out, h.playlistFullShape(r, p))
}
// LazyBookshelf reads payload.total to compute pagination; emit both
// for the bookshelf grid AND the create modal (modal ignores total).
writeJSON(w, http.StatusOK, map[string]any{"results": out, "total": len(out)})
}
// handleListPlaylists — GET /playlists.
// Returns the caller's playlists wrapped in {"playlists": [...]}.
// List-shape (no items[]).
func (h *Handler) handleListPlaylists(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
writeJSON(w, http.StatusOK, map[string]any{"playlists": []any{}})
return
}
rows, err := h.deps.PlaylistStore.ListUserPlaylists(r.Context(), a.UserID, a.ProfileID)
if err != nil {
slog.Error("abs playlist list failed", "err", err, "user", a.UserID)
http.Error(w, "playlist list failed", http.StatusInternalServerError)
return
}
out := make([]map[string]any, 0, len(rows))
for _, p := range rows {
out = append(out, playlistToABS(p, nil))
}
writeJSON(w, http.StatusOK, map[string]any{"playlists": out})
}
// handleGetPlaylist — GET /playlists/{id}.
// Owner gets full-shape; non-owner gets full-shape only when isPublic.
// Otherwise 404 (no existence leak).
func (h *Handler) handleGetPlaylist(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
p, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), playlistURLID(r))
if errors.Is(err, ErrNotFound) || (err == nil && p.UserID != a.UserID && !p.IsPublic) {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
if err != nil {
slog.Error("abs playlist get failed", "err", err)
http.Error(w, "playlist get failed", http.StatusInternalServerError)
return
}
writeJSON(w, http.StatusOK, h.playlistFullShape(r, p))
}
// handleUpdatePlaylist — PATCH /playlists/{id}.
// Owner-only. Partial body. Fires playlist_updated.
func (h *Handler) handleUpdatePlaylist(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
id := playlistURLID(r)
p, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if errors.Is(err, ErrNotFound) || (err == nil && p.UserID != a.UserID) {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
if err != nil {
slog.Error("abs playlist get-for-update failed", "err", err, "id", id)
http.Error(w, "playlist get failed", http.StatusInternalServerError)
return
}
var body playlistBody
if err := json.NewDecoder(io.LimitReader(r.Body, 1<<20)).Decode(&body); err != nil {
http.Error(w, "invalid body", http.StatusBadRequest)
return
}
if body.Name != nil {
p.Name = *body.Name
}
if body.Description != nil {
p.Description = *body.Description
}
if body.CoverItem != nil {
p.CoverItem = *body.CoverItem
}
if body.IsPublic != nil {
p.IsPublic = *body.IsPublic
}
if err := h.deps.PlaylistStore.UpdatePlaylist(r.Context(), p); err != nil {
slog.Error("abs playlist update failed", "err", err, "id", id)
http.Error(w, "playlist persist failed", http.StatusInternalServerError)
return
}
persisted, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if err != nil {
persisted = p
}
h.publish(a.UserID, "playlist_updated", map[string]any{"id": id})
writeJSON(w, http.StatusOK, h.playlistFullShape(r, persisted))
}
// handleAddPlaylistItem — POST /playlists/{id}/item.
// Body: {libraryItemId, episodeId?}.
// Owner-only. Item validation: audiobooks validated via MediaStore
// (404 on unknown); episode items skip validation per spec §7.1 (the
// audiobook-only-hydration policy doesn't reject opaque episode IDs).
// Idempotent on (libraryItemId, episodeId) tuple. Fires playlist_updated.
func (h *Handler) handleAddPlaylistItem(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
id := playlistURLID(r)
p, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if errors.Is(err, ErrNotFound) || (err == nil && p.UserID != a.UserID) {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
if err != nil {
slog.Error("abs playlist get-for-add failed", "err", err, "id", id)
http.Error(w, "playlist get failed", http.StatusInternalServerError)
return
}
var body playlistItemRef
if err := json.NewDecoder(io.LimitReader(r.Body, 1<<20)).Decode(&body); err != nil {
http.Error(w, "invalid body", http.StatusBadRequest)
return
}
if body.LibraryItemID == "" {
http.Error(w, "libraryItemId required", http.StatusBadRequest)
return
}
// Audiobook items validated; episodes skip validation.
if body.EpisodeID == "" {
item, err := h.deps.MediaStore.GetAudiobookByID(r.Context(), body.LibraryItemID)
if err != nil || item == nil {
http.Error(w, "item not found", http.StatusNotFound)
return
}
}
if err := h.deps.PlaylistStore.AddPlaylistItem(r.Context(), id, body.LibraryItemID, body.EpisodeID); err != nil {
slog.Error("abs playlist add-item failed", "err", err, "id", id)
http.Error(w, "playlist persist failed", http.StatusInternalServerError)
return
}
persisted, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if err != nil {
persisted = p
}
h.publish(a.UserID, "playlist_updated", map[string]any{"id": id})
writeJSON(w, http.StatusOK, h.playlistFullShape(r, persisted))
}
// handleDeletePlaylist — DELETE /playlists/{id}.
// Owner-only. Cascade drops user_personal_collection_items via FK.
// Fires playlist_removed.
func (h *Handler) handleDeletePlaylist(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
id := playlistURLID(r)
p, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if errors.Is(err, ErrNotFound) || (err == nil && p.UserID != a.UserID) {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
if err != nil {
slog.Error("abs playlist get-for-delete failed", "err", err, "id", id)
http.Error(w, "playlist get failed", http.StatusInternalServerError)
return
}
if err := h.deps.PlaylistStore.DeletePlaylist(r.Context(), id); err != nil {
slog.Error("abs playlist delete failed", "err", err, "id", id)
http.Error(w, "playlist delete failed", http.StatusInternalServerError)
return
}
h.publish(a.UserID, "playlist_removed", map[string]any{"id": id})
w.WriteHeader(http.StatusNoContent)
}
// batchItemsBody is the shared body shape for batch add/remove.
type batchItemsBody struct {
Items []playlistItemRef `json:"items"`
}
// handleBatchAddPlaylistItems — POST /playlists/{id}/batch/add.
// Body: {items: [{libraryItemId, episodeId?}]}. Per-item failures are
// tolerated silently (matches continuum). Only the whole-body decode
// failure surfaces as 400. Audiobook items validated per-entry; failed
// validations skipped with slog.Debug (the entry never reaches the
// store). One playlist_updated event fires for the whole batch.
func (h *Handler) handleBatchAddPlaylistItems(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
id := playlistURLID(r)
p, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if errors.Is(err, ErrNotFound) || (err == nil && p.UserID != a.UserID) {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
if err != nil {
slog.Error("abs playlist get-for-batch-add failed", "err", err, "id", id)
http.Error(w, "playlist get failed", http.StatusInternalServerError)
return
}
var body batchItemsBody
if err := json.NewDecoder(io.LimitReader(r.Body, 1<<20)).Decode(&body); err != nil {
http.Error(w, "invalid body", http.StatusBadRequest)
return
}
for _, it := range body.Items {
if it.LibraryItemID == "" {
slog.Debug("abs playlist batch-add: skipping empty libraryItemId")
continue
}
// Audiobook validation; episode items skip.
if it.EpisodeID == "" {
item, lookupErr := h.deps.MediaStore.GetAudiobookByID(r.Context(), it.LibraryItemID)
if lookupErr != nil || item == nil {
slog.Debug("abs playlist batch-add: skipping unknown audiobook", "id", it.LibraryItemID)
continue
}
}
if addErr := h.deps.PlaylistStore.AddPlaylistItem(r.Context(), id, it.LibraryItemID, it.EpisodeID); addErr != nil {
slog.Debug("abs playlist batch-add: store error", "err", addErr, "id", it.LibraryItemID)
}
}
persisted, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if err != nil {
persisted = p
}
h.publish(a.UserID, "playlist_updated", map[string]any{"id": id})
writeJSON(w, http.StatusOK, h.playlistFullShape(r, persisted))
}
// handleBatchRemovePlaylistItems — POST /playlists/{id}/batch/remove.
// Body: {items: [{libraryItemId, episodeId?}]}. Per-item failures
// tolerated; one playlist_updated event for the whole batch.
func (h *Handler) handleBatchRemovePlaylistItems(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
id := playlistURLID(r)
p, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if errors.Is(err, ErrNotFound) || (err == nil && p.UserID != a.UserID) {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
if err != nil {
slog.Error("abs playlist get-for-batch-remove failed", "err", err, "id", id)
http.Error(w, "playlist get failed", http.StatusInternalServerError)
return
}
var body batchItemsBody
if err := json.NewDecoder(io.LimitReader(r.Body, 1<<20)).Decode(&body); err != nil {
http.Error(w, "invalid body", http.StatusBadRequest)
return
}
for _, it := range body.Items {
if rmErr := h.deps.PlaylistStore.RemovePlaylistItem(r.Context(), id, it.LibraryItemID, it.EpisodeID); rmErr != nil {
slog.Debug("abs playlist batch-remove: store error", "err", rmErr, "id", it.LibraryItemID)
}
}
if h.autoDeleteIfEmpty(w, r, a.UserID, id, p) {
return
}
persisted, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if err != nil {
persisted = p
}
h.publish(a.UserID, "playlist_updated", map[string]any{"id": id})
writeJSON(w, http.StatusOK, h.playlistFullShape(r, persisted))
}
// handleRemovePlaylistItem — DELETE /playlists/{id}/item/{libraryItemId}.
// Owner-only. Removes the item with empty episode_id. Idempotent.
// Fires playlist_updated.
func (h *Handler) handleRemovePlaylistItem(w http.ResponseWriter, r *http.Request) {
h.removePlaylistItemImpl(w, r, "")
}
// handleRemovePlaylistEpisode — DELETE /playlists/{id}/item/{libraryItemId}/{episodeId}.
// Owner-only. Removes the item keyed on (libraryItemId, episodeId).
// Idempotent. Fires playlist_updated.
func (h *Handler) handleRemovePlaylistEpisode(w http.ResponseWriter, r *http.Request) {
h.removePlaylistItemImpl(w, r, chi.URLParam(r, "episodeId"))
}
// removePlaylistItemImpl is the shared body for both remove variants.
// episodeIDFromURL is "" for the libraryItemId-only DELETE and the
// {episodeId} URL param for the episode-aware DELETE.
func (h *Handler) removePlaylistItemImpl(w http.ResponseWriter, r *http.Request, episodeIDFromURL string) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.PlaylistStore == nil {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
id := playlistURLID(r)
libItem := chi.URLParam(r, "libraryItemId")
if libItem == "" {
http.Error(w, "libraryItemId required", http.StatusBadRequest)
return
}
p, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if errors.Is(err, ErrNotFound) || (err == nil && p.UserID != a.UserID) {
http.Error(w, "playlist not found", http.StatusNotFound)
return
}
if err != nil {
slog.Error("abs playlist get-for-remove failed", "err", err, "id", id)
http.Error(w, "playlist get failed", http.StatusInternalServerError)
return
}
if err := h.deps.PlaylistStore.RemovePlaylistItem(r.Context(), id, libItem, episodeIDFromURL); err != nil {
slog.Error("abs playlist remove-item failed", "err", err, "id", id, "item", libItem, "episode", episodeIDFromURL)
http.Error(w, "playlist delete failed", http.StatusInternalServerError)
return
}
if h.autoDeleteIfEmpty(w, r, a.UserID, id, p) {
return
}
persisted, err := h.deps.PlaylistStore.GetPlaylist(r.Context(), id)
if err != nil {
persisted = p
}
h.publish(a.UserID, "playlist_updated", map[string]any{"id": id})
writeJSON(w, http.StatusOK, h.playlistFullShape(r, persisted))
}
// autoDeleteIfEmpty mirrors the official audiobookshelf-server behavior
// where a playlist is destroyed once its final item is removed. After a
// successful item-remove the caller invokes this; if the playlist is now
// empty it is deleted and a `playlist_removed` event is fired (mobile
// client's pages/playlist/_id.vue uses this to navigate the user back to
// /bookshelf/playlists). Returns true when the handler has fully written
// the response and the caller should stop.
//
// Errors during the empty-check or delete step do not block the original
// remove from succeeding — we log and fall back to the standard
// playlist_updated path so the client at minimum sees an empty playlist
// (consistent with our pre-auto-delete behavior).
func (h *Handler) autoDeleteIfEmpty(w http.ResponseWriter, r *http.Request, userID, playlistID string, original Playlist) bool {
items, err := h.deps.PlaylistStore.ListPlaylistItems(r.Context(), playlistID)
if err != nil {
slog.Warn("abs playlist auto-delete: count failed", "err", err, "id", playlistID)
return false
}
if len(items) > 0 {
return false
}
if err := h.deps.PlaylistStore.DeletePlaylist(r.Context(), playlistID); err != nil {
slog.Warn("abs playlist auto-delete: delete failed", "err", err, "id", playlistID)
return false
}
h.publish(userID, "playlist_removed", map[string]any{"id": playlistID})
// Echo the now-deleted playlist as the response body — the official
// server returns the playlist (with empty items[]) so the client
// reconciles state regardless of whether the socket event arrives
// first.
writeJSON(w, http.StatusOK, playlistToABS(original, []map[string]any{}))
return true
}