- Publicity: Public Only All
tDAV-procs.tcl
Procedures in this file
- tdav::check_lock (public)
- tdav::check_lock_for_unlock (public)
- tdav::conn (public)
- tdav::copy_props (public)
- tdav::dbm_read_list (private)
- tdav::dbm_write_list (private)
- tdav::delete_props (public)
- tdav::get_lock_file (public)
- tdav::get_user_props (public)
- tdav::lock_timeout_left (private)
- tdav::read_lock (private)
- tdav::remove_lock (public)
- tdav::respond (public)
- tdav::set_lock (public)
- tdav::update_user_props (public)
- tdav::write_lock (private)
Detailed information
tdav::check_lock (public)
tdav::check_lock uri
Check whether the request may proceed under the resource's WebDAV lock. Remove an expired lock. If an active lock has no matching token in the If header, send HTTP 423.
- Parameters:
- uri (required)
- Resource URI.
- Returns:
- unlocked if the request may proceed, or filter_return after HTTP 423.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::check_lock_for_unlock (public)
tdav::check_lock_for_unlock uri
Check the Lock-Token header against the stored lock for an UNLOCK request.
- Parameters:
- uri (required)
- Resource URI.
- Returns:
- unlocked if the token matches or no lock exists, or filter_return if the token is missing or does not match.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::conn (public)
tdav::conn [ args... ]
Read or write tDAV request state. A read falls back to ns_conn when no tDAV value is set for the requested field.
- Returns:
- The value read or stored.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::copy_props (public)
tdav::copy_props uri newuri
Copy persistent user properties from one resource to another.
- Parameters:
- uri (required)
- Source resource URI.
- newuri (required)
- Destination resource URI.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::dbm_read_list (private)
tdav::dbm_read_list uri
Read a resource's stored WebDAV user properties.
- Parameters:
- uri (required)
- Resource URI.
- Returns:
- A list of property key and value pairs, or an empty list if none are stored.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::dbm_write_list (private)
tdav::dbm_write_list uri list
Store a resource's WebDAV user properties as a persistent client property.
- Parameters:
- uri (required)
- Resource URI.
- list (required)
- Alternating property keys and values.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::delete_props (public)
tdav::delete_props uri
Clear the persistent user properties for a resource.
- Parameters:
- uri (required)
- Resource URI.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::get_lock_file (public)
tdav::get_lock_file uri
Return the path to the lock file for a resource, creating its parent directory if needed. Use the configured lockdir or the default lockdir next to the page root.
- Parameters:
- uri (required)
- Resource URI.
- Returns:
- Lock file path.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::get_user_props (public)
tdav::get_user_props uri depth prop_req
Read all stored user properties for a resource.
- Parameters:
- uri (required)
- Resource URI.
- depth (required)
- Requested traversal depth. Accepted but unused.
- prop_req (required)
- Requested property selection. Accepted but unused.
- Returns:
- A list of property key and value pairs.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::lock_timeout_left (private)
tdav::lock_timeout_left timeout locktime
Calculate the remaining lifetime of a WebDAV lock.
- Parameters:
- timeout (required)
- Lock lifetime in seconds.
- locktime (required)
- Lock creation time in a format accepted by clock scan.
- Returns:
- Remaining seconds, or zero if the lock has expired.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::read_lock (private)
tdav::read_lock uri
Read and decode a resource's lock record from its lock file. Create an empty lock file if it is absent.
- Parameters:
- uri (required)
- Resource URI.
- Returns:
- Lock record as a list, or an empty list for an empty file.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::remove_lock (public)
tdav::remove_lock uri
Delete the stored lock file for a resource.
- Parameters:
- uri (required)
- Resource URI.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::respond (public)
tdav::respond response
Send a WebDAV response. Format the response for the current HTTP method, with a plain text response for HTTP 423.
- Parameters:
- response (required)
- List starting with the HTTP status code, followed by method-specific response data.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::set_lock (public)
tdav::set_lock uri depth type scope owner [ timeout ] [ locktime ]
Create and store a WebDAV lock for a resource.
- Parameters:
- uri (required)
- Resource URI.
- depth (required)
- Lock depth.
- type (required)
- Lock type.
- scope (required)
- Lock scope.
- owner (required)
- Lock owner.
- timeout (optional)
- Lock lifetime. An empty value uses the configured default.
- locktime (optional)
- Lock creation time. An empty value uses the current time.
- Returns:
- The generated lock token.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::update_user_props (public)
tdav::update_user_props uri prop_req
Apply set and remove operations to a resource's stored user properties.
- Parameters:
- uri (required)
- Resource URI.
- prop_req (required)
- Alternating action and property records. Each property record contains a namespace/name key and a value.
- Returns:
- A list of HTTP status and property key pairs.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
tdav::write_lock (private)
tdav::write_lock uri list
Write a resource's lock record to its lock file, replacing any prior record.
- Parameters:
- uri (required)
- Resource URI.
- list (required)
- Lock record containing type, scope, owner, token, timeout, depth, and creation time.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
