squeezelite-esp32/components/wifi-manager/http_server.c

/*
Copyright (c) 2017-2019 Tony Pottier

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

@file http_server.c
@author Tony Pottier
@brief Defines all functions necessary for the HTTP server to run.

Contains the freeRTOS task for the HTTP listener and all necessary support
function to process requests, decode URLs, serve files, etc. etc.

@note http_server task cannot run without the wifi_manager task!
@see https://idyl.io
@see https://github.com/tonyp7/esp32-wifi-manager
*/

#include "http_server.h"
#include "cmd_system.h"
#include "../squeezelite-ota/squeezelite-ota.h"

#define NVS_PARTITION_NAME "nvs"

/* @brief tag used for ESP serial console messages */
static const char TAG[] = "http_server";
static const char json_start[] = "{ \"autoexec\": %u, \"list\": [";
static const char json_end[] = "]}";
static const char template[] = "{ \"%s\": \"%s\" }";
static const char array_separator[]=",";
static char *s = "\"";
static char *r = "\\\"";
/* @brief task handle for the http server */
static TaskHandle_t task_http_server = NULL;
extern char current_namespace[];

/**
 * @brief embedded binary data.
 * @see file "component.mk"
 * @see https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#embedding-binary-data
 */
extern const uint8_t style_css_start[] asm("_binary_style_css_start");
extern const uint8_t style_css_end[]   asm("_binary_style_css_end");
extern const uint8_t jquery_gz_start[] asm("_binary_jquery_min_js_gz_start");
extern const uint8_t jquery_gz_end[] asm("_binary_jquery_min_js_gz_end");
extern const uint8_t popper_gz_start[] asm("_binary_popper_min_js_gz_start");
extern const uint8_t popper_gz_end[] asm("_binary_popper_min_js_gz_end");
extern const uint8_t bootstrap_js_gz_start[] asm("_binary_bootstrap_min_js_gz_start");
extern const uint8_t bootstrap_js_gz_end[] asm("_binary_bootstrap_min_js_gz_end");
extern const uint8_t bootstrap_css_gz_start[] asm("_binary_bootstrap_min_css_gz_start");
extern const uint8_t bootstrap_css_gz_end[] asm("_binary_bootstrap_min_css_gz_end");
extern const uint8_t code_js_start[] asm("_binary_code_js_start");
extern const uint8_t code_js_end[] asm("_binary_code_js_end");
extern const uint8_t index_html_start[] asm("_binary_index_html_start");
extern const uint8_t index_html_end[] asm("_binary_index_html_end");


/* const http headers stored in ROM */
const static char http_hdr_template[] = "HTTP/1.1 200 OK\nContent-type: %s\nAccept-Ranges: bytes\nContent-Length: %d\nContent-Encoding: %s\n\n";
const static char http_html_hdr[] = "HTTP/1.1 200 OK\nContent-type: text/html\n\n";
const static char http_css_hdr[] = "HTTP/1.1 200 OK\nContent-type: text/css\nCache-Control: public, max-age=31536000\n\n";
const static char http_js_hdr[] = "HTTP/1.1 200 OK\nContent-type: text/javascript\n\n";
const static char http_400_hdr[] = "HTTP/1.1 400 Bad Request\nContent-Length: 0\n\n";
const static char http_404_hdr[] = "HTTP/1.1 404 Not Found\nContent-Length: 0\n\n";
const static char http_503_hdr[] = "HTTP/1.1 503 Service Unavailable\nContent-Length: 0\n\n";
const static char http_ok_json_no_cache_hdr[] = "HTTP/1.1 200 OK\nContent-type: application/json\nCache-Control: no-store, no-cache, must-revalidate, max-age=0\nPragma: no-cache\n\n";
const static char http_redirect_hdr_start[] = "HTTP/1.1 302 Found\nLocation: http://";
const static char http_redirect_hdr_end[] = "/\n\n";





void CODE_RAM_LOCATION http_server_start(){

	if(task_http_server == NULL){
		xTaskCreate(&http_server, "http_server", 1024*5, NULL, WIFI_MANAGER_TASK_PRIORITY-1, &task_http_server);
	}
}

void CODE_RAM_LOCATION http_server(void *pvParameters) {

	struct netconn *conn, *newconn;
	err_t err;
	conn = netconn_new(NETCONN_TCP);
	netconn_bind(conn, IP_ADDR_ANY, 80);
	netconn_listen(conn);
	ESP_LOGI(TAG, "HTTP Server listening on 80/tcp");
	do {
		err = netconn_accept(conn, &newconn);
		if (err == ERR_OK) {
			http_server_netconn_serve(newconn);
			netconn_delete(newconn);
		}
		else
		{
			ESP_LOGE(TAG,"Error accepting new connection. Terminating HTTP server");
		}
		taskYIELD();  /* allows the freeRTOS scheduler to take over if needed. */
	} while(err == ERR_OK);

	netconn_close(conn);
	netconn_delete(conn);

	vTaskDelete( NULL );
}


char* CODE_RAM_LOCATION http_server_get_header(char *request, char *header_name, int *len) {
	*len = 0;
	char *ret = NULL;
	char *ptr = NULL;

	ptr = strstr(request, header_name);
	if (ptr) {
		ret = ptr + strlen(header_name);
		ptr = ret;
		while (*ptr != '\0' && *ptr != '\n' && *ptr != '\r') {
			(*len)++;
			ptr++;
		}
		return ret;
	}
	return NULL;
}
char* CODE_RAM_LOCATION http_server_search_header(char *request, char *header_name, int *len, char ** parm_name, char ** next_position, char * bufEnd) {
	*len = 0;
	char *ret = NULL;
	char *ptr = NULL;
	int currentLength=0;

	ESP_LOGD(TAG, "header name: [%s]\nRequest: %s", header_name, request);
	ptr = strstr(request, header_name);


	if (ptr!=NULL && ptr<bufEnd) {
		ret = ptr + strlen(header_name);
		ptr = ret;
		currentLength=(int)(ptr-request);
		ESP_LOGD(TAG, "found string at %d", currentLength);

		while (*ptr != '\0' && *ptr != '\n' && *ptr != '\r' && *ptr != ':' && ptr<bufEnd) {
			ptr++;
		}
		if(*ptr==':'){
			currentLength=(int)(ptr-ret);
			ESP_LOGD(TAG, "Found parameter name end, length : %d", currentLength);
			// save the parameter name: the string between header name and ":"
			*parm_name=malloc(currentLength+1);
			if(*parm_name==NULL){
				ESP_LOGE(TAG, "Unable to allocate memory for new header name");
				return NULL;
			}
			memset(*parm_name, 0x00,currentLength+1);
			strncpy(*parm_name,ret,currentLength);
			ESP_LOGD(TAG, "Found parameter name : %s ", *parm_name);
			ptr++;
			while (*ptr == ' ' && ptr<bufEnd) {
				ptr++;
			}

		}
		ret=ptr;
		while (*ptr != '\0' && *ptr != '\n' && *ptr != '\r'&& ptr<bufEnd) {
			(*len)++;
			ptr++;
		}
		// Terminate value inside its actual buffer so we can treat it as individual string
		*ptr='\0';
		currentLength=(int)(ptr-ret);
		ESP_LOGD(TAG, "Found parameter value end, length : %d, 	value: %s", currentLength,ret );

		*next_position=++ptr;
		return ret;
	}
	ESP_LOGD(TAG, "No more match for : %s", header_name);
	return NULL;
}
void CODE_RAM_LOCATION http_server_send_resource_file(struct netconn *conn,const uint8_t * start, const uint8_t * end, char * content_type,char * encoding){
	uint16_t len=end - start;
	size_t  buff_length= sizeof(http_hdr_template)+strlen(content_type)+strlen(encoding);
	char * http_hdr=malloc(buff_length);
	if( http_hdr == NULL){
		ESP_LOGE(TAG,"Cound not allocate %d bytes for headers.",buff_length);
		netconn_write(conn, http_503_hdr, sizeof(http_503_hdr) - 1, NETCONN_NOCOPY);
	}
	else
	{
		memset(http_hdr,0x00,buff_length);
		snprintf(http_hdr, buff_length-1,http_hdr_template,content_type,len,encoding);
		netconn_write(conn, http_hdr, strlen(http_hdr), NETCONN_NOCOPY);
		ESP_LOGD(TAG,"sending response : %s",http_hdr);
		netconn_write(conn, start, end - start, NETCONN_NOCOPY);
		free(http_hdr);
	}
}

void CODE_RAM_LOCATION http_server_netconn_serve(struct netconn *conn) {

	struct netbuf *inbuf;
	char *buf = NULL;
	u16_t buflen;
	err_t err;
	const char new_line[2] = "\n";

	err = netconn_recv(conn, &inbuf);
	if (err == ERR_OK) {

		netbuf_data(inbuf, (void**)&buf, &buflen);

		/* extract the first line of the request */
		char *save_ptr = buf;
		char *line = strtok_r(save_ptr, new_line, &save_ptr);
		ESP_LOGD(TAG,"Processing line %s",line);

		if(line) {

			/* captive portal functionality: redirect to access point IP for HOST that are not the access point IP OR the STA IP */
			int lenH = 0;
			char *host = http_server_get_header(save_ptr, "Host: ", &lenH);
			/* determine if Host is from the STA IP address */
			wifi_manager_lock_sta_ip_string(portMAX_DELAY);
			bool access_from_sta_ip = lenH > 0?strstr(host, wifi_manager_get_sta_ip_string()):false;
			wifi_manager_unlock_sta_ip_string();

			if (lenH > 0 && !strstr(host, DEFAULT_AP_IP) && !access_from_sta_ip) {
				ESP_LOGI(TAG,"Redirecting to default AP IP Address : %s", DEFAULT_AP_IP);
				netconn_write(conn, http_redirect_hdr_start, sizeof(http_redirect_hdr_start) - 1, NETCONN_NOCOPY);
				netconn_write(conn, DEFAULT_AP_IP, sizeof(DEFAULT_AP_IP) - 1, NETCONN_NOCOPY);
				netconn_write(conn, http_redirect_hdr_end, sizeof(http_redirect_hdr_end) - 1, NETCONN_NOCOPY);

			}
			else{
                //static stuff
				/* default page */
				if(strstr(line, "GET / ")) {
					netconn_write(conn, http_html_hdr, sizeof(http_html_hdr) - 1, NETCONN_NOCOPY);
					netconn_write(conn, index_html_start, index_html_end- index_html_start, NETCONN_NOCOPY);
				}
				else if(strstr(line, "GET /code.js ")) {
					netconn_write(conn, http_js_hdr, sizeof(http_js_hdr) - 1, NETCONN_NOCOPY);
					netconn_write(conn, code_js_start, code_js_end - code_js_start, NETCONN_NOCOPY);
				}
				else if(strstr(line, "GET /style.css ")) {
					netconn_write(conn, http_css_hdr, sizeof(http_css_hdr) - 1, NETCONN_NOCOPY);
					netconn_write(conn, style_css_start, style_css_end - style_css_start, NETCONN_NOCOPY);
				}
				else if(strstr(line, "GET /jquery.js ")) {
					http_server_send_resource_file(conn,jquery_gz_start, jquery_gz_end, "text/javascript", "gzip" );
				}
				else if(strstr(line, "GET /popper.js ")) {
					http_server_send_resource_file(conn,popper_gz_start, popper_gz_end, "text/javascript", "gzip" );
				}
				else if(strstr(line, "GET /bootstrap.js ")) {
					http_server_send_resource_file(conn,bootstrap_js_gz_start, bootstrap_js_gz_end, "text/javascript", "gzip" );
				}
				else if(strstr(line, "GET /bootstrap.css ")) {
					http_server_send_resource_file(conn,bootstrap_css_gz_start, bootstrap_css_gz_end, "text/css", "gzip" );
				}

                //dynamic stuff
				else if(strstr(line, "GET /ap.json ")) {
					/* if we can get the mutex, write the last version of the AP list */
					ESP_LOGI(TAG,"Processing ap.json request");
					if(wifi_manager_lock_json_buffer(( TickType_t ) 10)){
						netconn_write(conn, http_ok_json_no_cache_hdr, sizeof(http_ok_json_no_cache_hdr) - 1, NETCONN_NOCOPY);
						char *buff = wifi_manager_get_ap_list_json();
						netconn_write(conn, buff, strlen(buff), NETCONN_NOCOPY);
						wifi_manager_unlock_json_buffer();
					}
					else{
						netconn_write(conn, http_503_hdr, sizeof(http_503_hdr) - 1, NETCONN_NOCOPY);
						ESP_LOGE(TAG, "http_server_netconn_serve: GET /ap.json failed to obtain mutex");
					}
					/* request a wifi scan */
					ESP_LOGI(TAG,"Starting wifi scan");
					wifi_manager_scan_async();
				}
				else if(strstr(line, "GET /config.json ")){
					ESP_LOGI(TAG,"Serving config.json");

					char * autoexec_value=NULL;
					uint8_t autoexec_flag=0;
					int locbuflen=MAX_COMMAND_LINE_SIZE*4+strlen(template)+1;
					char * config_buffer = malloc(locbuflen);

					if(!config_buffer)
					{
						ESP_LOGE(TAG,"Unable to allocate buffer for config.json!");
						netconn_write(conn, http_503_hdr, sizeof(http_503_hdr) - 1, NETCONN_NOCOPY);
					}
					else
					{
						int i=1;
						size_t l = 0;
						nvs_entry_info_t info;

						netconn_write(conn, http_ok_json_no_cache_hdr, sizeof(http_ok_json_no_cache_hdr) - 1, NETCONN_NOCOPY);
						autoexec_flag = wifi_manager_get_flag();
						snprintf(config_buffer,locbuflen-1, json_start, autoexec_flag);
						netconn_write(conn, config_buffer, strlen(config_buffer), NETCONN_NOCOPY);

						ESP_LOGI(TAG, "About to get config from flash");
						nvs_iterator_t it = nvs_entry_find(NVS_PARTITION_NAME, NULL, NVS_TYPE_STR);
						if (it == NULL) {
							ESP_LOGW(TAG, "No nvs entry found in %s",NVS_PARTITION_NAME );
						}
						while (it != NULL){
							nvs_entry_info(it, &info);
							if(strstr(info.namespace_name, current_namespace)){
								if(i>1)
								{
									netconn_write(conn, array_separator, strlen(array_separator), NETCONN_NOCOPY);
									ESP_LOGD(TAG,"%s", array_separator);
								}

								autoexec_value = wifi_manager_alloc_get_config(info.key, &l);
								strreplace(autoexec_value, s, r);
								ESP_LOGI(TAG,"Namespace %s, key=%s, value=%s", info.namespace_name, info.key,autoexec_value );
								snprintf(config_buffer, locbuflen-1, template, info.key, autoexec_value);
								netconn_write(conn, config_buffer, strlen(config_buffer), NETCONN_NOCOPY);
								ESP_LOGD(TAG,"Freeing memory for command [%s] value [%s]", info.key, autoexec_value);
								free(autoexec_value );
								i++;
							}
							it = nvs_entry_next(it);
						}
						free(config_buffer);
						netconn_write(conn, json_end, strlen(json_end), NETCONN_NOCOPY);
					}
					ESP_LOGD(TAG,"Done serving config.json");
				}
				else if(strstr(line, "POST /config.json ")){
					ESP_LOGI(TAG,"Serving POST config.json");

					int lenA=0;
					char * last_parm=save_ptr;
					char * next_parm=save_ptr;
					char  * last_parm_name=NULL;
					uint8_t autoexec_flag=0;
					bool bErrorFound=false;
					bool bOTA=false;
					char * otaURL=NULL;

					while(last_parm!=NULL){
						// Search will return
						ESP_LOGI(TAG, "Getting parameters from X-Custom headers");
						last_parm = http_server_search_header(next_parm, "X-Custom-", &lenA, &last_parm_name,&next_parm,buf+buflen);
						if(last_parm!=NULL && last_parm_name!=NULL){
							ESP_LOGI(TAG, "http_server_netconn_serve: config.json/ call, found parameter %s=%s, length %i", last_parm_name, last_parm, lenA);
							if(strcmp(last_parm_name, "fwurl")==0){
								// we're getting a request to do an OTA from that URL
								ESP_LOGI(TAG, "OTA parameter found!");
								otaURL=strdup(last_parm);
								bOTA=true;
							}
							if(strcmp(last_parm_name, "autoexec")==0){
								autoexec_flag = atoi(last_parm);
								wifi_manager_save_autoexec_flag(autoexec_flag);
							}
							else {
								if(lenA < MAX_COMMAND_LINE_SIZE ){
									ESP_LOGD(TAG, "http_server_netconn_serve: config.json/ Storing parameter");
									wifi_manager_save_autoexec_config(last_parm,last_parm_name,lenA);
								}
								else
								{
									ESP_LOGE(TAG,"length is too long : %s = %s", last_parm_name, last_parm);
									last_parm=NULL;
									bErrorFound=true;
								}
							}
						}
						if(last_parm_name!=NULL) {
							free(last_parm_name);
							last_parm_name=NULL;
						}
					}
					if(bErrorFound){
						netconn_write(conn, http_400_hdr, sizeof(http_400_hdr) - 1, NETCONN_NOCOPY); //400 invalid request
					}
					else{
						if(bOTA){
							ESP_LOGI(TAG, "Restarting to process OTA for url %s",otaURL);
							netconn_write(conn, http_ok_json_no_cache_hdr, sizeof(http_ok_json_no_cache_hdr) - 1, NETCONN_NOCOPY); //200ok
							esp_restart();
						}
					}

				} 
				else if(strstr(line, "POST /connect.json ")) {
					ESP_LOGI(TAG, "http_server_netconn_serve: POST /connect.json");
					bool found = false;
					int lenS = 0, lenP = 0;
					char *ssid = NULL, *password = NULL;
					ssid = http_server_get_header(save_ptr, "X-Custom-ssid: ", &lenS);
					password = http_server_get_header(save_ptr, "X-Custom-pwd: ", &lenP);

					if(ssid && lenS <= MAX_SSID_SIZE && password && lenP <= MAX_PASSWORD_SIZE){
						wifi_config_t* config = wifi_manager_get_wifi_sta_config();
						memset(config, 0x00, sizeof(wifi_config_t));
						memcpy(config->sta.ssid, ssid, lenS);
						memcpy(config->sta.password, password, lenP);
						ESP_LOGD(TAG, "http_server_netconn_serve: wifi_manager_connect_async() call, with ssid: %s, password: %s", ssid, password);
						wifi_manager_connect_async();
						netconn_write(conn, http_ok_json_no_cache_hdr, sizeof(http_ok_json_no_cache_hdr) - 1, NETCONN_NOCOPY); //200ok
						found = true;
					}

					if(!found){
						/* bad request the authentification header is not complete/not the correct format */
						netconn_write(conn, http_400_hdr, sizeof(http_400_hdr) - 1, NETCONN_NOCOPY);
						ESP_LOGE(TAG, "bad request the authentification header is not complete/not the correct format");
					}

				}
				else if(strstr(line, "DELETE /connect.json ")) {
					ESP_LOGI(TAG, "http_server_netconn_serve: DELETE /connect.json");
					/* request a disconnection from wifi and forget about it */
					wifi_manager_disconnect_async();
					netconn_write(conn, http_ok_json_no_cache_hdr, sizeof(http_ok_json_no_cache_hdr) - 1, NETCONN_NOCOPY); /* 200 ok */
				}
				else if(strstr(line, "POST /reboot.json ")){
					esp_restart();
				}
				else if(strstr(line, "POST /recovery.json ")){
					guided_factory();
				}
				else if(strstr(line, "GET /status.json ")){
					ESP_LOGI(TAG,"Serving status.json");
					if(wifi_manager_lock_json_buffer(( TickType_t ) 10)){
						char *buff = wifi_manager_get_ip_info_json();
						if(buff){
							netconn_write(conn, http_ok_json_no_cache_hdr, sizeof(http_ok_json_no_cache_hdr) - 1, NETCONN_NOCOPY);
							netconn_write(conn, buff, strlen(buff), NETCONN_NOCOPY);

							wifi_manager_unlock_json_buffer();
						}
						else{
							netconn_write(conn, http_503_hdr, sizeof(http_503_hdr) - 1, NETCONN_NOCOPY);
						}
					}
					else{
						netconn_write(conn, http_503_hdr, sizeof(http_503_hdr) - 1, NETCONN_NOCOPY);
						ESP_LOGE(TAG, "http_server_netconn_serve: GET /status failed to obtain mutex");
					}
				}
				else{
					netconn_write(conn, http_400_hdr, sizeof(http_400_hdr) - 1, NETCONN_NOCOPY);
					ESP_LOGE(TAG, "bad request");
				}
			}
		}
		else{
			ESP_LOGE(TAG, "URL Not found. Sending 404.");
			netconn_write(conn, http_404_hdr, sizeof(http_404_hdr) - 1, NETCONN_NOCOPY);
		}
	}
	/* free the buffer */
	netbuf_delete(inbuf);
}

void CODE_RAM_LOCATION strreplace(char *src, char *str, char *rep)
{
    char *p = strstr(src, str);
    if (p)
    {
        int len = strlen(src)+strlen(rep)-strlen(str);
        char r[len];
        memset(r, 0, len);
        if ( p >= src ){
            strncpy(r, src, p-src);
            r[p-src]='\0';
            strncat(r, rep, strlen(rep));
            strncat(r, p+strlen(str), p+strlen(str)-src+strlen(src));
            strcpy(src, r);
            strreplace(p+strlen(rep), str, rep);
        }
    }
}