httpd.h

/*******************************************************************************
 * Copyright (c) 2014, Jan Koester jan.koester@gmx.net
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 * Neither the name of the <organization> nor the
 *      names of its contributors may be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
 
#include <netplus/socket.h>
#include <netplus/eventapi.h>
#include <netplus/threadpool.h>
#include <atomic>
#include <cstdint>
#include <map>
#include <memory>
#include <mutex>
#include <set>
#include <string>
#include <vector>
 
#include "http.h"
#include "qpack.h"
#include "exception.h"
 
#pragma once
 
namespace cmdplus {
    class CmdController;    
}
 
namespace libhttppp {
    class HttpEvent : public netplus::event {
    public:
        // h2OffloadThreads: when non-zero, spins up a background thread pool
        // (see shouldOffloadH2Dispatch) that lets HTTP/2 streams whose
        // RequestEvent does slow, blocking work (e.g. a backend network
        // round-trip) run without blocking every other stream multiplexed
        // on the same connection. Zero (the default) preserves the original
        // fully-synchronous H2 dispatch behavior for every existing caller.
        // idleTimeoutSeconds: forwarded to netplus::event's own idleTimeoutSeconds (see
        // eventapi.h's doc comment) -- closes an accepted connection once it's gone this long
        // with no genuine read/write activity. 0 (the default) preserves the original
        // behavior: a connection stays open until the peer closes it or a transport error
        // occurs, however long that takes.
        // h1OffloadThreads: HTTP/1.x analogue of h2OffloadThreads (see shouldOffloadH1Dispatch)
        // -- zero (the default) preserves the original fully-synchronous H1 dispatch behavior
        // for every existing caller. Unlike H2, an H1 connection has no per-stream separation
        // (cureq *is* the connection, one request in flight at a time), so offloading it
        // safely needs a detach/reattach round trip through netplus::detachConnection()/
        // reattachConnection() rather than H2's "hand off a throwaway tempreq" trick -- see
        // _dispatchH1Request's doc comment for the full mechanics.
        // h2DispatchQueueMax: caps how many H2 streams may be queued in _h2DispatchPool waiting
        // for a worker (see netplus::ThreadPool's own max_queue_size). 0 (the default) keeps the
        // pool unbounded for every existing caller -- exactly today's behavior, where a stuck or
        // saturated pool means every subsequent stream on every connection waits forever with no
        // way to notice. A positive value makes _dispatchH2Stream respond 503 immediately once
        // the pool is this full instead of queuing behind it. Has no effect if h2OffloadThreads
        // is 0 (nothing to bound).
        HttpEvent(std::vector<netplus::socket*> serversocket,int timeout = 1000,
                  size_t h2OffloadThreads = 0, int idleTimeoutSeconds = 0,
                  size_t h1OffloadThreads = 0, size_t h2DispatchQueueMax = 0);
 
        // Return true to have this stream's RequestEvent run on the H2
        // offload thread pool instead of inline in the frame-processing
        // loop. Called right after the per-stream request's headers have
        // been parsed (so :path/:method are already available), before
        // RequestEvent runs. Defaults to false — every route stays on the
        // original synchronous path unless a subclass opts a specific
        // route in. Has no effect if h2OffloadThreads is 0.
        virtual bool shouldOffloadH2Dispatch(HttpRequest &tempreq, uint32_t streamId) const {
            return false;
        }
 
        // Return true to have this HTTP/1.x request's RequestEvent run on the H1 offload
        // thread pool instead of inline on the epoll/kqueue worker that read it. Called right
        // after the request is fully parsed (headers and, for a body-bearing method, the
        // complete body already buffered), before RequestEvent runs. Defaults to false --
        // every route stays on the original synchronous path unless a subclass opts in. Has
        // no effect if h1OffloadThreads is 0.
        virtual bool shouldOffloadH1Dispatch(HttpRequest &cureq) const {
            return false;
        }
 
        virtual void RequestEvent(HttpRequest &curreq,const int tid,ULONG_PTR args);
        virtual void ResponseEvent(HttpRequest &curreq,const int tid,ULONG_PTR args);
        virtual void ConnectEvent(HttpRequest &curreq,const int tid,ULONG_PTR args);
        virtual void DisconnectEvent(HttpRequest &curreq,const int tid,ULONG_PTR args);
 
        virtual bool Http2RequestEvent(netplus::con &curcon,
                                       const int tid,
                                       ULONG_PTR args,
                                       const std::string &alpn,
                                       const netplus::ssl::FramingCallback &frame_cb);
        virtual void Http3StreamEvent(netplus::socket *sock,
                                      uint64_t stream_id,
                                      const std::vector<uint8_t> &data,
                                      bool fin);
 
        // Streaming body callbacks for H2/H3.
        // Called when headers are complete for a body-bearing stream.
        // Return true to handle body data via onH2DataChunk/onH3DataChunk
        // instead of buffering the full body.
        virtual bool onH2StreamHeaders(HttpRequest &conn, uint32_t streamId,
                                       const std::vector<hpack::HeaderField> &headers);
        virtual bool onH3StreamHeaders(netplus::socket *sock, uint64_t streamId,
                                       const std::vector<qpack::HeaderField> &headers);
 
        // Called for each body data chunk when streaming is enabled.
        // endStream/fin: true on the last chunk.
        virtual void onH2DataChunk(HttpRequest &conn, uint32_t streamId,
                                   const char *data, size_t len, bool endStream,
                                   std::string &h2out, const int tid, ULONG_PTR args);
        virtual void onH3DataChunk(netplus::socket *sock, uint64_t streamId,
                                   const char *data, size_t len, bool fin);
 
    protected:
        // Helpers for sending a complete response on an H2/H3 stream.
        void sendH2StreamResponse(std::string &h2out, uint32_t streamId,
                                  uint16_t status, const std::string &contentType,
                                  const std::string &body);
        void sendH3StreamResponse(netplus::socket *sock, uint64_t streamId,
                                  uint16_t status, const std::string &contentType,
                                  const std::string &body);
        virtual void CreateConnection(std::shared_ptr<netplus::con> &res);
 
        virtual void RequestEvent(netplus::con &curcon, const int tid, ULONG_PTR args);
        virtual void ResponseEvent(netplus::con &curcon,const int tid,ULONG_PTR args);
        virtual void ConnectEvent(netplus::con &curcon,const int tid,ULONG_PTR args);
        virtual void DisconnectEvent(netplus::con &curcon,const int tid,ULONG_PTR args);
 
        std::string _altSvcH3;   // Alt-Svc value for HTTP/3 advertisement
 
        // TLS session cache — shared across all accepted SSL connections
        // to enable abbreviated TLS 1.2 handshakes on client reconnection.
        netplus::TlsSessionCache _tlsSessionCache;
    private:
        // Per-stream state for HTTP/3: accumulates data and supports
        // incremental H3 frame parsing for streaming body callbacks.
        struct H3StreamState {
            std::vector<uint8_t> data;
            bool headersParsed = false;
            bool streaming = false;
            size_t parseOffset = 0;
        };
        std::mutex                            _h3BufferMutex;
        std::map<uint64_t, H3StreamState>     _h3StreamStates;
        std::atomic<int>                      _h3NextTid{0};
 
        // Non-null only when h2OffloadThreads > 0 was passed to the
        // constructor. See shouldOffloadH2Dispatch / _dispatchH2Stream.
        std::unique_ptr<netplus::ThreadPool>  _h2DispatchPool;
 
        // Non-null only when h1OffloadThreads > 0 was passed to the constructor. See
        // shouldOffloadH1Dispatch / _dispatchH1Request.
        std::unique_ptr<netplus::ThreadPool>  _h1DispatchPool;
 
        // Always constructed (unlike _h2DispatchPool, which is opt-in):
        // every streaming H3 response needs somewhere to run its
        // continuation loop (see Http3StreamEvent). Bounded so a burst of
        // concurrent large/slow responses spawns at most this many OS
        // threads instead of one raw detached thread per response.
        std::unique_ptr<netplus::ThreadPool>  _h3StreamPool;
 
        // Returns true if the stream was handed off to the background
        // offload pool instead of being finished synchronously — callers
        // must treat that as "progress" for reprocess-loop purposes even
        // though it leaves `out` unchanged, since the frame was still
        // consumed from RecvData either way.
        bool _dispatchH2Stream(HttpRequest &cureq, std::string &out,
                               uint32_t sid,
                               const std::vector<hpack::HeaderField> &decoded,
                               const std::string &reqBody,
                               const int tid, ULONG_PTR args);
        // Runs RequestEvent(cureq,...) for a fully-parsed HTTP/1.x request, offloading to
        // _h1DispatchPool when shouldOffloadH1Dispatch() opts in. consumeBodyBytes is how many
        // already-fully-buffered request body bytes to erase from RecvData once RequestEvent
        // has returned (0 for GET/DELETE/OPTIONS/HEAD, which never have one) -- mirrors
        // exactly what each REQUESTHANDLING case in RequestEvent(netplus::con&,...) used to do
        // inline before this existed.
        //
        // Unlike _dispatchH2Stream (which hands a throwaway per-stream tempreq to the pool,
        // since H2 multiplexes many streams per connection), H1's cureq *is* the connection --
        // there is no separate object to hand off while leaving the epoll worker free to keep
        // servicing the same fd. Offloading therefore round-trips through
        // netplus::detachConnection()/reattachConnection(): detach before submitting (so the
        // fd leaves the epoll/kqueue interest set and no second dispatch can ever race the
        // in-flight one), run RequestEvent + the body-erase + the response flush on the pool
        // thread with the socket in blocking mode (HttpResponse::send() only ever appends to
        // SendData -- something has to actually write it, and off the event loop nothing will
        // do that later the way EPOLLOUT normally would), then reattach so keep-alive/
        // pipelining resumes normally. A peer that stops reading mid-flush past the bounded
        // timeout, or any exception, closes the connection instead of reattaching it
        // half-sent.
        //
        // Always leaves cureq fully handled by the time this returns: either it ran
        // (synchronously) right here, or it's been handed to the pool and the caller must not
        // touch cureq again.
        void _dispatchH1Request(HttpRequest &cureq, size_t consumeBodyBytes,
                                const int tid, ULONG_PTR args);
        // The part of stream dispatch that must run on the connection's
        // owning thread: extracts the plugin's :res-* response headers off
        // an already-completed tempreq, HPACK-encodes them, and frames the
        // response (or sets up activeStreams for a streaming response).
        // Shared by both the synchronous path and the offload-completion
        // path so they behave identically once RequestEvent has returned.
        void _finishH2Dispatch(HttpRequest &cureq, std::string &out,
                               uint32_t sid,
                               std::unique_ptr<HttpRequest> tempreq,
                               const int tid, ULONG_PTR args);
        // Factored out of the synchronous dispatch loop's immediate-flush
        // step so the offload-completion path (which has no "loop" to fall
        // through to) can reuse the exact same send behavior.
        bool _flushSendDataNow(HttpRequest &cureq);
        void _resumeH2Streams(HttpRequest &cureq, std::string &out,
                              const int tid, ULONG_PTR args);
        void _reapStalledH2Streams(HttpRequest &cureq, std::string &out);
    };
 
    // netplus::quic leaves sendControlStreams() (RFC 9114 §6.2.1: control +
    // QPACK encoder/decoder streams) as a no-op — that framing is HTTP/3
    // application-layer knowledge, which belongs here alongside qpack.h/
    // hpack.h rather than in the QUIC transport library. This override
    // holds the real implementation.
    class Http3QuicSocket : public netplus::quic {
    public:
        using netplus::quic::quic;
        void sendControlStreams() override;
        std::vector<uint8_t> buildAlpnExtension(const std::string& alpn) override;
        std::string selectStreamProtocol(const std::string& proto) override;
        std::shared_ptr<netplus::quic> createChild() const override;
    private:
        bool _ctrlStreamsSent = false;
    };
 
    class HttpD {
    public:
        HttpD(int argc, char** argv);
        HttpD(const std::string &httpaddr, int port, int maxconnections, const std::string &sslcertpath, const  std::string &sslkeypath, const std::string &sslpassword = "");
        // SNI virtual hosting: certsByHostname is keyed by the SNI hostname each bundle should
        // be presented for (unlike the single-cert ctor above, whose _certBundle ends up keyed
        // by httpaddr) -- netplus::ssl/quic pick a bundle per-connection from this map by
        // matching the ClientHello's requested hostname, see netplus::tls::cert_map.
        HttpD(const std::string &httpaddr, int port, int maxconnections,
              const std::map<std::string, netplus::ssl::CertificateBundle> &certsByHostname);
        ~HttpD();
        std::vector<netplus::socket*> getServerSockets();
 
        // Reload SSL certificates from file(s). Updates all ssl/quic server sockets.
        bool reloadCertificates(const std::string &certpath, const std::string &keypath, const std::string &password = "");
 
        // Reload just one SNI hostname's bundle (for a multi-hostname HttpD from the ctor
        // above) without disturbing any other hostname's certificate.
        bool reloadCertificate(const std::string &hostname, const std::string &certpath,
                                const std::string &keypath, const std::string &password = "");
    protected:
        void                        FileServer();
    private:
 
        bool             _fileServer;
        std::vector<std::unique_ptr<netplus::socket>> _ServerSockets;
        std::map<std::string, netplus::ssl::CertificateBundle> _certBundle;
        HTTPException    _httpexception;
    };
};