6e4d0e534d
## Summary
* This PR introduces a migration from binary file storage to JSON-based
storage for application settings, state, and various credential stores.
This improves readability, maintainability, and allows for easier manual
configuration editing.
* Benefits:
- Settings files are now JSON and can be easily read/edited manually
- Easier to inspect application state and settings during development
- JSON structure is more flexible for future changes
* Drawback: around 15k of additional flash usage
* Compatibility: Seamless migration preserves existing user data
## Additional Context
1. New JSON I/O Infrastructure files:
- JsonSettingsIO: Core JSON serialization/deserialization logic using
ArduinoJson library
- ObfuscationUtils: XOR-based password obfuscation for sensitive data
2. Migrated Components (now use JSON storage with automatic binary
migration):
- CrossPointSettings (settings.json): Main application settings
- CrossPointState (state.json): Application state (open book, sleep
mode, etc.)
- WifiCredentialStore (wifi.json): WiFi network credentials (Password
Obfuscation: Sensitive data like WiFi passwords, uses XOR encryption
with fixed keys. Note: This is obfuscation, not cryptographic security -
passwords can be recovered with the key)
- KOReaderCredentialStore (koreader.json): KOReader sync credentials
- RecentBooksStore (recent.json): Recently opened books list
3. Migration Logic
- Forward Compatibility: New installations use JSON format
- Backward Compatibility: Existing binary files are automatically
migrated to JSON on first load
- Backup Safety: Original binary files are renamed with .bak extension
after successful migration
- Fallback Handling: If JSON parsing fails, system falls back to binary
loading
4. Infrastructure Updates
- HalStorage: Added rename() method for backup operations
---
### AI Usage
While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.
Did you use AI tools to help write this code? _** YES**_
---------
Co-authored-by: Dave Allie <dave@daveallie.com>
79 lines
2.8 KiB
C++
79 lines
2.8 KiB
C++
#pragma once
|
|
#include <cstdint>
|
|
#include <string>
|
|
|
|
// Document matching method for KOReader sync
|
|
enum class DocumentMatchMethod : uint8_t {
|
|
FILENAME = 0, // Match by filename (simpler, works across different file sources)
|
|
BINARY = 1, // Match by partial MD5 of file content (more accurate, but files must be identical)
|
|
};
|
|
|
|
class KOReaderCredentialStore;
|
|
namespace JsonSettingsIO {
|
|
bool saveKOReader(const KOReaderCredentialStore& store, const char* path);
|
|
bool loadKOReader(KOReaderCredentialStore& store, const char* json, bool* needsResave);
|
|
} // namespace JsonSettingsIO
|
|
|
|
/**
|
|
* Singleton class for storing KOReader sync credentials on the SD card.
|
|
* Passwords are XOR-obfuscated with the device's unique hardware MAC address
|
|
* and base64-encoded before writing to JSON (not cryptographically secure,
|
|
* but prevents casual reading and ties credentials to the specific device).
|
|
*/
|
|
class KOReaderCredentialStore {
|
|
private:
|
|
static KOReaderCredentialStore instance;
|
|
std::string username;
|
|
std::string password;
|
|
std::string serverUrl; // Custom sync server URL (empty = default)
|
|
DocumentMatchMethod matchMethod = DocumentMatchMethod::FILENAME; // Default to filename for compatibility
|
|
|
|
// Private constructor for singleton
|
|
KOReaderCredentialStore() = default;
|
|
|
|
bool loadFromBinaryFile();
|
|
|
|
friend bool JsonSettingsIO::saveKOReader(const KOReaderCredentialStore&, const char*);
|
|
friend bool JsonSettingsIO::loadKOReader(KOReaderCredentialStore&, const char*, bool*);
|
|
|
|
public:
|
|
// Delete copy constructor and assignment
|
|
KOReaderCredentialStore(const KOReaderCredentialStore&) = delete;
|
|
KOReaderCredentialStore& operator=(const KOReaderCredentialStore&) = delete;
|
|
|
|
// Get singleton instance
|
|
static KOReaderCredentialStore& getInstance() { return instance; }
|
|
|
|
// Save/load from SD card
|
|
bool saveToFile() const;
|
|
bool loadFromFile();
|
|
|
|
// Credential management
|
|
void setCredentials(const std::string& user, const std::string& pass);
|
|
const std::string& getUsername() const { return username; }
|
|
const std::string& getPassword() const { return password; }
|
|
|
|
// Get MD5 hash of password for API authentication
|
|
std::string getMd5Password() const;
|
|
|
|
// Check if credentials are set
|
|
bool hasCredentials() const;
|
|
|
|
// Clear credentials
|
|
void clearCredentials();
|
|
|
|
// Server URL management
|
|
void setServerUrl(const std::string& url);
|
|
const std::string& getServerUrl() const { return serverUrl; }
|
|
|
|
// Get base URL for API calls (with http:// normalization if no protocol, falls back to default)
|
|
std::string getBaseUrl() const;
|
|
|
|
// Document matching method
|
|
void setMatchMethod(DocumentMatchMethod method);
|
|
DocumentMatchMethod getMatchMethod() const { return matchMethod; }
|
|
};
|
|
|
|
// Helper macro to access credential store
|
|
#define KOREADER_STORE KOReaderCredentialStore::getInstance()
|