ESP3D/esp3d/src/modules/network/netservices.cpp

/*
  netservices.cpp -  network services functions class

  Copyright (c) 2014 Luc Lebosse. All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#include "../../include/esp3d_config.h"

#include "netconfig.h"
#include "netservices.h"
#include "../../core/settings_esp3d.h"
#include "../../core/esp3doutput.h"
#if defined( ARDUINO_ARCH_ESP8266)
#ifdef MDNS_FEATURE
#include <ESP8266mDNS.h>
#endif //MDNS_FEATURE
#ifdef SSDP_FEATURE
#include <ESP8266SSDP.h>
#endif //SSDP_FEATURE
#endif //ARDUINO_ARCH_ESP8266
#if defined( ARDUINO_ARCH_ESP32)
#ifdef MDNS_FEATURE
#include <ESPmDNS.h>
#endif //MDNS_FEATURE
#ifdef SSDP_FEATURE
#include <ESP32SSDP.h>
#endif //SSDP_FEATURE
#endif //ARDUINO_ARCH_ESP32
#ifdef OTA_FEATURE
#include <ArduinoOTA.h>
#endif //OTA_FEATURE
#if defined(FILESYSTEM_FEATURE)
#include "../filesystem/esp_filesystem.h"
#endif //FILESYSTEM_FEATURE
#ifdef TELNET_FEATURE
#include "../telnet/telnet_server.h"
#endif //TELNET_FEATURE
#ifdef HTTP_FEATURE
#include "../http/http_server.h"
#endif //HTTP_FEATURE
#if defined(HTTP_FEATURE) || defined(WS_DATA_FEATURE)
#include "../websocket/websocket_server.h"
#endif //HTTP_FEATURE || WS_DATA_FEATURE
#ifdef CAPTIVE_PORTAL_FEATURE
#include <DNSServer.h>
const byte DNS_PORT = 53;
DNSServer dnsServer;
#endif //CAPTIVE_PORTAL_FEATURE
#ifdef TIMESTAMP_FEATURE
#include "../time/time_server.h"
#endif //TIMESTAMP_FEATURE
#ifdef NOTIFICATION_FEATURE
#include "../notifications/notifications_service.h"
#endif //NOTIFICATION_FEATURE

bool NetServices::_started = false;

NetServices::NetServices()
{
}
NetServices::~NetServices()
{
    end();
}

bool NetServices::begin()
{
    bool res = true;
    _started = false;
    String hostname = Settings_ESP3D::read_string(ESP_HOSTNAME);
    ESP3DOutput output(ESP_ALL_CLIENTS);
    end();
#ifdef TIMESTAMP_FEATURE
    if (WiFi.getMode() != WIFI_AP) {
        if(!timeserver.begin()) {
            output.printERROR("Failed contact time servers!");
        } else {
            String tmp = "Time set :";
            tmp+=timeserver.current_time();
            output.printMSG(tmp.c_str());
        }
    }
#endif //TIMESTAMP_FEATURE
#if defined(MDNS_FEATURE) && defined(ARDUINO_ARCH_ESP8266)
    if(WiFi.getMode() != WIFI_AP) {
        String lhostname =hostname;
        lhostname.toLowerCase();
        if (!MDNS.begin(hostname.c_str())) {
            output.printERROR("mDNS failed to start");
            _started =false;
        } else {
            String stmp = "mDNS started with '" + lhostname + ".local'";
            output.printMSG(stmp.c_str());
        }
    }
#endif //MDNS_FEATURE && ARDUINO_ARCH_ESP8266

#ifdef OTA_FEATURE
    if(WiFi.getMode() != WIFI_AP) {
        ArduinoOTA.onStart([]() {
            ESP3DOutput output(ESP_ALL_CLIENTS);
            String type = "Start OTA updating ";
            if (ArduinoOTA.getCommand() == U_FLASH) {
                type += "sketch";
            } else { // U_SPIFFS or any FS
                // NOTE: if updating FS this would be the place to unmount FS using FS.end()
                type += "filesystem";
#if defined(FILESYSTEM_FEATURE)
                ESP_FileSystem::end();
#endif //FILESYSTEM_FEATURE

            }
            output.printMSG(type.c_str());
        });
        ArduinoOTA.onEnd([]() {
            ESP3DOutput output(ESP_ALL_CLIENTS);
            output.printMSG("End OTA");
        });
        ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) {
            String prg = "OTA Progress ";
            ESP3DOutput output(ESP_ALL_CLIENTS);
            prg += String(progress / (total / 100)) + "%";
            output.printMSG(prg.c_str());
        });
        ArduinoOTA.onError([](ota_error_t error) {
            String stmp = "OTA Error: " + String(error);
            ESP3DOutput output(ESP_ALL_CLIENTS);
            output.printERROR(stmp.c_str());
            if (error == OTA_AUTH_ERROR) {
                output.printERROR("Auth Failed");
            } else if (error == OTA_BEGIN_ERROR) {
                output.printERROR("Begin Failed");
            } else if (error == OTA_CONNECT_ERROR) {
                output.printERROR("Connect Failed");
            } else if (error == OTA_RECEIVE_ERROR) {
                output.printERROR("Receive Failed");
            } else if (error == OTA_END_ERROR) {
                output.printERROR("End Failed");
            }
        });
        output.printMSG("OTA service started");
        ArduinoOTA.begin();
    }
#endif

#if defined(MDNS_FEATURE) && defined(ARDUINO_ARCH_ESP32)
    if(WiFi.getMode() != WIFI_AP) {
        String lhostname =hostname;
        lhostname.toLowerCase();
        if (!MDNS.begin(hostname.c_str())) {
            output.printERROR("mDNS failed to start");
            _started =false;
        } else {
            String stmp = "mDNS started with '" + lhostname + ".local'";
            output.printMSG(stmp.c_str());
        }
    }
#endif //MDNS_FEATURE && ARDUINO_ARCH_ESP8266

#ifdef CAPTIVE_PORTAL_FEATURE
    if(WiFi.getMode() == WIFI_AP) {
        // if DNSServer is started with "*" for domain name, it will reply with
        // provided IP to all DNS request
        if (dnsServer.start(DNS_PORT, "*", WiFi.softAPIP())) {
            output.printMSG("Captive Portal started");
        } else {
            output.printERROR("Failed start Captive Portal");
        }
    }
#endif //CAPTIVE_PORTAL_FEATURE
#ifdef HTTP_FEATURE
    if (!HTTP_Server::begin()) {
        res= false;
        output.printERROR("HTTP server failed");
    } else {
        String stmp = "HTTP server started port " + String(HTTP_Server::port());
        output.printMSG(stmp.c_str());
    }
#endif //HTTP_FEATURE
#ifdef TELNET_FEATURE
    if (!telnet_server.begin()) {
        res= false;
        output.printERROR("Telnet server failed");
    } else {
        String stmp = "Telnet server started port " + String(telnet_server.port());
        output.printMSG(stmp.c_str());
    }
#endif //TELNET_FEATURE
#if defined(HTTP_FEATURE)
    if (!websocket_terminal_server.begin()) {
        output.printMSG("Failed start Terminal Web Socket");
    }
#endif //HTTP_FEATURE  || WS_DATA_FEATURE
#ifdef MDNS_FEATURE
    if(WiFi.getMode() != WIFI_AP) {
        // Add service to MDNS-SD
        MDNS.addService("http", "tcp", 80);
    }
#endif //MDNS_FEATURE
#ifdef SSDP_FEATURE
    //SSDP service presentation
    if(WiFi.getMode() != WIFI_AP) {
        //Add specific for SSDP
        String stmp = String(Hal::getChipID());
        SSDP.setSchemaURL ("description.xml");
        SSDP.setHTTPPort (HTTP_Server::port());
        SSDP.setName (hostname.c_str());
        SSDP.setURL ("/");
        SSDP.setDeviceType ("upnp:rootdevice");
        SSDP.setSerialNumber (stmp.c_str());
        //Any customization could be here
        SSDP.setModelName (ESP_MODEL_NAME);
        SSDP.setModelURL (ESP_MODEL_URL);
        SSDP.setModelNumber (ESP_MODEL_NUMBER);
        SSDP.setManufacturer (ESP_MANUFACTURER_NAME);
        SSDP.setManufacturerURL (ESP_MANUFACTURER_URL);
        SSDP.begin();
        stmp = "SSDP started with '" + hostname + "'";
        output.printMSG(stmp.c_str());
    }
#endif //SSDP_FEATURE
#ifdef NOTIFICATION_FEATURE
    notificationsservice.begin();
#endif //NOTIFICATION_FEATURE
    if (!res) {
        end();
    }
    _started = res;
    return _started;
}
void NetServices::end()
{
    if(!_started) {
        return;
    }
    _started = false;
#ifdef NOTIFICATION_FEATURE
    notificationsservice.end();
#endif //NOTIFICATION_FEATURE
#ifdef CAPTIVE_PORTAL_FEATURE
    if(WiFi.getMode() == WIFI_AP) {
        dnsServer.stop();
    }
#endif //CAPTIVE_PORTAL_FEATURE
#ifdef SSDP_FEATURE
#if defined(ARDUINO_ARCH_ESP32)
    SSDP.end();
#endif //ARDUINO_ARCH_ESP32
#endif //SSDP_FEATURE
#ifdef MDNS_FEATURE
#if defined(ARDUINO_ARCH_ESP32)
    if(WiFi.getMode() != WIFI_AP) {
        mdns_service_remove("_http", "_tcp");
        MDNS.end();
    }
#endif // ARDUINO_ARCH_ESP32
#endif //MDNS_FEATURE

#ifdef OTA_FEATURE
#if defined(ARDUINO_ARCH_ESP32)
    if(WiFi.getMode() != WIFI_AP) {
        ArduinoOTA.end();
    }
#endif // ARDUINO_ARCH_ESP32
#endif //OTA_FEATURE
#if defined(HTTP_FEATURE)
    websocket_terminal_server.end();
#endif //HTTP_FEATURE
#ifdef HTTP_FEATURE
    HTTP_Server::end();
#endif //HTTP_FEATURE

#ifdef TELNET_FEATURE
    telnet_server.end();
#endif //TELNET_FEATURE

}

void NetServices::handle()
{
    if (_started) {
#ifdef MDNS_FEATURE
#if defined(ARDUINO_ARCH_ESP8266)
        MDNS.update();
#endif //ARDUINO_ARCH_ESP8266
#endif //MDNS_FEATURE
#ifdef OTA_FEATURE
        ArduinoOTA.handle();
#endif //OTA_FEATURE
#ifdef CAPTIVE_PORTAL_FEATURE
        if (WiFi.getMode()== WIFI_AP ) {
            dnsServer.processNextRequest();
        }
#endif //CAPTIVE_PORTAL_FEATURE
#ifdef HTTP_FEATURE
        HTTP_Server::handle();
#endif //HTTP_FEATURE
#if defined(HTTP_FEATURE)
        websocket_terminal_server.handle();
#endif //HTTP_FEATURE
#ifdef TELNET_FEATURE
        telnet_server.handle();
#endif //TELNET_FEATURE
#ifdef NOTIFICATION_FEATURE
        notificationsservice.handle();
#endif //NOTIFICATION_FEATURE
    }
}