WebUtil.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file WebUtil.qm Qore user module supprting web server operations

/*  WebUtil.qm Copyright (C) 2013 - 2016 Qore Technologies, sro

    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.
*/

// this module requires Qore 0.8.12 or better

// require type definitions everywhere

// enable all warnings

// do not use "$" signs, assume local vars



namespace WebUtil {
class FileStreamRequest : public HttpServer::AbstractStreamRequest {

public:
private:

public:

        private :
            ReadOnlyFile f;
            bool txt;
            string ct;
            int cs;

public:

        constructor(HttpServer::HttpListenerInterface listener, HttpServer::AbstractHttpRequestHandler handler, Qore::Socket s, hash cx, hash hdr, *data body, Qore::ReadOnlyFile file, bool textflag, string content_type, int chunk_size) ;


        private hash getResponseHeaderMessageImpl();


        private any sendImpl();

    };

    class TextTemplateBase {

public:
        private :
            Program p;

public:

        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;

public:

        constructor(int po = DefaultProgramOptions);



          static string add(Qore::Program p, string fn, string name, string src);


private:
          static string getCode(bool bare_refs, string fmt);
public:



private:
          static bool doBlock(string end, reference src, string type, reference i, reference l);
public:


          static string getContentType(string name);
    };

class FileTemplate : public TextTemplateBase {

public:
        private :
            int po;

            string path;

            string ct;

            const TemplateFunc = "t";

            *code psetup;

            RWLock rwl();

            *date mtime;

public:

        public :

public:


        constructor(string resource_path, int parse_opts = DefaultProgramOptions, *code pgm_setup) ;



        hash render(date new_mtime, hash ctx, int code = 200, *hash hdr);


        private setupTemplateIntern(date new_mtime);

    };


    class TemplateFileManager {

public:
        private :
            RWLock rwl();

            hash th;

            int po;

            *code psetup;

public:


        constructor(int parse_opts = TextTemplateBase::DefaultProgramOptions, *code pgm_setup);



        hash render(string tname, string path, date mtime, hash ctx, int code = 200, *hash hdr);


        purge(string tname);

    };


class StaticTemplateManager : public WebUtil::TextTemplateBase {

public:
        private :
            hash th;

            Sequence seq();

public:

        constructor(int po = DefaultProgramOptions) ;



        string add(string name, string src, *string ct);


        bool hasTemplate(string tname);



        hash render(string tname, hash ctx, int code = 200, *hash hdr);



        *hash tryRender(string tname, hash ctx, int code = 200, *hash hdr);


        *hash getTemplateHash();


        list getTemplateList();

    };

class FileHandler : public HttpServer::AbstractUrlHandler, private WebUtil::TemplateFileManager {

public:
        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 DirSep = Qore::DirSep;

            const Defaults = (
                // default index file
                "IndexFile": "index.html",
                "IndexTemplate": "index.qhtml",
                "TemplateExtensions": (
                    "qhtml": True,
                ),
                "ChunkedThreshold": 10 * 1024,
                "ChunkSize": 4096,
                );

            const Dirlisting = "<html lang=\"en\" >"
"{%"
"    Dir $d();"
"    $d.chdir($ctx.path);"
"    string $title = sprintf(\"Index of /%s\", $ctx.resource_path);"
"%}"
"    <head>"
"        <meta charset=\"utf-8\" />"
"        <title>{{ $title }}</title>"
"    </head>"
"    <body>"
"        <header>"
"            <h1>{{ $title }}</h1>"
"        </header>"
"        <div class=\"container\">"
"            <table>"
"                <tr>"
"                    <th>Name</th>"
"                    <th width=\"40\">Type</th>"
"                    <th width=\"80\">Size</th>"
"                </tr>"
"                {% if ($ctx.parent_url) { %}"
"                <tr>"
"                    <td colspan=\"2\"><a href=\"{{ $ctx.parent_url }}\">Parent Directory</a></td>"
"                </tr>"
"                {% } %}"
"                {% foreach string $dir in (sort($d.listDirs())) { %}"
"                {% if ($dir[0]!=\".\") {"
"                    string $path = replace($ctx.path, $ctx.file_root, \"\");"
"                %}"
"                <tr><td><a href=\"{{ $ctx.url_root + $path + \"/\" + $dir }}\">{{ $dir }}</a></td><td width=\"40\">Directory</td></tr>"
"                {% } %}"
"                {% } %}"
"                {% foreach string $file in (sort($d.listFiles())) { %}"
"                {% if ($file[0]!=\".\") {"
"                    string $path = replace($ctx.path, $ctx.file_root, \"\");"
"                %}"
"                <tr><td><a href=\"{{ $ctx.url_root + $path + \"/\" + $file }}\">{{ $file }}</a></td><td width=\"40\">File</td><td align=\"right\">{{hstat($ctx.path + \"/\" + $file).size }}</td></tr>"
"                {% } %}"
"                {% } %}"
"            </table>"
"        </div>"
"    </body>"
"</html>";

public:

        private :
            StaticTemplateManager stm();

public:


        constructor(string new_file_root, string url_root = "/", *hash opt) ;


        private string getDirlistingTemplate();



        hash handleRequest(HttpServer::HttpListenerInterface listener, Qore::Socket s, hash cx, hash hdr, *data body);


        logInfo(string fmt);


        logError(string fmt);


        logDebug(string fmt);



        private hash unhandledRequest(hash cx, hash hdr, *data body);



        private hash fileError(hash cx, hash sh);



        private hash serverError(hash cx, hash ex);


        private *hash tryServeRequest(HttpServer::HttpListenerInterface listener, Qore::Socket s, hash cx, hash hdr, *data body);


        private FileStreamRequest getFileStreamRequestImpl(HttpServer::HttpListenerInterface listener, Qore::Socket s, hash cx, hash hdr, *data body, Qore::ReadOnlyFile f, bool txt, string ct);


        private hash sendFile(ReadOnlyFile f, bool txt, string ct);


        private hash sendFileChunked(HttpServer::HttpListenerInterface listener, Qore::Socket s, hash cx, hash hdr, *data body, Qore::ReadOnlyFile f, bool txt, string ct);



        *hash renderDirectory(hash cx, string path);



        private *hash handleRequestImpl(reference cx, hash hdr, *data body);

    };
};