server.cpp

////////////////////////////////////////////////////////////////////////////////
// INCLUDE FILES
////////////////////////////////////////////////////////////////////////////////
#include <arduino.h>
#include <ArduinoJson.h>
#include <FS.h>

#include "server.h"
#include "lua.h"




////////////////////////////////////////////////////////////////////////////////
// MAIN WEB SERVER OBJECT LISTENING ON TCP PORT 80
////////////////////////////////////////////////////////////////////////////////
ESP8266WebServer _server(80);




////////////////////////////////////////////////////////////////////////////////
// ??
////////////////////////////////////////////////////////////////////////////////
String getContentType(String filename) {
//	if (_server.hasArg(F("download")))	return F("application/octet-stream");
	if (_server.hasArg("download"))		return F("application/octet-stream");
	if (filename.endsWith(F(".txt")))	return F("text/plain");
	if (filename.endsWith(F(".lua")))	return F("text/plain");
	if (filename.endsWith(F(".htm")))	return F("text/html");
	if (filename.endsWith(F(".html")))	return F("text/html");
	if (filename.endsWith(F(".css")))	return F("text/css");
	if (filename.endsWith(F(".xml")))	return F("text/xml");
	if (filename.endsWith(F(".js")))	return F("application/javascript");
	if (filename.endsWith(F(".json")))	return F("application/json");
	if (filename.endsWith(F(".png")))	return F("image/png");
	if (filename.endsWith(F(".gif")))	return F("image/gif");
	if (filename.endsWith(F(".jpg")))	return F("image/jpeg");
	if (filename.endsWith(F(".jpeg")))	return F("image/jpeg");
	if (filename.endsWith(F(".ico")))	return F("image/x-icon");
	if (filename.endsWith(F(".svg")))	return F("image/svg+xml");
	if (filename.endsWith(F(".pdf")))	return F("application/x-pdf");
	if (filename.endsWith(F(".zip")))	return F("application/x-zip");
	if (filename.endsWith(F(".gz")))	return F("application/x-gzip");
	if (filename.endsWith(F(".woff2")))	return F("font/woff2");
	if (filename.endsWith(F(".c")))		return F("text/plain");
	if (filename.endsWith(F(".cpp")))	return F("text/plain");
	if (filename.endsWith(F(".h")))		return F("text/plain");
	if (filename.endsWith(F(".hpp")))	return F("text/plain");
	if (filename.endsWith(F(".log")))	return F("text/plain");

	return F("application/octet-stream");
}




////////////////////////////////////////////////////////////////////////////////
// ??
////////////////////////////////////////////////////////////////////////////////
bool handleFileRead(String path) {
	if (path.endsWith("/")) path += F("index.html");

	String contentType	= getContentType(path);
	String pathWithGz	= path + F(".gz");

	if (SPIFFS.exists(pathWithGz)  ||  likely(SPIFFS.exists(path))) {
		if (SPIFFS.exists(pathWithGz)) path += F(".gz");
		File file	= SPIFFS.open(path, "r");
		size_t sent	= _server.streamFile(file, contentType);
		file.close();
		return true;
	}

	return false;
}




////////////////////////////////////////////////////////////////////////////////
// ??
////////////////////////////////////////////////////////////////////////////////
void server_setup() {




	////////////////////////////////////////////////////////////////////////////
	// ROOT DIRECTORY, SHOW STATUS INFORMATION
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/"), []() {
		_server.client().setNoDelay(true);

		char buf[100] = "";

		snprintf(
			buf,
			sizeof(buf),
			LUASTR("ESP %d, uptime %d\n"),
			ESP.getChipId(),
			millis() / 1000
		);

		_server.send(HTTP_OK, F("text/plain"), buf);
	});




	////////////////////////////////////////////////////////////////////////////
	// EVALUATE A SCRIPT
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/eval"), []() {
		_server.client().setNoDelay(true);

		const char *code = _server.arg("code");

		if (unlikely(spider_eval(code))) {
			Serial.println(F("Unable to eval LUA script"));
			Serial.println(spider_error);
			_server.send(HTTP_SERVER_ERROR, F("text/plain"), spider_error);
			return;
		}

		_server.send(HTTP_OK, F("text/plain"), F("OK"));
	});




	////////////////////////////////////////////////////////////////////////////
	// EXECUTE THE GIVEN LUA SCRIPT BY SPIFFS FILENAME
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/script"), []() {
		_server.client().setNoDelay(true);

		const char *code = _server.arg("code");

		//RESET LUA INSTANCE
		if (unlikely(lua_setup())) {
			Serial.println(F("Unable to setup LUA instance"));
			Serial.println(spider_error);
			_server.send(HTTP_SERVER_ERROR, F("text/plain"), spider_error);
			return;
		}

		if (unlikely(spider_eval(code))) {
			Serial.println(F("Unable to execute LUA script"));
			Serial.println(spider_error);
			_server.send(HTTP_SERVER_ERROR, F("text/plain"), spider_error);
			return;
		}

		_server.send(HTTP_OK, F("text/plain"), F("OK"));
	});




	////////////////////////////////////////////////////////////////////////////
	// RESET MICROCONTROLLER
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/reset"), []() {
		_server.client().setNoDelay(true);
		//TODO: _server.client().close();
		ESP.reset();
	});




	////////////////////////////////////////////////////////////////////////////
	// RESTART MICROCONTROLLER
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/restart"), []() {
		_server.client().setNoDelay(true);
		//TODO: _server.client().close();
		ESP.restart();
	});




	////////////////////////////////////////////////////////////////////////////
	// SAVE A FILE TO THE SPIFFS
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/save"), []() {
		_server.client().setNoDelay(true);

		const char	*code	= _server.arg("code");
		String		 name	= _server.arg(F("name"));

		if (name.charAt(0) != '/') name = "/" + name;

		if (unlikely(name == "/")) {
			String error = F("Invalid file name: ");
			error += name;
			Serial.println(error);
			_server.send(HTTP_SERVER_ERROR, F("text/plain"), error);
			return;
		}

		String msg	= F("Attempting to save: ");
		Serial.println(msg + name);

		File file	= SPIFFS.open(name, "w");

		if (file) {
			file.print(code);
			file.close();

		} else {
			_server.send(
				HTTP_SERVER_ERROR,
				F("text/plain"),
				F("Unable to open file for writing")
			);
		}

		_server.send(HTTP_OK, F("text/plain"), F("OK"));
	});




	////////////////////////////////////////////////////////////////////////////
	// EXECUTE THE GIVEN LUA SCRIPT BY SPIFFS FILENAME
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/run"), []() {
		_server.client().setNoDelay(true);

		String name	= _server.arg(F("name"));

		if (name.charAt(0) != '/') {
			name	= "/" + name;
		}

		//CANNOT EXECUTE ROOT PATH OR EMPTY PATH
		if (unlikely(name == "/")) {
			String error = F("Invalid file name: ");
			Serial.println(error + name);
			_server.send(HTTP_SERVER_ERROR, F("text/plain"), error + name);
			return;
		}

		//RESET LUA INSTANCE
		if (unlikely(lua_setup())) {
			Serial.println(spider_error);
			_server.send(HTTP_SERVER_ERROR, F("text/plain"), spider_error);
			return;
		}

		//EXECUTE THE FILE
		if (unlikely(lua_file(name.c_str()))) {
			Serial.println(spider_error);
			_server.send(HTTP_SERVER_ERROR, F("text/plain"), spider_error);
			return;
		}

		//WE GOOD, LET CLIENT KNOW!
		_server.send(HTTP_OK, F("text/plain"), F("OK"));
	});




	////////////////////////////////////////////////////////////////////////////
	// PING / PONG
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/ping"), []() {
		_server.client().setNoDelay(true);
		_server.send(HTTP_OK, F("text/plain"), F("pong"));
	});




	////////////////////////////////////////////////////////////////////////////
	// DIRECTORY LISTING OF ALL FILES IN SPIFFS
	////////////////////////////////////////////////////////////////////////////
	_server.on(F("/dir"), []() {
		_server.client().setNoDelay(true);

		// CREATE A NEW JSON DOCUMENT
		DynamicJsonDocument json(JSON_ARRAY_SIZE(100));
		JsonArray	files	= json.createNestedArray(F("files"));

		// POPULATE THE DOCUMENT WITH OUR LIST OF FILES
		Dir dir = SPIFFS.openDir("");
		while (dir.next()) {
			files.add( dir.fileName() );
		}

		// SERIALIZE AND OUTPUT TO CLIENT
		String text;
		serializeJson(json, text);
		_server.send(HTTP_OK, F("application/json"), text);
	});




	////////////////////////////////////////////////////////////////////////////
	// SEND A FILE FROM FILE SYSTEM IF AVAILABLE, IF NOT THEN ERROR 404
	////////////////////////////////////////////////////////////////////////////
	_server.onNotFound([](){
		_server.client().setNoDelay(true);

		if (unlikely(!handleFileRead(_server.uri()))) {
			_server.send(HTTP_NOT_FOUND, F("text/plain"), F("File Not Found"));
		}
	});




	////////////////////////////////////////////////////////////////////////////
	// START THE WEB SERVER
	////////////////////////////////////////////////////////////////////////////
	_server.begin();

}