Filesystem WebDavHandler inteface class. More...

#include <FsWebDavHandler.qc.dox.h>

Inheritance diagram for WebDavHandler::FsWebDavHandler:

Public Member Methods
	constructor (string path, *HttpServer::AbstractAuthenticator auth)
	Creates the object with an empty logger and an in-memory property handler. More...

	constructor (string path, *HttpServer::AbstractAuthenticator auth, string virtual_relative_path_base)
	Creates the object with the given argument and an in-memory property handler. More...

	constructor (string path, *HttpServer::AbstractAuthenticator auth, AbstractWebDavPropertyHandler property_handler, string virtual_relative_path_base="/")
	Creates the object with the given arguments. More...

	constructor (string path, *HttpServer::AbstractAuthenticator auth, Logger logger, AbstractWebDavPropertyHandler property_handler=new InMemoryWebDavPropertyHandler(), string virtual_relative_path_base="/")
	Creates the object with the given arguments. More...

private *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)
	Internal method for handling PROPPATCH requests. More...

Public Member Methods inherited from WebDavHandler::AbstractWebDavHandler
	constructor (*AbstractAuthenticator auth)
	Creates the object with an empty logger and an in-memory property handler. More...

	constructor (*AbstractAuthenticator auth, string virtual_relative_path_base)
	Creates the object with the given argument and an in-memory property handler. More...

	constructor (*AbstractAuthenticator auth, AbstractWebDavPropertyHandler property_handler, string virtual_relative_path_base='/')
	Creates the object with the given arguments. More...

	constructor (*AbstractAuthenticator auth, Logger logger, AbstractWebDavPropertyHandler property_handler=new InMemoryWebDavPropertyHandler(), string virtual_relative_path_base='/')
	Creates the object with the given arguments. More...

list< string >	getHttpMethods ()
	Returnd a list of WebDavHandler methods.

	setLogger (Logger logger)
	Replace the logger.

hash< HttpResponseInfo >	handleRequest (HttpListenerInterface listener, Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP/WebDavHandler requests and returns the response.

string	getRelativePath (string raw_path)
	Returns a relative path from an absolute path. More...

hash< HttpResponseInfo >	response (int response_code=200, data msg='OK')
	Returns a hash that can be used as an HTTP response with the given HTTP response code and response message.

hash< HttpResponseInfo >	response (int response_code=200, hash< auto > hdr)
	Returns a hash that can be used as an HTTP response with the given HTTP response code and response headers.

hash< HttpResponseInfo >	resp400 (data msg='Bad Request')
	Returns a hash that can be used as an HTTP response with a 400 response code and response message.

hash< HttpResponseInfo >	resp404 ()
	Returns a hash that can be used as an HTTP response with a 404 response code and response message.

hash< HttpResponseInfo >	resp500 (data msg='General Server Error')
	Returns a hash that can be used as an HTTP response with a 500 response code and response message.

hash< HttpResponseInfo >	resp501 ()
	Returns a hash that can be used as an HTTP response with a 501 response code and response message.

private	init (Logger logger, AbstractWebDavPropertyHandler property_handler, string virtual_relative_path_base="/")
	Common constructor code.

private 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)
	Returns a hash that can be serialized to an XML string for a PROPFIND request.

hash< HttpResponseInfo >	handleOptions (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles a WebDavHandler OPTIONS request. More...

hash< HttpResponseInfo >	handleGet (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP GET requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleHead (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP HEAD requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handlePost (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP POST requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handlePut (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP PUT requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleDelete (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP DELETE requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleCopy (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler COPY requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleMove (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler MOVE requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleLock (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler LOCK requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleUnlock (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler UNLOCK requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleMkcol (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler MKCOL requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handlePropfind (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler PROPFIND requests for WebDavHandler resources; reetrieves properties from WebDavHandler resources. More...

hash< HttpResponseInfo >	handleProppatch (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler PROPPATCH requests for WebDavHandler resources; sets or removes properties on WebDavHandler resources. More...

	logInfo (string fmt)
	This method is called with informational log messages.

	logError (string fmt)
	This method is called with error log messages.

	logDebug (string fmt)
	This method is called with debug log messages.

abstract private *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)
	Internal method for handling PROPPATCH requests. More...

Private Member Methods
	init (string path)
	Common constructor initialization.

string	getRealPath (string raw_path)
	Converts a request path to a normalized real path on the filesystem in the root WebDavHandler directory. More...

*string	getContentType (string filePath)
	Returns the content type for the file based on its extension.

hash< auto >	hstat2Resource (string path, string displayname, hash< StatInfo > h)
	Returns resources for use in a PROPFIND request based on a StatInfo hash.

hash< HttpResponseInfo >	handleGetImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP GET requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleHeadImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP HEAD requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handlePostImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP POST requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handlePutImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP PUT requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleDeleteImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP DELETE requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleCopyImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler COPY requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleMoveImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler MOVE requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleLockImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler LOCK requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleUnlockImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler UNLOCK requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handleMkcolImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler MKCOL requests for WebDavHandler resources. More...

hash< HttpResponseInfo >	handlePropfindImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler PROPFIND requests for WebDavHandler resources; reetrieves properties from WebDavHandler resources. More...

*hash< string, hash< string, hash< string, bool > > >	verifyPropertyUpdates (string path, *list< hash< PropPatchActionInfo > > actions)
	Verifies that all property updates can be performed before executing them.

Private Member Methods inherited from WebDavHandler::AbstractWebDavHandler
string	getRealPath (string raw_path)
	Converts a request path to a normalized real path on the filesystem in the root WebDavHandler directory. More...

*hash< HttpResponseInfo >	checkAuth (string method, hash< auto > cx, hash< auto > hdr, *data body)
	Checks if the request is authorized; if not, this method must return a value. More...

	copyProperties (string source_url, string target_url)
	Copies all properties from the given source URL to the target URL.

	moveProperties (string source_url, string target_url)
	Moves all properties from the given source URL to the target URL.

	deleteProperties (string source_url)
	Deletes all properties from the given URL.

string	getStatusMessage (softstring http_code)
	Returns a status message for the given HTTP response code. More...

hash< auto >	getXml (string body)
	Parse incoming XML and handle namespaces.

hash< HttpResponseInfo >	handleOptionsImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles an HTTP/WebDavHandler OPTIONS request. More...

abstract hash< HttpResponseInfo >	handleGetImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP GET requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handleHeadImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP HEAD requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handlePostImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP POST requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handlePutImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP PUT requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handleDeleteImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles HTTP DELETE requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handleCopyImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler COPY requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handleMoveImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler MOVE requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handleLockImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler LOCK requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handleUnlockImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler UNLOCK requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handleMkcolImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler MKCOL requests for WebDavHandler resources. More...

abstract hash< HttpResponseInfo >	handlePropfindImpl (Socket s, hash< auto > cx, hash< auto > hdr, *data body)
	Handles WebDavHandler PROPFIND requests for WebDavHandler resources; reetrieves properties from WebDavHandler resources. More...

Private Attributes
string	basePath
	The root directory for serving files.

const	BlockSize = 32 * 1024
	Default block size for chunked sends (32KiB)

const	IoTimeout = 30s
	Default I/O timeout.

Private Attributes inherited from WebDavHandler::AbstractWebDavHandler
AbstractWebDavPropertyHandler	property_handler
	The property handler object.

string	virtual_base_path
	The virtual base path for resources served by the WebDavHandler handler.

Logger	logger
	The Logger for this object.

Additional Inherited Members
Static Public Member Methods inherited from WebDavHandler::AbstractWebDavHandler
static	combineValue (reference< auto > h, auto v)
	Combines values recursively.

Public Attributes inherited from WebDavHandler::AbstractWebDavHandler
const	RequestMethods
	A hash of all supported WebDavHandler methods mapped to method names.

const	DestMethods
	A hash of methods that require a Destination header.

const	AllowHeaderValue = RequestMethods.keys().join(",")
	List of WebDavHandler methods in a string suitable for use in HTTP responses.

const	MethodList = keys RequestMethods
	List of WebDavHandler methods.

const	PPA_Remove = "R"
	PROPPATCH action: remove.

const	PPA_Set = "S"
	PROPPATCH action: set.

Detailed Description

Filesystem WebDavHandler inteface class.

Member Function Documentation

◆ constructor() [1/4]

WebDavHandler::FsWebDavHandler::constructor	(	string	path,
		*HttpServer::AbstractAuthenticator	auth
	)

Creates the object with an empty logger and an in-memory property handler.

Parameters

path	the path on the local filesystem for WebDAV file handline
auth	the authentication object to use to authenticate connections

◆ constructor() [2/4]

WebDavHandler::FsWebDavHandler::constructor	(	string	path,
		*HttpServer::AbstractAuthenticator	auth,
		AbstractWebDavPropertyHandler	property_handler,
		string	virtual_relative_path_base = `"/"`
	)

Creates the object with the given arguments.

Parameters

path	the path on the local filesystem for WebDAV file handline
auth	the authentication object to use to authenticate connections
property_handler	to handle properties
virtual_relative_path_base	the virtual base path for WebDavHandler requests; this path will be stripped from requests internally when serving WebDavHandler resources

◆ constructor() [3/4]

WebDavHandler::FsWebDavHandler::constructor	(	string	path,
		*HttpServer::AbstractAuthenticator	auth,
		Logger	logger,
		AbstractWebDavPropertyHandler	property_handler = `new InMemoryWebDavPropertyHandler()`,
		string	virtual_relative_path_base = `"/"`
	)

inline

Creates the object with the given arguments.

Parameters

path	the path on the local filesystem for WebDAV file handline
auth	the authentication object to use to authenticate connections
logger	the logger
property_handler	to handle properties
virtual_relative_path_base	the virtual base path for WebDavHandler requests; this path will be stripped from requests internally when serving WebDavHandler resources

◆ constructor() [4/4]

WebDavHandler::FsWebDavHandler::constructor	(	string	path,
		*HttpServer::AbstractAuthenticator	auth,
		string	virtual_relative_path_base
	)

Creates the object with the given argument and an in-memory property handler.

Parameters

path	the path on the local filesystem for WebDAV file handline
auth	the authentication object to use to authenticate connections
virtual_relative_path_base	the virtual base path for WebDavHandler requests; this path will be stripped from requests internally when serving WebDavHandler resources

◆ getRealPath()

string WebDavHandler::FsWebDavHandler::getRealPath ( string raw_path )

private

Converts a request path to a normalized real path on the filesystem in the root WebDavHandler directory.

Exceptions

WEBDAVHANDLER-FORBIDDEN if the path is not valid

◆ handleCopyImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleCopyImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles WebDavHandler COPY requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the WebDavHandler request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleDeleteImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleDeleteImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles HTTP DELETE requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the HTTP request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleGetImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleGetImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles HTTP GET requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the HTTP request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleHeadImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleHeadImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles HTTP HEAD requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the HTTP request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleLockImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleLockImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles WebDavHandler LOCK requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the WebDavHandler request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleMkcolImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleMkcolImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles WebDavHandler MKCOL requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the WebDavHandler request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleMoveImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleMoveImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles WebDavHandler MOVE requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the WebDavHandler request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handlePostImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handlePostImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles HTTP POST requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the HTTP request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handlePropfindImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handlePropfindImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles WebDavHandler PROPFIND requests for WebDavHandler resources; reetrieves properties from WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the WebDavHandler request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleProppatchImpl()

private *hash< string, hash< string, hash< string, bool > > > WebDavHandler::FsWebDavHandler::handleProppatchImpl	(	reference< string >	href,
		hash< auto >	cx,
		hash< auto >	hdr,
		*hash< auto >	request_xml,
		*list< hash< PropPatchActionInfo > >	actions
	)

inlinevirtual

Internal method for handling PROPPATCH requests.

Create, change and delete one or more properties on a resource in a single atomic action

Parameters

cx	the HTTP call context
hdr	as hash HTTP headers
request_xml	the parsed XML in the request
actions	a list of set and remove actions to execute on the given properties

Returns: a status map of HTTP code -> namespace -> property -> True

Exceptions

WEBDAVHANDLER-ERROR an error occured

Implements WebDavHandler::AbstractWebDavHandler.

◆ handlePutImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handlePutImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles HTTP PUT requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the HTTP request

Implements WebDavHandler::AbstractWebDavHandler.

◆ handleUnlockImpl()

hash< HttpResponseInfo > WebDavHandler::FsWebDavHandler::handleUnlockImpl	(	Socket	s,
		hash< auto >	cx,
		hash< auto >	hdr,
		*data	body
	)

privatevirtual

Handles WebDavHandler UNLOCK requests for WebDavHandler resources.

Parameters

cx	call context hash; this hash will have the following keys: `header-info`: a hash of information about the request header with the following keys: `accept-charset`: this key will be set to an appropriate value from any `"Accept-Charset"` header; if any of `"*"`, `"utf8"`, or `"utf-8"` are present, then this will be set to `"utf8"`, otherwise it will be set to the first requested character encoding in the list `accept-encoding`: a hash where keys are values from any `"Accept-Encoding"` header and the values are True `body-content-type`: this is the `"Content-Type"` header without any charset declaration `charset:` if there is a charset declaration in the `"Content-Type"` header, the value is returned in this key `client-cert`: if the server is configured to capture remote client certificates, and the client supplied a certificate, this key will be populated with the SSLCertificate for the client `close:` set to True if the connection should be closed after responding, False if not (as derived from the request header) `headers-raw`: a hash of raw request headers without any case conversions or other processing `request-uri`: gives the request URI in an HTTP request `socket:` the bind address used to bind the listener (`"socket-info"` provides more detailed information) `socket-info`: a hash of socket information for the listening socket (as returned by Qore::Socket::getSocketInfo()) `peer-info`: a hash of socket information for the remote socket (as returned by Qore::Socket::getPeerInfo()) `url:` a hash of broken-down URL information (as returned from Qore::parse_url()) `id:` the unique HTTP connection ID `ssl:` True if the request was encrypted with HTTPS, False if not `listener-id`: the HTTP server listener ID (see HttpServer::getListenerInfo()) `user:` the current RBAC username (if any) `root_path:` the root URL path matched if the request was matched by a URL prefix
hdr	incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present: `method:` the HTTP method received (ie `"GET"`, `"POST"`, etc) `path:` the HTTP path given in the request, after processing by Qore::decode_uri_request() `http_version:` the HTTP version number in the request (either `"1.0"` or `"1.1"`)
body	message body, if any

Returns: the response to the WebDavHandler request

Implements WebDavHandler::AbstractWebDavHandler.

The documentation for this class was generated from the following file:

doxygen/qlib/WebDavHandler/FsWebDavHandler.qc.dox.h

Public Member Methods

Private Member Methods

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ constructor() [1/4]

◆ constructor() [2/4]

◆ constructor() [3/4]

◆ constructor() [4/4]

◆ getRealPath()

◆ handleCopyImpl()

◆ handleDeleteImpl()

◆ handleGetImpl()

◆ handleHeadImpl()

◆ handleLockImpl()

◆ handleMkcolImpl()

◆ handleMoveImpl()

◆ handlePostImpl()

◆ handlePropfindImpl()

◆ handleProppatchImpl()

◆ handlePutImpl()

◆ handleUnlockImpl()