FsWebDavHandler.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 {
class FsWebDavHandler : public AbstractWebDavHandler {
 
public:
protected:
        string basePath;
        bool debug;
 
        const BlockSize = 32 * 1024;
 
        const IoTimeout = 30s;
 
public:
 
 
    constructor(string path, *HttpServer::AbstractAuthenticator auth) ;
 
 
 
    constructor(string path, *HttpServer::AbstractAuthenticator auth, string virtual_relative_path_base) ;
 
 
 
    constructor(string path, *HttpServer::AbstractAuthenticator auth, AbstractWebDavPropertyHandler property_handler, string virtual_relative_path_base = "/")
 ;
 
 
 
    constructor(string path, *HttpServer::AbstractAuthenticator auth, Logger logger, AbstractWebDavPropertyHandler property_handler = new InMemoryWebDavPropertyHandler(), string virtual_relative_path_base = '/') ;
 
 
protected:
     init(string path);
public:
 
 
 
protected:
     string getRealPath(string raw_path);
public:
 
 
protected:
     *string getContentType(string filePath);
public:
 
 
protected:
     hash<auto> hstat2Resource(string path, string displayname, hash<StatInfo> h);
public:
 
 
private:
     list<hash<auto>> preparePropFindResponse(hash<auto> cx, string depth = 'infinity', hash<StatInfo> h, bool all_props, *hash<string, hash<string, bool>> additional_props);
public:
 
 
private:
     string getETag(string path);
public:
 
 
private:
     hash<HttpResponseInfo> internalGet(Socket s, hash<auto> cx, hash<auto> hdr, *data body, bool get = True);
public:
 
 
private:
     *string getDirectoryList(string path);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleGetImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleHeadImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handlePostImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handlePutImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleDeleteImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleCopyImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleMoveImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleLockImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
protected:
     string getLockToken();
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleUnlockImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handleMkcolImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     hash<HttpResponseInfo> handlePropfindImpl(Socket s, hash<auto> cx, hash<auto> hdr, *data body);
public:
 
 
 
protected:
     *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:
 
 
protected:
     *hash<string, hash<string, hash<string, bool>>> verifyPropertyUpdates(string path, *list<hash<PropPatchActionInfo>> actions);
public:
 
 
private:
     hash<HttpResponseInfo> doCopyMoveIntern(Socket s, hash<auto> cx, hash<auto> hdr, *data body, bool copy_props);
public:
 
 
private:
     internalCopyMove(Socket s, hash<auto> cx, hash<auto> hdr, *data body, bool copy_props);
public:
 
}; // class FsWebDavHandler
}; // namespace WebDavHandler