Expose GitHub Sync credentials (username/PAT/repo/branch) via the web UI by moving them into CrossPointSettings, and fix Lockscreen incorrectly triggering on silent internal reboots (File Transfer/OPDS exit) instead of only on real wake/power-on
This commit is contained in:
Sterling Archer
@@ -1,41 +1,44 @@
|
||||
#include "GitHubSync.h"
|
||||
#include <HTTPClient.h>
|
||||
#include <ArduinoJson.h>
|
||||
#include <Preferences.h>
|
||||
#include <WiFi.h>
|
||||
#include <Logging.h>
|
||||
#include "CrossPointSettings.h"
|
||||
#include "SDCardManager.h"
|
||||
|
||||
#define GH_PREFS_NS "github_sync"
|
||||
#define GH_KEY_USER "username"
|
||||
#define GH_KEY_PAT "pat"
|
||||
#define GH_KEY_REPO "repo"
|
||||
#define GH_KEY_BRANCH "branch"
|
||||
#define GH_SHA_DIR "/.crosspoint/github_sha/"
|
||||
#define GH_BOOKS_DIR "/"
|
||||
#define GH_SLEEP_BMP "sleep.bmp"
|
||||
#define GH_SLEEP_PATH "/sleep.bmp"
|
||||
#define GH_API_BASE "https://api.github.com"
|
||||
|
||||
namespace {
|
||||
void setField(char* field, size_t fieldSize, const std::string& value) {
|
||||
strncpy(field, value.c_str(), fieldSize - 1);
|
||||
field[fieldSize - 1] = '\0';
|
||||
}
|
||||
} // namespace
|
||||
|
||||
// Config now lives in CrossPointSettings (persisted via SETTINGS.saveToFile()/
|
||||
// loadFromFile(), same as every other plugin setting) instead of a private NVS
|
||||
// namespace, so it's reachable through the standard settings list - which is
|
||||
// what makes it show up in the web UI's Settings page alongside Dark Mode,
|
||||
// Smaller Fonts, etc. On-device editing via GitHubSyncSettingsActivity is
|
||||
// unaffected since it only goes through this struct-based API.
|
||||
bool GitHubSync::loadConfig(GitHubSyncConfig &cfg) {
|
||||
Preferences prefs;
|
||||
prefs.begin(GH_PREFS_NS, true);
|
||||
cfg.username = prefs.getString(GH_KEY_USER, "").c_str();
|
||||
cfg.pat = prefs.getString(GH_KEY_PAT, "").c_str();
|
||||
cfg.repo = prefs.getString(GH_KEY_REPO, "xteink").c_str();
|
||||
cfg.branch = prefs.getString(GH_KEY_BRANCH, "main").c_str();
|
||||
prefs.end();
|
||||
cfg.username = SETTINGS.githubUsername;
|
||||
cfg.pat = SETTINGS.githubPat;
|
||||
cfg.repo = SETTINGS.githubRepo[0] ? SETTINGS.githubRepo : "xteink";
|
||||
cfg.branch = SETTINGS.githubBranch[0] ? SETTINGS.githubBranch : "main";
|
||||
return !cfg.username.empty() && !cfg.pat.empty();
|
||||
}
|
||||
|
||||
void GitHubSync::saveConfig(const GitHubSyncConfig &cfg) {
|
||||
Preferences prefs;
|
||||
prefs.begin(GH_PREFS_NS, false);
|
||||
prefs.putString(GH_KEY_USER, cfg.username.c_str());
|
||||
prefs.putString(GH_KEY_PAT, cfg.pat.c_str());
|
||||
prefs.putString(GH_KEY_REPO, cfg.repo.c_str());
|
||||
prefs.putString(GH_KEY_BRANCH, cfg.branch.c_str());
|
||||
prefs.end();
|
||||
setField(SETTINGS.githubUsername, sizeof(SETTINGS.githubUsername), cfg.username);
|
||||
setField(SETTINGS.githubPat, sizeof(SETTINGS.githubPat), cfg.pat);
|
||||
setField(SETTINGS.githubRepo, sizeof(SETTINGS.githubRepo), cfg.repo);
|
||||
setField(SETTINGS.githubBranch, sizeof(SETTINGS.githubBranch), cfg.branch);
|
||||
SETTINGS.saveToFile();
|
||||
}
|
||||
|
||||
bool GitHubSync::isConfigured() {
|
||||
|
||||
@@ -3,7 +3,7 @@ import os
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))))
|
||||
from framework.manifest import (
|
||||
PluginManifest, SourceFile, Include, SettingActionEnumValue, PluginsTabEntry, MainHook,
|
||||
PluginManifest, SourceFile, Include, SettingsField, SettingActionEnumValue, PluginsTabEntry, MainHook,
|
||||
)
|
||||
|
||||
# NOTE on scope: the original patch.py also pre-provisioned GitHub credentials
|
||||
@@ -11,10 +11,16 @@ from framework.manifest import (
|
||||
# generated nvs.csv + `esptool ... write-flash 0x3000`), so users wouldn't
|
||||
# have to type a PAT on-device. That's flash-time, not source-patch-time
|
||||
# logic, and GitHubSyncSettingsActivity already lets you configure
|
||||
# username/PAT/repo/branch on-device (or you can add web-UI editing later),
|
||||
# so this rewrite drops the NVS pre-seeding step for simplicity/safety and
|
||||
# has you configure GitHub Sync via Settings -> Plugins -> GitHub Sync after
|
||||
# first boot instead. Ask if you want the NVS pre-seeding restored.
|
||||
# username/PAT/repo/branch on-device, so this rewrite drops the NVS
|
||||
# pre-seeding step for simplicity/safety and has you configure GitHub Sync
|
||||
# via Settings -> Plugins -> GitHub Sync after first boot instead. Ask if you
|
||||
# want the NVS pre-seeding restored.
|
||||
#
|
||||
# Config now lives in CrossPointSettings (char fields below) rather than a
|
||||
# private NVS namespace, so it also shows up as editable text fields in the
|
||||
# web UI's Settings -> Plugins section, same mechanism as Hardcover's API
|
||||
# token - GitHubSync.cpp's loadConfig()/saveConfig() read/write these fields
|
||||
# directly instead of the old Preferences-based store.
|
||||
#
|
||||
# Also fixed in this rewrite: the original main.cpp hook only ran
|
||||
# GitHubSync::sync() inside one narrow boot branch (quick-resume-with-no-
|
||||
@@ -38,6 +44,12 @@ def get_manifest(ctx):
|
||||
Include("GitHubSyncSettingsActivity.h", "settings_activity_cpp"),
|
||||
Include("activities/settings/GitHubSync.h", "main_cpp"),
|
||||
],
|
||||
settings_fields=[
|
||||
SettingsField('char githubUsername[64] = "";'),
|
||||
SettingsField('char githubPat[256] = "";'),
|
||||
SettingsField('char githubRepo[64] = "xteink";'),
|
||||
SettingsField('char githubBranch[32] = "main";'),
|
||||
],
|
||||
setting_actions=[
|
||||
SettingActionEnumValue("GitHubSync"),
|
||||
],
|
||||
@@ -49,6 +61,35 @@ def get_manifest(ctx):
|
||||
action_value_text="Sync",
|
||||
activity_launch_expr="std::make_unique<GitHubSyncSettingsActivity>(renderer, mappedInput)",
|
||||
),
|
||||
# show_on_device=False: the device already edits these through the
|
||||
# GitHub Sync activity above, so a second on-device row would just
|
||||
# be redundant. hidden_from_web is left at its default (False) so
|
||||
# they show up as text fields in the web UI's Plugins section.
|
||||
PluginsTabEntry(
|
||||
label="GitHub Username",
|
||||
kind="string",
|
||||
key="githubUsername",
|
||||
show_on_device=False,
|
||||
),
|
||||
PluginsTabEntry(
|
||||
label="GitHub Personal Access Token",
|
||||
kind="string",
|
||||
key="githubPat",
|
||||
obfuscated=True,
|
||||
show_on_device=False,
|
||||
),
|
||||
PluginsTabEntry(
|
||||
label="GitHub Repo",
|
||||
kind="string",
|
||||
key="githubRepo",
|
||||
show_on_device=False,
|
||||
),
|
||||
PluginsTabEntry(
|
||||
label="GitHub Branch",
|
||||
kind="string",
|
||||
key="githubBranch",
|
||||
show_on_device=False,
|
||||
),
|
||||
],
|
||||
main_hooks=[
|
||||
MainHook(
|
||||
|
||||
Reference in New Issue
Block a user