/* WEBSOCKET MODULE Copyright (C) 2016-2019 by Xose PĂ©rez */ #if WEB_SUPPORT #include #include #include #include #include #include "libs/WebSocketIncommingBuffer.h" AsyncWebSocket _ws("/ws"); Ticker _web_defer; std::vector _ws_on_send_callbacks; std::vector _ws_on_action_callbacks; std::vector _ws_on_receive_callbacks; // ----------------------------------------------------------------------------- // Private methods // ----------------------------------------------------------------------------- typedef struct { IPAddress ip; unsigned long timestamp = 0; } ws_ticket_t; ws_ticket_t _ticket[WS_BUFFER_SIZE]; void _onAuth(AsyncWebServerRequest *request) { webLog(request); if (!webAuthenticate(request)) return request->requestAuthentication(); IPAddress ip = request->client()->remoteIP(); unsigned long now = millis(); unsigned short index; for (index = 0; index < WS_BUFFER_SIZE; index++) { if (_ticket[index].ip == ip) break; if (_ticket[index].timestamp == 0) break; if (now - _ticket[index].timestamp > WS_TIMEOUT) break; } if (index == WS_BUFFER_SIZE) { request->send(429); } else { _ticket[index].ip = ip; _ticket[index].timestamp = now; request->send(200, "text/plain", "OK"); } } bool _wsAuth(AsyncWebSocketClient * client) { IPAddress ip = client->remoteIP(); unsigned long now = millis(); unsigned short index = 0; for (index = 0; index < WS_BUFFER_SIZE; index++) { if ((_ticket[index].ip == ip) && (now - _ticket[index].timestamp < WS_TIMEOUT)) break; } if (index == WS_BUFFER_SIZE) { return false; } return true; } #if DEBUG_WEB_SUPPORT bool wsDebugSend(const char* prefix, const char* message) { if (!wsConnected()) return false; if (getFreeHeap() < (strlen(message) * 3)) return false; DynamicJsonBuffer jsonBuffer; JsonObject &root = jsonBuffer.createObject(); JsonObject &weblog = root.createNestedObject("weblog"); weblog.set("message", message); if (prefix && (prefix[0] != '\0')) { weblog.set("prefix", prefix); } wsSend(root); return true; } #endif // ----------------------------------------------------------------------------- #if MQTT_SUPPORT void _wsMQTTCallback(unsigned int type, const char * topic, const char * payload) { if (type == MQTT_CONNECT_EVENT) wsSend_P(PSTR("{\"mqttStatus\": true}")); if (type == MQTT_DISCONNECT_EVENT) wsSend_P(PSTR("{\"mqttStatus\": false}")); } #endif bool _wsStore(String key, String value) { // HTTP port if (key == "webPort") { if ((value.toInt() == 0) || (value.toInt() == 80)) { return delSetting(key); } } if (value != getSetting(key)) { return setSetting(key, value); } return false; } bool _wsStore(String key, JsonArray& value) { bool changed = false; unsigned char index = 0; for (auto element : value) { if (_wsStore(key + index, element.as())) changed = true; index++; } // Delete further values for (unsigned char i=index; iid(); // Parse JSON input DynamicJsonBuffer jsonBuffer; JsonObject& root = jsonBuffer.parseObject((char *) payload); if (!root.success()) { DEBUG_MSG_P(PSTR("[WEBSOCKET] Error parsing data\n")); wsSend_P(client_id, PSTR("{\"message\": 3}")); return; } // Check actions ----------------------------------------------------------- const char* action = root["action"]; if (action) { DEBUG_MSG_P(PSTR("[WEBSOCKET] Requested action: %s\n"), action); if (strcmp(action, "reboot") == 0) { deferredReset(100, CUSTOM_RESET_WEB); return; } if (strcmp(action, "reconnect") == 0) { _web_defer.once_ms(100, wifiDisconnect); return; } if (strcmp(action, "factory_reset") == 0) { DEBUG_MSG_P(PSTR("\n\nFACTORY RESET\n\n")); resetSettings(); deferredReset(100, CUSTOM_RESET_FACTORY); return; } JsonObject& data = root["data"]; if (data.success()) { // Callbacks for (unsigned char i = 0; i < _ws_on_action_callbacks.size(); i++) { (_ws_on_action_callbacks[i])(client_id, action, data); } // Restore configuration via websockets if (strcmp(action, "restore") == 0) { if (settingsRestoreJson(data)) { wsSend_P(client_id, PSTR("{\"message\": 5}")); } else { wsSend_P(client_id, PSTR("{\"message\": 4}")); } } return; } }; // Check configuration ----------------------------------------------------- JsonObject& config = root["config"]; if (config.success()) { DEBUG_MSG_P(PSTR("[WEBSOCKET] Parsing configuration data\n")); String adminPass; bool save = false; #if MQTT_SUPPORT bool changedMQTT = false; #endif for (auto kv: config) { bool changed = false; String key = kv.key; JsonVariant& value = kv.value; // Check password if (key == "adminPass") { if (!value.is()) continue; JsonArray& values = value.as(); if (values.size() != 2) continue; if (values[0].as().equals(values[1].as())) { String password = values[0].as(); if (password.length() > 0) { setSetting(key, password); save = true; wsSend_P(client_id, PSTR("{\"action\": \"reload\"}")); } } else { wsSend_P(client_id, PSTR("{\"message\": 7}")); } continue; } // Check if key has to be processed bool found = false; for (unsigned char i = 0; i < _ws_on_receive_callbacks.size(); i++) { found |= (_ws_on_receive_callbacks[i])(key.c_str(), value); // TODO: remove this to call all OnReceiveCallbacks with the // current key/value if (found) break; } if (!found) { delSetting(key); continue; } // Store values if (value.is()) { if (_wsStore(key, value.as())) changed = true; } else { if (_wsStore(key, value.as())) changed = true; } // Update flags if value has changed if (changed) { save = true; #if MQTT_SUPPORT if (key.startsWith("mqtt")) changedMQTT = true; #endif } } // Save settings if (save) { // Callbacks espurnaReload(); // This should got to callback as well // but first change management has to be in place #if MQTT_SUPPORT if (changedMQTT) mqttReset(); #endif // Persist settings saveSettings(); wsSend_P(client_id, PSTR("{\"message\": 8}")); } else { wsSend_P(client_id, PSTR("{\"message\": 9}")); } } } void _wsUpdate(JsonObject& root) { root["heap"] = getFreeHeap(); root["uptime"] = getUptime(); root["rssi"] = WiFi.RSSI(); root["loadaverage"] = systemLoadAverage(); #if ADC_MODE_VALUE == ADC_VCC root["vcc"] = ESP.getVcc(); #endif #if NTP_SUPPORT if (ntpSynced()) root["now"] = now(); #endif } void _wsDoUpdate(bool reset = false) { static unsigned long last = millis(); if (reset) { last = millis() + WS_UPDATE_INTERVAL; return; } if (millis() - last > WS_UPDATE_INTERVAL) { last = millis(); wsSend(_wsUpdate); } } bool _wsOnReceive(const char * key, JsonVariant& value) { if (strncmp(key, "ws", 2) == 0) return true; if (strncmp(key, "admin", 5) == 0) return true; if (strncmp(key, "hostname", 8) == 0) return true; if (strncmp(key, "desc", 4) == 0) return true; if (strncmp(key, "webPort", 7) == 0) return true; return false; } void _wsOnStart(JsonObject& root) { char chipid[7]; snprintf_P(chipid, sizeof(chipid), PSTR("%06X"), ESP.getChipId()); uint8_t * bssid = WiFi.BSSID(); char bssid_str[20]; snprintf_P(bssid_str, sizeof(bssid_str), PSTR("%02X:%02X:%02X:%02X:%02X:%02X"), bssid[0], bssid[1], bssid[2], bssid[3], bssid[4], bssid[5] ); root["webMode"] = WEB_MODE_NORMAL; root["app_name"] = APP_NAME; root["app_version"] = APP_VERSION; root["app_build"] = buildTime(); #if defined(APP_REVISION) root["app_revision"] = APP_REVISION; #endif root["manufacturer"] = MANUFACTURER; root["chipid"] = String(chipid); root["mac"] = WiFi.macAddress(); root["bssid"] = String(bssid_str); root["channel"] = WiFi.channel(); root["device"] = DEVICE; root["hostname"] = getSetting("hostname"); root["desc"] = getSetting("desc"); root["network"] = getNetwork(); root["deviceip"] = getIP(); root["sketch_size"] = ESP.getSketchSize(); root["free_size"] = ESP.getFreeSketchSpace(); root["sdk"] = ESP.getSdkVersion(); root["core"] = getCoreVersion(); root["btnDelay"] = getSetting("btnDelay", BUTTON_DBLCLICK_DELAY).toInt(); root["webPort"] = getSetting("webPort", WEB_PORT).toInt(); root["wsAuth"] = getSetting("wsAuth", WS_AUTHENTICATION).toInt() == 1; #if TERMINAL_SUPPORT root["cmdVisible"] = 1; #endif root["hbMode"] = getSetting("hbMode", HEARTBEAT_MODE).toInt(); root["hbInterval"] = getSetting("hbInterval", HEARTBEAT_INTERVAL).toInt(); _wsDoUpdate(true); } void wsSend(JsonObject& root) { size_t len = root.measureLength(); AsyncWebSocketMessageBuffer* buffer = _ws.makeBuffer(len); if (buffer) { root.printTo(reinterpret_cast(buffer->get()), len + 1); _ws.textAll(buffer); } } void wsSend(uint32_t client_id, JsonObject& root) { AsyncWebSocketClient* client = _ws.client(client_id); if (client == nullptr) return; size_t len = root.measureLength(); AsyncWebSocketMessageBuffer* buffer = _ws.makeBuffer(len); if (buffer) { root.printTo(reinterpret_cast(buffer->get()), len + 1); client->text(buffer); } } void _wsStart(uint32_t client_id) { #if USE_PASSWORD && WEB_FORCE_PASS_CHANGE bool changePassword = getAdminPass().equals(ADMIN_PASS); #else bool changePassword = false; #endif DynamicJsonBuffer jsonBuffer; JsonObject& root = jsonBuffer.createObject(); if (changePassword) { root["webMode"] = WEB_MODE_PASSWORD; wsSend(root); return; } for (auto& callback : _ws_on_send_callbacks) { callback(root); } wsSend(client_id, root); } void _wsEvent(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len){ if (type == WS_EVT_CONNECT) { client->_tempObject = nullptr; #ifndef NOWSAUTH if (!_wsAuth(client)) { wsSend_P(client->id(), PSTR("{\"message\": 10}")); DEBUG_MSG_P(PSTR("[WEBSOCKET] Validation check failed\n")); client->close(); return; } #endif IPAddress ip = client->remoteIP(); DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u connected, ip: %d.%d.%d.%d, url: %s\n"), client->id(), ip[0], ip[1], ip[2], ip[3], server->url()); _wsStart(client->id()); client->_tempObject = new WebSocketIncommingBuffer(&_wsParse, true); wifiReconnectCheck(); } else if(type == WS_EVT_DISCONNECT) { DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u disconnected\n"), client->id()); if (client->_tempObject) { delete (WebSocketIncommingBuffer *) client->_tempObject; } wifiReconnectCheck(); } else if(type == WS_EVT_ERROR) { DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u error(%u): %s\n"), client->id(), *((uint16_t*)arg), (char*)data); } else if(type == WS_EVT_PONG) { DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u pong(%u): %s\n"), client->id(), len, len ? (char*) data : ""); } else if(type == WS_EVT_DATA) { //DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u data(%u): %s\n"), client->id(), len, len ? (char*) data : ""); WebSocketIncommingBuffer *buffer = (WebSocketIncommingBuffer *)client->_tempObject; AwsFrameInfo * info = (AwsFrameInfo*)arg; buffer->data_event(client, info, data, len); } } void _wsLoop() { if (!wsConnected()) return; _wsDoUpdate(); } // ----------------------------------------------------------------------------- // Public API // ----------------------------------------------------------------------------- bool wsConnected() { return (_ws.count() > 0); } bool wsConnected(uint32_t client_id) { return _ws.hasClient(client_id); } void wsOnSendRegister(ws_on_send_callback_f callback) { _ws_on_send_callbacks.push_back(callback); } void wsOnReceiveRegister(ws_on_receive_callback_f callback) { _ws_on_receive_callbacks.push_back(callback); } void wsOnActionRegister(ws_on_action_callback_f callback) { _ws_on_action_callbacks.push_back(callback); } void wsSend(ws_on_send_callback_f callback) { if (_ws.count() > 0) { DynamicJsonBuffer jsonBuffer; JsonObject& root = jsonBuffer.createObject(); callback(root); wsSend(root); } } void wsSend(const char * payload) { if (_ws.count() > 0) { _ws.textAll(payload); } } void wsSend_P(PGM_P payload) { if (_ws.count() > 0) { char buffer[strlen_P(payload)]; strcpy_P(buffer, payload); _ws.textAll(buffer); } } void wsSend(uint32_t client_id, ws_on_send_callback_f callback) { AsyncWebSocketClient* client = _ws.client(client_id); if (client == nullptr) return; DynamicJsonBuffer jsonBuffer; JsonObject& root = jsonBuffer.createObject(); callback(root); size_t len = root.measureLength(); AsyncWebSocketMessageBuffer* buffer = _ws.makeBuffer(len); if (buffer) { root.printTo(reinterpret_cast(buffer->get()), len + 1); client->text(buffer); } } void wsSend(uint32_t client_id, const char * payload) { _ws.text(client_id, payload); } void wsSend_P(uint32_t client_id, PGM_P payload) { char buffer[strlen_P(payload)]; strcpy_P(buffer, payload); _ws.text(client_id, buffer); } void wsSetup() { _ws.onEvent(_wsEvent); webServer()->addHandler(&_ws); // CORS #ifdef WEB_REMOTE_DOMAIN DefaultHeaders::Instance().addHeader("Access-Control-Allow-Origin", WEB_REMOTE_DOMAIN); if (strcmp(WEB_REMOTE_DOMAIN, "*")) { DefaultHeaders::Instance().addHeader("Access-Control-Allow-Credentials", "true"); } #endif webServer()->on("/auth", HTTP_GET, _onAuth); #if MQTT_SUPPORT mqttRegister(_wsMQTTCallback); #endif wsOnSendRegister(_wsOnStart); wsOnReceiveRegister(_wsOnReceive); espurnaRegisterLoop(_wsLoop); } #endif // WEB_SUPPORT