WebUtil.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  WebUtil.qm Copyright (C) 2013 - 2023 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.
*/
 
// minimum Qore version
 
// require type definitions everywhere
 
// enable all warnings
 
// do not use "$" signs, assume local vars
 
 
 
namespace WebUtil {
class FileStreamRequest : public HttpServer::AbstractStreamRequest {
 
public:
        
 
protected:
            ReadOnlyFile f;
            bool txt;
            int cs;
            *hash<auto> respHdr;
 
public:
 
        constructor(HttpServer::HttpListenerInterface listener, HttpServer::AbstractHttpRequestHandler handler,
                Qore::Socket s, hash<auto> cx, hash<auto> hdr, *data body, Qore::ReadOnlyFile file, bool textflag,
                int chunk_size, *hash<auto> respHdr)
 ;
 
 
protected:
         hash<HttpResponseInfo> getResponseHeaderMessageImpl();
public:
 
 
protected:
         auto sendImpl();
public:
 
    };
 
class InputStreamRequest : public HttpServer::AbstractStreamRequest {
 
public:
        
 
protected:
            InputStream stream;
            int cs;
            *hash<auto> respHdr;
 
public:
 
        constructor(HttpServer::HttpListenerInterface listener, HttpServer::AbstractHttpRequestHandler handler,
                Qore::Socket s, hash<auto> cx, hash<auto> hdr, *data body, InputStream stream,
                int chunk_size, *hash<auto> respHdr)
 ;
 
 
protected:
         hash<HttpResponseInfo> getResponseHeaderMessageImpl();
public:
 
 
protected:
         auto sendImpl();
public:
 
    };
 
    class AbstractTemplate {
 
public:
 
        hash<HttpResponseInfo> render(date new_mtime, hash<auto> ctx, int http_code = 200, *hash<auto> hdr);
 
 
 
protected:
        abstract  hash<HttpResponseInfo> renderImpl(date new_mtime, hash<auto> ctx, int http_code = 200, *hash<auto> hdr);
public:
    };
 
    class StaticTextTemplateBase {
 
public:
            const DefaultProgramOptions = PO_REQUIRE_OUR|PO_NO_TOP_LEVEL_STATEMENTS|PO_NO_INHERIT_USER_FUNC_VARIANTS|PO_NO_INHERIT_GLOBAL_VARS|PO_NO_USER_CLASSES|PO_NO_TERMINAL_IO;
 
 
          static string add(Qore::Program p, string fn, string name, string src);
 
protected:
          static string getCode(bool bare_refs, string fmt);
public:
 
 
protected:
          static bool doBlock(string end, reference<string> src, string type, reference<int> i, reference<list<hash>> l);
public:
 
 
          static string getContentType(string name);
    };
 
class TextTemplateBase : public StaticTextTemplateBase {
 
public:
protected:
            Program p;
 
public:
 
        constructor(int po = DefaultProgramOptions);
 
 
        Program getProgram();
 
    };
 
class FileTemplate : public AbstractTemplate,public  TextTemplateBase {
 
public:
protected:
            int po;
 
            string path;
 
            string ct;
 
            const TemplateFunc = "t";
 
            *code psetup;
 
            RWLock rwl();
 
            *date mtime;
 
public:
 
 
 
        constructor(string resource_path, int parse_opts = DefaultProgramOptions, *code pgm_setup) ;
 
 
 
protected:
         hash<HttpResponseInfo> renderImpl(date new_mtime, hash<auto> ctx, int http_code = 200, *hash<auto> hdr);
public:
 
 
protected:
         setupTemplateIntern(date new_mtime);
public:
 
    };
 
 
    class TemplateFileManager {
 
public:
protected:
            RWLock rwl();
 
            hash<string, AbstractTemplate> th;
 
            int po;
 
            *code psetup;
 
public:
 
 
        constructor(int parse_opts = StaticTextTemplateBase::DefaultProgramOptions, *code pgm_setup);
 
 
 
        hash<HttpResponseInfo> render(string tname, string path, date mtime, hash<auto> ctx, int code = 200, *hash<auto> hdr);
 
 
        purge(string tname);
 
    };
 
 
class StaticTemplateManager : public WebUtil::StaticTextTemplateBase {
 
public:
protected:
            hash<string, TextTemplateBase> toh;
 
            hash<string, hash<auto>> th;
 
            Sequence seq();
 
            int po;
 
public:
 
        constructor(int po = DefaultProgramOptions);
 
 
 
        string add(string name, string src, *string ct);
 
 
        bool hasTemplate(string tname);
 
 
 
        hash<HttpResponseInfo> render(string tname, hash<auto> ctx, int code = 200, *hash<auto> hdr);
 
 
 
        *hash<HttpResponseInfo> tryRender(string tname, hash<auto> ctx, int code = 200, *hash<auto> hdr);
 
 
        *hash<string, bool> getTemplateHash();
 
 
        list<string> getTemplateList();
 
 
        setupProgram(Program p);
 
    };
 
class FileHandler : public HttpServer::AbstractUrlHandler, protected WebUtil::TemplateFileManager {
 
public:
            string file_root;
 
            softlist indexes = (Defaults.IndexTemplate, Defaults.IndexFile);
 
            hash template_extensions = Defaults.TemplateExtensions;
 
            *string default_target;
 
            softint chunked_threshold = Defaults.ChunkedThreshold;
 
            softint chunk_size = Defaults.ChunkSize;
 
 
            softint error_level = 0;
 
            const Unix = (PlatformOS != "Windows");
 
            const DefaultFileReadTimeout = 20s;
 
 
            const DirSep = Qore::DirSep;
 
            const Defaults = {
                // default index file
                "IndexFile": "index.html",
                "IndexTemplate": "index.qhtml",
                "TemplateExtensions": {
                    "qhtml": True,
                },
                "ChunkedThreshold": 10 * 1024,
                "ChunkSize": 4096,
            };
 
            const Dirlisting = ...;
 
 
protected:
            StaticTemplateManager stm();
 
public:
 
 
        constructor(string new_file_root, string url_root = '/', *hash<auto> opt)
 ;
 
 
protected:
         string getDirlistingTemplate();
public:
 
 
 
        hash<HttpResponseInfo> handleRequest(HttpServer::HttpListenerInterface listener, Qore::Socket s,
                hash<auto> cx, hash<auto> hdr, *data body) {
            // get local request path and "localize" it and strip off any query args
            string path = getRelativePath(hdr.path);
 
            // add URI query parameters to hdr if possible
            hdr.params = parse_uri_query(hdr.path).params;
 
            cx += {"resource_path": path, "url_root": url_root, "file_root": file_root, "isregex": False, "hdr": hdr};
 
            try {
                *hash<HttpResponseInfo> h = handleRequestImpl(\cx, hdr, body);
                if (!h) {
                    h = tryServeRequest(listener, s, cx, hdr, body);
                    if (!h) {
                        cx.resource_path = default_target;
                        h = tryServeRequest(listener, s, cx, hdr, body);
                    }
                }
                if (h) {
                    return h;
                }
            } catch (hash<ExceptionInfo> ex) {
                return serverError(cx, ex);
            }
 
            return unhandledRequest(cx, hdr, body);
        }
 
        logInfo(string fmt);
 
 
        logError(string fmt);
 
 
        logDebug(string fmt);
 
 
 
protected:
         hash<HttpResponseInfo> unhandledRequest(hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
         hash<HttpResponseInfo> fileError(hash<auto> cx, hash<auto> sh);
public:
 
 
 
protected:
         hash<HttpResponseInfo> serverError(hash<auto> cx, hash<auto> ex);
public:
 
 
        private *hash<HttpResponseInfo> tryServeRequest(HttpServer::HttpListenerInterface listener, Qore::Socket s,
                hash<auto> cx, hash<auto> hdr, *data body) {
            string path;
            *hash<StatInfo> stat_hash = statPath(cx, hdr, \path);
            if (!stat_hash);
 
 
            // issue #4550: ensure that the path is inside the file_root
            if (cx.resource_path ==1);
 
 
            // add index if the request corresponds to a directory
            if (stat_hash.type == 'DIRECTORY');
 else if (stat_hash.type != 'REGULAR');
 
 
            // see if we should handle as a template
            *string ext = (cx.resource_path =~ x/\.([a-z0-9]+)$/i)[0];
            if (ext && template_extensions{ext});
 
 
            return sendFilePath(listener, s, cx, hdr, body, path, stat_hash);
        }
 
        private *hash<HttpResponseInfo> sendFilePath(HttpServer::HttpListenerInterface listener, Qore::Socket s,
                hash<auto> cx, hash<auto> hdr, *data body, string path, hash<StatInfo> stat_hash) {
            // send an empty response for an empty file
            if (!stat_hash.size);
 
 
            FileInputStream stream;
            try {
                stream = new FileInputStream(path, DefaultFileReadTimeout);
            } catch (hash<ExceptionInfo> ex) {
                if (ex.err == "FILE-OPEN2-ERROR") {
                    return;
                }
                rethrow;
            }
 
            *hash<auto> respHdr = getResponseHeadersForFile(path, cx, hdr);
            // add the content type if it's missing for backwards compatibilitye
            if (!hdr.'Content-Type');
 
            return stat_hash.size > chunked_threshold
                ? sendFileChunked(listener, s, cx, hdr, body, stream, respHdr)
                : sendFile(stream, respHdr);
        }
 
protected:
         *hash<StatInfo> statPath(hash<auto> cx, hash<auto> hdr, reference<string> path);
public:
 
 
        private AbstractStreamRequest getStreamRequestImpl(HttpServer::HttpListenerInterface listener, Qore::Socket s,
                hash<auto> cx, hash<auto> hdr, *data body, InputStream stream, *hash<auto> respHdr) {
            return new InputStreamRequest(listener, self, s, cx, hdr, body, stream, chunk_size, respHdr);
        }
 
 
protected:
         hash<auto> getResponseHeadersForFile(string path, hash<auto> cx, hash<auto> request_hdr);
public:
 
 
protected:
         hash<HttpResponseInfo> sendFile(InputStream stream, *hash<auto> respHdr);
public:
 
 
        private hash<HttpResponseInfo> sendFileChunked(HttpServer::HttpListenerInterface listener, Qore::Socket s,
                hash<auto> cx, hash<auto> hdr, *data body, InputStream stream, *hash<auto> respHdr) {
            AbstractStreamRequest fsr = getStreamRequestImpl(listener, s, cx, hdr, body, stream, respHdr);
            return cast<hash<HttpResponseInfo>>(fsr.handleRequest());
        }
 
 
        *hash<HttpResponseInfo> renderDirectory(hash<auto> cx, string path);
 
 
 
protected:
         *hash<HttpResponseInfo> handleRequestImpl(reference<hash<auto>> cx, hash<auto> hdr, *data body);
public:
 
    };
};