mirror of
https://github.com/bookorbit/bookorbit.git
synced 2026-11-03 08:21:39 -06:00
neon
cc50b55eeb
Add original and text-only EPUB delivery choices across Kobo, KOReader, OPDS, web downloads and email while keeping source files unchanged. Persist server defaults, device overrides and captured artifact identities so retries and guided replacement retain the selected rendition. Preserve saved progress across first opens, replacement resets and stale updates, and project annotations against the copy delivered to each device. Handle XML resource references, large inodes, retry backoff and background worker state correctly. Consolidate the schema changes into one migration and retain released-client request and response compatibility. Verify with the full server and client checks, delivery and sync HTTP suites, independent code reviews, and live KOReader download/settings/reader proof. Fixes #1496 Closes #1603 Closes #1714 Fixes #1723 Ref #1633 Ref #1508 Ref #1621 Ref #1136
86 lines
3.8 KiB
Lua
86 lines
3.8 KiB
Lua
local Capabilities = require("bookorbit_capabilities")
|
|
local _ = require("gettext")
|
|
local Delivery = {}
|
|
|
|
local function validVariant(value)
|
|
return value == "original" or value == "audioless_epub"
|
|
end
|
|
|
|
function Delivery.key(client)
|
|
return tostring(client.server_url) .. "|" .. tostring(client.username)
|
|
end
|
|
|
|
local function legacyPreference(settings, client)
|
|
return (settings.catalog_delivery_profiles or {})[Delivery.key(client)]
|
|
end
|
|
|
|
function Delivery.preference(settings, client)
|
|
local cached = client.delivery_settings
|
|
if cached and cached.key == Delivery.key(client) then return cached.readAloudDelivery end
|
|
local remote = (settings.catalog_delivery_server_profiles or {})[Delivery.key(client)]
|
|
if validVariant(remote) then return remote end
|
|
return legacyPreference(settings, client) == "original" and "original" or "audioless_epub"
|
|
end
|
|
|
|
local function remember(settings, client, body)
|
|
if type(body) ~= "table" or not validVariant(body.readAloudDelivery) then
|
|
return nil, _("The server returned an invalid EPUB delivery preference. Reconnect and retry.")
|
|
end
|
|
local profiles = settings.catalog_delivery_server_profiles or {}
|
|
profiles[Delivery.key(client)] = body.readAloudDelivery
|
|
settings.catalog_delivery_server_profiles = profiles
|
|
client.delivery_settings = {
|
|
key = Delivery.key(client), readAloudDelivery = body.readAloudDelivery,
|
|
credentialDefault = body.credentialDefault, deviceOverride = body.deviceOverride,
|
|
}
|
|
return body.readAloudDelivery
|
|
end
|
|
|
|
function Delivery.refresh(settings, client)
|
|
local body = client:getDeliverySettings()
|
|
if not body then return nil, _("Could not load the EPUB delivery default from BookOrbit. Reconnect and retry, or choose a variant for this download.") end
|
|
if type(body) ~= "table" or not validVariant(body.readAloudDelivery) then return remember(settings, client, body) end
|
|
if body.deviceConfigured == false then
|
|
local legacy = legacyPreference(settings, client)
|
|
body = client:setDeliverySettings(validVariant(legacy) and legacy or nil, true)
|
|
if not body then return nil, _("Could not migrate the EPUB delivery preference to BookOrbit. Reconnect and retry.") end
|
|
end
|
|
return remember(settings, client, body)
|
|
end
|
|
|
|
function Delivery.resolve(settings, client, override)
|
|
local supported = client.getPluginVersion and Capabilities.supports(client, "readAloudDeliveryVariants")
|
|
if supported then
|
|
if override then return override end
|
|
if Capabilities.supports(client, "readAloudDeliverySettings") then return Delivery.refresh(settings, client) end
|
|
return Delivery.preference(settings, client)
|
|
end
|
|
local requested = override or Delivery.preference(settings, client)
|
|
if requested == "original" or override then
|
|
return nil, _("This server cannot confirm support for the requested EPUB variant. Reconnect to a compatible server and retry.")
|
|
end
|
|
return nil
|
|
end
|
|
|
|
function Delivery.update(settings, client, variant)
|
|
if client.getPluginVersion and Capabilities.supports(client, "readAloudDeliverySettings") then
|
|
local body = client:setDeliverySettings(variant, false)
|
|
if not body then return nil, _("Could not save the EPUB delivery preference in BookOrbit. Reconnect and retry.") end
|
|
return remember(settings, client, body)
|
|
end
|
|
if not variant then return nil, _("This server does not support a server default. Update BookOrbit first.") end
|
|
local resolved, err = Delivery.resolve(settings, client, variant)
|
|
if err then return nil, err end
|
|
Delivery.set(settings, client, resolved)
|
|
return resolved
|
|
end
|
|
|
|
function Delivery.set(settings, client, variant)
|
|
local profiles = settings.catalog_delivery_profiles or {}
|
|
profiles[Delivery.key(client)] = variant
|
|
settings.catalog_delivery_profiles = profiles
|
|
return profiles
|
|
end
|
|
|
|
return Delivery
|