Files
readest/apps/readest.koplugin/library/cloud_icons.lua
T
Huang Xin ed8956e9ed feat(koplugin): Readest Library view in KOReader (#4056)
* feat(koplugin/library): data layer + busted harness + design doc

- LibraryStore: per-user SQLite index merging cloud + local books by
  partial-md5 hash. listBooks/listBookshelfBooks/listBookshelfGroups,
  upsertBook with cloud_present/local_present OR-merge + _force/clear
  sentinels, parseSyncRow, getChangedBooks for tombstone push.
- EXTS table mirroring web's document.ts.
- busted harness with KOReader stubs (G_reader_settings, DataStorage,
  lua-ljsqlite3 against :memory:); spec_helper, exts_spec, smoke_spec,
  librarystore_spec covering schema, sort, group nesting, dedupe.
- Library design doc + spec README.
- pnpm test:lua wired through root + app package.json; lint-koplugin
  recurses into library/ + spec/.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(koplugin/library): cloud sync — push, pull, upload, delete, downloads

- Spore methods: pullBooks (incremental /sync), getDownloadUrl,
  getUploadUrl, listFiles, deleteFile.
- syncbooks.lua: pushBook + pushChangedBooks (advances watermark to
  max(updated_at, deleted_at)), syncBooks(opts, mode) for push/pull/both,
  downloadBook + downloadCover (sync socket.http with file sink; cover
  download via fork+poll with single-slot queue + visible-page filter +
  coalesced refresh), uploadBook (presigned-PUT flow + best-effort
  cover), deleteCloudFiles (list-then-delete-each, mirrors
  cloudService.deleteBook).
- SyncAuth.withFreshToken wrapper resolves the ensureClient race; 401/403
  unified across syncconfig + syncannotations.
- Cloud + local book covers shared by partial-md5 hash; cover.png cached
  at <settings>/readest_covers/<hash>.png with sentinel for known 404s.
- syncbooks_spec covers row-to-wire conversion + file_key shape.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(koplugin/library): local discovery — sidecar scanner + cover provider

- localscanner.lightScan iterates ReadHistory entries, reads
  partial_md5_checksum from .sdr sidecars, and upserts local rows.
  Slow filesystem walks deferred to fullSidecarWalk (24h-gated).
- coverprovider wraps BookInfoManager:getBookInfo for local books with
  graceful FakeCover fallback when coverbrowser is absent.
- localscanner_spec + coverprovider_spec.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(koplugin/library): UI — widget, item, view menu, FileManager hooks

- librarywidget: full-screen Menu mixed in with CoverMenu + Mosaic/List
  per zen_ui's group_view pattern. Title-bar tap → view menu, search via
  left icon, drill-in/back for grouping. Async cloud sync deferred via
  scheduleIn so the menu paints before HTTP fires.
- libraryitem: BIM patch for cloud-only (readest-cloud://) and group
  (readest-group://) URIs; group-cover composer (2x2 mosaic for grid,
  same in list) with cache key derived from the actual first-N hashes
  for content-based invalidation; ListMenuItem update + paintTo patches
  for wider list-mode cover strip and cloud-up/down icon overlay.
- libraryviewmenu: ButtonDialog with View/Group by/Sort by/Actions.
  Default Group by = Groups (parity with web), values authors/groups.
- librarypaint: partial-page e-ink repaint shim adapted from zen_ui.
- main.lua: Library menu entry, dispatcher actions (Open Library / Push
  / Pull as general; progress + annotations as reader-only),
  "Add to Readest" button in FileManager's long-press file dialog
  (dedupe by partial_md5; bumps updated_at when present, inserts a
  fresh local-only row otherwise; un-tombstones via _clear_fields).
  Push books on Library open when auto_sync is on, pull-only otherwise.
- Long-press action sheet with Readest BookDetailView parity:
  Remove from Cloud & Device / Cloud Only / Device Only,
  Upload to Cloud, Download Book / Cover / All.
- Cloud-down + cloud-up SVG icons (LiaCloudDownloadAltSolid /
  LiaCloudUploadAltSolid) painted in the right-side wpageinfo slot.
- i18n catalog updated for new strings.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(koplugin/library): split libraryitem into focused modules

libraryitem.lua had grown to 1018 lines mixing five unrelated
concerns. Split along the natural seams:

  cloud_covers — readest-cloud:// URI scheme, on-disk <hash>.png
                 cache, single-slot async download queue, visible-page
                 filter
  group_covers — readest-group:// URI scheme, 2x2 mosaic composer with
                 content-derived cache key (first-N hashes), cell
                 layout table
  cloud_icons  — bundled cloud-up/cloud-down SVG loader, IconWidget
                 cache, paint-overlay positioning
  list_strip   — list-mode group row builder (4-cover wider strip
                 replacing ListMenu's square cover slot)
  bim_patch    — BookInfoManager:getBookInfo router (cloud / group /
                 local) + ListMenuItem update + paintTo patches; owns
                 the _library_local_paths set and orig BIM reference

libraryitem.lua is now 141 lines: just the entry-table constructors
(entry_from_row, entry_from_group, entry_back) plus thin install /
set_visible_hashes delegates. Each new module is 88-216 lines.

No behavior change — same 113 specs pass.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore(koplugin): co-locate dev tooling, ship-zip exclusions, CI job split

- apps/readest.koplugin/scripts/build-koplugin.mjs: local sideloading
  build with the same exclusions the release workflow uses.
- Move lint-koplugin + test-koplugin from apps/readest-app/scripts/ to
  apps/readest.koplugin/scripts/. All koplugin dev tooling now lives
  with the koplugin and is excluded from the published release zip.
- Rename to .mjs so Node treats them as ESM without the reparse warning
  (the i18n CommonJS scripts stay .js).
- Release workflow: zip -r exclusions for scripts/, docs/, spec/,
  .busted so dev artifacts don't ship to end users.
- PR workflow: split build_web_app into build_web_app + test_web_app
  for parallelism. The test job installs luarocks + busted +
  lsqlite3complete and runs pnpm test:lua. test-koplugin.mjs now
  hard-fails (instead of soft-skipping) when CI=true and a tool is
  missing — a broken CI toolchain previously exited 0 silently.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-04 23:12:34 +02:00

89 lines
3.2 KiB
Lua

-- cloud_icons.lua
-- Per-row cloud-up/cloud-down overlay icons painted on top of the
-- standard ListMenuItem widget tree. Loaded once from bundled SVGs
-- and cached as IconWidget instances for reuse across all rows.
local M = {}
-- Resolve apps/readest.koplugin root via debug.getinfo on this file's
-- own source path (same trick as zen_ui's plugin_root.lua). Needed
-- because our bundled icons aren't in any of KOReader's ICONS_DIRS,
-- so we load them by absolute path through ImageWidget instead of
-- IconWidget's name-based lookup.
local _plugin_root = (function()
local src = debug.getinfo(1, "S").source or ""
local path = (src:sub(1, 1) == "@")
and src:sub(2):match("^(.*)/library/[^/]+$") or nil
if path and path:sub(1, 1) ~= "/" then
local ok, lfs = pcall(require, "libs/libkoreader-lfs")
local cwd = ok and lfs and lfs.currentdir()
if cwd then path = cwd .. "/" .. path end
end
return path
end)()
local ICON_FILES = {
dl = _plugin_root and (_plugin_root .. "/icons/cloud_download.svg"),
up = _plugin_root and (_plugin_root .. "/icons/cloud_upload.svg"),
}
-- Per-icon cache: {key → {widget, size_loaded}}. IconWidget loads +
-- caches its bb on first render so we only pay the SVG decode once
-- per icon size.
local _cache = {}
function M.has_icon(kind)
return ICON_FILES[kind] ~= nil
end
local function get_widget(kind, target_size)
local entry = _cache[kind]
if entry and entry.size_loaded == target_size then
return entry.widget
end
if entry and entry.widget then
local prev = entry.widget
entry.widget = nil
pcall(function() prev:free() end)
end
local file = ICON_FILES[kind]
if not file then return nil end
local ok, ImageWidget = pcall(require, "ui/widget/imagewidget")
if not ok then return nil end
local widget = ImageWidget:new{
file = file,
width = target_size,
height = target_size,
scale_factor = 0, -- aspect-preserving fit
alpha = true, -- preserve SVG transparency
is_icon = true,
}
_cache[kind] = { widget = widget, size_loaded = target_size }
return widget
end
-- Paint the cloud icon at the right edge of the row, in the slot
-- where ListMenuItem normally draws its second line of right-side
-- text (wpageinfo, e.g. "1% of 1424 pages"). For row height dimen.h,
-- the standard wright VerticalGroup is roughly:
-- VerticalSpan(2) + fileinfo(~h*0.28) + pageinfo(~h*0.28)
-- center-aligned, which lands pageinfo at ~y + 0.5*h. Mirroring that
-- keeps the format label and the cloud icon visually stacked at the
-- right edge with consistent padding.
function M.paint(item, bb, x, y, kind)
local Screen = require("device").screen
local icon_size = math.floor(item.height * 0.28)
local icon = get_widget(kind, icon_size)
if not icon then return end
-- _render so getSize returns the actual scaled dims, not the
-- requested width/height.
icon:_render()
local s = icon:getSize()
local pad_right = Screen:scaleBySize(10)
local icon_x = x + item.width - pad_right - s.w
local icon_y = y + math.floor(item.height * 0.5)
icon:paintTo(bb, icon_x, icon_y)
end
return M