#pragma once #include #include #include #include #include #include #include #include #include namespace DB { namespace ErrorCodes { extern const int LOGICAL_ERROR; } /// The difference from WriteBufferFromOStream is that this buffer gets the underlying std::ostream /// (using response.send()) only after data is flushed for the first time. This is needed in HTTP /// servers to change some HTTP headers (e.g. response code) before any data is sent to the client /// (headers can't be changed after response.send() is called). /// /// In short, it allows delaying the call to response.send(). /// /// Additionally, supports HTTP response compression (in this case corresponding Content-Encoding /// header will be set). class WriteBufferFromHTTPServerResponse : public BufferWithOwnMemory { private: Poco::Net::HTTPServerResponse & response; bool add_cors_header; bool compress; ZlibCompressionMethod compression_method; int compression_level = Z_DEFAULT_COMPRESSION; std::unique_ptr out_raw; std::experimental::optional deflating_buf; WriteBuffer * out = nullptr; /// Uncompressed HTTP body is written to this buffer. Points to out_raw or possibly to deflating_buf. void sendHeaders() { if (!out) { if (add_cors_header) { response.set("Access-Control-Allow-Origin","*"); } setResponseDefaultHeaders(response); if (compress && offset()) /// Empty response need not be compressed. { if (compression_method == ZlibCompressionMethod::Gzip) response.set("Content-Encoding", "gzip"); else if (compression_method == ZlibCompressionMethod::Zlib) response.set("Content-Encoding", "deflate"); else throw Exception("Logical error: unknown compression method passed to WriteBufferFromHTTPServerResponse", ErrorCodes::LOGICAL_ERROR); out_raw = std::make_unique(response.send()); /// Use memory allocated for the outer buffer in the buffer pointed to by out. This avoids extra allocation and copy. deflating_buf.emplace(*out_raw, compression_method, compression_level, working_buffer.size(), working_buffer.begin()); out = &deflating_buf.value(); } else { out_raw = std::make_unique(response.send(), working_buffer.size(), working_buffer.begin()); out = out_raw.get(); } } } void nextImpl() override { if (!offset()) return; sendHeaders(); out->position() = position(); out->next(); } public: WriteBufferFromHTTPServerResponse( Poco::Net::HTTPServerResponse & response_, bool compress_ = false, /// If true - set Content-Encoding header and compress the result. ZlibCompressionMethod compression_method_ = ZlibCompressionMethod::Gzip, size_t size = DBMS_DEFAULT_BUFFER_SIZE) : BufferWithOwnMemory(size), response(response_), compress(compress_), compression_method(compression_method_) {} /// Send at least HTTP headers if no data has been sent yet. /// Use after the data has possibly been sent and no error happened (and thus you do not plan /// to change response HTTP code. void finalize() { sendHeaders(); } /// Turn compression on or off. /// The setting has any effect only if HTTP headers haven't been sent yet. void setCompression(bool enable_compression) { compress = enable_compression; } /// Set compression level if the compression is turned on. /// The setting has any effect only if HTTP headers haven't been sent yet. void setCompressionLevel(int level) { compression_level = level; } /// Turn CORS on or off. /// The setting has any effect only if HTTP headers haven't been sent yet. void addHeaderCORS(bool enable_cors) { add_cors_header = enable_cors; } ~WriteBufferFromHTTPServerResponse() { if (!offset()) return; try { next(); } catch (...) { tryLogCurrentException(__PRETTY_FUNCTION__); } } }; }