web_server.h

Go to the documentation of this file.

#pragma once
 
#include "list_entities.h"
 
#include "esphome/components/json/json_util.h"
#include "esphome/components/web_server_base/web_server_base.h"
#ifdef USE_WEBSERVER
#include "esphome/core/component.h"
#include "esphome/core/controller.h"
#include "esphome/core/entity_base.h"
#ifdef USE_LOGGER
#include "esphome/components/logger/logger.h"
#endif
 
#include <functional>
#include <list>
#include <map>
#include <string>
#include <utility>
#include <vector>
 
#if USE_WEBSERVER_VERSION >= 2
extern const uint8_t ESPHOME_WEBSERVER_INDEX_HTML[] PROGMEM;
extern const size_t ESPHOME_WEBSERVER_INDEX_HTML_SIZE;
#endif
 
#ifdef USE_WEBSERVER_CSS_INCLUDE
extern const uint8_t ESPHOME_WEBSERVER_CSS_INCLUDE[] PROGMEM;
extern const size_t ESPHOME_WEBSERVER_CSS_INCLUDE_SIZE;
#endif
 
#ifdef USE_WEBSERVER_JS_INCLUDE
extern const uint8_t ESPHOME_WEBSERVER_JS_INCLUDE[] PROGMEM;
extern const size_t ESPHOME_WEBSERVER_JS_INCLUDE_SIZE;
#endif
 
namespace esphome::web_server {
 
// Type for parameter names that can be stored in flash on ESP8266
#ifdef USE_ESP8266
using ParamNameType = const __FlashStringHelper *;
#else
using ParamNameType = const char *;
#endif
 
// All platforms need to defer actions to main loop thread.
// Multi-core platforms need this for thread safety.
// ESP8266 needs this because ESPAsyncWebServer callbacks run in "sys" context
// (SDK system context), not "cont" context (continuation/main loop). Calling
// yield() from sys context causes a panic in the Arduino core.
#define DEFER_ACTION(capture, action) this->defer([capture]() mutable { action; })
 
struct EntityMatchResult {
  bool matched;          
  bool action_is_empty;  
};
 
struct UrlMatch {
  StringRef domain;  
  StringRef id;      
  StringRef method;  
#ifdef USE_DEVICES
  StringRef device_name;  
#endif
  bool valid{false};  
 
  // Helper methods for string comparisons
  bool domain_equals(const char *str) const { return this->domain == str; }
  bool method_equals(const char *str) const { return this->method == str; }
 
#ifdef USE_ESP8266
  // Overloads for flash strings on ESP8266
  bool domain_equals(const __FlashStringHelper *str) const { return this->domain == str; }
  bool method_equals(const __FlashStringHelper *str) const { return this->method == str; }
#endif
 
  EntityMatchResult match_entity(EntityBase *entity) const;
};
 
#ifdef USE_WEBSERVER_SORTING
struct SortingComponents {
  float weight;
  uint64_t group_id;
};
 
struct SortingGroup {
  std::string name;
  float weight;
};
#endif
 
enum JsonDetail { DETAIL_ALL, DETAIL_STATE };
 
/*
  In order to defer updates in arduino mode, we need to create one AsyncEventSource per incoming request to /events.
  This is because only minimal changes were made to the ESPAsyncWebServer lib_dep, it was undesirable to put deferred
  update logic into that library. We need one deferred queue per connection so instead of one AsyncEventSource with
  multiple clients, we have multiple event sources with one client each. This is slightly awkward which is why it's
  implemented in a more straightforward way for ESP-IDF. Arduino platform will eventually go away and this workaround
  can be forgotten.
*/
#if !defined(USE_ESP32) && defined(USE_ARDUINO)
using message_generator_t = json::SerializationBuffer<>(WebServer *, void *);
 
class DeferredUpdateEventSourceList;
class DeferredUpdateEventSource final : public AsyncEventSource {
  friend class DeferredUpdateEventSourceList;
 
  /*
    This class holds a pointer to the source component that wants to publish a state event, and a pointer to a function
    that will lazily generate that event.  The two pointers allow dedup in the deferred queue if multiple publishes for
    the same component are backed up, and take up only two pointers of memory.  The entry in the deferred queue (a
    std::vector) is the DeferredEvent instance itself (not a pointer to one elsewhere in heap) so still only two
    pointers per entry (and no heap fragmentation).  Even 100 backed up events (you'd have to have at least 100 sensors
    publishing because of dedup) would take up only 0.8 kB.
  */
  struct DeferredEvent {
    friend class DeferredUpdateEventSource;
 
   protected:
    void *source_;
    message_generator_t *message_generator_;
 
   public:
    DeferredEvent(void *source, message_generator_t *message_generator)
        : source_(source), message_generator_(message_generator) {}
    bool operator==(const DeferredEvent &test) const {
      return (source_ == test.source_ && message_generator_ == test.message_generator_);
    }
  };
  static_assert(sizeof(DeferredEvent) == sizeof(void *) + sizeof(message_generator_t *),
                "DeferredEvent should have no padding");
 
 protected:
  // surface a couple methods from the base class
  using AsyncEventSource::handleRequest;
  using AsyncEventSource::send;
 
  ListEntitiesIterator entities_iterator_;
  // vector is used very specifically for its zero memory overhead even though items are popped from the front (memory
  // footprint is more important than speed here)
  std::vector<DeferredEvent> deferred_queue_;
  WebServer *web_server_;
  uint16_t consecutive_send_failures_{0};
  static constexpr uint16_t MAX_CONSECUTIVE_SEND_FAILURES = 2500;  // ~20 seconds at 125Hz loop rate
 
  // helper for allowing only unique entries in the queue
  void deq_push_back_with_dedup_(void *source, message_generator_t *message_generator);
 
  void process_deferred_queue_();
 
 public:
  DeferredUpdateEventSource(WebServer *ws, const String &url)
      : AsyncEventSource(url), entities_iterator_(ListEntitiesIterator(ws, this)), web_server_(ws) {}
 
  void loop();
 
  void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator);
  void try_send_nodefer(const char *message, const char *event = nullptr, uint32_t id = 0, uint32_t reconnect = 0);
};
 
class DeferredUpdateEventSourceList final : public std::list<DeferredUpdateEventSource *> {
 protected:
  void on_client_connect_(DeferredUpdateEventSource *source);
  void on_client_disconnect_(DeferredUpdateEventSource *source);
 
 public:
  bool loop();
 
  void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator);
  void try_send_nodefer(const char *message, const char *event = nullptr, uint32_t id = 0, uint32_t reconnect = 0);
 
  void add_new_client(WebServer *ws, AsyncWebServerRequest *request);
};
#endif
 
class WebServer final : public Controller, public Component, public AsyncWebHandler {
#if !defined(USE_ESP32) && defined(USE_ARDUINO)
  friend class DeferredUpdateEventSourceList;
#endif
 
 public:
  WebServer(web_server_base::WebServerBase *base);
 
#if USE_WEBSERVER_VERSION == 1
  void set_css_url(const char *css_url);
 
  void set_js_url(const char *js_url);
#endif
 
#ifdef USE_WEBSERVER_CSS_INCLUDE
  void set_css_include(const char *css_include);
#endif
 
#ifdef USE_WEBSERVER_JS_INCLUDE
  void set_js_include(const char *js_include);
#endif
 
  void set_include_internal(bool include_internal) { include_internal_ = include_internal; }
  void set_expose_log(bool expose_log) { this->expose_log_ = expose_log; }
 
  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
  void setup() override;
  void loop() override;
 
  void dump_config() override;
 
#ifdef USE_LOGGER
  void on_log(uint8_t level, const char *tag, const char *message, size_t message_len);
#endif
 
  float get_setup_priority() const override;
 
  void handle_index_request(AsyncWebServerRequest *request);
 
  json::SerializationBuffer<> get_config_json();
 
#ifdef USE_WEBSERVER_CSS_INCLUDE
  void handle_css_request(AsyncWebServerRequest *request);
#endif
 
#ifdef USE_WEBSERVER_JS_INCLUDE
  void handle_js_request(AsyncWebServerRequest *request);
#endif
 
#ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS
  // Handle Private Network Access CORS OPTIONS request
  void handle_pna_cors_request(AsyncWebServerRequest *request);
#endif
 
#ifdef USE_SENSOR
  void on_sensor_update(sensor::Sensor *obj) override;
  void handle_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> sensor_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> sensor_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_SWITCH
  void on_switch_update(switch_::Switch *obj) override;
 
  void handle_switch_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> switch_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> switch_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_BUTTON
  void handle_button_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  // Buttons are stateless, so there is no button_state_json_generator
  static json::SerializationBuffer<> button_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_BINARY_SENSOR
  void on_binary_sensor_update(binary_sensor::BinarySensor *obj) override;
 
  void handle_binary_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> binary_sensor_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> binary_sensor_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_FAN
  void on_fan_update(fan::Fan *obj) override;
 
  void handle_fan_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> fan_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> fan_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_LIGHT
  void on_light_update(light::LightState *obj) override;
 
  void handle_light_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> light_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> light_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_TEXT_SENSOR
  void on_text_sensor_update(text_sensor::TextSensor *obj) override;
 
  void handle_text_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> text_sensor_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> text_sensor_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_COVER
  void on_cover_update(cover::Cover *obj) override;
 
  void handle_cover_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> cover_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> cover_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_NUMBER
  void on_number_update(number::Number *obj) override;
  void handle_number_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> number_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> number_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_DATETIME_DATE
  void on_date_update(datetime::DateEntity *obj) override;
  void handle_date_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> date_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> date_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_DATETIME_TIME
  void on_time_update(datetime::TimeEntity *obj) override;
  void handle_time_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> time_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> time_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_DATETIME_DATETIME
  void on_datetime_update(datetime::DateTimeEntity *obj) override;
  void handle_datetime_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> datetime_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> datetime_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_TEXT
  void on_text_update(text::Text *obj) override;
  void handle_text_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> text_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> text_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_SELECT
  void on_select_update(select::Select *obj) override;
  void handle_select_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> select_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> select_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_CLIMATE
  void on_climate_update(climate::Climate *obj) override;
  void handle_climate_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> climate_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> climate_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_LOCK
  void on_lock_update(lock::Lock *obj) override;
 
  void handle_lock_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> lock_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> lock_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_VALVE
  void on_valve_update(valve::Valve *obj) override;
 
  void handle_valve_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> valve_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> valve_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_ALARM_CONTROL_PANEL
  void on_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj) override;
 
  void handle_alarm_control_panel_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> alarm_control_panel_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> alarm_control_panel_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_WATER_HEATER
  void on_water_heater_update(water_heater::WaterHeater *obj) override;
 
  void handle_water_heater_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> water_heater_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> water_heater_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_INFRARED
  void handle_infrared_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> infrared_all_json_generator(WebServer *web_server, void *source);
#endif
 
#ifdef USE_EVENT
  void on_event(event::Event *obj) override;
 
  static json::SerializationBuffer<> event_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> event_all_json_generator(WebServer *web_server, void *source);
 
  void handle_event_request(AsyncWebServerRequest *request, const UrlMatch &match);
#endif
 
#ifdef USE_UPDATE
  void on_update(update::UpdateEntity *obj) override;
 
  void handle_update_request(AsyncWebServerRequest *request, const UrlMatch &match);
 
  static json::SerializationBuffer<> update_state_json_generator(WebServer *web_server, void *source);
  static json::SerializationBuffer<> update_all_json_generator(WebServer *web_server, void *source);
#endif
 
  bool canHandle(AsyncWebServerRequest *request) const override;
  void handleRequest(AsyncWebServerRequest *request) override;
  bool isRequestHandlerTrivial() const override;  // NOLINT(readability-identifier-naming)
 
#ifdef USE_WEBSERVER_SORTING
  void add_entity_config(EntityBase *entity, float weight, uint64_t group);
  void add_sorting_group(uint64_t group_id, const std::string &group_name, float weight);
 
  std::map<EntityBase *, SortingComponents> sorting_entitys_;
  std::map<uint64_t, SortingGroup> sorting_groups_;
#endif
 
  bool include_internal_{false};
 
 protected:
  void add_sorting_info_(JsonObject &root, EntityBase *entity);
 
#ifdef USE_LIGHT
  // Helper to parse and apply a float parameter with optional scaling
  template<typename T, typename Ret>
  void parse_light_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret (T::*setter)(float),
                          float scale = 1.0f) {
    auto value = parse_number<float>(request->arg(param_name).c_str());
    if (value.has_value()) {
      (call.*setter)(*value / scale);
    }
  }
 
  // Helper to parse and apply a uint32_t parameter with optional scaling
  template<typename T, typename Ret>
  void parse_light_param_uint_(AsyncWebServerRequest *request, ParamNameType param_name, T &call,
                               Ret (T::*setter)(uint32_t), uint32_t scale = 1) {
    auto value = parse_number<uint32_t>(request->arg(param_name).c_str());
    if (value.has_value()) {
      (call.*setter)(*value * scale);
    }
  }
#endif
 
  // Generic helper to parse and apply a numeric parameter
  template<typename NumT, typename T, typename Ret>
  void parse_num_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret (T::*setter)(NumT)) {
    auto value = parse_number<NumT>(request->arg(param_name).c_str());
    if (value.has_value()) {
      (call.*setter)(*value);
    }
  }
 
  // Generic helper to parse and apply a string parameter using const char* setter (avoids std::string allocation)
  template<typename T, typename Ret>
  void parse_cstr_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call,
                         Ret (T::*setter)(const char *, size_t)) {
    if (request->hasArg(param_name)) {
      const auto &value = request->arg(param_name);
      (call.*setter)(value.c_str(), value.length());
    }
  }
 
  // Generic helper to parse and apply a bool parameter
  // Accepts: "on", "true", "1" (case-insensitive) as true
  // Accepts: "off", "false", "0" (case-insensitive) as false
  // Invalid values are ignored (setter not called)
  template<typename T, typename Ret>
  void parse_bool_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret (T::*setter)(bool)) {
    const auto &param_value = request->arg(param_name);
    // Arduino String has isEmpty() not empty(), use length() for cross-platform compatibility
    if (param_value.length() > 0) {  // NOLINT(readability-container-size-empty)
      // First check on/off (default), then true/false (custom)
      auto val = parse_on_off(param_value.c_str());
      if (val == PARSE_NONE) {
        val = parse_on_off(param_value.c_str(), "true", "false");
      }
      if (val == PARSE_ON || param_value == "1") {
        (call.*setter)(true);
      } else if (val == PARSE_OFF || param_value == "0") {
        (call.*setter)(false);
      }
      // PARSE_NONE/PARSE_TOGGLE: ignore invalid values
    }
  }
 
  web_server_base::WebServerBase *base_;
#ifdef USE_ESP32
  AsyncEventSource events_{"/events", this};
#elif USE_ARDUINO
  DeferredUpdateEventSourceList events_;
#endif
 
#if USE_WEBSERVER_VERSION == 1
  const char *css_url_{nullptr};
  const char *js_url_{nullptr};
#endif
#ifdef USE_WEBSERVER_CSS_INCLUDE
  const char *css_include_{nullptr};
#endif
#ifdef USE_WEBSERVER_JS_INCLUDE
  const char *js_include_{nullptr};
#endif
  bool expose_log_{true};
 
 private:
#ifdef USE_SENSOR
  json::SerializationBuffer<> sensor_json_(sensor::Sensor *obj, float value, JsonDetail start_config);
#endif
#ifdef USE_SWITCH
  json::SerializationBuffer<> switch_json_(switch_::Switch *obj, bool value, JsonDetail start_config);
#endif
#ifdef USE_BUTTON
  json::SerializationBuffer<> button_json_(button::Button *obj, JsonDetail start_config);
#endif
#ifdef USE_BINARY_SENSOR
  json::SerializationBuffer<> binary_sensor_json_(binary_sensor::BinarySensor *obj, bool value,
                                                  JsonDetail start_config);
#endif
#ifdef USE_FAN
  json::SerializationBuffer<> fan_json_(fan::Fan *obj, JsonDetail start_config);
#endif
#ifdef USE_LIGHT
  json::SerializationBuffer<> light_json_(light::LightState *obj, JsonDetail start_config);
#endif
#ifdef USE_TEXT_SENSOR
  json::SerializationBuffer<> text_sensor_json_(text_sensor::TextSensor *obj, const std::string &value,
                                                JsonDetail start_config);
#endif
#ifdef USE_COVER
  json::SerializationBuffer<> cover_json_(cover::Cover *obj, JsonDetail start_config);
#endif
#ifdef USE_NUMBER
  json::SerializationBuffer<> number_json_(number::Number *obj, float value, JsonDetail start_config);
#endif
#ifdef USE_DATETIME_DATE
  json::SerializationBuffer<> date_json_(datetime::DateEntity *obj, JsonDetail start_config);
#endif
#ifdef USE_DATETIME_TIME
  json::SerializationBuffer<> time_json_(datetime::TimeEntity *obj, JsonDetail start_config);
#endif
#ifdef USE_DATETIME_DATETIME
  json::SerializationBuffer<> datetime_json_(datetime::DateTimeEntity *obj, JsonDetail start_config);
#endif
#ifdef USE_TEXT
  json::SerializationBuffer<> text_json_(text::Text *obj, const std::string &value, JsonDetail start_config);
#endif
#ifdef USE_SELECT
  json::SerializationBuffer<> select_json_(select::Select *obj, StringRef value, JsonDetail start_config);
#endif
#ifdef USE_CLIMATE
  json::SerializationBuffer<> climate_json_(climate::Climate *obj, JsonDetail start_config);
#endif
#ifdef USE_LOCK
  json::SerializationBuffer<> lock_json_(lock::Lock *obj, lock::LockState value, JsonDetail start_config);
#endif
#ifdef USE_VALVE
  json::SerializationBuffer<> valve_json_(valve::Valve *obj, JsonDetail start_config);
#endif
#ifdef USE_ALARM_CONTROL_PANEL
  json::SerializationBuffer<> alarm_control_panel_json_(alarm_control_panel::AlarmControlPanel *obj,
                                                        alarm_control_panel::AlarmControlPanelState value,
                                                        JsonDetail start_config);
#endif
#ifdef USE_EVENT
  json::SerializationBuffer<> event_json_(event::Event *obj, StringRef event_type, JsonDetail start_config);
#endif
#ifdef USE_WATER_HEATER
  json::SerializationBuffer<> water_heater_json_(water_heater::WaterHeater *obj, JsonDetail start_config);
#endif
#ifdef USE_INFRARED
  json::SerializationBuffer<> infrared_json_(infrared::Infrared *obj, JsonDetail start_config);
#endif
#ifdef USE_UPDATE
  json::SerializationBuffer<> update_json_(update::UpdateEntity *obj, JsonDetail start_config);
#endif
};
 
}  // namespace esphome::web_server
#endif