mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-16 03:12:43 +00:00
fdc6de2a27
adds a new "virtual" parameter `__request_body` which can be used in http rules, see below tremendously helps in producing arbitrary REST interfaces for example: ```xml <http_handlers> <rule> <methods>POST</methods> <url>/ingest</url> <handler> <type>predefined_query_handler</type> <query>INSERT INTO events(id, data) SELECT {id:UInt32}, {__request_body:String}</query> </handler> </rule> </http_handlers> ```
174 lines
6.0 KiB
C++
174 lines
6.0 KiB
C++
#pragma once
|
|
|
|
#include <Core/Names.h>
|
|
#include <Server/HTTP/HTMLForm.h>
|
|
#include <Server/HTTP/HTTPRequestHandler.h>
|
|
#include <Server/HTTP/WriteBufferFromHTTPServerResponse.h>
|
|
#include <Common/CurrentMetrics.h>
|
|
#include <Common/CurrentThread.h>
|
|
|
|
#include <re2/re2.h>
|
|
|
|
namespace CurrentMetrics
|
|
{
|
|
extern const Metric HTTPConnection;
|
|
}
|
|
|
|
namespace Poco { class Logger; }
|
|
|
|
namespace DB
|
|
{
|
|
|
|
class Session;
|
|
class Credentials;
|
|
class IServer;
|
|
struct Settings;
|
|
class WriteBufferFromHTTPServerResponse;
|
|
|
|
using CompiledRegexPtr = std::shared_ptr<const re2::RE2>;
|
|
|
|
class HTTPHandler : public HTTPRequestHandler
|
|
{
|
|
public:
|
|
HTTPHandler(IServer & server_, const std::string & name, const std::optional<String> & content_type_override_);
|
|
virtual ~HTTPHandler() override;
|
|
|
|
void handleRequest(HTTPServerRequest & request, HTTPServerResponse & response) override;
|
|
|
|
/// This method is called right before the query execution.
|
|
virtual void customizeContext(HTTPServerRequest & /* request */, ContextMutablePtr /* context */, ReadBuffer & /* body */) {}
|
|
|
|
virtual bool customizeQueryParam(ContextMutablePtr context, const std::string & key, const std::string & value) = 0;
|
|
|
|
virtual std::string getQuery(HTTPServerRequest & request, HTMLForm & params, ContextMutablePtr context) = 0;
|
|
|
|
private:
|
|
struct Output
|
|
{
|
|
/* Raw data
|
|
* ↓
|
|
* CascadeWriteBuffer out_maybe_delayed_and_compressed (optional)
|
|
* ↓ (forwards data if an overflow is occur or explicitly via pushDelayedResults)
|
|
* CompressedWriteBuffer out_maybe_compressed (optional)
|
|
* ↓
|
|
* WriteBufferFromHTTPServerResponse out
|
|
*/
|
|
|
|
std::shared_ptr<WriteBufferFromHTTPServerResponse> out;
|
|
/// Points to 'out' or to CompressedWriteBuffer(*out), depending on settings.
|
|
std::shared_ptr<WriteBuffer> out_maybe_compressed;
|
|
/// Points to 'out' or to CompressedWriteBuffer(*out) or to CascadeWriteBuffer.
|
|
std::shared_ptr<WriteBuffer> out_maybe_delayed_and_compressed;
|
|
|
|
bool finalized = false;
|
|
|
|
inline bool hasDelayed() const
|
|
{
|
|
return out_maybe_delayed_and_compressed != out_maybe_compressed;
|
|
}
|
|
|
|
inline void finalize()
|
|
{
|
|
if (finalized)
|
|
return;
|
|
finalized = true;
|
|
|
|
if (out_maybe_delayed_and_compressed)
|
|
out_maybe_delayed_and_compressed->finalize();
|
|
if (out_maybe_compressed)
|
|
out_maybe_compressed->finalize();
|
|
if (out)
|
|
out->finalize();
|
|
}
|
|
|
|
inline bool isFinalized() const
|
|
{
|
|
return finalized;
|
|
}
|
|
};
|
|
|
|
IServer & server;
|
|
Poco::Logger * log;
|
|
|
|
/// It is the name of the server that will be sent in an http-header X-ClickHouse-Server-Display-Name.
|
|
String server_display_name;
|
|
|
|
CurrentMetrics::Increment metric_increment{CurrentMetrics::HTTPConnection};
|
|
|
|
/// Reference to the immutable settings in the global context.
|
|
/// Those settings are used only to extract a http request's parameters.
|
|
/// See settings http_max_fields, http_max_field_name_size, http_max_field_value_size in HTMLForm.
|
|
const Settings & default_settings;
|
|
|
|
/// Overrides Content-Type provided by the format of the response.
|
|
std::optional<String> content_type_override;
|
|
|
|
// session is reset at the end of each request/response.
|
|
std::unique_ptr<Session> session;
|
|
|
|
// The request_credential instance may outlive a single request/response loop.
|
|
// This happens only when the authentication mechanism requires more than a single request/response exchange (e.g., SPNEGO).
|
|
std::unique_ptr<Credentials> request_credentials;
|
|
|
|
// Returns true when the user successfully authenticated,
|
|
// the session instance will be configured accordingly, and the request_credentials instance will be dropped.
|
|
// Returns false when the user is not authenticated yet, and the 'Negotiate' response is sent,
|
|
// the session and request_credentials instances are preserved.
|
|
// Throws an exception if authentication failed.
|
|
bool authenticateUser(
|
|
HTTPServerRequest & request,
|
|
HTMLForm & params,
|
|
HTTPServerResponse & response);
|
|
|
|
/// Also initializes 'used_output'.
|
|
void processQuery(
|
|
HTTPServerRequest & request,
|
|
HTMLForm & params,
|
|
HTTPServerResponse & response,
|
|
Output & used_output,
|
|
std::optional<CurrentThread::QueryScope> & query_scope);
|
|
|
|
void trySendExceptionToClient(
|
|
const std::string & s,
|
|
int exception_code,
|
|
HTTPServerRequest & request,
|
|
HTTPServerResponse & response,
|
|
Output & used_output);
|
|
|
|
static void pushDelayedResults(Output & used_output);
|
|
};
|
|
|
|
class DynamicQueryHandler : public HTTPHandler
|
|
{
|
|
private:
|
|
std::string param_name;
|
|
public:
|
|
explicit DynamicQueryHandler(IServer & server_, const std::string & param_name_ = "query", const std::optional<String>& content_type_override_ = std::nullopt);
|
|
|
|
std::string getQuery(HTTPServerRequest & request, HTMLForm & params, ContextMutablePtr context) override;
|
|
|
|
bool customizeQueryParam(ContextMutablePtr context, const std::string &key, const std::string &value) override;
|
|
};
|
|
|
|
class PredefinedQueryHandler : public HTTPHandler
|
|
{
|
|
private:
|
|
NameSet receive_params;
|
|
std::string predefined_query;
|
|
CompiledRegexPtr url_regex;
|
|
std::unordered_map<String, CompiledRegexPtr> header_name_with_capture_regex;
|
|
public:
|
|
PredefinedQueryHandler(
|
|
IServer & server_, const NameSet & receive_params_, const std::string & predefined_query_
|
|
, const CompiledRegexPtr & url_regex_, const std::unordered_map<String, CompiledRegexPtr> & header_name_with_regex_
|
|
, const std::optional<std::string> & content_type_override_);
|
|
|
|
void customizeContext(HTTPServerRequest & request, ContextMutablePtr context, ReadBuffer & body) override;
|
|
|
|
std::string getQuery(HTTPServerRequest & request, HTMLForm & params, ContextMutablePtr context) override;
|
|
|
|
bool customizeQueryParam(ContextMutablePtr context, const std::string & key, const std::string & value) override;
|
|
};
|
|
|
|
}
|