## Summary * **What is the goal of this PR?** Fix KOSync failing with "Network error" on large/complex EPUBs, and simplify the sync navigation flow by removing the callback/result pattern. * **What changes are included?** This PR combines the approaches from #1855 and #1760 into a single, cleaner solution: **Memory fix (from #1855):** - `EpubReaderActivity` pre-computes the local KOReader position and chapter name, then explicitly releases `epub` and `section` before launching `KOReaderSyncActivity`. This frees ~65KB measured on device, giving the TLS handshake sufficient heap. The root cause was `MBEDTLS_ERR_X509_ALLOC_FAILED` (-0x2880) when a 3-cert chain consumed ~48KB during the handshake with only ~50KB available. - `KOReaderSyncActivity` no longer receives a `shared_ptr<Epub>` at construction — it lazy-loads the Epub after TLS only if remote progress is found (`ensureEpubLoaded()`). - Added `MIN_HEAP_FOR_TLS = 55000` guard in `KOReaderSyncClient` — returns `LOW_MEMORY` early if aggregate free heap is too low before attempting a TLS connection. **Navigation simplification (from #1760):** - Replaced `startActivityForResult` + callback with `activityManager.replaceActivity` / `activityManager.goToReader`. Progress is saved to `progress.bin` before the epub is released (cancel/upload paths) and in `saveProgressAndReturn` (apply remote path). The reader re-launches from the saved position naturally via `goToReader`, eliminating the need to reload the epub in a callback. - Extracted `ReaderUtils::saveProgress()` as a shared helper used by both `EpubReaderActivity` and `KOReaderSyncActivity`. - Added `STR_SAVE_PROGRESS_FAILED` to all 22 language files for the case where writing the synced position to SD fails. **Orientation fix (found during device testing):** - `EpubReaderActivity::onExit()` resets the renderer to portrait before destruction. With `replaceActivity` the reader is fully torn down before KOSync starts, so KOSync was always rendering in portrait even when reading in landscape. Fixed by calling `ReaderUtils::applyOrientation` in `KOReaderSyncActivity::onEnter()`. ## Additional Context Heap measurements on device (large EPUB with complex CSS): | Metric | Before | After | |---|---|---| | Heap before Epub release | 88,156 bytes | — | | Heap after Epub release | — | 153,892 bytes (+65,736) | | Heap at TLS handshake | ~50,000 bytes (fails) | ~116,384 bytes (passes) | | Min-free-ever during sync session | 2,600 bytes | 33,052 bytes | | TLS result | `MBEDTLS_ERR_X509_ALLOC_FAILED` | HTTP 200 | Tested on device: sync from inside a large EPUB in both portrait and landscape, cancel, apply remote progress, upload local progress. --- ### AI Usage Did you use AI tools to help write this code? _**YES**_ --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
264 lines
9.0 KiB
C++
264 lines
9.0 KiB
C++
#include "KOReaderSyncClient.h"
|
|
|
|
#include <ArduinoJson.h>
|
|
#include <Logging.h>
|
|
#include <base64.h>
|
|
#include <esp_crt_bundle.h>
|
|
#include <esp_http_client.h>
|
|
|
|
#include <ctime>
|
|
|
|
#include "KOReaderCredentialStore.h"
|
|
|
|
int KOReaderSyncClient::lastHttpCode = 0;
|
|
|
|
namespace {
|
|
// Device identifier for CrossPoint reader
|
|
constexpr char DEVICE_NAME[] = "CrossPoint";
|
|
constexpr char DEVICE_ID[] = "crosspoint-reader";
|
|
|
|
// Small TLS buffers to fit in ESP32-C3's limited heap (~46KB free after WiFi).
|
|
// KOSync payloads are tiny JSON (<1KB), so 2KB buffers are sufficient.
|
|
// Default 16KB buffers cause OOM during TLS handshake.
|
|
constexpr int HTTP_BUF_SIZE = 2048;
|
|
|
|
// Cloudflare tunnels send a 3-cert Google Trust Services chain. During the TLS handshake
|
|
// mbedTLS makes many small allocations that collectively consume ~48KB of heap. With only
|
|
// ~50KB free after WiFi connects, the session drove min-free-ever down to 2600 bytes before
|
|
// failing with MBEDTLS_ERR_X509_ALLOC_FAILED (-0x2880). Check total free heap (not max
|
|
// contiguous block) because the failure mode is aggregate exhaustion, not one large alloc.
|
|
constexpr uint32_t MIN_HEAP_FOR_TLS = 55000;
|
|
|
|
// Response buffer for reading HTTP body
|
|
struct ResponseBuffer {
|
|
char* data = nullptr;
|
|
int len = 0;
|
|
int capacity = 0;
|
|
|
|
~ResponseBuffer() { free(data); }
|
|
|
|
bool ensure(int size) {
|
|
if (size <= capacity) return true;
|
|
char* newData = (char*)realloc(data, size);
|
|
if (!newData) return false;
|
|
data = newData;
|
|
capacity = size;
|
|
return true;
|
|
}
|
|
};
|
|
|
|
// HTTP event handler to collect response body
|
|
esp_err_t httpEventHandler(esp_http_client_event_t* evt) {
|
|
auto* buf = static_cast<ResponseBuffer*>(evt->user_data);
|
|
if (evt->event_id == HTTP_EVENT_ON_DATA && buf) {
|
|
if (buf->ensure(buf->len + evt->data_len + 1)) {
|
|
memcpy(buf->data + buf->len, evt->data, evt->data_len);
|
|
buf->len += evt->data_len;
|
|
buf->data[buf->len] = '\0';
|
|
} else {
|
|
LOG_ERR("KOSync", "Response buffer allocation failed (%d bytes)", evt->data_len);
|
|
}
|
|
}
|
|
return ESP_OK;
|
|
}
|
|
|
|
// Create configured esp_http_client with small TLS buffers
|
|
esp_http_client_handle_t createClient(const char* url, ResponseBuffer* buf,
|
|
esp_http_client_method_t method = HTTP_METHOD_GET) {
|
|
esp_http_client_config_t config = {};
|
|
config.url = url;
|
|
config.event_handler = httpEventHandler;
|
|
config.user_data = buf;
|
|
config.method = method;
|
|
config.timeout_ms = 15000;
|
|
config.buffer_size = HTTP_BUF_SIZE;
|
|
config.buffer_size_tx = HTTP_BUF_SIZE;
|
|
config.crt_bundle_attach = esp_crt_bundle_attach;
|
|
|
|
esp_http_client_handle_t client = esp_http_client_init(&config);
|
|
if (!client) return nullptr;
|
|
|
|
// KOSync auth headers
|
|
if (esp_http_client_set_header(client, "Accept", "application/vnd.koreader.v1+json") != ESP_OK ||
|
|
esp_http_client_set_header(client, "x-auth-user", KOREADER_STORE.getUsername().c_str()) != ESP_OK ||
|
|
esp_http_client_set_header(client, "x-auth-key", KOREADER_STORE.getMd5Password().c_str()) != ESP_OK) {
|
|
LOG_ERR("KOSync", "Failed to set auth headers");
|
|
esp_http_client_cleanup(client);
|
|
return nullptr;
|
|
}
|
|
|
|
// HTTP Basic Auth for Calibre-Web-Automated compatibility
|
|
std::string credentials = KOREADER_STORE.getUsername() + ":" + KOREADER_STORE.getPassword();
|
|
String encoded = base64::encode(reinterpret_cast<const uint8_t*>(credentials.data()), credentials.size());
|
|
std::string authHeader = "Basic " + std::string(encoded.c_str());
|
|
if (esp_http_client_set_header(client, "Authorization", authHeader.c_str()) != ESP_OK) {
|
|
LOG_ERR("KOSync", "Failed to set Authorization header");
|
|
esp_http_client_cleanup(client);
|
|
return nullptr;
|
|
}
|
|
|
|
return client;
|
|
}
|
|
} // namespace
|
|
|
|
KOReaderSyncClient::Error KOReaderSyncClient::authenticate() {
|
|
lastHttpCode = 0;
|
|
if (!KOREADER_STORE.hasCredentials()) {
|
|
LOG_DBG("KOSync", "No credentials configured");
|
|
return NO_CREDENTIALS;
|
|
}
|
|
|
|
std::string url = KOREADER_STORE.getBaseUrl() + "/users/auth";
|
|
const uint32_t freeHeap = ESP.getFreeHeap();
|
|
LOG_DBG("KOSync", "Authenticating: %s (heap: %u)", url.c_str(), (unsigned)freeHeap);
|
|
if (freeHeap < MIN_HEAP_FOR_TLS) {
|
|
LOG_ERR("KOSync", "Insufficient heap for TLS handshake: %u bytes free (need %u)", freeHeap, MIN_HEAP_FOR_TLS);
|
|
return LOW_MEMORY;
|
|
}
|
|
|
|
ResponseBuffer buf;
|
|
esp_http_client_handle_t client = createClient(url.c_str(), &buf);
|
|
if (!client) return NETWORK_ERROR;
|
|
|
|
esp_err_t err = esp_http_client_perform(client);
|
|
const int httpCode = esp_http_client_get_status_code(client);
|
|
lastHttpCode = httpCode;
|
|
esp_http_client_cleanup(client);
|
|
|
|
LOG_DBG("KOSync", "Auth response: %d (err: %d)", httpCode, err);
|
|
|
|
if (err != ESP_OK) return NETWORK_ERROR;
|
|
if (httpCode == 200) return OK;
|
|
if (httpCode == 401) return AUTH_FAILED;
|
|
return SERVER_ERROR;
|
|
}
|
|
|
|
KOReaderSyncClient::Error KOReaderSyncClient::getProgress(const std::string& documentHash,
|
|
KOReaderProgress& outProgress) {
|
|
lastHttpCode = 0;
|
|
if (!KOREADER_STORE.hasCredentials()) {
|
|
LOG_DBG("KOSync", "No credentials configured");
|
|
return NO_CREDENTIALS;
|
|
}
|
|
|
|
std::string url = KOREADER_STORE.getBaseUrl() + "/syncs/progress/" + documentHash;
|
|
const uint32_t freeHeap = ESP.getFreeHeap();
|
|
LOG_DBG("KOSync", "Getting progress: %s (heap: %u)", url.c_str(), (unsigned)freeHeap);
|
|
if (freeHeap < MIN_HEAP_FOR_TLS) {
|
|
LOG_ERR("KOSync", "Insufficient heap for TLS handshake: %u bytes free (need %u)", freeHeap, MIN_HEAP_FOR_TLS);
|
|
return LOW_MEMORY;
|
|
}
|
|
|
|
ResponseBuffer buf;
|
|
esp_http_client_handle_t client = createClient(url.c_str(), &buf);
|
|
if (!client) return NETWORK_ERROR;
|
|
|
|
esp_err_t err = esp_http_client_perform(client);
|
|
const int httpCode = esp_http_client_get_status_code(client);
|
|
lastHttpCode = httpCode;
|
|
esp_http_client_cleanup(client);
|
|
|
|
LOG_DBG("KOSync", "Get progress response: %d (err: %d)", httpCode, err);
|
|
|
|
if (err != ESP_OK) return NETWORK_ERROR;
|
|
|
|
if (httpCode == 200 && buf.data) {
|
|
JsonDocument doc;
|
|
const DeserializationError error = deserializeJson(doc, buf.data);
|
|
|
|
if (error) {
|
|
LOG_ERR("KOSync", "JSON parse failed: %s", error.c_str());
|
|
return JSON_ERROR;
|
|
}
|
|
|
|
outProgress.document = documentHash;
|
|
outProgress.progress = doc["progress"].as<std::string>();
|
|
outProgress.percentage = doc["percentage"].as<float>();
|
|
outProgress.device = doc["device"].as<std::string>();
|
|
outProgress.deviceId = doc["device_id"].as<std::string>();
|
|
outProgress.timestamp = doc["timestamp"].as<int64_t>();
|
|
|
|
LOG_DBG("KOSync", "Got progress: %.2f%% at %s", outProgress.percentage * 100, outProgress.progress.c_str());
|
|
return OK;
|
|
}
|
|
|
|
if (httpCode == 401) return AUTH_FAILED;
|
|
if (httpCode == 404) return NOT_FOUND;
|
|
return SERVER_ERROR;
|
|
}
|
|
|
|
KOReaderSyncClient::Error KOReaderSyncClient::updateProgress(const KOReaderProgress& progress) {
|
|
lastHttpCode = 0;
|
|
if (!KOREADER_STORE.hasCredentials()) {
|
|
LOG_DBG("KOSync", "No credentials configured");
|
|
return NO_CREDENTIALS;
|
|
}
|
|
|
|
std::string url = KOREADER_STORE.getBaseUrl() + "/syncs/progress";
|
|
const uint32_t freeHeap = ESP.getFreeHeap();
|
|
LOG_DBG("KOSync", "Updating progress: %s (heap: %u)", url.c_str(), (unsigned)freeHeap);
|
|
if (freeHeap < MIN_HEAP_FOR_TLS) {
|
|
LOG_ERR("KOSync", "Insufficient heap for TLS handshake: %u bytes free (need %u)", freeHeap, MIN_HEAP_FOR_TLS);
|
|
return LOW_MEMORY;
|
|
}
|
|
|
|
// Build JSON body
|
|
JsonDocument doc;
|
|
doc["document"] = progress.document;
|
|
doc["progress"] = progress.progress;
|
|
doc["percentage"] = progress.percentage;
|
|
doc["device"] = DEVICE_NAME;
|
|
doc["device_id"] = DEVICE_ID;
|
|
|
|
std::string body;
|
|
serializeJson(doc, body);
|
|
|
|
LOG_DBG("KOSync", "Request body: %s", body.c_str());
|
|
|
|
ResponseBuffer buf;
|
|
esp_http_client_handle_t client = createClient(url.c_str(), &buf, HTTP_METHOD_PUT);
|
|
if (!client) return NETWORK_ERROR;
|
|
|
|
if (esp_http_client_set_header(client, "Content-Type", "application/json") != ESP_OK ||
|
|
esp_http_client_set_post_field(client, body.c_str(), body.length()) != ESP_OK) {
|
|
LOG_ERR("KOSync", "Failed to set request body");
|
|
esp_http_client_cleanup(client);
|
|
return NETWORK_ERROR;
|
|
}
|
|
|
|
esp_err_t err = esp_http_client_perform(client);
|
|
const int httpCode = esp_http_client_get_status_code(client);
|
|
lastHttpCode = httpCode;
|
|
esp_http_client_cleanup(client);
|
|
|
|
LOG_DBG("KOSync", "Update progress response: %d (err: %d)", httpCode, err);
|
|
|
|
if (err != ESP_OK) return NETWORK_ERROR;
|
|
if (httpCode == 200 || httpCode == 202) return OK;
|
|
if (httpCode == 401) return AUTH_FAILED;
|
|
return SERVER_ERROR;
|
|
}
|
|
|
|
const char* KOReaderSyncClient::errorString(Error error) {
|
|
switch (error) {
|
|
case OK:
|
|
return "Success";
|
|
case NO_CREDENTIALS:
|
|
return "No credentials configured";
|
|
case NETWORK_ERROR:
|
|
return "Network error";
|
|
case AUTH_FAILED:
|
|
return "Authentication failed";
|
|
case SERVER_ERROR:
|
|
return "Server error (try again later)";
|
|
case JSON_ERROR:
|
|
return "JSON parse error";
|
|
case NOT_FOUND:
|
|
return "No progress found";
|
|
case LOW_MEMORY:
|
|
return "Not enough memory for sync — please retry";
|
|
default:
|
|
return "Unknown error";
|
|
}
|
|
}
|