AbstractWebDavHandler.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  WebDavHandler module Copyright 2019 - 2022 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.
*/
 
 
namespace WebDavHandler {
hashdecl PropPatchActionInfo {
    string action;
    string ns;
    string prop;
    auto val;
}
 
class AbstractWebDavHandler : public HttpServer::AbstractHttpRequestHandler  {
 
public:
        const RequestMethods = ...;
 
 
        const DestMethods = ...;
 
 
        const AllowHeaderValue = RequestMethods.keys().join(",");
 
        const MethodList = keys RequestMethods;
 
        const PPA_Remove = "R";
 
        const PPA_Set = "S";
 
protected:
        AbstractWebDavPropertyHandler property_handler;
 
        string virtual_base_path;
 
        Logger logger;
 
public:
 
 
    constructor(*AbstractAuthenticator auth) ;
 
 
 
    constructor(*AbstractAuthenticator auth, string virtual_relative_path_base) ;
 
 
 
    constructor(*AbstractAuthenticator auth, AbstractWebDavPropertyHandler property_handler, string virtual_relative_path_base = '/') ;
 
 
 
    constructor(*AbstractAuthenticator auth, Logger logger, AbstractWebDavPropertyHandler property_handler = new InMemoryWebDavPropertyHandler(), string virtual_relative_path_base = '/') ;
 
 
    list<string> getHttpMethods();
 
 
    setLogger(Logger logger);
 
 
    hash<HttpResponseInfo> handleRequest(HttpListenerInterface listener, Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    string getRelativePath(string raw_path);
 
 
    hash<HttpResponseInfo> response(int response_code = 200, data msg = 'OK');
 
 
    hash<HttpResponseInfo> response(int response_code = 200, hash<auto> hdr);
 
 
    hash<HttpResponseInfo> resp400(data msg = 'Bad Request');
 
 
    hash<HttpResponseInfo> resp404();
 
 
    hash<HttpResponseInfo> resp500(data msg = 'General Server Error');
 
 
    hash<HttpResponseInfo> resp501();
 
 
protected:
     init(Logger logger, AbstractWebDavPropertyHandler property_handler, string virtual_relative_path_base = '/');
public:
 
 
 
protected:
     string getRealPath(string raw_path);
public:
 
 
 
protected:
     *hash<HttpResponseInfo> checkAuth(string method, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     copyProperties(string source_url, string target_url);
public:
 
 
protected:
     moveProperties(string source_url, string target_url);
public:
 
 
protected:
     deleteProperties(string source_url);
public:
 
 
protected:
     hash<auto> preparePropFindXmlResponse(string local_path, string href, bool is_collection, hash<auto> base_props, bool all_props = False, *hash<string, hash<string, bool>> additional_props);
public:
 
 
protected:
     hash<auto> propStatXmlHash(string href, *hash<auto> code_map);
public:
 
 
 
protected:
     string getStatusMessage(softstring http_code);
public:
 
 
 
    hash<HttpResponseInfo> handleOptions(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleGet(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleHead(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handlePost(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handlePut(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleDelete(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleCopy(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleMove(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleLock(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleUnlock(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleMkcol(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handlePropfind(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    hash<HttpResponseInfo> handleProppatch(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
 
 
 
    logInfo(string fmt);
 
 
 
    logError(string fmt);
 
 
 
    logDebug(string fmt);
 
 
protected:
     hash<auto> getXml(string body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleOptionsImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     abstract hash<HttpResponseInfo> handleGetImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handleHeadImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handlePostImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handlePutImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handleDeleteImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handleCopyImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handleMoveImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handleLockImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handleUnlockImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handleMkcolImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract hash<HttpResponseInfo> handlePropfindImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     abstract *hash<string, hash<string, hash<string, bool>>> handleProppatchImpl(reference<string> href, hash<auto> cx, hash<auto> hdr, *hash<auto> request_xml, *list<hash<PropPatchActionInfo>> actions);
public:
 
private:
     *hash<auto> fixDavPrefixes(string ns, hash<auto> h, *string pfx);
public:
 
 
      static combineValue(reference<auto> h, auto v);
 
private:
     string getNsPrefix(string ns);
public:
 
 
private:
     string getKey(string key, *string nsa);
public:
 
 
private:
     list<auto> fixDavPrefixes(string ns, list<auto> l, *string pfx);
public:
 
 
private:
     auto fixDavPrefixes(string ns, auto v, *string pfx);
public:
 
};
}
 
// unexperted namespace
namespace Priv {
// for namespace handling while parsing
hashdecl NsInfo {
    // map of namespace abbreviations to namespace URIs
    hash<string, string> nsmap = {
        DavNs: DavNs,
    };
    // reverse of nsmap
    hash<string, string> nsrmap = {
        DavNs: DavNs,
    };
}
 
thread_local hash<NsInfo> nsinfo;
}