Merge branch 'Sudashiii:master' into master

Author: ThePixelPro366

README.md

@@ -187,25 +187,31 @@ Basic setup flow:
 
 1. Install the plugin in KOReader like any other plugin.
 2. Open `Settings -> More tools -> Sake`.
-3. Set the public URL of your Sake web app.
-4. Log in with the same username and password you use in the web app.
-5. Choose `Login and fetch device key`.
-6. Use the sync actions to pull books, push progress, or check for plugin updates.
+3. Open `Setup`.
+4. Set the public URL of your Sake web app in `Server URL`.
+5. Optionally rename the device in `Device Name`.
+6. Choose `Pair Device` and log in with the same username and password you use in the web app.
+7. Use the actions in `Sync`, `Library Import/Export`, and `Maintenance` as needed.
 
 The login step exchanges your password for a device API key and clears the password from the device afterward.
 
 You can also export ebooks from the devices home folder back to the web app, including sidecar data such as progress and notes. Great if you have a pre-existing library on your device!
 
-KOReader plugin releases are tracked in the database and the artifacts are served through S3-compatible storage. If the KOReader plugin is updated and you start the app, the new version will be uploaded to S3 so you can use the updater plugin to easily update the core plugin without needing to manually mvoe the files to your KOReader device.
+KOReader plugin releases are tracked in the database and the artifacts are served through S3-compatible storage. If the KOReader plugin is updated and you start the app, the new version will be uploaded to S3 so you can use the updater plugin to easily update the core plugin without needing to manually move the files to your KOReader device.
 
 ### Concrete Usage
 - The Plugin can be found under "Settings" --> "More tools" --> "Sake"
-- Books are are downloaded when pressing "Sync Books now" or when setting the device to sleep
-- The progress gets automatically uploaded when putting the device to sleep and you are currently in the book (dont exit the book!)
-- If you use multiple devices, the progress needs to be manually downloadede with the "Sync progress now" button. (I had problems getting background sync to work, but im still working on it!)
-- Pressing "Export Existing Library" tries to upload every book and progress sidecar to the WebApp. This takes a while and the E-Reader is not usable before finishing!
-- Before using it you need to set the API URL (base url like, sake.yourdomain.com) and login to fetch the API Key. Your password will be removed from the device after logging in.
-- You can optionally change the auto generated device name. The device name will show up in the WebApp in the API-Key list and on the Book Detail you ("Downloaded on device x)
+- `Setup` contains `Server URL`, `Device Name`, and `Pair Device` / `Refresh Device Key`
+- `Sync` contains `Download New Books`, `Pull Progress From Other Devices`, and `Upload Current Book Progress`
+- Books are downloaded when pressing `Download New Books` or when setting the device to sleep
+- Progress is automatically uploaded when putting the device to sleep while a book is still open
+- If you use multiple devices, use `Pull Progress From Other Devices` to fetch newer progress from another reader
+- `Library Import/Export -> Import or Export Existing Library` uploads books already on the device, along with sidecar data such as progress and notes
+- Library import/export can take a while, and the device may be unusable until the process finishes
+- `Maintenance -> Check for Plugin Updates` checks for new plugin releases
+- `Maintenance -> Advanced -> Remote Log Shipping` toggles shipping KOReader logs back to Sake
+- Before using the plugin you need to set the server URL and pair the device. Your password is removed from the device after pairing succeeds.
+- You can optionally change the auto-generated device name. The device name shows up in the web app for device-specific downloads and API keys.
 
 ## Search providers and downloads
 

koreaderPlugins/sake.koplugin/_meta.lua

@@ -4,5 +4,5 @@ return {
     fullname = _("Sake"),
     description = _([[Svelte and Koreader Ecosystem - Syncs your books and progress.]]),
     author = "Sascha Lorenz",
-    version = "0.7.2",
+    version = "0.9.2",
 }

koreaderPlugins/sake.koplugin/controllers/library_export.lua

@@ -1,3 +1,4 @@
+local ConfirmBox = require("ui/widget/confirmbox")
 local InfoMessage = require("ui/widget/infomessage")
 local UIManager = require("ui/uimanager")
 local logger = require("core/log")
@@ -63,7 +64,7 @@ function LibraryExport:showError(message)
     })
 end
 
-function LibraryExport:start()
+function LibraryExport:startExport()
     logger.info("[Sake] Existing-library export started.")
 
     self.popup = InfoMessage:new{
@@ -104,6 +105,20 @@ function LibraryExport:start()
     end)
 end
 
+function LibraryExport:start()
+    UIManager:show(ConfirmBox:new{
+        text = _(
+            "Importing or exporting an existing library can take a while.\n"
+            .. "Your device may be unusable until the process finishes.\n\n"
+            .. "Do you want to continue?"
+        ),
+        ok_text = _("Continue"),
+        ok_callback = function()
+            self:startExport()
+        end,
+    })
+end
+
 function LibraryExport:startQueue(books, index, summary)
     closePopup(self)
 

koreaderPlugins/sake.koplugin/controllers/progress_sync.lua

@@ -59,6 +59,10 @@ function ProgressSync:syncCurrentBookProgress(opts)
     local ok_snapshot, snapshot_or_err = self.engine:prepareCurrentDocumentProgressSnapshot()
     if not ok_snapshot then
         if snapshot_or_err == "No document open" then
+            if opts and opts.no_remote_fallback then
+                logger.info(LOG_PREFIX .. "No document open. Skipping upload because remote fallback is disabled.")
+                return true, { no_document = true }
+            end
             logger.info(LOG_PREFIX .. "No document open. Running remote progress download sync.")
             return self:syncNewProgressForDevice(opts)
         end
@@ -85,6 +89,7 @@ function ProgressSync:syncCurrentBookProgress(opts)
         return true, {
             deferred = true,
             percent_finished = snapshot.percent_finished,
+            uploaded = false,
         }
     end
 
@@ -94,7 +99,10 @@ function ProgressSync:syncCurrentBookProgress(opts)
     end
 
     logger.info(LOG_PREFIX .. "Live percent_finished: " .. tostring(percent_finished_or_err))
-    return true
+    return true, {
+        uploaded = true,
+        percent_finished = percent_finished_or_err,
+    }
 end
 
 function ProgressSync:syncNewProgressForDevice(opts)

koreaderPlugins/sake.koplugin/core/settings.lua

@@ -45,22 +45,33 @@ end
 
 function Settings.validateRequired(settings)
     local missing = {}
-    if not settings.api_url or settings.api_url == "" then table.insert(missing, "API URL") end
+    if not settings.api_url or settings.api_url == "" then table.insert(missing, "Server URL") end
     if not settings.device_name or settings.device_name == "" then table.insert(missing, "Device Name") end
     local has_api_key = settings.api_key and settings.api_key ~= ""
-    if not has_api_key then
-        if not settings.api_user or settings.api_user == "" then table.insert(missing, "Login Username") end
-        if not settings.api_pass or settings.api_pass == "" then table.insert(missing, "Login Password") end
+    local has_pairing_credentials = settings.api_user and settings.api_user ~= ""
+        and settings.api_pass and settings.api_pass ~= ""
+    if not has_api_key and not has_pairing_credentials then
+        table.insert(missing, "Device Key")
     end
     if #missing > 0 then
         return false, table.concat(missing, ", ")
     end
     return true
 end
 
+function Settings.validatePairingSetup(settings)
+    local missing = {}
+    if not settings.api_url or settings.api_url == "" then table.insert(missing, "Server URL") end
+    if not settings.device_name or settings.device_name == "" then table.insert(missing, "Device Name") end
+    if #missing > 0 then
+        return false, table.concat(missing, ", ")
+    end
+    return true
+end
+
 function Settings.validatePairingRequired(settings)
     local missing = {}
-    if not settings.api_url or settings.api_url == "" then table.insert(missing, "API URL") end
+    if not settings.api_url or settings.api_url == "" then table.insert(missing, "Server URL") end
     if not settings.api_user or settings.api_user == "" then table.insert(missing, "Login Username") end
     if not settings.api_pass or settings.api_pass == "" then table.insert(missing, "Login Password") end
     if not settings.device_name or settings.device_name == "" then table.insert(missing, "Device Name") end