2023-01-03 21:27:36 +01:00
|
|
|
#ifndef WEB_SERVER_REQUEST_SCRIPTABLE_H
|
|
|
|
#define WEB_SERVER_REQUEST_SCRIPTABLE_H
|
|
|
|
|
2023-12-18 00:25:33 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* web_server_request_scriptable.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. */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
2023-01-03 21:27:36 +01:00
|
|
|
#include "core/containers/vector.h"
|
|
|
|
#include "core/string/ustring.h"
|
|
|
|
#include "core/variant/dictionary.h"
|
|
|
|
|
|
|
|
#include "core/object/object.h"
|
|
|
|
#include "core/object/reference.h"
|
|
|
|
|
|
|
|
#include "http_server_enums.h"
|
|
|
|
|
|
|
|
#include "web_server_request.h"
|
|
|
|
|
|
|
|
class WebServer;
|
|
|
|
class WebServerCookie;
|
|
|
|
class HTTPSession;
|
|
|
|
class WebPermission;
|
|
|
|
class WebNode;
|
|
|
|
|
|
|
|
class WebServerRequestScriptable : public WebServerRequest {
|
|
|
|
GDCLASS(WebServerRequestScriptable, WebServerRequest);
|
|
|
|
|
|
|
|
public:
|
|
|
|
virtual String get_cookie(const String &key);
|
|
|
|
|
|
|
|
virtual HTTPServerEnums::HTTPMethod get_method() const;
|
|
|
|
|
|
|
|
virtual int get_file_count() const;
|
|
|
|
virtual String get_file_file_name(const int index) const;
|
|
|
|
virtual String get_file_key(const int index) const;
|
2024-03-09 23:39:33 +01:00
|
|
|
virtual uint64_t get_file_length(const int index) const;
|
2023-01-03 21:27:36 +01:00
|
|
|
virtual PoolByteArray get_file_data(const int index) const;
|
|
|
|
virtual String get_file_data_str(const int index) const;
|
2024-03-10 09:07:13 +01:00
|
|
|
virtual Error move_file(const int index, const String &p_dest_file, const bool p_force = false);
|
2024-03-09 23:39:33 +01:00
|
|
|
virtual bool is_file_moved(const int index) const;
|
2023-01-03 21:27:36 +01:00
|
|
|
|
|
|
|
virtual String get_parameter(const String &key) const;
|
|
|
|
virtual String get_post_parameter(const String &key) const;
|
|
|
|
virtual String get_get_parameter(const String &key) const;
|
|
|
|
|
2023-03-22 13:20:25 +01:00
|
|
|
virtual void set_post_parameter(const String &key, const String &value);
|
|
|
|
virtual void set_get_parameter(const String &key, const String &value);
|
|
|
|
|
2023-12-22 13:02:17 +01:00
|
|
|
virtual String get_header_parameter(const String &key) const;
|
|
|
|
virtual void set_header_parameter(const String &key, const String &value);
|
|
|
|
|
2023-12-22 13:14:17 +01:00
|
|
|
virtual PoolStringArray get_header_parameter_keys() const;
|
|
|
|
virtual PoolStringArray get_parameter_keys() const;
|
|
|
|
virtual PoolStringArray get_post_parameter_keys() const;
|
|
|
|
virtual PoolStringArray get_get_parameter_keys() const;
|
|
|
|
|
2023-01-03 21:27:36 +01:00
|
|
|
virtual void send_redirect(const String &location, const HTTPServerEnums::HTTPStatusCode status_code = HTTPServerEnums::HTTP_STATUS_CODE_302_FOUND);
|
|
|
|
virtual void compile_body();
|
|
|
|
virtual void compile_and_send_body();
|
|
|
|
virtual void send();
|
|
|
|
virtual void send_file(const String &p_file_path);
|
|
|
|
virtual void send_error(int error_code);
|
|
|
|
virtual String parser_get_path();
|
|
|
|
virtual String get_host() const;
|
|
|
|
|
|
|
|
virtual String get_path_full() const;
|
|
|
|
|
|
|
|
virtual void update();
|
|
|
|
|
|
|
|
// script virtuals
|
2023-03-22 13:20:25 +01:00
|
|
|
virtual String _get_cookie(const String &key);
|
|
|
|
|
|
|
|
virtual HTTPServerEnums::HTTPMethod _get_method() const;
|
2023-01-03 21:27:36 +01:00
|
|
|
|
2023-03-22 13:20:25 +01:00
|
|
|
virtual int _get_file_count() const;
|
|
|
|
virtual String _get_file_file_name(const int index) const;
|
|
|
|
virtual String _get_file_key(const int index) const;
|
|
|
|
virtual int _get_file_length(const int index) const;
|
|
|
|
virtual PoolByteArray _get_file_data(const int index) const;
|
|
|
|
virtual String _get_file_data_str(const int index) const;
|
2024-03-10 09:07:13 +01:00
|
|
|
virtual Error _move_file(const int index, const String &p_dest_file, const bool p_force);
|
2024-03-09 23:39:33 +01:00
|
|
|
virtual bool _is_file_moved(const int index) const;
|
2023-01-03 21:27:36 +01:00
|
|
|
|
2023-03-22 13:20:25 +01:00
|
|
|
virtual String _get_parameter(const String &key) const;
|
|
|
|
virtual String _get_post_parameter(const String &key) const;
|
|
|
|
virtual String _get_get_parameter(const String &key) const;
|
2023-01-03 21:27:36 +01:00
|
|
|
|
2023-03-22 13:20:25 +01:00
|
|
|
virtual void _set_post_parameter(const String &key, const String &value);
|
|
|
|
virtual void _set_get_parameter(const String &key, const String &value);
|
2023-01-03 21:27:36 +01:00
|
|
|
|
2023-12-22 13:02:17 +01:00
|
|
|
virtual String _get_header_parameter(const String &key) const;
|
|
|
|
virtual void _set_header_parameter(const String &key, const String &value);
|
|
|
|
|
2023-12-22 13:14:17 +01:00
|
|
|
virtual PoolStringArray _get_header_parameter_keys() const;
|
|
|
|
virtual PoolStringArray _get_parameter_keys() const;
|
|
|
|
virtual PoolStringArray _get_post_parameter_keys() const;
|
|
|
|
virtual PoolStringArray _get_get_parameter_keys() const;
|
|
|
|
|
2023-01-03 21:27:36 +01:00
|
|
|
void _send_redirect(const String &location, const HTTPServerEnums::HTTPStatusCode status_code);
|
|
|
|
void _compile_body();
|
|
|
|
void _compile_and_send_body();
|
|
|
|
void _send();
|
|
|
|
void _send_file(const String &p_file_path);
|
|
|
|
void _send_error(int error_code);
|
|
|
|
String _parser_get_path();
|
|
|
|
String _get_host() const;
|
|
|
|
|
|
|
|
String _get_path_full() const;
|
|
|
|
|
|
|
|
void _update();
|
|
|
|
|
|
|
|
WebServerRequestScriptable();
|
|
|
|
~WebServerRequestScriptable();
|
|
|
|
|
|
|
|
void _set_server_bind(Node *v);
|
|
|
|
void _set_web_root_bind(Node *v);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|