pandemonium_engine/modules/http_server_simple/web_server_simple.h

#ifndef WEB_SERVER_SIMPLE_H
#define WEB_SERVER_SIMPLE_H

/*************************************************************************/
/*  web_server_simple.h                                                  */
/*************************************************************************/
/*                         This file is part of:                         */
/*                          PANDEMONIUM ENGINE                           */
/*             https://github.com/Relintai/pandemonium_engine            */
/*************************************************************************/
/* Copyright (c) 2022-present Péter Magyar.                              */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md).   */
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur.                 */
/*                                                                       */
/* 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.                */
/*************************************************************************/

#include "core/io/image_loader.h"
#include "core/io/json.h"
#include "core/io/stream_peer_ssl.h"
#include "core/io/tcp_server.h"
#include "core/io/zip_io.h"
#include "core/os/mutex.h"

#include "modules/web/http/web_server.h"

#include "core/config/project_settings.h"

class HTTPServerSimple;

class WebServerSimple : public WebServer {
	GDCLASS(WebServerSimple, WebServer);

public:
	enum MaxRequestSizeTypes {
		MAX_REQUEST_SIZE_TYPE_BYTE = 0,
		MAX_REQUEST_SIZE_TYPE_KILO_BYTE = 1,
		MAX_REQUEST_SIZE_TYPE_MEGA_BYTE = 2,
		MAX_REQUEST_SIZE_TYPE_GIGA_BYTE = 3,
	};

	enum FileUploadStoreType {
		FILE_UPLOAD_STORE_TYPE_MEMORY = 0,
		FILE_UPLOAD_STORE_TYPE_TEMP_FILES,
		//FILE_UPLOAD_STORE_TYPE_TEMP_FILES_SORTED_FOLDERS -> Use a hash as file name, and sort them into folders like /ab/cd/abcd... TODO
	};

	int get_bind_port();
	void set_bind_port(const int val);

	String get_bind_host();
	void set_bind_host(const String &val);

	bool get_start_on_ready();
	void set_start_on_ready(const bool val);

	bool get_use_ssl();
	void set_use_ssl(const bool val);

	String get_ssl_key();
	void set_ssl_key(const String &val);

	String get_ssl_cert();
	void set_ssl_cert(const String &val);

	bool get_use_poll_thread();
	void set_use_poll_thread(const bool val);

	bool get_use_worker_threads();
	void set_use_worker_threads(const bool val);

	int get_worker_thread_count();
	void set_worker_thread_count(const int val);

	MaxRequestSizeTypes get_max_request_size_type();
	void set_max_request_size_type(const MaxRequestSizeTypes val);

	// This includes the entire request header,
	// including file uploads (only if they are stored in memory) because
	// then a big file upload / request can eat all the ram in a server!
	// Also 0 means 0, not unlimited -> This should NOT change (Reason: line above).
	int get_max_request_size();
	void set_max_request_size(const int val);

	FileUploadStoreType upload_get_file_store_type();
	void upload_set_file_store_type(const FileUploadStoreType val);

	String upload_get_temp_file_store_path();
	void upload_set_temp_file_store_path(const String &val);

	// Total, not per file (less room for misconfigurations). Only relevant if FILE_UPLOAD_STORE_TYPE_TEMP_FILES.
	MaxRequestSizeTypes upload_get_request_max_file_size_type();
	void upload_set_request_max_file_size_type(const MaxRequestSizeTypes val);

	int upload_get_request_max_file_size();
	void upload_set_request_max_file_size(const int val);

	void add_mime_type(const String &file_extension, const String &mime_type);
	void remove_mime_type(const String &file_extension);

	bool is_running() const;

	void _start();
	void _stop();

	Dictionary _unregister_connection_for_request(const Ref<WebServerRequest> &request);

	WebServerSimple();
	~WebServerSimple();

protected:
	void _apply_max_request_size_type();
	void _apply_request_max_file_upload_size_type();

	void _validate_property(PropertyInfo &property) const;
	void _notification(int p_what);

	static void _bind_methods();

	int _bind_port;
	String _bind_host;

	bool _start_on_ready;

	bool _use_ssl;
	String _ssl_key;
	String _ssl_cert;

	bool _use_poll_thread;
	bool _use_worker_threads;
	int _worker_thread_count;

	bool _single_threaded_poll;

	MaxRequestSizeTypes _max_request_size_type;
	int _max_request_size;

	FileUploadStoreType _upload_file_store_type;
	String _upload_temp_file_store_path;
	MaxRequestSizeTypes _upload_request_max_file_size_type;
	int _upload_request_max_file_size;

	Ref<HTTPServerSimple> _server;
	bool _server_quit;
	Mutex _server_lock;
	Thread *_poll_thread;
	bool _running;

	static void _server_thread_poll(void *data);
};

VARIANT_ENUM_CAST(WebServerSimple::MaxRequestSizeTypes);
VARIANT_ENUM_CAST(WebServerSimple::FileUploadStoreType);

#endif