YamlRpcHandler.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-

/*  YamlRpcHandler.qm Copyright (C) 2012 - 2015 David Nichols

    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

// requires the binary yaml module

// need mime definitions

// need Util module

// need HttpServerUtil module at a minimum in this module

// do not use $ signs in declarations


/*  Version History
    * 2014-03-05 v1.2: David Nichols <david@qore.org>: minor error logging updates, updated minimum qore version to 0.8.7 for get_ex_pos()
    * 2013-09-24 v1.1: David Nichols <david@qore.org>: added optional log closure to constructor
    * 2012-05-24 v1.0: David Nichols <david@qore.org>: updated to a user module
*/

namespace YamlRpcHandler {

class YamlRpcHandler : public AbstractHttpRequestHandler {

public:
        const Version = "1.0";

        const InternalMethods = (
            ("function": "help",
             "help"    : "shows a list of YAML-RPC methods registered with this handler",
             "text"    : "help",
             "logopt"  : 2
            ),
            ("function": "listMethods",
             "help"    : "lists YAML-RPC method names registered with this handler",
             "text"    : "system.listMethods",
             "logopt"  : 2
            ),
            ("function": "system_describe",
             "help"    : "returns a service description object, like the one specified by the JSON-RPC 1.1 spec (even though we use YAML instead of JSON)",
             "text"    : "system.describe",
             "logopt"  : 2
            ),
            );

        private :
            list methods = ();
            hash mi;
            int loglevel;

            // if True then verbose exception info will be logged
            bool debug;

            // prefix to add to derived methods with GET requests if no "." characters are in the path
            __7_ string get_prefix;

            // a closure/call reference to get the log message and/or process arguments in incoming requests
            __7_ code getLogMessage;

            // a closure/call reference for logging (when set this is used instead of the HTTP server's logfunc for logging)
            __7_ code clog;

public:


        constructor(HttpServer::AbstractAuthenticator v_auth, list v_methods, __7_ code v_get_log_msg, bool v_dbg = False, __7_ string v_get_prefix, __7_ code v_log);



        addMethod(string name, code func, string text, string help, any logopt, any cmark);


        setDebug(bool dbg = True);


        bool getDebug();


          static string makeResponse(any response, int flags = YAML::None);

          static string makeErrorResponse(int code, string mess, any err, int flags = YAML::None);

        // method called by HttpServer to handle a request
        // don't reimplement this method; fix/enhance it in the module
        final hash handleRequest(hash cx, hash hdr, __7_ data body);


        // don't reimplement this method; fix/enhance it in the module
        final private addMethodInternal(hash h);


        private hash help();


        private hash system_describe();


        private list listMethods();


        private log(hash cx, string str);


        // don't reimplement this method; fix/enhance it in the module
        final private hash callMethod(hash cx, any params);

    };
};