From 2de44ed5d94cc88378b261cebd53c9aa8c4a992e Mon Sep 17 00:00:00 2001 From: Maxim Prokhorov Date: Wed, 31 Mar 2021 05:06:47 +0300 Subject: [PATCH] ntp: remove legacy module --- code/espurna/config/dependencies.h | 9 - code/espurna/libs/SecureClientHelpers.h | 6 +- code/espurna/ntp.cpp | 4 +- code/espurna/ntp_legacy.cpp | 313 ------------------------ code/espurna/rpnrules.cpp | 34 +-- code/espurna/scheduler.cpp | 19 -- code/espurna/utils.cpp | 4 +- 7 files changed, 5 insertions(+), 384 deletions(-) delete mode 100644 code/espurna/ntp_legacy.cpp diff --git a/code/espurna/config/dependencies.h b/code/espurna/config/dependencies.h index 0dc575d4..43319e0a 100644 --- a/code/espurna/config/dependencies.h +++ b/code/espurna/config/dependencies.h @@ -172,15 +172,6 @@ #define SSDP_SUPPORT 0 #endif -//------------------------------------------------------------------------------ -// Change ntp module depending on Core version - -#if NTP_SUPPORT && defined(ARDUINO_ESP8266_RELEASE_2_3_0) -#define NTP_LEGACY_SUPPORT 1 -#else -#define NTP_LEGACY_SUPPORT 0 -#endif - //------------------------------------------------------------------------------ // It looks more natural that one click will enable display // and long click will switch relay diff --git a/code/espurna/libs/SecureClientHelpers.h b/code/espurna/libs/SecureClientHelpers.h index 2748910a..71596813 100644 --- a/code/espurna/libs/SecureClientHelpers.h +++ b/code/espurna/libs/SecureClientHelpers.h @@ -191,11 +191,7 @@ struct SecureClientChecks { client.setFingerprint(_buffer); } } else if (check == SECURE_CLIENT_CHECK_CA) { - #if NTP_LEGACY_SUPPORT - client.setX509Time(ntpLocal2UTC(now())); - #else - client.setX509Time(now()); - #endif + client.setX509Time(now()); if (!certs.getCount()) { if (config.on_certificate) certs.append(config.on_certificate()); } diff --git a/code/espurna/ntp.cpp b/code/espurna/ntp.cpp index 756cafbe..9c3e23ea 100644 --- a/code/espurna/ntp.cpp +++ b/code/espurna/ntp.cpp @@ -13,7 +13,7 @@ Copyright (C) 2019 by Maxim Prokhorov #include "ntp.h" -#if NTP_SUPPORT && !NTP_LEGACY_SUPPORT +#if NTP_SUPPORT #include #include @@ -503,4 +503,4 @@ void ntpSetup() { } -#endif // NTP_SUPPORT && !NTP_LEGACY_SUPPORT +#endif // NTP_SUPPORT diff --git a/code/espurna/ntp_legacy.cpp b/code/espurna/ntp_legacy.cpp deleted file mode 100644 index 7eb4c49a..00000000 --- a/code/espurna/ntp_legacy.cpp +++ /dev/null @@ -1,313 +0,0 @@ -/* - -NTP MODULE (based on NtpClientLib) - -Copyright (C) 2016-2019 by Xose Pérez - -*/ - -#include "ntp.h" - -#if NTP_LEGACY_SUPPORT && NTP_SUPPORT - -#include -#include -#include - -#include - -#include "debug.h" -#include "broker.h" -#include "ws.h" - -BrokerBind(NtpBroker); - -Ticker _ntp_defer; - -bool _ntp_report = false; -bool _ntp_configure = false; -bool _ntp_want_sync = false; - -// ----------------------------------------------------------------------------- -// NtpClient overrides to avoid triggering network sync -// ----------------------------------------------------------------------------- - -class NTPClientWrap : public NTPClient { - -public: - - NTPClientWrap() : NTPClient() { - udp = new WiFiUDP(); - _lastSyncd = 0; - } - - bool setInterval(int shortInterval, int longInterval) { - _shortInterval = shortInterval; - _longInterval = longInterval; - return true; - } - -}; - -// NOTE: original NTP should be discarded by the linker -// TODO: allow NTP client object to be destroyed -static NTPClientWrap NTPw; - -// ----------------------------------------------------------------------------- -// NTP -// ----------------------------------------------------------------------------- - -#if WEB_SUPPORT - -bool _ntpWebSocketOnKeyCheck(const char * key, JsonVariant& value) { - return (strncmp(key, "ntp", 3) == 0); -} - -void _ntpWebSocketOnVisible(JsonObject& root) { - root["ntpVisible"] = 1; - root["ntplegacyVisible"] = 1; -} - -void _ntpWebSocketOnData(JsonObject& root) { - root["ntpStatus"] = (timeStatus() == timeSet); -} - -void _ntpWebSocketOnConnected(JsonObject& root) { - root["ntpServer"] = getSetting("ntpServer", NTP_SERVER); - root["ntpOffset"] = getSetting("ntpOffset", NTP_TIME_OFFSET); - root["ntpDST"] = getSetting("ntpDST", 1 == NTP_DAY_LIGHT); - root["ntpRegion"] = getSetting("ntpRegion", NTP_DST_REGION); -} - -#endif - -time_t _ntpSyncProvider() { - _ntp_want_sync = true; - return 0; -} - -void _ntpWantSync() { - _ntp_want_sync = true; -} - -// Randomized in time to avoid clogging the server with simultaious requests from multiple devices -// (for example, when multiple devices start up at the same time) -int _ntpSyncInterval() { - return secureRandom(NTP_SYNC_INTERVAL, NTP_SYNC_INTERVAL * 2); -} - -int _ntpUpdateInterval() { - return secureRandom(NTP_UPDATE_INTERVAL, NTP_UPDATE_INTERVAL * 2); -} - -void _ntpConfigure() { - - _ntp_configure = false; - - int offset = getSetting("ntpOffset", NTP_TIME_OFFSET); - int sign = offset > 0 ? 1 : -1; - offset = abs(offset); - int tz_hours = sign * (offset / 60); - int tz_minutes = sign * (offset % 60); - if (NTPw.getTimeZone() != tz_hours || NTPw.getTimeZoneMinutes() != tz_minutes) { - NTPw.setTimeZone(tz_hours, tz_minutes); - _ntp_report = true; - } - - const bool daylight = getSetting("ntpDST", 1 == NTP_DAY_LIGHT); - if (NTPw.getDayLight() != daylight) { - NTPw.setDayLight(daylight); - _ntp_report = true; - } - - const auto server = getSetting("ntpServer", NTP_SERVER); - if (!NTPw.getNtpServerName().equals(server)) { - NTPw.setNtpServerName(server); - } - - uint8_t dst_region = getSetting("ntpRegion", NTP_DST_REGION); - NTPw.setDSTZone(dst_region); - - // Some remote servers can be slow to respond, increase accordingly - // TODO does this need upper constrain? - NTPw.setNTPTimeout(getSetting("ntpTimeout", NTP_TIMEOUT)); - -} - -void _ntpStart() { - - _ntpConfigure(); - - // short (initial) and long (after sync) intervals - NTPw.setInterval(_ntpSyncInterval(), _ntpUpdateInterval()); - DEBUG_MSG_P(PSTR("[NTP] Update intervals: %us / %us\n"), - NTPw.getShortInterval(), NTPw.getLongInterval()); - - // setSyncProvider will immediatly call given function by setting next sync time to the current time. - // Avoid triggering sync immediatly by canceling sync provider flag and resetting sync interval again - setSyncProvider(_ntpSyncProvider); - _ntp_want_sync = false; - - setSyncInterval(NTPw.getShortInterval()); - -} - - -void _ntpReport() { - - _ntp_report = false; - - #if DEBUG_SUPPORT - if (ntpSynced()) { - time_t t = now(); - DEBUG_MSG_P(PSTR("[NTP] UTC Time : %s\n"), ntpDateTime(ntpLocal2UTC(t)).c_str()); - DEBUG_MSG_P(PSTR("[NTP] Local Time: %s\n"), ntpDateTime(t).c_str()); - } - #endif - -} - -#if BROKER_SUPPORT - -void inline _ntpBroker() { - static unsigned char last_minute = 60; - if (ntpSynced() && (minute() != last_minute)) { - last_minute = minute(); - NtpBroker::Publish(NtpTick::EveryMinute, now(), ntpDateTime()); - } -} - -#endif - -void _ntpLoop() { - - // Disable ntp sync when softAP is active. This will not crash, but instead spam debug-log with pointless sync failures. - if (!wifiConnected()) return; - - if (_ntp_configure) _ntpConfigure(); - - // NTPClientLib will trigger callback with sync status - // see: NTPw.onNTPSyncEvent([](NTPSyncEvent_t error){ ... }) below - if (_ntp_want_sync) { - _ntp_want_sync = false; - NTPw.getTime(); - } - - // Print current time whenever configuration changes or after successful sync - if (_ntp_report) _ntpReport(); - - #if BROKER_SUPPORT - _ntpBroker(); - #endif - -} - -// TODO: remove me! -void _ntpBackwards() { - moveSetting("ntpServer1", "ntpServer"); - delSetting("ntpServer2"); - delSetting("ntpServer3"); - int offset = getSetting("ntpOffset", NTP_TIME_OFFSET); - if (-30 < offset && offset < 30) { - offset *= 60; - setSetting("ntpOffset", offset); - } -} - -// ----------------------------------------------------------------------------- - -bool ntpSynced() { - #if NTP_WAIT_FOR_SYNC - // Has synced at least once - return (NTPw.getFirstSync() > 0); - #else - // TODO: runtime setting? - return true; - #endif -} - -String ntpDateTime(time_t t) { - char buffer[20]; - snprintf_P(buffer, sizeof(buffer), - PSTR("%04d-%02d-%02d %02d:%02d:%02d"), - year(t), month(t), day(t), hour(t), minute(t), second(t) - ); - return String(buffer); -} - -String ntpDateTime() { - if (ntpSynced()) return ntpDateTime(now()); - return String(); -} - -// XXX: returns garbage during DST switch -time_t ntpLocal2UTC(time_t local) { - int offset = getSetting("ntpOffset", NTP_TIME_OFFSET); - if (NTPw.isSummerTime()) offset += 60; - return local - offset * 60; -} - -// ----------------------------------------------------------------------------- - -void ntpSetup() { - - _ntpBackwards(); - - #if TERMINAL_SUPPORT - terminalRegisterCommand(F("NTP"), [](const terminal::CommandContext&) { - if (ntpSynced()) { - _ntpReport(); - terminalOK(); - } else { - DEBUG_MSG_P(PSTR("[NTP] Not synced\n")); - } - }); - - terminalRegisterCommand(F("NTP.SYNC"), [](const terminal::CommandContext&) { - _ntpWantSync(); - terminalOK(); - }); - #endif - - NTPw.onNTPSyncEvent([](NTPSyncEvent_t error) { - if (error) { - if (error == noResponse) { - DEBUG_MSG_P(PSTR("[NTP] Error: NTP server not reachable\n")); - } else if (error == invalidAddress) { - DEBUG_MSG_P(PSTR("[NTP] Error: Invalid NTP server address\n")); - } - #if WEB_SUPPORT - wsPost(_ntpWebSocketOnData); - #endif - } else { - _ntp_report = true; - setTime(NTPw.getLastNTPSync()); - } - }); - - wifiRegister([](justwifi_messages_t code, char * parameter) { - if (code == MESSAGE_CONNECTED) { - if (!ntpSynced()) { - _ntp_defer.once(secureRandom(NTP_START_DELAY, NTP_START_DELAY * 2), _ntpWantSync); - } - } - }); - - #if WEB_SUPPORT - wsRegister() - .onVisible(_ntpWebSocketOnVisible) - .onConnected(_ntpWebSocketOnConnected) - .onData(_ntpWebSocketOnData) - .onKeyCheck(_ntpWebSocketOnKeyCheck); - #endif - - // Main callbacks - espurnaRegisterLoop(_ntpLoop); - espurnaRegisterReload([]() { _ntp_configure = true; }); - - // Sets up NTP instance, installs ours sync provider - _ntpStart(); - -} - -#endif // NTP_SUPPORT && NTP_LEGACY_SUPPORT diff --git a/code/espurna/rpnrules.cpp b/code/espurna/rpnrules.cpp index ea1e7fac..01a1c835 100644 --- a/code/espurna/rpnrules.cpp +++ b/code/espurna/rpnrules.cpp @@ -575,10 +575,7 @@ void _rpnInit() { // Init context rpn_init(_rpn_ctxt); - // Time functions need NTP support - // TODO: since 1.15.0, timelib+ntpclientlib are no longer used with latest Cores - // `now` is always in UTC, `utc_...` functions to be used instead to convert time - #if NTP_SUPPORT && !NTP_LEGACY_SUPPORT + #if NTP_SUPPORT { constexpr size_t time_t_argc { split_t{} ? 2 : 1 }; @@ -625,35 +622,6 @@ void _rpnInit() { } #endif - // TODO: 1.14.0 weekday(...) conversion seemed to have 0..6 range with Monday as 0 - // using classic Sunday as first, but instead of 0 it is 1 - // Implementation above also uses 1 for Sunday, staying compatible with TimeLib - #if NTP_SUPPORT && NTP_LEGACY_SUPPORT - rpn_operator_set(_rpn_ctxt, "utc", 0, [](rpn_context & ctxt) -> rpn_error { - if (!ntpSynced()) return rpn_operator_error::CannotContinue; - rpn_value ts { static_cast(ntpLocal2UTC(now())) }; - rpn_stack_push(ctxt, ts); - return 0; - }); - rpn_operator_set(_rpn_ctxt, "now", 0, _rpnNtpNow); - - rpn_operator_set(_rpn_ctxt, "month", 1, [](rpn_context & ctxt) { - return _rpnNtpFunc(ctxt, month); - }); - rpn_operator_set(_rpn_ctxt, "day", 1, [](rpn_context & ctxt) { - return _rpnNtpFunc(ctxt, day); - }); - rpn_operator_set(_rpn_ctxt, "dow", 1, [](rpn_context & ctxt) { - return _rpnNtpFunc(ctxt, weekday); - }); - rpn_operator_set(_rpn_ctxt, "hour", 1, [](rpn_context & ctxt) { - return _rpnNtpFunc(ctxt, hour); - }); - rpn_operator_set(_rpn_ctxt, "minute", 1, [](rpn_context & ctxt) { - return _rpnNtpFunc(ctxt, minute); - }); - #endif - // Accept relay number and numeric API status value (0, 1 and 2) #if RELAY_SUPPORT diff --git a/code/espurna/scheduler.cpp b/code/espurna/scheduler.cpp index 599bd520..b2de9649 100644 --- a/code/espurna/scheduler.cpp +++ b/code/espurna/scheduler.cpp @@ -215,23 +215,6 @@ void _schAction(unsigned char sch_id, int sch_action, int sch_switch) { } } -#if NTP_LEGACY_SUPPORT - -NtpCalendarWeekday _schGetWeekday(time_t timestamp, int daybefore) { - if (daybefore > 0) { - timestamp = timestamp - ((hour(timestamp) * SECS_PER_HOUR) + ((minute(timestamp) + 1) * SECS_PER_MIN) + second(timestamp) + (daybefore * SECS_PER_DAY)); - } - - // XXX: no - time_t utc_timestamp = ntpLocal2UTC(timestamp); - return NtpCalendarWeekday { - weekday(timestamp), hour(timestamp), minute(timestamp), - weekday(utc_timestamp), hour(utc_timestamp), minute(utc_timestamp) - }; -} - -#else - constexpr time_t secondsPerMinute = 60; constexpr time_t secondsPerHour = 3600; constexpr time_t secondsPerDay = secondsPerHour * 24; @@ -256,8 +239,6 @@ NtpCalendarWeekday _schGetWeekday(time_t timestamp, int daybefore) { }; } -#endif - // If daybefore and target is -1, check with current timestamp // Otherwise, modify it by moving 'daybefore' days back and only use the 'target' id void _schCheck(int target, int daybefore) { diff --git a/code/espurna/utils.cpp b/code/espurna/utils.cpp index 27c64a51..5ea0346a 100644 --- a/code/espurna/utils.cpp +++ b/code/espurna/utils.cpp @@ -101,9 +101,7 @@ const String& getVersion() { } String buildTime() { -#if NTP_LEGACY_SUPPORT && NTP_SUPPORT - return ntpDateTime(__UNIX_TIMESTAMP__); -#elif NTP_SUPPORT +#if NTP_SUPPORT constexpr const time_t ts = __UNIX_TIMESTAMP__; tm timestruct; gmtime_r(&ts, ×truct);