Portal.cpp

/*
  Portal.cpp - Handle the webserver interface
  Saul bertuccio 11 feb 2017
  Released into the public domain.
*/

#include "Portal.h"

Portal::Portal():message(String("")) {}

boolean Portal::setup() {

  IPAddress ip = ConnectionManager::getIpAddress();
 
  if (ip.toString() == "0.0.0.0") {
    Serial.println("Indirizzo IP non valido");
    return false;
  }

  ap_mode = ConnectionManager::isApMode();

  // Avvio captive portal
  if (ap_mode) {
    dnsServer.reset(new DNSServer());
    dnsServer->setErrorReplyCode(DNSReplyCode::NoError);

    if (dnsServer->start(DNS_PORT, "*", ip)) {
      Serial.println("Avviato servizio DNS");
      } else {
        Serial.println("Impossibile avviare servizio DNS");
    }
  }

  /* Configuro il webserver */
  server.reset(new ESP8266WebServer(SERVER_PORT));

  /* Bind delle url alle funzioni */
  server->on("/", std::bind(&Portal::handleRootPage, this));
  server->on("/setup/wifi", std::bind(&Portal::handleSetupWifi, this));
  server->on("/setup/wifilist", std::bind(&Portal::handleWifiList, this));
  server->on("/setup/savewifi", std::bind(&Portal::handleSaveWifi, this));
  server->on("/sendKey", std::bind(&Portal::handleSendKey, this));

  /* For CORS options requests
  server->on("/sendKey", HTTP_OPTIONS, [&]() {
      server->sendHeader("Access-Control-Max-Age", "10000");
      server->sendHeader("Access-Control-Allow-Methods", "POST,GET,OPTIONS");
      server->sendHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
      server->send(200, "text/plain", "" );
    });
  */

  
  if (!ap_mode) {
    server->serveStatic("/js", SPIFFS, "/js");
    server->on("/setup/devices", std::bind(&Portal::handleSetupDevices, this));
    server->on("/setup/editDevice", std::bind(&Portal::handleEditDevice, this));
    server->on("/setup/getKeyPanel", std::bind(&Portal::handleGetKeyPanel, this));    
    server->on("/setup/deleteDevice", std::bind(&Portal::handleDeleteDevice, this));
    server->on("/setup/getDeviceInfo", std::bind(&Portal::handleGetDeviceInfo, this));
    server->on("/setup/editDeviceKey", std::bind(&Portal::handleEditDeviceKey, this));
    server->on("/setup/acquireKeyData", std::bind(&Portal::handleAcquireKeyData, this));
    server->on("/setup/deleteDeviceKey", std::bind(&Portal::handleDeleteDeviceKey, this));
  }
  server->onNotFound (std::bind(&Portal::handleNotFound, this));
  server->begin(); // Web server start

  dh = DeviceHandler();
  Serial.println("Avviato server HTTP");
/*
  if (!ap_mode) {
    MDNS.begin(AP_SSID);
    MDNS.addService("http", "tcp", 80);
    delay(1000);
    //Serial.println("Avviato servizio mDNS");
  }
*/
  return true;

}

boolean Portal::needRestart() { return need_restart; }

void Portal::handleRequest() {

  if (ap_mode)
    dnsServer->processNextRequest();
  server->handleClient();
}

void Portal::handleRootPage() {

  if (redirect())
    return;

  String page = this->basePage();
  
  page.replace("{onready}", "");
  page.replace("{message}", message);
  page.replace("{body}", getMainMenu());
  page.replace("{script}","");
  server->send(200, "text/html", page); 
}

void Portal::handleSaveWifi() {

  // get post data
  String new_ssid = server->arg("ssid");
  String new_pass = server->arg("password");
  String msg;

  message = getMessageTpl();

  boolean success = ConnectionManager::connectWifi(new_ssid, new_pass, true);

  if (!success) {
    Serial.print("Impossibile collegarsi alla rete Wifi ");
    message.replace("{class}",  "error");
    msg = "Errore impossibile collegarsi alla rete senza fili ";
    msg += new_ssid;
  } else {
    message.replace("{class}",  "info");
    msg = "Connessione riuscita il dispositivo si riavvierà per completare la configurazione.";
    need_restart = true;
  }

  message.replace("{message}", msg);
  redirectHeaders("/setup");

}

void Portal::handleSendKey() {
  String device_name="", key_name="", msg="";
  boolean error = true;
  
  if(server->hasArg("device_name") && server->hasArg("key_name")) {
      device_name = server->arg("device_name");
      key_name = server->arg("key_name");

      if (
          Validation::isValidDeviceName(device_name)
          &&Validation::isValidDeviceName(key_name)
      ) {
        if (dh.setDevice( device_name ) ) {
          Device & d = dh.getDevice();
          if (d.sendKeyData(key_name)) {
            msg="Invio tasto riuscito";
            error = false;
          } else {
            msg="Errore: impossibile inviare tasto";
          }
         
        } else {
          msg="Errore: impossibile selezionare dispositivo";
        }
      } else {
        msg = "Errore: parametri non validi";
      }
  } else {
    msg = "Errore: parametri assenti";
  }

  String json = "{ \"error\" :";
  json += (error ? String("true") : String("false"));
  json += String(",\"message\" : \"") + msg + "\" }";
  server->send( 200, "text/json", json );
}

void Portal::handleEditDevice() {

    String device_name="", device_type="";

    String msg;
    bool error = true;

    if(!server->hasArg("device_name") || !server->hasArg("device_type")) {
      
      msg = "Errore: nome o tipo dispositivo non specificati";

    } else {

      device_name = server->arg("device_name");
      device_type = server->arg("device_type");

      if (!Validation::isValidDeviceName(device_name)) {

        msg = "Errore: nome dispositivo non valido";

      } else if (!Validation::isValidDeviceType(device_type)) {

        msg = "Errore: tipo dispositivo non valido";

      } else if (dh.setDevice( device_name, device_type ))  {

        if (server->hasArg("new_device_name")) {

          String new_device_name = server->arg("new_device_name");

          if (Validation::isValidDeviceName(new_device_name)) {

            if (dh.renameDevice(new_device_name)) {
              error = false;
              msg = "Dispositivo rinominato";
              device_name = new_device_name;
            } else {
              msg = "Errore: impossibile rinominare il dispositivo";
            }
          } else {
            msg = "Errore: nuovo nome del dispositivo non valido"; 
          }

        } else {
          error = false;
          msg = "Dispositivo correttamente configurato";
        }

      } else {
        msg = "Errore: impossibile configurare il dispositivo";
      }
    }

    String json = "{ \"error\" :";
    json += (error ? String("true") : String("false"));
    json += String(",\"message\":\"") + msg + "\"}";

    server->send( 200, "text/json", json );
}


void Portal::handleDeleteDevice() {
  
  String device_name="", msg="\"\"";
  bool error = true;

  if(!server->hasArg("device_name")) {
      
    msg = "Errore: nome dispositivo non specificato";

  } else {

    device_name = server->arg("device_name");

    if (!Validation::isValidDeviceName(device_name)) {

      msg = "Errore: nome dispositivo non valido";

    } else if (dh.setDevice(device_name)) {

      if (dh.deleteDevice()) {
        error = false;
        msg = "Dispositivo eliminato correttamente";
      } else {
        msg = "Errore: impossibile eliminare il dispositivo";
      }
    }
  }

  String json = "{\"error\":";
  json += (error ? String("true") : String("false"));
  json += String(",\"message\":\"") + msg + "\"}";

  server->send( 200, "text/json", json );
}

void Portal::handleGetDeviceInfo() {
  
  String device_name="", msg="";
  String dev_data;
  bool error = true;

  if(!server->hasArg("device_name")) {
      
    msg = "Errore: nome dispositivo non specificato";

  } else {

    device_name = server->arg("device_name");

    if (!Validation::isValidDeviceName(device_name)) {

      msg = "Errore: nome dispositivo non valido";

    } else if (dh.setDevice(device_name)) {

      dev_data = getDeviceData(dh.getDevice());
      error = false;

    } else {

      msg = "Errore: impossibile selezionare il dispositivo";

    }
  }

  String json = "{\"error\":";
  json += (error ? String("true") : String("false"));
  json += String(",\"device\": {") + dev_data + '}';
  json += String(",\"message\":\"") + msg + "\"}";

  server->send( 200, "text/json", json );
}

void Portal::handleGetKeyPanel() {

    String html_tpl;

    if(server->hasArg("device_type") && server->hasArg("template_type")) {
 
      String device_type = server->arg("device_type");
      String template_type = server->arg("template_type");
      device_type.toUpperCase();
      template_type.toUpperCase();

      // IRDA
      if (device_type == Device::TYPES[0]) {

        if (template_type == "DEV_PANE")
          html_tpl = FPSTR(HTML_DEV_PANE_IRDA_TPL);
        else if ( template_type == "FORM_EDIT" )
          html_tpl = FPSTR(HTML_FORM_EDIT_IRDA_KEY);
      // RF433
      } else if (device_type == Device::TYPES[1]) {
          
        if (template_type == "DEV_PANE")
          html_tpl = FPSTR(HTML_DEV_PANE_RF433_TPL);
        else if ( template_type == "FORM_EDIT" )
          html_tpl = FPSTR(HTML_FORM_EDIT_RF433_KEY);
      }
    }

    server->send(200, "text/html", html_tpl);
}

void Portal::handleEditDeviceKey() {

  String
    msg = "",
    device_name = "",
    device_key = "{ "
  ;

  bool error = true;

  if(!server->hasArg("device_name")) {
      
    msg = "Errore: nome dispositivo non specificato";

  } else {
    
    device_name = server->arg("device_name");

    if (!Validation::isValidDeviceName(device_name)) {

      msg = "Errore: nome dispositivo non valido";

    } else if (dh.setDevice(device_name)) {

      Device & d = dh.getDevice();
      int num = d.getKeysPropertyNum();
      String * names = d.getKeysPropertyNames();
      String values[num];
      error = false;

      for (int i = 0; i < num; i++) {
        String form_input = "device_key_" + names[i];
        if(
          server->hasArg(form_input)
          && d.isValidPropertyById(i, server->arg(form_input))
        ) {
          values[i] = server->arg(form_input);
          device_key += "\"" + names[i] + "\":\"" + values[i] + "\","; 
        } else {
          error = true;
          msg = "Errore parametro " + names[i] + " non valido";
          break;
        }
      }

      delete[] names;

      device_key.setCharAt(device_key.length() - 1, ' ');
      
      if (!error) {
        if (dh.addDeviceKey(values)) {
          msg = "Tasto aggiunto al dispositivo";
        } else {
          msg = "Errore impossibile salvare la configurazione del tasto";
          error = true;
        }
      }
    } else {
        msg = "Errore: impossibile configurare il dispositivo";  
    }
  }

  device_key.setCharAt(device_key.length() - 1, '}');
  String json = "{ \"error\" :";
  json += (error ? String("true") : String("false"));
  json += String(",\"message\":\"") + msg + "\"";
  json += String(",\"key\":") + device_key + "}";

  server->send( 200, "text/json", json );
}

void Portal::handleDeleteDeviceKey() {

    String
      msg = "",
      device_name = "",
      device_key_name = "";

    bool error = true;

    if(!server->hasArg("device_name")
      || !server->hasArg("device_key_name")
    ) {

      msg = "Errore: paramentri mancanti";

    } else {

      device_name = server->arg("device_name");
      device_key_name = server->arg("device_key_name");

      if (!Validation::isValidDeviceName(device_name)) {

        msg = "Errore: nome dispositivo non valido";

      } else if (!Validation::isValidDeviceKeyName(device_key_name)) {

        msg = "Errore: nome tasto non valido";

      } else if (!dh.setDevice( device_name ))  {

        msg = "Errore: impossibile configurare il dispositivo";  

      } else if (dh.deleteDeviceKey( device_key_name)) {

        msg = "Tasto eliminato dal dispositivo";
        error = false;

      } else {
        
        msg = "Errore: impossibile salvare la configurazione del dispositivo";
      }
    }

    String json = "{ \"error\" :";
    json += (error ? String("true") : String("false"));
    json += String(",\"message\":\"") + msg + "\"}";

    server->send( 200, "text/json", json );
}

void Portal::handleWifiList() {

  WifiNetworks nets = ConnectionManager::getNetworkList();

  String json = "{\"networks\":[";
  String prot;
  for (int i = 0; i < nets.netNum(); i++) {
    prot = ConnectionManager::encryptionCodeToString(nets.getProtection(i));
    json += String("{ \"name\" : \"") + nets.getName(i) + "\",";
    json += String("\"protection\":\"") + prot + "\",";
    json += String("\"quality\":\"") + nets.getQuality(i) + "\"},";
  }
  json.setCharAt(json.length() - 1, ' ');
  json += "]}";
  server->send( 200, "text/json", json );

}

void Portal::handleSetupWifi() {

    String body = FPSTR(HTML_PAGE_HEADER);
    body.replace("{btext}", "Impostazione dispositivi e tasti");
    body.replace("{stext}","");
    body += (ap_mode ? FPSTR(HTML_SIMPLE_WIFI_FORM) : FPSTR(HTML_FULL_WIFI_FORM));
    body.replace("{ssid}", ConnectionManager::getSsid());
    body.replace("{password}", ConnectionManager::getPassword());

    String page = basePage();
    page.replace("{body}",  body);
    page.replace("{onready}", FPSTR(JAVASCRIPT_NETLIST));
    page.replace("{script}", "");
    page.replace("{warn}", FPSTR(HTML_WIFISAVE_WARNING));

    server->send(200, "text/html", page);
}

void Portal::handleSetupDevices() {

    String body = FPSTR(HTML_PAGE_HEADER);
    body.replace("{btext}", "Impostazione dispositivi e tasti");
    body.replace("{stext}","");
    body += getDevPanel();

    String page = basePage();
    page.replace("{body}",  body);
    page.replace("{onready}", FPSTR(JAVASCRIPT_DEVICE_ONLOAD));
    page.replace("{script}", FPSTR(JAVASCRIPT_DEVICE_FUNCTIONS));
    server->send(200, "text/html", page);
}

void Portal::handleAcquireKeyData() {


  String device_name = "", msg = "", kjattr = "{}";
  bool error = true;

  if(!server->hasArg("device_name")) {
      
    msg = "Errore: nome dispositivo non specificato";

  } else {

    device_name = server->arg("device_name");

    if (!Validation::isValidDeviceName(device_name)) {

      msg = "Errore: nome dispositivo non valido";

    } else if (dh.setDevice(device_name)) {

      Device & d = dh.getDevice();
      int num = d.getKeysPropertyNum();
      Key * key = NULL;
      error = false;
      if (key = d.acquireKeyData()) {
        kjattr = Portal::keyAttrToJson(num, key);
        delete key;
      }
    } else {
      msg = "Errore: impossibile configurare il dispositivo";
    }
  }
  String json = "{ \"error\" :";
  json += (error ? String("true") : String("false"));
  json += String(",\"message\":\"") + msg + "\",";
  json += "\"key_data\":" + kjattr + "}";

  server->send( 200, "text/json", json );
}

void Portal::handleNotFound() {

  if (redirect())
    return;
    
  String page = this->basePage();
  page.replace("{onready}", "");
  page.replace("{script}","");
  
  String body = FPSTR(HTML_404_TPL);
  int sargs = server->args();
  
  body.replace( "{uri}", server->uri() );
  body.replace( "{method}", server->method() == HTTP_GET ? String("GET") : String("POST" ) ); 
  body.replace( "{args}", String(sargs) );

  String arglist = "";
      
  for ( int i = 0; i < sargs; i++ ) {
    arglist += "<li><span class=\"text-muted\">" + server->argName( i ) +": </span>";
    arglist += "<span class=\"text-success\">" + server->arg( i ) + "</span></li>";
  }
  body.replace("{arglist}", arglist);
  page.replace("{body}", body);
  
  server->sendHeader("Cache-Control", "no-cache, no-store, must-revalidate");
  server->sendHeader("Pragma", "no-cache");
  server->sendHeader("Expires", "-1");
  server->send( 404, "text/html", page );

}

String Portal::basePage() {
  
  String page = FPSTR(ap_mode ? HTML_SIMPLE_TPL : HTML_FULL_TPL);
  String appdata = FPSTR(APP_NAME);
  appdata += " ver .";
  appdata += FPSTR(APP_VER);
  page.replace("{title}", appdata);
  page.replace("{message}", message);
  return page;
}

String Portal::getMessageTpl() {
  return FPSTR(ap_mode ? HTML_SIMPLE_ALERT_TPL : HTML_FULL_ALERT_TPL);
}

boolean Portal::redirect() {

  if ( ap_mode && !ConnectionManager::isIp(server->hostHeader())) {
    Serial.println("Richiesto un hostname redirigo la richiesta verso l'ip locale.");
    this->redirectHeaders(String("http://") + server->client().localIP().toString());
    return true;
  }
  return false;
}

void Portal::redirectHeaders(String where) {
  
      Serial.println("Redirigo la richiesta verso ");
      Serial.println(where);

      server->sendHeader("Location", where, true);
      // nessuna intestazione Content-length, perchè non inviamo contenuto
      server->send ( 302, "text/plain", ""); 
      // è necessario chiudere la connessione manualmente
      server->client().stop();
}

String Portal::getDevPanel() {
  
  String devpane = FPSTR(HTML_DEV_PANEL);
  String * list = DeviceHandler::getDevicesName();
  int dn = DeviceHandler::getDevicesNum();

  devpane += prepareModal(
    String("device-edit"),
    String("Modifica/Crea dispositivo"),
    prepareDeviceForm(),
    "saveDeviceData"
  );
  devpane += prepareModal(
    String("device-delete"),
    String("Elimina dispositivo"),
    String("Eliminare il dispositivo <b class=\"device-name\"></b> e i comandi configurati?"),
    "deleteDevice"
  );
  devpane += prepareModal(
    String("device-key-edit"),
    String("Tasto dispositivo"),
    "",
    "saveDeviceKey" 
  );

  devpane += prepareModal(
    String("device-key-delete"),
    String("Elimina tasto"),
    String("Eliminare il tasto <b class=\"device-key-name\"></b> del dispositivo <i class=\"device-name\"></i>"),
    "deleteDeviceKey"
  );

  String panelbody = FPSTR(HTML_DEV_LIST_TPL);
  panelbody += "<div id=\"device-template\" class=\"hidden\">";
  panelbody += FPSTR(HTML_DEV_LI_TPL);
  panelbody += FPSTR(HTML_DEV_PANE_TPL);
  panelbody += "</div>";

  String alert = FPSTR(HTML_FULL_ALERT_TPL);
  alert.replace("{message}", "Nessun dispositivo configurato");

  if (dn == 0) {
    panelbody.replace("{dev_li_list}", "");
    panelbody.replace("{dev_pane_list}","");
    alert.replace("{class}", "danger no-device-alert");
    panelbody += alert;
    devpane.replace("{panel_body}", panelbody);
    return devpane;
  }

  String li = "", pane = "", wrk;

  for (int i = 0; i < dn; i++) {
        wrk = FPSTR(HTML_DEV_LI_TPL);
        wrk.replace("{dev_name}", list[i]);
        li += wrk;
        wrk = FPSTR(HTML_DEV_PANE_TPL);
        wrk.replace("{dev_name}", list[i]);
        pane += wrk;
  }

  delete [] list;

  panelbody.replace("{dev_li_list}", li);
  panelbody.replace("{dev_pane_list}", pane);
  alert.replace("{class}", "danger no-device-alert hidden");
  panelbody += alert;
  devpane.replace("{panel_body}", panelbody);

  return devpane;
    
}

String Portal::prepareDeviceForm() {

  String form = FPSTR(HTML_FORM_EDIT_DEVICE);
  int qt = DeviceHandler::getDeviceTypesNum();
  String tpl, options = "";

  for( int i=0; i < qt; i++){
    tpl = FPSTR(HTML_OPTION_TPL);
    tpl.replace("{value}", DeviceHandler::getDeviceTypes()[i]);
    tpl.replace("{name}", DeviceHandler::getDeviceTypesDescription()[i]);
    options += tpl;
  }
  form.replace("{device_types}", options);
  return form;
}

String Portal::prepareModal(String const &id, String const &title, String const &body, String const &ok_callback) {

  String modal = FPSTR(HTML_MODAL_TPL);
  modal.replace("{id}", id);
  modal.replace("{title}", title);
  modal.replace("{body}", body);
  modal.replace("{ok-callback}", ok_callback);
  return modal;
}

String Portal::getDeviceKeyAttrs(Device &d) {

  int num = d.getKeysPropertyNum();
  Key * key = d.getKeys();

  
  if (!key)
    return "";

  String pairs = " ";

  while (key) {

    pairs += Portal::keyAttrToJson(num, key);
    pairs += ",";
    key = key->getNext();
  }
  pairs.setCharAt(pairs.length() - 1, ' ');
  return pairs;
  
}

String Portal::getDeviceData(Device &d) {

  String json = "\"name\":\"" + d.getName() + "\",";
  json += "\"type\":\"" + d.getType() + "\",";
  json += "\"keys\":[" + getDeviceKeyAttrs(d) + "]";
  return json;
}

String Portal::getMainMenu() {
  String tpl = FPSTR(HTML_ROOT_TPL);
  String menu = FPSTR(HTML_WIFI_MENU);

  if (!ap_mode) {
    menu += FPSTR(HTML_DEVICE_MENU);
  }
  tpl.replace("{menu}", menu);
  return tpl;
}

String Portal::keyAttrToJson(int num, Key * key) {

    String jattrs = "{";

    for (int i = 0; i < num; i++) {
      jattrs += String("\"") + key->getPropertyNameById(i) + String("\":");
      jattrs += String("\"") + key->getPropertyById(i) + String("\",");
    }

    jattrs.remove(jattrs.length() - 1);
    jattrs += "}";
    return jattrs;
}