trilwu
10ea651e26
The Arduino WiFiClientSecure allocates 16KB TLS buffers by default, which exhausts the ESP32-C3's limited heap (~46KB free after WiFi) during the TLS handshake. This causes KOReader sync to fail silently or crash on HTTPS servers (including the default sync.koreader.rocks). Replace WiFiClientSecure/HTTPClient with esp_http_client (ESP-IDF), which supports configurable buffer sizes. Use 2KB TLS buffers — more than sufficient for KOSync's tiny JSON payloads (<1KB). Also: - Use esp_crt_bundle for proper TLS certificate verification instead of setInsecure() - Strip trailing slashes from server URL to prevent double-slash in API paths - Add lastHttpCode for diagnostics - Add heap logging to help debug memory issues Fixes #581 (cherry picked from commit 835abc19ff14fcbea8571ccb0dfd8d21e882b84c)
81 lines
2.2 KiB
C++
81 lines
2.2 KiB
C++
#pragma once
|
|
#include <string>
|
|
|
|
/**
|
|
* Progress data from KOReader sync server.
|
|
*/
|
|
struct KOReaderProgress {
|
|
std::string document; // Document hash
|
|
std::string progress; // XPath-like progress string
|
|
float percentage; // Progress percentage (0.0 to 1.0)
|
|
std::string device; // Device name
|
|
std::string deviceId; // Device ID
|
|
int64_t timestamp; // Unix timestamp of last update
|
|
};
|
|
|
|
/**
|
|
* HTTP client for KOReader sync API.
|
|
*
|
|
* Base URL: https://sync.koreader.rocks:443/
|
|
*
|
|
* API Endpoints:
|
|
* POST /users/create - Register a new user
|
|
* GET /users/auth - Authenticate (validate credentials)
|
|
* GET /syncs/progress/:document - Get progress for a document
|
|
* PUT /syncs/progress - Update progress for a document
|
|
*
|
|
* Authentication:
|
|
* x-auth-user: username
|
|
* x-auth-key: MD5 hash of password
|
|
*/
|
|
class KOReaderSyncClient {
|
|
public:
|
|
enum Error {
|
|
OK = 0,
|
|
NO_CREDENTIALS,
|
|
NETWORK_ERROR,
|
|
AUTH_FAILED,
|
|
SERVER_ERROR,
|
|
JSON_ERROR,
|
|
NOT_FOUND,
|
|
USER_EXISTS,
|
|
REGISTRATION_DISABLED
|
|
};
|
|
|
|
/**
|
|
* Register a new user account with the sync server.
|
|
* Uses credentials already stored in KOReaderCredentialStore.
|
|
* @return OK on success, USER_EXISTS if taken, REGISTRATION_DISABLED if server disallows it
|
|
*/
|
|
static Error registerUser();
|
|
|
|
/**
|
|
* Authenticate with the sync server (validate credentials).
|
|
* @return OK on success, error code on failure
|
|
*/
|
|
static Error authenticate();
|
|
|
|
/**
|
|
* Get reading progress for a document.
|
|
* @param documentHash The document hash (from KOReaderDocumentId)
|
|
* @param outProgress Output: the progress data
|
|
* @return OK on success, NOT_FOUND if no progress exists, error code on failure
|
|
*/
|
|
static Error getProgress(const std::string& documentHash, KOReaderProgress& outProgress);
|
|
|
|
/**
|
|
* Update reading progress for a document.
|
|
* @param progress The progress data to upload
|
|
* @return OK on success, error code on failure
|
|
*/
|
|
static Error updateProgress(const KOReaderProgress& progress);
|
|
|
|
/**
|
|
* Get human-readable error message.
|
|
*/
|
|
static const char* errorString(Error error);
|
|
|
|
/** HTTP status code from the last request (for diagnostics). */
|
|
static int lastHttpCode;
|
|
};
|