HttpServer.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  HttpServer.qm Copyright (C) 2012 - 2025 Qore Technologies, s.r.o.
 
    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.
*/
 
// need mime definitions
 
 
 
 
namespace HttpServer {
 
 string get_exception_string(hash<auto> ex);
 
 
public hashdecl HttpServerOptionInfo {
    string name = HttpServer::HttpServerString;
 
    bool debug = False;
 
    bool protect_last_listener = False;
 
    hash<auto> hdr = {
        "X-Powered-By": "Qore/" + Qore::VersionString,
    };;
 
    date ttl = HttpServer::DefaultTtl;
 
    *LoggerInterface logger;
};
 
class HttpServer : public HttpServer::AbstractLogger {
 
public:
        const Version = HttpServer::HttpServerVersion;
        const ReadTimeout = HttpServer::ReadTimeout;  # recvs timeout after 30 seconds
        const PollTimeout = 250ms;
 
        // logging options
        const LP_LOGPARAMS = HttpServer::LP_LOGPARAMS;
        const LP_LEVELMASK = HttpServer::LP_LEVELMASK;
 
        const AIFlags = AI_PASSIVE | AI_ADDRCONFIG;
 
        const HttpMethods = ...;
 
 
        const HttpCodes = HttpServer::HttpCodes;
 
        const ContentEncodings = ...;
 
 
        const DefaultIdleThreads = 10;
 
        const CompressionThreshold = 1024;
 
        const LLO_RECV_HEADERS = (1 << 0);
 
        const LLO_RECV_BODY = (1 << 1);
 
        const LLO_SEND_HEADERS = (1 << 2);
 
        const LLO_SEND_BODY = (1 << 3);
 
        const DefaultTtl = 75s;
 
protected:
        // for masking HTTP request log msgs
        *code maskfunc;
 
        // quit server flag
        bool exit = False;
 
        // if True then verbose exception info will be logged
        bool debug;
 
        Sequence seqSessions();
        Sequence seqListeners();
 
        bool stopped = False;
 
        // permanent handlers; these handlers are never removed
        HttpHandlerList handlers();
 
        // default handler
        hash<auto> defaultHandler;
 
        // hash of listeners keyed by listener ID
        hash<string, HttpListener> listeners;
 
        // map of bind addresses to listener IDs
        hash<string, int> smap;
 
        // map of listener names to listener IDs
        hash<string, int> nmap;
 
        // listener Gate
        Gate lm();
 
        // running listener counter
        Counter c();
 
        // dynamic handlers
        DynamicHttpHandlerList dhandlers();
 
        // connection thread pool
        ThreadPool threadPool(-1, DefaultIdleThreads);
 
        // other misc response headers
        hash<auto> hdr;
 
 
        *string override_encoding;
 
        string http_server_string;
 
        hash<string, bool> http_methods = HttpMethods;
 
        *LoggerInterface logger;
 
        bool protect_last_listener = False;
 
        date ttl = DefaultTtl;
 
public:
 
 
      deprecated constructor(*code logfunc, *code errlogfunc, bool dbg = False, string name = HttpServer::HttpServerString, hash<auto> hdr = {'X-Powered-By': 'Qore/' + Qore::VersionString});
 
 
    constructor(hash<HttpServerOptionInfo> opts);
 
 
    constructor();
 
 
    destructor();
 
 
    date getTtl();
 
 
    setTtl(date ttl);
 
 
 
    addHttpMethod(string m);
 
 
      static string getHttpServerVersionString();
 
    setDefaultTextEncoding(string enc);
 
 
    string getDefaultTextEncoding();
 
 
    callListenerStopCallback(code stopc, string name, hash<auto> socket_info);
 
 
 
    final list<hash<auto>> addListeners(string bind, hash<HttpListenerOptionInfo> info, *reference<hash<string, string>> errmap);
 
 
 
    final list<hash<auto>> addListeners(hash<HttpListenerOptionInfo> info, *reference<hash<string, string>> errmap);
 
 
 
    hash<auto> addListener(int port);
 
 
 
    hash<auto> addListener(hash<HttpListenerOptionInfo> opts);
 
 
    copy();
 
 
 
    hash<string, hash<auto>> getListeners();
 
 
 
    hash<auto> getListenerInfo(softint id);
 
 
 
    hash<auto> getListenerInfoName(string name);
 
 
 
    reloadListenerCertificate(int id);
 
 
 
    reloadListenerCertificateName(string name);
 
 
    int getListenerCount();
 
 
 
    stopNoWait();
 
 
    waitStop();
 
 
 
    listenerStarted(int id, hash<auto> sinfo);
 
 
    // only called from the listeners - do not call externally
    listenerStopped(HttpListener l);
 
 
 
    stop();
 
 
 
    stopListener(softstring bind);
 
 
 
    stopListenerID(softint id);
 
 
 
    stopListenerIDNoWait(softint id);
 
 
    int getListenerTID(softint id);
 
 
    setDefaultHandler(string name, HttpServer::AbstractHttpRequestHandler obj);
 
 
    setHandler(string name, hash<HttpHandlerConfigInfo> info);
 
 
    setHandler(string name, string path, *softlist<softstring> content_types, HttpServer::AbstractHttpRequestHandler obj, *softlist<softstring> special_headers, bool isregex = True);
 
 
    setDynamicHandler(string name, hash<HttpHandlerConfigInfo> info);
 
 
    setDynamicHandler(string name, string path, *softlist<softstring> content_types, HttpServer::AbstractHttpRequestHandler obj, *softlist<softstring> special_headers, bool isregex = True);
 
 
    setHandler(string name, HttpServer::AbstractUrlHandler obj);
 
 
    setDynamicHandler(string name, HttpServer::AbstractUrlHandler obj);
 
 
    addHandlerToListener(softstring bind, string name, hash<HttpHandlerConfigInfo> info);
 
 
 
    addHandlerToListenerID(softint id, string name, hash<HttpHandlerConfigInfo> info);
 
 
 
    addHandlerToListenerID(softint id, string name, string path, *softlist content_type, HttpServer::AbstractHttpRequestHandler obj, *softlist special_headers, bool isregex = True);
 
 
    addHandlerToListener(softstring bind, string name, HttpServer::AbstractUrlHandler obj);
 
 
 
    addHandlerToListenerID(softint id, string name, HttpServer::AbstractUrlHandler obj);
 
 
 
    bool removeHandlerFromListenerID(softstring id, string handler_name);
 
 
 
    bool removeHandlerFromListenerID(softstring id, HttpServer::AbstractHttpRequestHandler handler);
 
 
 
    setListenerLogOptions(softstring bind, softint code);
 
 
 
    setListenerLogOptionsID(softint id, softint code);
 
 
 
    int getListenerLogOptions(softstring bind);
 
 
 
    int getListenerLogOptionsID(softint id);
 
 
 
    disableDynamicHandler(string name);
 
 
 
    removeDynamicHandler(string name, *bool force_immediate);
 
 
    log(string fmt, ...);
 
 
    logError(string fmt, ...);
 
 
    sendHttpError(HttpListener listener, hash<auto> cx, Socket s, int status_code, *data msg, *InputStream chunked_msg, *hash<auto> extra_hdrs, *string encoding, bool head);
 
 
 
    string maskData(string msg);
 
 
 
    setMaskCode(code maskfunc);
 
 
 
      static string getURLFromBind(softstring bind, *string host);
 
    setDebug(bool dbg = True);
 
 
    bool getDebug();
 
 
    startConnection(code c);
 
 
 
    clearContextInfo();
 
 
 
protected:
     int getListenerIdFromBindUnlocked(string bind);
public:
 
 
protected:
     setListenerLogOptionsUnlocked(softstring id, int code);
public:
 
 
protected:
     int getListenerLogOptionsUnlocked(softstring id);
public:
 
 
      static nothing setReplyHeaders(Socket s, hash<auto> cx, reference<hash<auto>> rv);
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  HttpListener addListenerIntern(*string node, *softstring service, *Qore::SSLCertificate cert, *Qore::SSLPrivateKey key, *hash<string, hash<HttpHandlerConfigInfo>> handler_info, *LoggerInterface logger, *code stopc, *string name, int family = AF_UNSPEC);
public:
 
 
protected:
    final  HttpListener addListenerIntern(hash<HttpListenerOptionInfo> info);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  list<hash<auto>> addINETListenersIntern(hash<HttpListenerOptionInfo> info, *reference<hash<string, string>> errmap);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  hash<HttpResponseInfo> noHandlerError(hash<auto> cx, hash<auto> hdr, auto body);
public:
 
 
 
    handleRequest(HttpListener listener, Socket s, reference<hash<auto>> cx, hash<auto> hdr, bool head = False, HttpPersistentHandlerInfo phi, hash<auto> info, reference<bool> dedicated, reference<bool> dedicated_external);
 
 
    // sends a reply to a request
    // don't reimplement this method; fix/enhance it in the module
    final sendReply(HttpListener listener, Socket s, *HttpServer::AbstractHttpRequestHandler handler, hash<auto> rv, reference<hash> cx, hash<auto> hdr, bool head, reference<bool> dedicated, reference<bool> dedicated_external);
 
 
    // rv is "hash" to strip types
private:
     doResponse(HttpListener listener, Socket s, hash<auto> cx, hash rv);
public:
 
};
 
class HttpPersistentHandlerInfo {
 
public:
        *DynamicHandlerHelper dhh;
        *HttpServer::AbstractHttpRequestHandler handler;
 
    destructor();
 
 
    assign(*DynamicHandlerHelper n_dhh, HttpServer::AbstractHttpRequestHandler n_handler);
 
 
    clear();
 
};
 
 
class HttpListener : public Qore::Socket, public HttpServer::HttpListenerInterface {
 
public:
protected:
        HttpServer serv;
        Sequence ss;
 
        *hash<HttpListenerOptionInfo> opts;
 
        //*SSLCertificate cert;
        //*SSLPrivateKey key;
        bool ssl = False;
        auto socket;
        hash socket_info;
 
        // connection counter for normal connection threads
        Counter cThreads();
        // connection counter for dedicated socket threads
        Counter dThreads();
 
        bool exit = False;
        bool stopped = False;
        int id;
 
        // socket handler hash
        hash<string, AbstractHttpSocketHandlerInterface> shh;
 
        // mutex
        Mutex m();
 
        *LoggerInterface logger;
 
        // stop notification closure
        *code stopc;
 
        string name;
 
        // log recv headers flag
        bool log_recv_headers = False;
 
        // log recv body flag
        bool log_recv_body = False;
 
        // log send headers flag
        bool log_send_headers = False;
 
        // log send body flag
        bool log_send_body = False;
 
        bool get_remote_certs = False;
 
        int ssl_verify_flags = SSL_VERIFY_NONE;
 
        bool ssl_accept_all_certs = True;
 
        int lock_waiting;
 
        const PollInterval = 250ms;
        const ListenQueue = 100;
        const BodyLogLimit = 40;
 
        // handler ref count
        int handler_ref_cnt = 0;
 
        // listener-specific handlers
        HttpHandlerList handlers();
 
        const SslVerifyMap = ...;
 
 
public:
 
        // TID of the background listener thread
        int tid;
 
        // default handler info
        *HandlerInfo defaultHandler;
 
 
    constructor(HttpServer server, string name, int id, Sequence ss, *hash<HttpListenerOptionInfo> opts);
 
 
 
    reloadCertificate();
 
 
    addHandlers(hash<string, hash<HttpHandlerConfigInfo>> handler_info);
 
 
    removeHandler(string handler_name);
 
 
    removeHandler(HttpServer::AbstractHttpRequestHandler handler);
 
 
    setDefaultHandler(string name);
 
 
    *HandlerInfo findHandler(hash<auto> hdr, reference<int> score, bool finalv = False, *reference<string> root_path);
 
 
    bool hasHandlers();
 
 
 
      static bool stopIfNoHandlers(HttpServer::HttpListener listener);
 
    hash getListenerSocketInfo();
 
 
    copy();
 
 
    destructor();
 
 
    logRecvHeaders(softbool flag = True);
 
 
    logRecvBody(softbool flag = True);
 
 
    logSendHeaders(softbool flag = True);
 
 
    logSendBody(softbool flag = True);
 
 
    doLogRecvBody(*data body, hash<auto> cx, hash<auto> hdr, hash<auto> info);
 
 
    hash<auto> getLogOptions();
 
 
    string getName();
 
 
    auto getAddress();
 
 
    int getID();
 
 
    bool isSecure();
 
 
    hash<auto> getInfo();
 
 
protected:
     setupSslIntern();
public:
 
 
protected:
     softlist<string> getSslVerifyModeList();
public:
 
 
    auto removeUserThreadContext(*string k);
 
 
    addUserThreadContext(hash<auto> uctx);
 
 
    stopNoWait();
 
 
    stop();
 
 
    string getResponseLogString(hash<auto> cx, int status_code, *data body, *hash<auto> hdr);
 
 
    logResponse(hash<auto> cx, int status_code, *data body, *hash<auto> hdr);
 
 
    logResponse(hash<auto> cx, int code, InputStream body, *hash<auto> hdr);
 
 
    logResponse(hash<auto> cx, hash<auto> rv);
 
 
    // Called when an HTTP response could not be sent
    logResponseError(hash<auto> cx, hash<auto> rv, hash<ExceptionInfo> ex);
 
 
    log(string fmt, ...);
 
 
    logError(string fmt, ...);
 
 
protected:
     mainThread();
public:
 
 
    // thread for handling communication per connection
protected:
     connectionThread(Socket s);
public:
 
 
    bool registerDedicatedSocket(softstring id, HttpServer::AbstractHttpSocketHandlerInterface h, reference<bool> dedicated);
 
 
    removeExternalDedicatedSocket(softstring id);
 
 
    removeDedicatedSocket(softstring id, *bool managed_externally);
 
};
}
 
namespace Priv {
// class containing handler info
class HandlerInfo {
 
public:
        string name;
        HttpServer::AbstractHttpRequestHandler obj;
        string path;
        bool isregex;
        // content type map
        *hash<string, bool> content_type_map;
        *list<string> special_header_list;
 
 
    constructor(string name, hash<HttpHandlerConfigInfo> info);
 
 
    bool matchContentType(string ct);
 
 
    int matchRequest(hash<auto> hdr, int score);
 
 
    stop();
 
};
 
// class to implement handler-handling (private)
class HttpHandlerList {
 
public:
        hash<string, HandlerInfo> handlers;
        TreeMap treeMap();
 
    /*
    private static checkSpecialHeaders(reference sh) {
        foreach auto h in (\sh) {
            if (h.typeCode() != NT_STRING)
                throw "SETHANDLER-ERROR", sprintf("entry %d in the special header list is not a string; type: %s", $#, h.type());
            # make sure header is in lower case for matching
            h = tolower(h);
        }
    }
    */
 
    setHandler(string name, hash<HttpHandlerConfigInfo> info);
 
 
 
    removeHandler(string handler_name);
 
 
 
    removeHandler(HttpServer::AbstractHttpRequestHandler handler);
 
 
    // matches a handler to the request
    *HandlerInfo findHandler(hash<auto> hdr, reference<int> score, bool finalv = False, *reference<string> root_path);
 
 
    bool empty();
 
 
    int size();
 
};
 
// class containing dynamic handler info
class DynamicHandlerInfo : public HandlerInfo {
 
public:
        Counter counter();
 
    constructor(string name, hash<HttpHandlerConfigInfo> info) ;
 
};
 
// maintains the request count for dynamic handlers (private)
class DynamicHandlerHelper {
 
public:
    
 
protected:
        Counter c;
 
public:
 
    constructor(Counter n_c);
 
 
    destructor();
 
};
 
// for dynamic handler-handling (private)
class DynamicHttpHandlerList : public HttpHandlerList {
 
public:
protected:
        RWLock dhl();
 
        // issue #4173: allow dynamic handlers to be disabled before being removed
        hash<string, bool> disable_map;
 
public:
 
    setHandler(string name, hash<HttpHandlerConfigInfo> info);
 
 
 
    removeHandler(string name, *bool force_immediate);
 
 
 
    disableHandler(string name);
 
 
    *DynamicHandlerInfo findHandler(hash<auto> hdr, reference<int> score, reference<DynamicHandlerHelper> dhh, *reference<string> root_path);
 
};
 
class HttpServerCallbackAppender : public LoggerAppenderWithLayout {
 
public:
protected:
        code logfunc;
 
public:
 
    constructor(code logfunc) ;
 
 
    processEventImpl(int type, auto params);
 
};
};