Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
mod_dav.h
Go to the documentation of this file.
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements. See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
26 #ifndef _MOD_DAV_H_
27 #define _MOD_DAV_H_
28 
29 #include "apr_hooks.h"
30 #include "apr_hash.h"
31 #include "apr_dbm.h"
32 #include "apr_tables.h"
33 
34 #include "httpd.h"
35 #include "util_filter.h"
36 #include "util_xml.h"
37 
38 #include <limits.h> /* for INT_MAX */
39 #include <time.h> /* for time_t */
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 
46 #define DAV_VERSION AP_SERVER_BASEREVISION
47 
48 #define DAV_XML_HEADER "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
49 #define DAV_XML_CONTENT_TYPE "text/xml; charset=\"utf-8\""
50 
51 #define DAV_READ_BLOCKSIZE 2048 /* used for reading input blocks */
52 
53 #define DAV_RESPONSE_BODY_1 "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">\n<html>\n<head>\n<title>"
54 #define DAV_RESPONSE_BODY_2 "</title>\n</head><body>\n<h1>"
55 #define DAV_RESPONSE_BODY_3 "</h1>\n<p>"
56 #define DAV_RESPONSE_BODY_4 "</p>\n"
57 #define DAV_RESPONSE_BODY_5 "</body></html>\n"
58 
59 #define DAV_DO_COPY 0
60 #define DAV_DO_MOVE 1
61 
62 
63 #if 1
64 #define DAV_DEBUG 1
65 #define DEBUG_CR "\n"
66 #define DBG0(f) ap_log_error(APLOG_MARK, \
67  APLOG_ERR, 0, NULL, (f))
68 #define DBG1(f,a1) ap_log_error(APLOG_MARK, \
69  APLOG_ERR, 0, NULL, f, a1)
70 #define DBG2(f,a1,a2) ap_log_error(APLOG_MARK, \
71  APLOG_ERR, 0, NULL, f, a1, a2)
72 #define DBG3(f,a1,a2,a3) ap_log_error(APLOG_MARK, \
73  APLOG_ERR, 0, NULL, f, a1, a2, a3)
74 #else
75 #undef DAV_DEBUG
76 #define DEBUG_CR ""
77 #endif
78 
79 #define DAV_INFINITY INT_MAX /* for the Depth: header */
80 
81 /* Create a set of DAV_DECLARE(type), DAV_DECLARE_NONSTD(type) and
82  * DAV_DECLARE_DATA with appropriate export and import tags for the platform
83  */
84 #if !defined(WIN32)
85 #define DAV_DECLARE(type) type
86 #define DAV_DECLARE_NONSTD(type) type
87 #define DAV_DECLARE_DATA
88 #elif defined(DAV_DECLARE_STATIC)
89 #define DAV_DECLARE(type) type __stdcall
90 #define DAV_DECLARE_NONSTD(type) type
91 #define DAV_DECLARE_DATA
92 #elif defined(DAV_DECLARE_EXPORT)
93 #define DAV_DECLARE(type) __declspec(dllexport) type __stdcall
94 #define DAV_DECLARE_NONSTD(type) __declspec(dllexport) type
95 #define DAV_DECLARE_DATA __declspec(dllexport)
96 #else
97 #define DAV_DECLARE(type) __declspec(dllimport) type __stdcall
98 #define DAV_DECLARE_NONSTD(type) __declspec(dllimport) type
99 #define DAV_DECLARE_DATA __declspec(dllimport)
100 #endif
101 
102 /* --------------------------------------------------------------------
103 **
104 ** ERROR MANAGEMENT
105 */
106 
107 /*
108 ** dav_error structure.
109 **
110 ** In most cases, mod_dav uses a pointer to a dav_error structure. If the
111 ** pointer is NULL, then no error has occurred.
112 **
113 ** In certain cases, a dav_error structure is directly used. In these cases,
114 ** a status value of 0 means that an error has not occurred.
115 **
116 ** Note: this implies that status != 0 whenever an error occurs.
117 **
118 ** The desc field is optional (it may be NULL). When NULL, it typically
119 ** implies that Apache has a proper description for the specified status.
120 */
121 typedef struct dav_error {
122  int status; /* suggested HTTP status (0 for no error) */
123  int error_id; /* DAV-specific error ID */
124  const char *desc; /* DAV:responsedescription and error log */
125 
126  apr_status_t aprerr; /* APR error if any, or 0/APR_SUCCESS */
127 
128  const char *namespace; /* [optional] namespace of error */
129  const char *tagname; /* name of error-tag */
130 
131  struct dav_error *prev; /* previous error (in stack) */
132 
133  const char *childtags; /* error-tag may have children */
134 
135 } dav_error;
136 
137 /*
138 ** Create a new error structure. save_errno will be filled with the current
139 ** errno value.
140 */
141 DAV_DECLARE(dav_error*) dav_new_error(apr_pool_t *p, int status,
143  const char *desc);
144 
145 
146 /*
147 ** Create a new error structure with tagname and (optional) namespace;
148 ** namespace may be NULL, which means "DAV:".
149 */
150 DAV_DECLARE(dav_error*) dav_new_error_tag(apr_pool_t *p, int status,
151  int error_id, apr_status_t aprerr,
152  const char *desc,
153  const char *namespace,
154  const char *tagname);
155 
156 
157 /*
158 ** Push a new error description onto the stack of errors.
159 **
160 ** This function is used to provide an additional description to an existing
161 ** error.
162 **
163 ** <status> should contain the caller's view of what the current status is,
164 ** given the underlying error. If it doesn't have a better idea, then the
165 ** caller should pass prev->status.
166 **
167 ** <error_id> can specify a new error_id since the topmost description has
168 ** changed.
169 */
170 DAV_DECLARE(dav_error*) dav_push_error(apr_pool_t *p, int status, int error_id,
171  const char *desc, dav_error *prev);
172 
173 
174 /*
175 ** Join two errors together.
176 **
177 ** This function is used to add a new error stack onto an existing error so
178 ** that subsequent errors can be reported after the first error. It returns
179 ** the correct error stack to use so that the caller can blindly call it
180 ** without checking that both dest and src are not NULL.
181 **
182 ** <dest> is the error stack that the error will be added to.
183 **
184 ** <src> is the error stack that will be appended.
185 */
186 DAV_DECLARE(dav_error*) dav_join_error(dav_error* dest, dav_error* src);
187 
188 typedef struct dav_response dav_response;
189 
190 /*
191 ** dav_handle_err()
192 **
193 ** Handle the standard error processing. <err> must be non-NULL.
194 **
195 ** <response> is set by the following:
196 ** - dav_validate_request()
197 ** - dav_add_lock()
198 ** - repos_hooks->remove_resource
199 ** - repos_hooks->move_resource
200 ** - repos_hooks->copy_resource
201 ** - vsn_hooks->update
202 */
203 DAV_DECLARE(int) dav_handle_err(request_rec *r, dav_error *err,
204  dav_response *response);
205 
206 /* error ID values... */
207 
208 /* IF: header errors */
209 #define DAV_ERR_IF_PARSE 100 /* general parsing error */
210 #define DAV_ERR_IF_MULTIPLE_NOT 101 /* multiple "Not" found */
211 #define DAV_ERR_IF_UNK_CHAR 102 /* unknown char in header */
212 #define DAV_ERR_IF_ABSENT 103 /* no locktokens given */
213 #define DAV_ERR_IF_TAGGED 104 /* in parsing tagged-list */
214 #define DAV_ERR_IF_UNCLOSED_PAREN 105 /* in no-tagged-list */
215 
216 /* Prop DB errors */
217 #define DAV_ERR_PROP_BAD_MAJOR 200 /* major version was wrong */
218 #define DAV_ERR_PROP_READONLY 201 /* prop is read-only */
219 #define DAV_ERR_PROP_NO_DATABASE 202 /* writable db not avail */
220 #define DAV_ERR_PROP_NOT_FOUND 203 /* prop not found */
221 #define DAV_ERR_PROP_BAD_LOCKDB 204 /* could not open lockdb */
222 #define DAV_ERR_PROP_OPENING 205 /* problem opening propdb */
223 #define DAV_ERR_PROP_EXEC 206 /* problem exec'ing patch */
224 
225 /* Predefined DB errors */
226 /* ### any to define?? */
227 
228 /* Predefined locking system errors */
229 #define DAV_ERR_LOCK_OPENDB 400 /* could not open lockdb */
230 #define DAV_ERR_LOCK_NO_DB 401 /* no database defined */
231 #define DAV_ERR_LOCK_CORRUPT_DB 402 /* DB is corrupt */
232 #define DAV_ERR_LOCK_UNK_STATE_TOKEN 403 /* unknown State-token */
233 #define DAV_ERR_LOCK_PARSE_TOKEN 404 /* bad opaquelocktoken */
234 #define DAV_ERR_LOCK_SAVE_LOCK 405 /* err saving locks */
235 
236 /*
237 ** Some comments on Error ID values:
238 **
239 ** The numbers do not necessarily need to be unique. Uniqueness simply means
240 ** that two errors that have not been predefined above can be distinguished
241 ** from each other. At the moment, mod_dav does not use this distinguishing
242 ** feature, but it could be used in the future to collapse <response> elements
243 ** into groups based on the error ID (and associated responsedescription).
244 **
245 ** If a compute_desc is provided, then the error ID should be unique within
246 ** the context of the compute_desc function (so the function can figure out
247 ** what to filled into the desc).
248 **
249 ** Basically, subsystems can ignore defining new error ID values if they want
250 ** to. The subsystems *do* need to return the predefined errors when
251 ** appropriate, so that mod_dav can figure out what to do. Subsystems can
252 ** simply leave the error ID field unfilled (zero) if there isn't an error
253 ** that must be placed there.
254 */
255 
256 
257 /* --------------------------------------------------------------------
258 **
259 ** HOOK STRUCTURES
260 **
261 ** These are here for forward-declaration purposes. For more info, see
262 ** the section title "HOOK HANDLING" for more information, plus each
263 ** structure definition.
264 */
265 
266 /* forward-declare this structure */
274 
275 /* ### deprecated name */
277 
278 
279 /* --------------------------------------------------------------------
280 **
281 ** RESOURCE HANDLING
282 */
283 
284 /*
285 ** Resource Types:
286 ** The base protocol defines only file and collection resources.
287 ** The versioning protocol defines several additional resource types
288 ** to represent artifacts of a version control system.
289 **
290 ** This enumeration identifies the type of URL used to identify the
291 ** resource. Since the same resource may have more than one type of
292 ** URL which can identify it, dav_resource_type cannot be used
293 ** alone to determine the type of the resource; attributes of the
294 ** dav_resource object must also be consulted.
295 */
296 typedef enum {
298 
299  DAV_RESOURCE_TYPE_REGULAR, /* file or collection; could be
300  * unversioned, or version selector,
301  * or baseline selector */
302 
303  DAV_RESOURCE_TYPE_VERSION, /* version or baseline URL */
304 
305  DAV_RESOURCE_TYPE_HISTORY, /* version or baseline history URL */
306 
307  DAV_RESOURCE_TYPE_WORKING, /* working resource URL */
308 
309  DAV_RESOURCE_TYPE_WORKSPACE, /* workspace URL */
310 
311  DAV_RESOURCE_TYPE_ACTIVITY, /* activity URL */
312 
313  DAV_RESOURCE_TYPE_PRIVATE /* repository-private type */
314 
316 
317 /*
318 ** Opaque, repository-specific information for a resource.
319 */
321 
323 
324 /*
325 ** Resource descriptor, generated by a repository provider.
326 **
327 ** Note: the lock-null state is not explicitly represented here,
328 ** since it may be expensive to compute. Use dav_get_resource_state()
329 ** to determine whether a non-existent resource is a lock-null resource.
330 **
331 ** A quick explanation of how the flags can apply to different resources:
332 **
333 ** unversioned file or collection:
334 ** type = DAV_RESOURCE_TYPE_REGULAR
335 ** exists = ? (1 if exists)
336 ** collection = ? (1 if collection)
337 ** versioned = 0
338 ** baselined = 0
339 ** working = 0
340 **
341 ** version-controlled resource or configuration:
342 ** type = DAV_RESOURCE_TYPE_REGULAR
343 ** exists = 1
344 ** collection = ? (1 if collection)
345 ** versioned = 1
346 ** baselined = ? (1 if configuration)
347 ** working = ? (1 if checked out)
348 **
349 ** version/baseline history:
350 ** type = DAV_RESOURCE_TYPE_HISTORY
351 ** exists = 1
352 ** collection = 0
353 ** versioned = 0
354 ** baselined = 0
355 ** working = 0
356 **
357 ** version/baseline:
358 ** type = DAV_RESOURCE_TYPE_VERSION
359 ** exists = 1
360 ** collection = ? (1 if collection)
361 ** versioned = 1
362 ** baselined = ? (1 if baseline)
363 ** working = 0
364 **
365 ** working resource:
366 ** type = DAV_RESOURCE_TYPE_WORKING
367 ** exists = 1
368 ** collection = ? (1 if collection)
369 ** versioned = 1
370 ** baselined = 0
371 ** working = 1
372 **
373 ** workspace:
374 ** type = DAV_RESOURCE_TYPE_WORKSPACE
375 ** exists = ? (1 if exists)
376 ** collection = 1
377 ** versioned = ? (1 if version-controlled)
378 ** baselined = ? (1 if baseline-controlled)
379 ** working = ? (1 if checked out)
380 **
381 ** activity:
382 ** type = DAV_RESOURCE_TYPE_ACTIVITY
383 ** exists = ? (1 if exists)
384 ** collection = 0
385 ** versioned = 0
386 ** baselined = 0
387 ** working = 0
388 */
389 typedef struct dav_resource {
391 
392  int exists; /* 0 => null resource */
393 
394  int collection; /* 0 => file; can be 1 for
395  * REGULAR, VERSION, and WORKING resources,
396  * and is always 1 for WORKSPACE */
397 
398  int versioned; /* 0 => unversioned; can be 1 for
399  * REGULAR and WORKSPACE resources,
400  * and is always 1 for VERSION and WORKING */
401 
402  int baselined; /* 0 => not baselined; can be 1 for
403  * REGULAR, VERSION, and WORKSPACE resources;
404  * versioned == 1 when baselined == 1 */
405 
406  int working; /* 0 => not checked out; can be 1 for
407  * REGULAR and WORKSPACE resources,
408  * and is always 1 for WORKING */
409 
410  const char *uri; /* the URI for this resource;
411  * currently has an ABI flaw where sometimes it is
412  * assumed to be encoded and sometimes not */
413 
414  dav_resource_private *info; /* the provider's private info */
415 
416  const dav_hooks_repository *hooks; /* hooks used for this resource */
417 
418  /* When allocating items related specifically to this resource, the
419  following pool should be used. Its lifetime will be at least as
420  long as the dav_resource structure. */
422 
423  const dav_acl_provider *acls; /* acls used for this resource */
424 
425  void *ctx; /* additional parameter */
426 
427 } dav_resource;
428 
429 /*
430 ** Lock token type. Lock providers define the details of a lock token.
431 ** However, all providers are expected to at least be able to parse
432 ** the "opaquelocktoken" scheme, which is represented by a uuid_t.
433 */
435 
436 DAV_DECLARE(dav_error *) dav_get_resource(request_rec *r, int label_allowed,
438 
439 
440 /* --------------------------------------------------------------------
441 **
442 ** BUFFER HANDLING
443 **
444 ** These buffers are used as a lightweight buffer reuse mechanism. Apache
445 ** provides sub-pool creation and destruction to much the same effect, but
446 ** the sub-pools are a bit more general and heavyweight than these buffers.
447 */
448 
449 /* buffer for reuse; can grow to accommodate needed size */
450 typedef struct
451 {
452  apr_size_t alloc_len; /* how much has been allocated */
453  apr_size_t cur_len; /* how much is currently being used */
454  char *buf; /* buffer contents */
455 } dav_buffer;
456 #define DAV_BUFFER_MINSIZE 256 /* minimum size for buffer */
457 #define DAV_BUFFER_PAD 64 /* amount of pad when growing */
458 
459 /* set the cur_len to the given size and ensure space is available */
460 DAV_DECLARE(void) dav_set_bufsize(apr_pool_t *p, dav_buffer *pbuf,
461  apr_size_t size);
462 
463 /* initialize a buffer and copy the specified (null-term'd) string into it */
464 DAV_DECLARE(void) dav_buffer_init(apr_pool_t *p, dav_buffer *pbuf,
465  const char *str);
466 
467 /* check that the buffer can accommodate <extra_needed> more bytes */
468 DAV_DECLARE(void) dav_check_bufsize(apr_pool_t *p, dav_buffer *pbuf,
470 
471 /* append a string to the end of the buffer, adjust length */
472 DAV_DECLARE(void) dav_buffer_append(apr_pool_t *p, dav_buffer *pbuf,
473  const char *str);
474 
475 /* place a string on the end of the buffer, do NOT adjust length */
476 DAV_DECLARE(void) dav_buffer_place(apr_pool_t *p, dav_buffer *pbuf,
477  const char *str);
478 
479 /* place some memory on the end of a buffer; do NOT adjust length */
480 DAV_DECLARE(void) dav_buffer_place_mem(apr_pool_t *p, dav_buffer *pbuf,
481  const void *mem, apr_size_t amt,
482  apr_size_t pad);
483 
484 
485 /* --------------------------------------------------------------------
486 **
487 ** HANDY UTILITIES
488 */
489 
490 /* contains results from one of the getprop functions */
491 typedef struct
492 {
493  apr_text * propstats; /* <propstat> element text */
494  apr_text * xmlns; /* namespace decls for <response> elem */
496 
497 /* holds the contents of a <response> element */
498 struct dav_response
499 {
500  const char *href; /* always */
501  const char *desc; /* optional description at <response> level */
502 
503  /* use status if propresult.propstats is NULL. */
505 
506  int status;
507 
508  struct dav_response *next;
509 };
510 
511 typedef struct
512 {
513  request_rec *rnew; /* new subrequest */
514  dav_error err; /* potential error response */
516 
517 
518 DAV_DECLARE(dav_lookup_result) dav_lookup_uri(const char *uri, request_rec *r,
519  int must_be_absolute);
520 
521 /* defines type of property info a provider is to return */
522 typedef enum {
523  DAV_PROP_INSERT_NOTDEF, /* property is defined by this provider,
524  but nothing was inserted because the
525  (live) property is not defined for this
526  resource (it may be present as a dead
527  property). */
528  DAV_PROP_INSERT_NOTSUPP, /* property is recognized by this provider,
529  but it is not supported, and cannot be
530  treated as a dead property */
531  DAV_PROP_INSERT_NAME, /* a property name (empty elem) was
532  inserted into the text block */
533  DAV_PROP_INSERT_VALUE, /* a property name/value pair was inserted
534  into the text block */
535  DAV_PROP_INSERT_SUPPORTED /* a supported live property was added to
536  the text block as a
537  <DAV:supported-live-property> element */
539 
540 /* ### this stuff is private to dav/fs/repos.c; move it... */
541 /* format a time string (buf must be at least DAV_TIMEBUF_SIZE chars) */
542 #define DAV_STYLE_ISO8601 1
543 #define DAV_STYLE_RFC822 2
544 #define DAV_TIMEBUF_SIZE 30
545 
546 /* Write a complete RESPONSE object out as a <DAV:response> xml
547  * element. Data is sent into brigade BB, which is auto-flushed into
548  * the output filter stack for request R. Use POOL for any temporary
549  * allocations.
550  *
551  * [Presumably the <multistatus> tag has already been written; this
552  * routine is shared by dav_send_multistatus and dav_stream_response.]
553  */
554 DAV_DECLARE(void) dav_send_one_response(dav_response *response,
556  request_rec *r,
557  apr_pool_t *pool);
558 
559 /* Factorized helper function: prep request_rec R for a multistatus
560  * response and write <multistatus> tag into BB, destined for
561  * R->output_filters. Use xml NAMESPACES in initial tag, if
562  * non-NULL.
563  */
564 DAV_DECLARE(void) dav_begin_multistatus(apr_bucket_brigade *bb,
565  request_rec *r, int status,
567 
568 /* Finish a multistatus response started by dav_begin_multistatus: */
569 DAV_DECLARE(apr_status_t) dav_finish_multistatus(request_rec *r,
570  apr_bucket_brigade *bb);
571 
572 /* Send a multistatus response */
573 DAV_DECLARE(void) dav_send_multistatus(request_rec *r, int status,
574  dav_response *first,
575  apr_array_header_t *namespaces);
576 
577 DAV_DECLARE(apr_text *) dav_failed_proppatch(apr_pool_t *p,
579 DAV_DECLARE(apr_text *) dav_success_proppatch(apr_pool_t *p,
580  apr_array_header_t *prop_ctx);
581 
582 DAV_DECLARE(int) dav_get_depth(request_rec *r, int def_depth);
583 
584 DAV_DECLARE(int) dav_validate_root(const apr_xml_doc *doc,
585  const char *tagname);
586 DAV_DECLARE(int) dav_validate_root_ns(const apr_xml_doc *doc,
587  int ns, const char *tagname);
588 DAV_DECLARE(apr_xml_elem *) dav_find_child(const apr_xml_elem *elem,
589  const char *tagname);
590 DAV_DECLARE(apr_xml_elem *) dav_find_child_ns(const apr_xml_elem *elem,
591  int ns, const char *tagname);
592 DAV_DECLARE(apr_xml_elem *) dav_find_next_ns(const apr_xml_elem *elem,
593  int ns, const char *tagname);
594 
595 /* find and return the attribute with a name in the given namespace */
596 DAV_DECLARE(apr_xml_attr *) dav_find_attr_ns(const apr_xml_elem *elem,
597  int ns, const char *attrname);
598 
599 /* find and return the attribute with a given DAV: tagname */
600 DAV_DECLARE(apr_xml_attr *) dav_find_attr(const apr_xml_elem *elem,
601  const char *attrname);
602 
603 /* gather up all the CDATA into a single string */
604 DAV_DECLARE(const char *) dav_xml_get_cdata(const apr_xml_elem *elem, apr_pool_t *pool,
605  int strip_white);
606 
607 /*
608 ** XML namespace handling
609 **
610 ** This structure tracks namespace declarations (xmlns:prefix="URI").
611 ** It maintains a one-to-many relationship of URIs-to-prefixes. In other
612 ** words, one URI may be defined by many prefixes, but any specific
613 ** prefix will specify only one URI.
614 **
615 ** Prefixes using the "g###" pattern can be generated automatically if
616 ** the caller does not have specific prefix requirements.
617 */
618 typedef struct {
620  apr_hash_t *uri_prefix; /* map URIs to an available prefix */
621  apr_hash_t *prefix_uri; /* map all prefixes to their URIs */
622  int count; /* counter for "g###" prefixes */
624 
625 /* create an empty dav_xmlns_info structure */
626 DAV_DECLARE(dav_xmlns_info *) dav_xmlns_create(apr_pool_t *pool);
627 
628 /* add a specific prefix/URI pair. the prefix/uri should have a lifetime
629  at least that of xmlns->pool */
630 DAV_DECLARE(void) dav_xmlns_add(dav_xmlns_info *xi,
631  const char *prefix, const char *uri);
632 
633 /* add a URI (if not present); any prefix is acceptable and is returned.
634  the uri should have a lifetime at least that xmlns->pool */
635 DAV_DECLARE(const char *) dav_xmlns_add_uri(dav_xmlns_info *xi,
636  const char *uri);
637 
638 /* return the URI for a specified prefix (or NULL if the prefix is unknown) */
639 DAV_DECLARE(const char *) dav_xmlns_get_uri(dav_xmlns_info *xi,
640  const char *prefix);
641 
642 /* return an available prefix for a specified URI (or NULL if the URI
643  is unknown) */
644 DAV_DECLARE(const char *) dav_xmlns_get_prefix(dav_xmlns_info *xi,
645  const char *uri);
646 
647 /* generate xmlns declarations (appending into the given text) */
648 DAV_DECLARE(void) dav_xmlns_generate(dav_xmlns_info *xi,
650 
651 /* --------------------------------------------------------------------
652 **
653 ** DAV PLUGINS
654 */
655 
656 /* ### docco ... */
657 
658 /*
659 ** dav_provider
660 **
661 ** This structure wraps up all of the hooks that a mod_dav provider can
662 ** supply. The provider MUST supply <repos> and <propdb>. The rest are
663 ** optional and should contain NULL if that feature is not supplied.
664 **
665 ** Note that a provider cannot pick and choose portions from various
666 ** underlying implementations (which was theoretically possible in
667 ** mod_dav 1.0). There are too many dependencies between a dav_resource
668 ** (defined by <repos>) and the other functionality.
669 **
670 ** Live properties and report extensions are not part of the dav_provider
671 ** structure because they are handled through the APR_HOOK interface (to
672 ** allow for multiple providers). The core always provides some
673 ** properties, and then a given provider will add more properties.
674 **
675 ** Some providers may need to associate a context with the dav_provider
676 ** structure -- the ctx field is available for storing this context. Just
677 ** leave it NULL if it isn't required.
678 */
679 typedef struct {
686 
687  void *ctx;
688 } dav_provider;
689 
690 /*
691 ** gather_propsets: gather all live property propset-URIs
692 **
693 ** The hook implementor should push one or more URIs into the specified
694 ** array. These URIs are returned in the DAV: header to let clients know
695 ** what sets of live properties are supported by the installation. mod_dav
696 ** will place open/close angle brackets around each value (much like
697 ** a Coded-URL); quotes and brackets should not be in the value.
698 **
699 ** Example: http://apache.org/dav/props/
700 **
701 ** (of course, use your own domain to ensure a unique value)
702 */
703 APR_DECLARE_EXTERNAL_HOOK(dav, DAV, void, gather_propsets,
704  (apr_array_header_t *uris))
705 
706 /*
707 ** find_liveprop: find a live property, returning a non-zero, unique,
708 ** opaque identifier.
709 **
710 ** If the hook implementor determines the specified URI/name refers to
711 ** one of its properties, then it should fill in HOOKS and return a
712 ** non-zero value. The returned value is the "property ID" and will
713 ** be passed to the various liveprop hook functions.
714 **
715 ** Return 0 if the property is not defined by the hook implementor.
716 */
717 APR_DECLARE_EXTERNAL_HOOK(dav, DAV, int, find_liveprop,
718  (const dav_resource *resource,
719  const char *ns_uri, const char *name,
720  const dav_hooks_liveprop **hooks))
721 
722 /*
723 ** insert_all_liveprops: insert all (known) live property names/values.
724 **
725 ** The hook implementor should append XML text to PHDR, containing liveprop
726 ** names. If INSVALUE is true, then the property values should also be
727 ** inserted into the output XML stream.
728 **
729 ** The liveprop provider should insert *all* known and *defined* live
730 ** properties on the specified resource. If a particular liveprop is
731 ** not defined for this resource, then it should not be inserted.
732 */
733 APR_DECLARE_EXTERNAL_HOOK(dav, DAV, void, insert_all_liveprops,
734  (request_rec *r, const dav_resource *resource,
736 
737 /*
738 ** deliver_report: given a parsed report request, process the request
739 ** an deliver the resulting report.
740 **
741 ** The hook implementer should decide whether it should handle the given
742 ** report, and if so, write the response to the output filter. If the
743 ** report is not relevant, return DECLINED.
744 */
745 APR_DECLARE_EXTERNAL_HOOK(dav, DAV, int, deliver_report,
746  (request_rec *r,
747  const dav_resource *resource,
748  const apr_xml_doc *doc,
749  ap_filter_t *output, dav_error **err))
750 
751 /*
752 ** gather_reports: get all reports.
753 **
754 ** The hook implementor should push one or more dav_report_elem structures
755 ** containing report names into the specified array. These names are returned
756 ** in the DAV:supported-reports-set property to let clients know
757 ** what reports are supported by the installation.
758 **
759 */
760 APR_DECLARE_EXTERNAL_HOOK(dav, DAV, void, gather_reports,
761  (request_rec *r, const dav_resource *resource,
762  apr_array_header_t *reports, dav_error **err))
763 
764 /*
765  ** method_precondition: check method preconditions.
766  **
767  ** If a WebDAV extension needs to set any preconditions on a method, this
768  ** hook is where to do it. If the precondition fails, return an error
769  ** response with the tagname set to the value of the failed precondition.
770  **
771  ** If the method requires an XML body, this will be read and provided as
772  ** the doc value. If not, doc is NULL. An extension that needs to verify
773  ** the non-XML body of a request should register an input filter to do so
774  ** within this hook.
775  **
776  ** Methods like PUT will supply a single src resource, and the dst will
777  ** be NULL.
778  **
779  ** Methods like COPY or MOVE will trigger this hook twice. The first
780  ** invocation will supply just the source resource. The second invocation
781  ** will supply a source and destination. This allows preconditions on the
782  ** source resource to be verified before making an attempt to get the
783  ** destination resource.
784  **
785  ** Methods like PROPFIND and LABEL will trigger this hook initially for
786  ** the src resource, and then subsequently for each resource that has
787  ** been walked during processing, with the walked resource passed in dst,
788  ** and NULL passed in src.
789  **
790  ** As a rule, the src resource originates from a request that has passed
791  ** through httpd's authn/authz hooks, while the dst resource has not.
792  */
793 APR_DECLARE_EXTERNAL_HOOK(dav, DAV, int, method_precondition,
794  (request_rec *r,
795  dav_resource *src, const dav_resource *dst,
796  const apr_xml_doc *doc, dav_error **err))
797 
798 
799 DAV_DECLARE(const dav_hooks_locks *) dav_get_lock_hooks(request_rec *r);
800 DAV_DECLARE(const dav_hooks_propdb *) dav_get_propdb_hooks(request_rec *r);
801 DAV_DECLARE(const dav_hooks_vsn *) dav_get_vsn_hooks(request_rec *r);
802 DAV_DECLARE(const dav_hooks_binding *) dav_get_binding_hooks(request_rec *r);
803 DAV_DECLARE(const dav_hooks_search *) dav_get_search_hooks(request_rec *r);
804 
805 DAV_DECLARE(void) dav_register_provider(apr_pool_t *p, const char *name,
806  const dav_provider *hooks);
807 DAV_DECLARE(const dav_provider *) dav_lookup_provider(const char *name);
808 DAV_DECLARE(const char *) dav_get_provider_name(request_rec *r);
809 DAV_DECLARE(const dav_provider *) dav_get_provider(request_rec *r);
810 
811 
812 /* ### deprecated */
813 #define DAV_GET_HOOKS_PROPDB(r) dav_get_propdb_hooks(r)
814 #define DAV_GET_HOOKS_LOCKS(r) dav_get_lock_hooks(r)
815 #define DAV_GET_HOOKS_VSN(r) dav_get_vsn_hooks(r)
816 #define DAV_GET_HOOKS_BINDING(r) dav_get_binding_hooks(r)
817 #define DAV_GET_HOOKS_SEARCH(r) dav_get_search_hooks(r)
818 
819 
820 /* --------------------------------------------------------------------
821 **
822 ** IF HEADER PROCESSING
823 **
824 ** Here is the definition of the If: header from RFC 2518, S9.4:
825 **
826 ** If = "If" ":" (1*No-tag-list | 1*Tagged-list)
827 ** No-tag-list = List
828 ** Tagged-list = Resource 1*List
829 ** Resource = Coded-URL
830 ** List = "(" 1*(["Not"](State-token | "[" entity-tag "]")) ")"
831 ** State-token = Coded-URL
832 ** Coded-URL = "<" absoluteURI ">" ; absoluteURI from RFC 2616
833 **
834 ** List corresponds to dav_if_state_list. No-tag-list corresponds to
835 ** dav_if_header with uri==NULL. Tagged-list corresponds to a sequence of
836 ** dav_if_header structures with (duplicate) uri==Resource -- one
837 ** dav_if_header per state_list. A second Tagged-list will start a new
838 ** sequence of dav_if_header structures with the new URI.
839 **
840 ** A summary of the semantics, mapped into our structures:
841 ** - Chained dav_if_headers: OR
842 ** - Chained dav_if_state_lists: AND
843 ** - NULL uri matches all resources
844 */
845 
846 typedef enum
847 {
850  dav_if_unknown /* the "unknown" state type; always matches false. */
852 
853 typedef struct dav_if_state_list
854 {
856 
858 #define DAV_IF_COND_NORMAL 0
859 #define DAV_IF_COND_NOT 1 /* "Not" was applied */
860 
861  const char *etag;
863 
866 
867 typedef struct dav_if_header
868 {
869  const char *uri;
873 
874  int dummy_header; /* used internally by the lock/etag validation */
875 } dav_if_header;
876 
877 typedef struct dav_locktoken_list
878 {
882 
883 DAV_DECLARE(dav_error *) dav_get_locktoken_list(request_rec *r,
885 
886 
887 /* --------------------------------------------------------------------
888 **
889 ** LIVE PROPERTY HANDLING
890 */
891 
892 /* opaque type for PROPPATCH rollback information */
894 
896 {
897  /*
898  ** Insert property information into a text block. The property to
899  ** insert is identified by the propid value. The information to insert
900  ** is identified by the "what" argument, as follows:
901  ** DAV_PROP_INSERT_NAME
902  ** property name, as an empty XML element
903  ** DAV_PROP_INSERT_VALUE
904  ** property name/value, as an XML element
905  ** DAV_PROP_INSERT_SUPPORTED
906  ** if the property is defined on the resource, then
907  ** a DAV:supported-live-property element, as defined
908  ** by the DeltaV extensions to RFC2518.
909  **
910  ** Providers should return DAV_PROP_INSERT_NOTDEF if the property is
911  ** known and not defined for this resource, so should be handled as a
912  ** dead property. If a provider recognizes, but does not support, a
913  ** property, and does not want it handled as a dead property, it should
914  ** return DAV_PROP_INSERT_NOTSUPP.
915  **
916  ** Some DAV extensions, like CalDAV, specify both document elements
917  ** and property elements that need to be taken into account when
918  ** generating a property. The document element and property element
919  ** are made available in the dav_liveprop_elem structure under the
920  ** DAV_PROP_ELEMENT key in the resource pool, accessible as follows:
921  **
922  ** apr_pool_userdata_get(&elem, DAV_PROP_ELEMENT, resource->pool);
923  **
924  ** Returns one of DAV_PROP_INSERT_* based on what happened.
925  **
926  ** ### we may need more context... ie. the lock database
927  */
928  dav_prop_insert (*insert_prop)(const dav_resource *resource,
929  int propid, dav_prop_insert what,
931 
932  /*
933  ** Determine whether a given property is writable.
934  **
935  ** ### we may want a different semantic. i.e. maybe it should be
936  ** ### "can we write <value> into this property?"
937  **
938  ** Returns 1 if the live property can be written, 0 if read-only.
939  */
940  int (*is_writable)(const dav_resource *resource, int propid);
941 
942  /*
943  ** This member defines the set of namespace URIs that the provider
944  ** uses for its properties. When insert_all is called, it will be
945  ** passed a list of integers that map from indices into this list
946  ** to namespace IDs for output generation.
947  **
948  ** The last entry in this list should be a NULL value (sentinel).
949  */
950  const char * const * namespace_uris;
951 
952  /*
953  ** ### this is not the final design. we want an open-ended way for
954  ** ### liveprop providers to attach *new* properties. To this end,
955  ** ### we'll have a "give me a list of the props you define", a way
956  ** ### to check for a prop's existence, a way to validate a set/remove
957  ** ### of a prop, and a way to execute/commit/rollback that change.
958  */
959 
960  /*
961  ** Validate that the live property can be assigned a value, and that
962  ** the provided value is valid.
963  **
964  ** elem will point to the XML element that names the property. For
965  ** example:
966  ** <lp1:executable>T</lp1:executable>
967  **
968  ** The provider can access the cdata fields and the child elements
969  ** to extract the relevant pieces.
970  **
971  ** operation is one of DAV_PROP_OP_SET or _DELETE.
972  **
973  ** The provider may return a value in *context which will be passed
974  ** to each of the exec/commit/rollback functions. For example, this
975  ** may contain an internal value which has been processed from the
976  ** input element.
977  **
978  ** The provider must set defer_to_dead to true (non-zero) or false.
979  ** If true, then the set/remove is deferred to the dead property
980  ** database. Note: it will be set to zero on entry.
981  */
982  dav_error * (*patch_validate)(const dav_resource *resource,
983  const apr_xml_elem *elem,
984  int operation,
985  void **context,
986  int *defer_to_dead);
987 
988  /* ### doc... */
989  dav_error * (*patch_exec)(const dav_resource *resource,
990  const apr_xml_elem *elem,
991  int operation,
992  void *context,
993  dav_liveprop_rollback **rollback_ctx);
994 
995  /* ### doc... */
996  void (*patch_commit)(const dav_resource *resource,
997  int operation,
998  void *context,
999  dav_liveprop_rollback *rollback_ctx);
1000 
1001  /* ### doc... */
1002  dav_error * (*patch_rollback)(const dav_resource *resource,
1003  int operation,
1004  void *context,
1005  dav_liveprop_rollback *rollback_ctx);
1006 
1007  /*
1008  ** If a provider needs a context to associate with this hooks structure,
1009  ** then this field may be used. In most cases, it will just be NULL.
1010  */
1011  void *ctx;
1012 };
1013 
1014 /*
1015 ** dav_liveprop_spec: specify a live property
1016 **
1017 ** This structure is used as a standard way to determine if a particular
1018 ** property is a live property. Its use is not part of the mandated liveprop
1019 ** interface, but can be used by liveprop providers in conjunction with the
1020 ** utility routines below.
1021 **
1022 ** spec->name == NULL is the defined end-sentinel for a list of specs.
1023 */
1024 typedef struct {
1025  int ns; /* provider-local namespace index */
1026  const char *name; /* name of the property */
1027 
1028  int propid; /* provider-local property ID */
1029 
1030  int is_writable; /* is the property writable? */
1031 
1033 
1034 /*
1035 ** dav_liveprop_group: specify a group of liveprops
1036 **
1037 ** This structure specifies a group of live properties, their namespaces,
1038 ** and how to handle them.
1039 */
1040 typedef struct {
1042  const char * const *namespace_uris;
1044 
1046 
1047 /* ### docco */
1048 DAV_DECLARE(int) dav_do_find_liveprop(const char *ns_uri, const char *name,
1049  const dav_liveprop_group *group,
1050  const dav_hooks_liveprop **hooks);
1051 
1052 /* ### docco */
1053 DAV_DECLARE(long) dav_get_liveprop_info(int propid,
1054  const dav_liveprop_group *group,
1055  const dav_liveprop_spec **info);
1056 
1057 /* ### docco */
1058 DAV_DECLARE(void) dav_register_liveprop_group(apr_pool_t *pool,
1059  const dav_liveprop_group *group);
1060 
1061 /* ### docco */
1062 DAV_DECLARE(long) dav_get_liveprop_ns_index(const char *uri);
1063 
1064 /* ### docco */
1065 DAV_DECLARE(long) dav_get_liveprop_ns_count(void);
1066 
1067 /* ### docco */
1068 DAV_DECLARE(void) dav_add_all_liveprop_xmlns(apr_pool_t *p,
1070 
1071 /*
1072  ** When calling insert_prop(), the request element is associated with
1073  ** the pool userdata attached to the resource. Access as follows:
1074  **
1075  ** apr_pool_userdata_get(&elem, DAV_PROP_ELEMENT, resource->pool);
1076  **
1077  */
1078 #define DAV_PROP_ELEMENT "mod_dav-element"
1079 
1080 typedef struct {
1084 
1085 /*
1086 ** The following three functions are part of mod_dav's internal handling
1087 ** for the core WebDAV properties. They are not part of mod_dav's API.
1088 */
1089 DAV_DECLARE_NONSTD(int) dav_core_find_liveprop(
1090  const dav_resource *resource,
1091  const char *ns_uri,
1092  const char *name,
1093  const dav_hooks_liveprop **hooks);
1094 DAV_DECLARE_NONSTD(void) dav_core_insert_all_liveprops(
1095  request_rec *r,
1096  const dav_resource *resource,
1098  apr_text_header *phdr);
1099 DAV_DECLARE_NONSTD(void) dav_core_register_uris(apr_pool_t *p);
1100 
1101 
1102 /*
1103 ** Standard WebDAV Property Identifiers
1104 **
1105 ** A live property provider does not need to use these; they are simply
1106 ** provided for convenience.
1107 **
1108 ** Property identifiers need to be unique within a given provider, but not
1109 ** *across* providers (note: this uniqueness constraint was different in
1110 ** older versions of mod_dav).
1111 **
1112 ** The identifiers start at 20000 to make it easier for providers to avoid
1113 ** conflicts with the standard properties. The properties are arranged
1114 ** alphabetically, and may be reordered from time to time (as properties
1115 ** are introduced).
1116 **
1117 ** NOTE: there is no problem with reordering (e.g. binary compat) since the
1118 ** identifiers are only used within a given provider, which would pick up
1119 ** the entire set of changes upon a recompile.
1120 */
1121 enum {
1123 
1124  /* Standard WebDAV properties (RFC 2518) */
1136 
1137  /* DeltaV properties (from the I-D (#14)) */
1176 
1178 };
1179 
1180 /*
1181 ** Property Identifier Registration
1182 **
1183 ** At the moment, mod_dav requires live property providers to ensure that
1184 ** each property returned has a unique value. For now, this is done through
1185 ** central registration (there are no known providers other than the default,
1186 ** so this remains manageable).
1187 **
1188 ** WARNING: the TEST ranges should never be "shipped".
1189 */
1190 #define DAV_PROPID_CORE 10000 /* ..10099. defined by mod_dav */
1191 #define DAV_PROPID_FS 10100 /* ..10299.
1192  mod_dav filesystem provider. */
1193 #define DAV_PROPID_TEST1 10300 /* ..10399 */
1194 #define DAV_PROPID_TEST2 10400 /* ..10499 */
1195 #define DAV_PROPID_TEST3 10500 /* ..10599 */
1196 /* Next: 10600 */
1197 
1198 
1199 /* --------------------------------------------------------------------
1200 **
1201 ** DATABASE FUNCTIONS
1202 */
1203 
1204 typedef struct dav_db dav_db;
1207 
1208 typedef struct {
1209  const char *ns; /* "" signals "no namespace" */
1210  const char *name;
1211 } dav_prop_name;
1212 
1213 /* hook functions to enable pluggable databases */
1215 {
1216  dav_error * (*open)(apr_pool_t *p, const dav_resource *resource, int ro,
1217  dav_db **pdb);
1218  void (*close)(dav_db *db);
1219 
1220  /*
1221  ** In bulk, define any namespaces that the values and their name
1222  ** elements may need.
1223  **
1224  ** Note: sometimes mod_dav will defer calling this until output_value
1225  ** returns found==1. If the output process needs the dav_xmlns_info
1226  ** filled for its work, then it will need to fill it on demand rather
1227  ** than depending upon this hook to fill in the structure.
1228  **
1229  ** Note: this will *always* be called during an output sequence. Thus,
1230  ** the provider may rely solely on using this to fill the xmlns info.
1231  */
1232  dav_error * (*define_namespaces)(dav_db *db, dav_xmlns_info *xi);
1233 
1234  /*
1235  ** Output the value from the database (i.e. add an element name and
1236  ** the value into *phdr). Set *found based on whether the name/value
1237  ** was found in the propdb.
1238  **
1239  ** Note: it is NOT an error for the key/value pair to not exist.
1240  **
1241  ** The dav_xmlns_info passed to define_namespaces() is also passed to
1242  ** each output_value() call so that namespaces can be added on-demand.
1243  ** It can also be used to look up prefixes or URIs during the output
1244  ** process.
1245  */
1246  dav_error * (*output_value)(dav_db *db, const dav_prop_name *name,
1247  dav_xmlns_info *xi,
1248  apr_text_header *phdr, int *found);
1249 
1250  /*
1251  ** Build a mapping from "global" namespaces (stored in apr_xml_*)
1252  ** into provider-local namespace identifiers.
1253  **
1254  ** This mapping should be done once per set of namespaces, and the
1255  ** resulting mapping should be passed into the store() hook function.
1256  **
1257  ** Note: usually, there is just a single document/namespaces for all
1258  ** elements passed. However, the generality of creating multiple
1259  ** mappings and passing them to store() is provided here.
1260  **
1261  ** Note: this is only in preparation for a series of store() calls.
1262  ** As a result, the propdb must be open for read/write access when
1263  ** this function is called.
1264  */
1265  dav_error * (*map_namespaces)(dav_db *db,
1267  dav_namespace_map **mapping);
1268 
1269  /*
1270  ** Store a property value for a given name. The value->combined field
1271  ** MUST be set for this call.
1272  **
1273  ** ### WARNING: current providers will quote the text within ELEM.
1274  ** ### this implies you can call this function only once with a given
1275  ** ### element structure (a second time will quote it again).
1276  */
1277  dav_error * (*store)(dav_db *db, const dav_prop_name *name,
1278  const apr_xml_elem *elem,
1279  dav_namespace_map *mapping);
1280 
1281  /* remove a given property */
1282  dav_error * (*remove)(dav_db *db, const dav_prop_name *name);
1283 
1284  /* returns 1 if the record specified by "key" exists; 0 otherwise */
1286 
1287  /*
1288  ** Iterate over the property names in the database.
1289  **
1290  ** iter->name.ns == iter->name.name == NULL when there are no more names.
1291  **
1292  ** Note: only one iteration may occur over the propdb at a time.
1293  */
1294  dav_error * (*first_name)(dav_db *db, dav_prop_name *pname);
1295  dav_error * (*next_name)(dav_db *db, dav_prop_name *pname);
1296 
1297  /*
1298  ** Rollback support: get rollback context, and apply it.
1299  **
1300  ** struct dav_deadprop_rollback is a provider-private structure; it
1301  ** should remember the name, and the name's old value (or the fact that
1302  ** the value was not present, and should be deleted if a rollback occurs).
1303  */
1304  dav_error * (*get_rollback)(dav_db *db, const dav_prop_name *name,
1305  dav_deadprop_rollback **prollback);
1306  dav_error * (*apply_rollback)(dav_db *db,
1307  dav_deadprop_rollback *rollback);
1308 
1309  /*
1310  ** If a provider needs a context to associate with this hooks structure,
1311  ** then this field may be used. In most cases, it will just be NULL.
1312  */
1313  void *ctx;
1314 };
1315 
1316 
1317 /* --------------------------------------------------------------------
1318 **
1319 ** LOCK FUNCTIONS
1320 */
1321 
1322 /* Used to represent a Timeout header of "Infinity" */
1323 #define DAV_TIMEOUT_INFINITE 0
1324 
1325 DAV_DECLARE(time_t) dav_get_timeout(request_rec *r);
1326 
1327 /*
1328 ** Opaque, provider-specific information for a lock database.
1329 */
1331 
1332 /*
1333 ** Opaque, provider-specific information for a lock record.
1334 */
1336 
1337 /*
1338 ** Lock database type. Lock providers are urged to implement a "lazy" open, so
1339 ** doing an "open" is cheap until something is actually needed from the DB.
1340 */
1341 typedef struct
1342 {
1343  const dav_hooks_locks *hooks; /* the hooks used for this lockdb */
1344  int ro; /* was it opened readonly? */
1345 
1346  dav_lockdb_private *info;
1347 
1348 } dav_lockdb;
1349 
1350 typedef enum {
1354 } dav_lock_scope;
1355 
1356 typedef enum {
1359 } dav_lock_type;
1360 
1361 typedef enum {
1362  DAV_LOCKREC_DIRECT, /* lock asserted on this resource */
1363  DAV_LOCKREC_INDIRECT, /* lock inherited from a parent */
1364  DAV_LOCKREC_INDIRECT_PARTIAL /* most info is not filled in */
1366 
1367 /*
1368 ** dav_lock: hold information about a lock on a resource.
1369 **
1370 ** This structure is used for both direct and indirect locks. A direct lock
1371 ** is a lock applied to a specific resource by the client. An indirect lock
1372 ** is one that is inherited from a parent resource by virtue of a non-zero
1373 ** Depth: header when the lock was applied.
1374 **
1375 ** mod_dav records both types of locks in the lock database, managing their
1376 ** addition/removal as resources are moved about the namespace.
1377 **
1378 ** Note that the lockdb is free to marshal this structure in any form that
1379 ** it likes.
1380 **
1381 ** For a "partial" lock, the <rectype> and <locktoken> fields must be filled
1382 ** in. All other (user) fields should be zeroed. The lock provider will
1383 ** usually fill in the <info> field, and the <next> field may be used to
1384 ** construct a list of partial locks.
1385 **
1386 ** The lock provider MUST use the info field to store a value such that a
1387 ** dav_lock structure can locate itself in the underlying lock database.
1388 ** This requirement is needed for refreshing: when an indirect dav_lock is
1389 ** refreshed, its reference to the direct lock does not specify the direct's
1390 ** resource, so the only way to locate the (refreshed, direct) lock in the
1391 ** database is to use the info field.
1392 **
1393 ** Note that <is_locknull> only refers to the resource where this lock was
1394 ** found.
1395 ** ### hrm. that says the abstraction is wrong. is_locknull may disappear.
1396 */
1397 typedef struct dav_lock
1398 {
1399  dav_lock_rectype rectype; /* type of lock record */
1400  int is_locknull; /* lock establishes a locknull resource */
1401 
1402  /* ### put the resource in here? */
1403 
1404  dav_lock_scope scope; /* scope of the lock */
1405  dav_lock_type type; /* type of lock */
1406  int depth; /* depth of the lock */
1407  time_t timeout; /* when the lock will timeout */
1408 
1409  const dav_locktoken *locktoken; /* the token that was issued */
1410 
1411  const char *owner; /* (XML) owner of the lock */
1412  const char *auth_user; /* auth'd username owning lock */
1413 
1414  dav_lock_private *info; /* private to the lockdb */
1415 
1416  struct dav_lock *next; /* for managing a list of locks */
1417 } dav_lock;
1418 
1419 /* Property-related public lock functions */
1420 DAV_DECLARE(const char *)dav_lock_get_activelock(request_rec *r,
1422  dav_buffer *pbuf);
1423 
1424 /* LockDB-related public lock functions */
1425 DAV_DECLARE(dav_error *) dav_open_lockdb(request_rec *r,
1426  int ro,
1427  dav_lockdb **lockdb);
1428 DAV_DECLARE(void) dav_close_lockdb(dav_lockdb *lockdb);
1429 DAV_DECLARE(dav_error *) dav_lock_parse_lockinfo(request_rec *r,
1431  dav_lockdb *lockdb,
1432  const apr_xml_doc *doc,
1434 DAV_DECLARE(int) dav_unlock(request_rec *r,
1436  const dav_locktoken *locktoken);
1437 DAV_DECLARE(dav_error *) dav_add_lock(request_rec *r,
1438  const dav_resource *resource,
1439  dav_lockdb *lockdb, dav_lock *request,
1440  dav_response **response);
1441 DAV_DECLARE(dav_error *) dav_notify_created(request_rec *r,
1442  dav_lockdb *lockdb,
1443  const dav_resource *resource,
1444  int resource_state,
1445  int depth);
1446 
1447 DAV_DECLARE(dav_error*) dav_lock_query(dav_lockdb *lockdb,
1448  const dav_resource *resource,
1449  dav_lock **locks);
1450 
1451 DAV_DECLARE(dav_error *) dav_validate_request(request_rec *r,
1452  dav_resource *resource,
1453  int depth,
1454  dav_locktoken *locktoken,
1455  dav_response **response,
1456  int flags,
1457  dav_lockdb *lockdb);
1458 /*
1459 ** flags:
1460 ** 0x0F -- reserved for <dav_lock_scope> values
1461 **
1462 ** other flags, detailed below
1463 */
1464 #define DAV_VALIDATE_RESOURCE 0x0010 /* validate just the resource */
1465 #define DAV_VALIDATE_PARENT 0x0020 /* validate resource AND its parent */
1466 #define DAV_VALIDATE_ADD_LD 0x0040 /* add DAV:lockdiscovery into
1467  the 424 DAV:response */
1468 #define DAV_VALIDATE_USE_424 0x0080 /* return 424 status, not 207 */
1469 #define DAV_VALIDATE_IS_PARENT 0x0100 /* for internal use */
1470 #define DAV_VALIDATE_NO_MODIFY 0x0200 /* resource is not being modified
1471  so allow even if lock token
1472  is not provided */
1473 
1474 /* Lock-null related public lock functions */
1475 DAV_DECLARE(int) dav_get_resource_state(request_rec *r,
1476  const dav_resource *resource);
1477 
1478 /* Lock provider hooks. Locking is optional, so there may be no
1479  * lock provider for a given repository.
1480  */
1482 {
1483  /* Return the supportedlock property for a resource */
1484  const char * (*get_supportedlock)(
1485  const dav_resource *resource
1486  );
1487 
1488  /* Parse a lock token URI, returning a lock token object allocated
1489  * in the given pool.
1490  */
1491  dav_error * (*parse_locktoken)(
1492  apr_pool_t *p,
1493  const char *char_token,
1494  dav_locktoken **locktoken_p
1495  );
1496 
1497  /* Format a lock token object into a URI string, allocated in
1498  * the given pool.
1499  *
1500  * Always returns non-NULL.
1501  */
1502  const char * (*format_locktoken)(
1503  apr_pool_t *p,
1504  const dav_locktoken *locktoken
1505  );
1506 
1507  /* Compare two lock tokens.
1508  *
1509  * Result < 0 => lt1 < lt2
1510  * Result == 0 => lt1 == lt2
1511  * Result > 0 => lt1 > lt2
1512  */
1513  int (*compare_locktoken)(
1514  const dav_locktoken *lt1,
1515  const dav_locktoken *lt2
1516  );
1517 
1518  /* Open the provider's lock database.
1519  *
1520  * The provider may or may not use a "real" database for locks
1521  * (a lock could be an attribute on a resource, for example).
1522  *
1523  * The provider may choose to use the value of the DAVLockDB directive
1524  * (as returned by dav_get_lockdb_path()) to decide where to place
1525  * any storage it may need.
1526  *
1527  * The request storage pool should be associated with the lockdb,
1528  * so it can be used in subsequent operations.
1529  *
1530  * If ro != 0, only readonly operations will be performed.
1531  * If force == 0, the open can be "lazy"; no subsequent locking operations
1532  * may occur.
1533  * If force != 0, locking operations will definitely occur.
1534  */
1535  dav_error * (*open_lockdb)(
1536  request_rec *r,
1537  int ro,
1538  int force,
1539  dav_lockdb **lockdb
1540  );
1541 
1542  /* Indicates completion of locking operations */
1543  void (*close_lockdb)(
1545  );
1546 
1547  /* Take a resource out of the lock-null state. */
1548  dav_error * (*remove_locknull_state)(
1549  dav_lockdb *lockdb,
1550  const dav_resource *resource
1551  );
1552 
1553  /*
1554  ** Create a (direct) lock structure for the given resource. A locktoken
1555  ** will be created.
1556  **
1557  ** The lock provider may store private information into lock->info.
1558  */
1559  dav_error * (*create_lock)(dav_lockdb *lockdb,
1560  const dav_resource *resource,
1561  dav_lock **lock);
1562 
1563  /*
1564  ** Get the locks associated with the specified resource.
1565  **
1566  ** If resolve_locks is true (non-zero), then any indirect locks are
1567  ** resolved to their actual, direct lock (i.e. the reference to followed
1568  ** to the original lock).
1569  **
1570  ** The locks, if any, are returned as a linked list in no particular
1571  ** order. If no locks are present, then *locks will be NULL.
1572  */
1573  dav_error * (*get_locks)(dav_lockdb *lockdb,
1574  const dav_resource *resource,
1575  int calltype,
1576  dav_lock **locks);
1577 
1578 #define DAV_GETLOCKS_RESOLVED 0 /* resolve indirects to directs */
1579 #define DAV_GETLOCKS_PARTIAL 1 /* leave indirects partially filled */
1580 #define DAV_GETLOCKS_COMPLETE 2 /* fill out indirect locks */
1581 
1582  /*
1583  ** Find a particular lock on a resource (specified by its locktoken).
1584  **
1585  ** *lock will be set to NULL if the lock is not found.
1586  **
1587  ** Note that the provider can optimize the unmarshalling -- only one
1588  ** lock (or none) must be constructed and returned.
1589  **
1590  ** If partial_ok is true (non-zero), then an indirect lock can be
1591  ** partially filled in. Otherwise, another lookup is done and the
1592  ** lock structure will be filled out as a DAV_LOCKREC_INDIRECT.
1593  */
1594  dav_error * (*find_lock)(dav_lockdb *lockdb,
1595  const dav_resource *resource,
1596  const dav_locktoken *locktoken,
1597  int partial_ok,
1598  dav_lock **lock);
1599 
1600  /*
1601  ** Quick test to see if the resource has *any* locks on it.
1602  **
1603  ** This is typically used to determine if a non-existent resource
1604  ** has a lock and is (therefore) a locknull resource.
1605  **
1606  ** WARNING: this function may return TRUE even when timed-out locks
1607  ** exist (i.e. it may not perform timeout checks).
1608  */
1609  dav_error * (*has_locks)(dav_lockdb *lockdb,
1610  const dav_resource *resource,
1611  int *locks_present);
1612 
1613  /*
1614  ** Append the specified lock(s) to the set of locks on this resource.
1615  **
1616  ** If "make_indirect" is true (non-zero), then the specified lock(s)
1617  ** should be converted to an indirect lock (if it is a direct lock)
1618  ** before appending. Note that the conversion to an indirect lock does
1619  ** not alter the passed-in lock -- the change is internal the
1620  ** append_locks function.
1621  **
1622  ** Multiple locks are specified using the lock->next links.
1623  */
1624  dav_error * (*append_locks)(dav_lockdb *lockdb,
1625  const dav_resource *resource,
1626  int make_indirect,
1627  const dav_lock *lock);
1628 
1629  /*
1630  ** Remove any lock that has the specified locktoken.
1631  **
1632  ** If locktoken == NULL, then ALL locks are removed.
1633  */
1634  dav_error * (*remove_lock)(dav_lockdb *lockdb,
1635  const dav_resource *resource,
1636  const dav_locktoken *locktoken);
1637 
1638  /*
1639  ** Refresh all locks, found on the specified resource, which has a
1640  ** locktoken in the provided list.
1641  **
1642  ** If the lock is indirect, then the direct lock is referenced and
1643  ** refreshed.
1644  **
1645  ** Each lock that is updated is returned in the <locks> argument.
1646  ** Note that the locks will be fully resolved.
1647  */
1648  dav_error * (*refresh_locks)(dav_lockdb *lockdb,
1649  const dav_resource *resource,
1650  const dav_locktoken_list *ltl,
1651  time_t new_time,
1652  dav_lock **locks);
1653 
1654  /*
1655  ** Look up the resource associated with a particular locktoken.
1656  **
1657  ** The search begins at the specified <start_resource> and the lock
1658  ** specified by <locktoken>.
1659  **
1660  ** If the resource/token specifies an indirect lock, then the direct
1661  ** lock will be looked up, and THAT resource will be returned. In other
1662  ** words, this function always returns the resource where a particular
1663  ** lock (token) was asserted.
1664  **
1665  ** NOTE: this function pointer is allowed to be NULL, indicating that
1666  ** the provider does not support this type of functionality. The
1667  ** caller should then traverse up the repository hierarchy looking
1668  ** for the resource defining a lock with this locktoken.
1669  */
1670  dav_error * (*lookup_resource)(dav_lockdb *lockdb,
1671  const dav_locktoken *locktoken,
1672  const dav_resource *start_resource,
1673  const dav_resource **resource);
1674 
1675  /*
1676  ** If a provider needs a context to associate with this hooks structure,
1677  ** then this field may be used. In most cases, it will just be NULL.
1678  */
1679  void *ctx;
1680 };
1681 
1682 /* what types of resources can be discovered by dav_get_resource_state() */
1683 #define DAV_RESOURCE_LOCK_NULL 10 /* resource lock-null */
1684 #define DAV_RESOURCE_NULL 11 /* resource null */
1685 #define DAV_RESOURCE_EXISTS 12 /* resource exists */
1686 #define DAV_RESOURCE_ERROR 13 /* an error occurred */
1687 
1688 
1689 /* --------------------------------------------------------------------
1690 **
1691 ** PROPERTY HANDLING
1692 */
1693 
1694 typedef struct dav_propdb dav_propdb;
1695 
1696 
1697 DAV_DECLARE(dav_error *) dav_open_propdb(
1698  request_rec *r,
1699  dav_lockdb *lockdb,
1700  const dav_resource *resource,
1701  int ro,
1703  dav_propdb **propdb);
1704 
1705 DAV_DECLARE(dav_error *) dav_popen_propdb(
1706  apr_pool_t *p,
1707  request_rec *r,
1708  dav_lockdb *lockdb,
1709  const dav_resource *resource,
1710  int ro,
1711  apr_array_header_t *ns_xlate,
1712  dav_propdb **propdb);
1713 
1714 
1715 DAV_DECLARE(void) dav_close_propdb(dav_propdb *db);
1716 
1717 DAV_DECLARE(dav_get_props_result) dav_get_props(
1718  dav_propdb *db,
1719  apr_xml_doc *doc);
1720 
1721 DAV_DECLARE(dav_get_props_result) dav_get_allprops(
1722  dav_propdb *db,
1724 
1725 DAV_DECLARE(void) dav_get_liveprop_supported(
1726  dav_propdb *propdb,
1727  const char *ns_uri,
1728  const char *propname,
1730 
1731 /*
1732 ** 3-phase property modification.
1733 **
1734 ** 1) validate props. readable? unlocked? ACLs allow access?
1735 ** 2) execute operation (set/delete)
1736 ** 3) commit or rollback
1737 **
1738 ** ### eventually, auth must be available. a ref to the request_rec (which
1739 ** ### contains the auth info) should be in the shared context struct.
1740 **
1741 ** Each function may alter the error values and information contained within
1742 ** the context record. This should be done as an "increasing" level of
1743 ** error, rather than overwriting any previous error.
1744 **
1745 ** Note that commit() cannot generate errors. It should simply free the
1746 ** rollback information.
1747 **
1748 ** rollback() may generate additional errors because the rollback operation
1749 ** can sometimes fail(!).
1750 **
1751 ** The caller should allocate an array of these, one per operation. It should
1752 ** be zero-initialized, then the db, operation, and prop fields should be
1753 ** filled in before calling dav_prop_validate. Note that the set/delete
1754 ** operations are order-dependent. For a given (logical) context, the same
1755 ** pointer must be passed to each phase.
1756 **
1757 ** error_type is an internal value, but will have the same numeric value
1758 ** for each possible "desc" value. This allows the caller to group the
1759 ** descriptions via the error_type variable, rather than through string
1760 ** comparisons. Note that "status" does not provide enough granularity to
1761 ** differentiate/group the "desc" values.
1762 **
1763 ** Note that the propdb will maintain some (global) context across all
1764 ** of the property change contexts. This implies that you can have only
1765 ** one open transaction per propdb.
1766 */
1767 typedef struct dav_prop_ctx
1768 {
1770 
1771  apr_xml_elem *prop; /* property to affect */
1772 
1774 #define DAV_PROP_OP_SET 1 /* set a property value */
1775 #define DAV_PROP_OP_DELETE 2 /* delete a prop value */
1776 /* ### add a GET? */
1777 
1778  /* private items to the propdb */
1781  struct dav_rollback_item *rollback; /* optional rollback info */
1782 
1783  dav_error *err; /* error (if any) */
1784 
1785  /* private to mod_dav.c */
1787 
1788 } dav_prop_ctx;
1789 
1790 DAV_DECLARE_NONSTD(void) dav_prop_validate(dav_prop_ctx *ctx);
1791 DAV_DECLARE_NONSTD(void) dav_prop_exec(dav_prop_ctx *ctx);
1792 DAV_DECLARE_NONSTD(void) dav_prop_commit(dav_prop_ctx *ctx);
1793 DAV_DECLARE_NONSTD(void) dav_prop_rollback(dav_prop_ctx *ctx);
1794 
1795 #define DAV_PROP_CTX_HAS_ERR(dpc) ((dpc).err && (dpc).err->status >= 300)
1796 
1797 
1798 /* --------------------------------------------------------------------
1799 **
1800 ** WALKER STRUCTURE
1801 */
1802 
1803 enum {
1804  DAV_CALLTYPE_MEMBER = 1, /* called for a member resource */
1805  DAV_CALLTYPE_COLLECTION, /* called for a collection */
1806  DAV_CALLTYPE_LOCKNULL /* called for a locknull resource */
1807 };
1808 
1809 typedef struct
1810 {
1811  /* the client-provided context */
1812  void *walk_ctx;
1813 
1814  /* pool to use for allocations in the callback */
1816 
1817  /* the current resource */
1819 
1820  /* OUTPUT: add responses to this */
1821  dav_response *response;
1822 
1824 
1825 typedef struct
1826 {
1828 #define DAV_WALKTYPE_AUTH 0x0001 /* limit to authorized files */
1829 #define DAV_WALKTYPE_NORMAL 0x0002 /* walk normal files */
1830 #define DAV_WALKTYPE_LOCKNULL 0x0004 /* walk locknull resources */
1831 
1832  /* callback function and a client context for the walk */
1833  dav_error * (*func)(dav_walk_resource *wres, int calltype);
1834  void *walk_ctx;
1835 
1836  /* what pool to use for allocations needed by walk logic */
1838 
1839  /* beginning root of the walk */
1841 
1842  /* lock database to enable walking LOCKNULL resources */
1844 
1845 } dav_walk_params;
1846 
1847 /* directory tree walking context */
1848 typedef struct dav_walker_ctx
1849 {
1850  /* input: */
1852 
1853 
1854  /* ### client data... phasing out this big glom */
1855 
1856  /* this brigade buffers data being sent to r->output_filters */
1858 
1859  /* a scratch pool, used to stream responses and iteratively cleared. */
1861 
1862  request_rec *r; /* original request */
1863 
1864  /* for PROPFIND operations */
1867 #define DAV_PROPFIND_IS_ALLPROP 1
1868 #define DAV_PROPFIND_IS_PROPNAME 2
1869 #define DAV_PROPFIND_IS_PROP 3
1870 
1871  apr_text *propstat_404; /* (cached) propstat giving a 404 error */
1872 
1873  const dav_if_header *if_header; /* for validation */
1874  const dav_locktoken *locktoken; /* for UNLOCK */
1875  const dav_lock *lock; /* for LOCK */
1876  int skip_root; /* for dav_inherit_locks() */
1877 
1878  int flags;
1879 
1880  dav_buffer work_buf; /* for dav_validate_request() */
1881 
1882 } dav_walker_ctx;
1883 
1884 DAV_DECLARE(void) dav_add_response(dav_walk_resource *wres,
1885  int status,
1887 
1888 
1889 /* --------------------------------------------------------------------
1890 **
1891 ** "STREAM" STRUCTURE
1892 **
1893 ** mod_dav uses this abstraction for interacting with the repository
1894 ** while fetching/storing resources. mod_dav views resources as a stream
1895 ** of bytes.
1896 **
1897 ** Note that the structure is opaque -- it is private to the repository
1898 ** that created the stream in the repository's "open" function.
1899 **
1900 ** ### THIS STUFF IS GOING AWAY ... GET/read requests are handled by
1901 ** ### having the provider jam stuff straight into the filter stack.
1902 ** ### this is only left for handling PUT/write requests.
1903 */
1904 
1905 typedef struct dav_stream dav_stream;
1906 
1907 typedef enum {
1908  DAV_MODE_WRITE_TRUNC, /* truncate and open for writing */
1909  DAV_MODE_WRITE_SEEKABLE /* open for writing; random access */
1910 } dav_stream_mode;
1911 
1912 
1913 /* --------------------------------------------------------------------
1914 **
1915 ** REPOSITORY FUNCTIONS
1916 */
1917 
1918 /* Repository provider hooks */
1920 {
1921  /* Flag for whether repository requires special GET handling.
1922  * If resources in the repository are not visible in the
1923  * filesystem location which URLs map to, then special handling
1924  * is required to first fetch a resource from the repository,
1925  * respond to the GET request, then free the resource copy.
1926  */
1928 
1929  /* Get a resource descriptor for the URI in a request. A descriptor
1930  * should always be returned even if the resource does not exist. This
1931  * repository has been identified as handling the resource given by
1932  * the URI, so an answer must be given. If there is a problem with the
1933  * URI or accessing the resource or whatever, then an error should be
1934  * returned.
1935  *
1936  * root_dir:
1937  * the root of the directory for which this repository is configured.
1938  *
1939  * label:
1940  * if a Label: header is present (and allowed), this is the label
1941  * to use to identify a version resource from the resource's
1942  * corresponding version history. Otherwise, it will be NULL.
1943  *
1944  * use_checked_in:
1945  * use the DAV:checked-in property of the resource identified by the
1946  * Request-URI to identify and return a version resource
1947  *
1948  * The provider may associate the request storage pool with the resource
1949  * (in the resource->pool field), to use in other operations on that
1950  * resource.
1951  */
1952  dav_error * (*get_resource)(
1953  request_rec *r,
1954  const char *root_dir,
1955  const char *label,
1956  int use_checked_in,
1958  );
1959 
1960  /* Get a resource descriptor for the parent of the given resource.
1961  * The resources need not exist. NULL is returned if the resource
1962  * is the root collection.
1963  *
1964  * An error should be returned only if there is a fatal error in
1965  * fetching information about the parent resource.
1966  */
1967  dav_error * (*get_parent_resource)(
1968  const dav_resource *resource,
1969  dav_resource **parent_resource
1970  );
1971 
1972  /* Determine whether two resource descriptors refer to the same resource.
1973  *
1974  * Result != 0 => the resources are the same.
1975  */
1977  const dav_resource *res1,
1978  const dav_resource *res2
1979  );
1980 
1981  /* Determine whether one resource is a parent (immediate or otherwise)
1982  * of another.
1983  *
1984  * Result != 0 => res1 is a parent of res2.
1985  */
1987  const dav_resource *res1,
1988  const dav_resource *res2
1989  );
1990 
1991  /*
1992  ** Open a stream for this resource, using the specified mode. The
1993  ** stream will be returned in *stream.
1994  */
1995  dav_error * (*open_stream)(const dav_resource *resource,
1996  dav_stream_mode mode,
1997  dav_stream **stream);
1998 
1999  /*
2000  ** Close the specified stream.
2001  **
2002  ** mod_dav will (ideally) make sure to call this. For safety purposes,
2003  ** a provider should (ideally) register a cleanup function with the
2004  ** request pool to get this closed and cleaned up.
2005  **
2006  ** Note the possibility of an error from the close -- it is entirely
2007  ** feasible that the close does a "commit" of some kind, which can
2008  ** produce an error.
2009  **
2010  ** commit should be TRUE (non-zero) or FALSE (0) if the stream was
2011  ** opened for writing. This flag states whether to retain the file
2012  ** or not.
2013  ** Note: the commit flag is ignored for streams opened for reading.
2014  */
2015  dav_error * (*close_stream)(dav_stream *stream, int commit);
2016 
2017  /*
2018  ** Write data to the stream.
2019  **
2020  ** All of the bytes must be written, or an error should be returned.
2021  */
2022  dav_error * (*write_stream)(dav_stream *stream,
2023  const void *buf, apr_size_t bufsize);
2024 
2025  /*
2026  ** Seek to an absolute position in the stream. This is used to support
2027  ** Content-Range in a GET/PUT.
2028  **
2029  ** NOTE: if this function is NULL (which is allowed), then any
2030  ** operations using Content-Range will be refused.
2031  */
2032  dav_error * (*seek_stream)(dav_stream *stream, apr_off_t abs_position);
2033 
2034  /*
2035  ** If a GET is processed using a stream (open_stream, read_stream)
2036  ** rather than via a sub-request (on get_pathname), then this function
2037  ** is used to provide the repository with a way to set the headers
2038  ** in the response.
2039  **
2040  ** This function may be called without a following deliver(), to
2041  ** handle a HEAD request.
2042  **
2043  ** This may be NULL if handle_get is FALSE.
2044  */
2045  dav_error * (*set_headers)(request_rec *r,
2046  const dav_resource *resource);
2047 
2048  /*
2049  ** The provider should deliver the resource into the request's output
2050  ** filter stack. Basically, this is the response to the GET method.
2051  **
2052  ** Note that this is called for all resources, including collections.
2053  ** The provider should determine what has content to deliver or not.
2054  **
2055  ** set_headers will be called prior to this function, allowing the
2056  ** provider to set the appropriate response headers.
2057  **
2058  ** This may be NULL if handle_get is FALSE.
2059  ** ### maybe toss handle_get and just use this function as the marker
2060  **
2061  ** API ISSUE: don't use the passed-in 'output' filter.
2062  **
2063  ** Instead, generate the response into the output filter stack for the
2064  ** request (r->output_filters). An implementation can use the request_rec
2065  ** that was passed to get_resource() for this purpose. Using 'output'
2066  ** filter for the response can cause unbounded memory usage.
2067  **
2068  ** See https://mail-archives.apache.org/mod_mbox/httpd-dev/201608.mbox/%3C20160822151917.GA22369%40redhat.com%3E
2069  */
2070  dav_error * (*deliver)(const dav_resource *resource,
2071  ap_filter_t *output);
2072 
2073  /* Create a collection resource. The resource must not already exist.
2074  *
2075  * Result == NULL if the collection was created successfully. Also, the
2076  * resource object is updated to reflect that the resource exists, and
2077  * is a collection.
2078  */
2079  dav_error * (*create_collection)(
2081  );
2082 
2083  /* Copy one resource to another. The destination may exist, if it is
2084  * versioned.
2085  * Handles both files and collections. Properties are copied as well.
2086  * If the destination exists and is versioned, the provider must update
2087  * the destination to have identical content to the source,
2088  * recursively for collections.
2089  * The depth argument is ignored for a file, and can be either 0 or
2090  * DAV_INFINITY for a collection.
2091  * If an error occurs in a child resource, then the return value is
2092  * non-NULL, and *response is set to a multistatus response.
2093  * If the copy is successful, the dst resource object is
2094  * updated to reflect that the resource exists.
2095  */
2096  dav_error * (*copy_resource)(
2097  const dav_resource *src,
2098  dav_resource *dst,
2099  int depth,
2100  dav_response **response
2101  );
2102 
2103  /* Move one resource to another. The destination must not exist.
2104  * Handles both files and collections. Properties are moved as well.
2105  * If an error occurs in a child resource, then the return value is
2106  * non-NULL, and *response is set to a multistatus response.
2107  * If the move is successful, the src and dst resource objects are
2108  * updated to reflect that the source no longer exists, and the
2109  * destination does.
2110  */
2111  dav_error * (*move_resource)(
2112  dav_resource *src,
2113  dav_resource *dst,
2114  dav_response **response
2115  );
2116 
2117  /* Remove a resource. Handles both files and collections.
2118  * Removes any associated properties as well.
2119  * If an error occurs in a child resource, then the return value is
2120  * non-NULL, and *response is set to a multistatus response.
2121  * If the delete is successful, the resource object is updated to
2122  * reflect that the resource no longer exists.
2123  */
2124  dav_error * (*remove_resource)(
2126  dav_response **response
2127  );
2128 
2129  /* Walk a resource hierarchy.
2130  *
2131  * Iterates over the resource hierarchy specified by params->root.
2132  * Control of the walk and the callback are specified by 'params'.
2133  *
2134  * An error may be returned. *response will contain multistatus
2135  * responses (if any) suitable for the body of the error. It is also
2136  * possible to return NULL, yet still have multistatus responses.
2137  * In this case, typically the caller should return a 207 (Multistatus)
2138  * and the responses (in the body) as the HTTP response.
2139  */
2140  dav_error * (*walk)(const dav_walk_params *params, int depth,
2141  dav_response **response);
2142 
2143  /* Get the entity tag for a resource */
2144  const char * (*getetag)(const dav_resource *resource);
2145 
2146  /*
2147  ** If a provider needs a context to associate with this hooks structure,
2148  ** then this field may be used. In most cases, it will just be NULL.
2149  */
2150  void *ctx;
2151 
2152  /* Get the request rec for a resource */
2153  request_rec * (*get_request_rec)(const dav_resource *resource);
2154 
2155  /* Get the pathname for a resource */
2156  const char * (*get_pathname)(const dav_resource *resource);
2157 };
2158 
2159 
2160 /* --------------------------------------------------------------------
2161 **
2162 ** VERSIONING FUNCTIONS
2163 */
2164 
2165 
2166 /* dav_add_vary_header
2167  *
2168  * If there were any headers in the request which require a Vary header
2169  * in the response, add it.
2170  */
2171 DAV_DECLARE(void) dav_add_vary_header(request_rec *in_req,
2173  const dav_resource *resource);
2174 
2175 /*
2176 ** Flags specifying auto-versioning behavior, returned by
2177 ** the auto_versionable hook. The value returned depends
2178 ** on both the state of the resource and the value of the
2179 ** DAV:auto-versioning property for the resource.
2180 **
2181 ** If the resource does not exist (null or lock-null),
2182 ** DAV_AUTO_VERSION_ALWAYS causes creation of a new version-controlled resource
2183 **
2184 ** If the resource is checked in,
2185 ** DAV_AUTO_VERSION_ALWAYS causes it to be checked out always,
2186 ** DAV_AUTO_VERSION_LOCKED causes it to be checked out only when locked
2187 **
2188 ** If the resource is checked out,
2189 ** DAV_AUTO_VERSION_ALWAYS causes it to be checked in always,
2190 ** DAV_AUTO_VERSION_LOCKED causes it to be checked in when unlocked
2191 ** (note: a provider should allow auto-checkin only for resources which
2192 ** were automatically checked out)
2193 **
2194 ** In all cases, DAV_AUTO_VERSION_NEVER results in no auto-versioning behavior.
2195 */
2196 typedef enum {
2201 
2202 /*
2203 ** This structure is used to record what auto-versioning operations
2204 ** were done to make a resource writable, so that they can be undone
2205 ** at the end of a request.
2206 */
2207 typedef struct {
2208  int resource_versioned; /* 1 => resource was auto-version-controlled */
2209  int resource_checkedout; /* 1 => resource was auto-checked-out */
2210  int parent_checkedout; /* 1 => parent was auto-checked-out */
2211  dav_resource *parent_resource; /* parent resource, if it was needed */
2213 
2214 /* Ensure that a resource is writable. If there is no versioning
2215  * provider, then this is essentially a no-op. Versioning repositories
2216  * require explicit resource creation and checkout before they can
2217  * be written to. If a new resource is to be created, or an existing
2218  * resource deleted, the parent collection must be checked out as well.
2219  *
2220  * Set the parent_only flag to only make the parent collection writable.
2221  * Otherwise, both parent and child are made writable as needed. If the
2222  * child does not exist, then a new versioned resource is created and
2223  * checked out.
2224  *
2225  * If auto-versioning is not enabled for a versioned resource, then an error is
2226  * returned, since the resource cannot be modified.
2227  *
2228  * The dav_auto_version_info structure is filled in with enough information
2229  * to restore both parent and child resources to the state they were in
2230  * before the auto-versioning operations occurred.
2231  */
2232 DAV_DECLARE(dav_error *) dav_auto_checkout(
2233  request_rec *r,
2234  dav_resource *resource,
2235  int parent_only,
2237 
2238 /* Revert the writability of resources back to what they were
2239  * before they were modified. If undo == 0, then the resource
2240  * modifications are maintained (i.e. they are checked in).
2241  * If undo != 0, then resource modifications are discarded
2242  * (i.e. they are unchecked out).
2243  *
2244  * Set the unlock flag to indicate that the resource is about
2245  * to be unlocked; it will be checked in if the resource
2246  * auto-versioning property indicates it should be. In this case,
2247  * av_info is ignored, so it can be NULL.
2248  *
2249  * The resource argument may be NULL if only the parent resource
2250  * was checked out (i.e. the parent_only was != 0 in the
2251  * dav_auto_checkout call).
2252  */
2253 DAV_DECLARE(dav_error *) dav_auto_checkin(
2254  request_rec *r,
2255  dav_resource *resource,
2256  int undo,
2257  int unlock,
2258  dav_auto_version_info *av_info);
2259 
2260 /*
2261 ** This structure is used to describe available reports
2262 **
2263 ** "nmspace" should be valid XML and URL-quoted. mod_dav will place
2264 ** double-quotes around it and use it in an xmlns declaration.
2265 */
2266 typedef struct {
2267  const char *nmspace; /* namespace of the XML report element */
2268  const char *name; /* element name for the XML report */
2269 } dav_report_elem;
2270 
2271 
2272 /* Versioning provider hooks */
2274 {
2275  /*
2276  ** MANDATORY HOOKS
2277  ** The following hooks are mandatory for all versioning providers;
2278  ** they define the functionality needed to implement "core" versioning.
2279  */
2280 
2281  /* Return supported versioning options.
2282  * Each dav_text item in the list will be returned as a separate
2283  * DAV header. Providers are advised to limit the length of an
2284  * individual text item to 63 characters, to conform to the limit
2285  * used by MS Web Folders.
2286  */
2288 
2289  /* Get the value of a specific option for an OPTIONS request.
2290  * The option being requested is given by the parsed XML
2291  * element object "elem". The value of the option should be
2292  * appended to the "option" text object.
2293  */
2294  dav_error * (*get_option)(const dav_resource *resource,
2295  const apr_xml_elem *elem,
2296  apr_text_header *option);
2297 
2298  /* Determine whether a non-versioned (or non-existent) resource
2299  * is versionable. Returns != 0 if resource can be versioned.
2300  */
2302 
2303  /* Determine whether auto-versioning is enabled for a resource
2304  * (which may not exist, or may not be versioned). If the resource
2305  * is a checked-out resource, the provider must only enable
2306  * auto-checkin if the resource was automatically checked out.
2307  *
2308  * The value returned depends on both the state of the resource
2309  * and the value of its DAV:auto-version property. See the description
2310  * of the dav_auto_version enumeration above for the details.
2311  */
2313 
2314  /* Put a resource under version control. If the resource already
2315  * exists unversioned, then it becomes the initial version of the
2316  * new version history, and it is replaced by a version selector
2317  * which targets the new version.
2318  *
2319  * If the resource does not exist, then a new version-controlled
2320  * resource is created which either targets an existing version (if the
2321  * "target" argument is not NULL), or the initial, empty version
2322  * in a new history resource (if the "target" argument is NULL).
2323  *
2324  * If successful, the resource object state is updated appropriately
2325  * (that is, changed to refer to the new version-controlled resource).
2326  */
2327  dav_error * (*vsn_control)(dav_resource *resource,
2328  const char *target);
2329 
2330  /* Checkout a resource. If successful, the resource
2331  * object state is updated appropriately.
2332  *
2333  * The auto_checkout flag will be set if this checkout is being
2334  * done automatically, as part of some method which modifies
2335  * the resource. The provider must remember that the resource
2336  * was automatically checked out, so it can determine whether it
2337  * can be automatically checked in. (Auto-checkin should only be
2338  * enabled for resources which were automatically checked out.)
2339  *
2340  * If the working resource has a different URL from the
2341  * target resource, a dav_resource descriptor is returned
2342  * for the new working resource. Otherwise, the original
2343  * resource descriptor will refer to the working resource.
2344  * The working_resource argument can be NULL if the caller
2345  * is not interested in the working resource.
2346  *
2347  * If the client has specified DAV:unreserved or DAV:fork-ok in the
2348  * checkout request, then the corresponding flags are set. If
2349  * DAV:activity-set has been specified, then create_activity is set
2350  * if DAV:new was specified; otherwise, the DAV:href elements' CDATA
2351  * (the actual href text) is passed in the "activities" array (each
2352  * element of the array is a const char *). activities will be NULL
2353  * no DAV:activity-set was provided or when create_activity is set.
2354  */
2356  int auto_checkout,
2357  int is_unreserved, int is_fork_ok,
2358  int create_activity,
2359  apr_array_header_t *activities,
2360  dav_resource **working_resource);
2361 
2362  /* Uncheckout a checked-out resource. If successful, the resource
2363  * object state is updated appropriately.
2364  */
2365  dav_error * (*uncheckout)(dav_resource *resource);
2366 
2367  /* Checkin a checked-out resource. If successful, the resource
2368  * object state is updated appropriately, and the
2369  * version_resource descriptor will refer to the new version.
2370  * The version_resource argument can be NULL if the caller
2371  * is not interested in the new version resource.
2372  *
2373  * If the client has specified DAV:keep-checked-out in the checkin
2374  * request, then the keep_checked_out flag is set. The provider
2375  * should create a new version, but keep the resource in the
2376  * checked-out state.
2377  */
2379  int keep_checked_out,
2380  dav_resource **version_resource);
2381 
2382  /*
2383  ** Return the set of reports available at this resource.
2384  **
2385  ** An array of report elements should be returned, with an end-marker
2386  ** element containing namespace==NULL. The value of the
2387  ** DAV:supported-report-set property will be constructed and
2388  ** returned.
2389  */
2390  dav_error * (*avail_reports)(const dav_resource *resource,
2391  const dav_report_elem **reports);
2392 
2393  /*
2394  ** Determine whether a Label header can be used
2395  ** with a particular report. The dav_xml_doc structure
2396  ** contains the parsed report request body.
2397  ** Returns 0 if the Label header is not allowed.
2398  */
2400 
2401  /*
2402  ** Generate a report on a resource. Since a provider is free
2403  ** to define its own reports, and the value of request headers
2404  ** may affect the interpretation of a report, the request record
2405  ** must be passed to this routine.
2406  **
2407  ** The dav_xml_doc structure contains the parsed report request
2408  ** body. The report response should be generated into the specified
2409  ** output filter.
2410  **
2411  ** If an error occurs, and a response has not yet been generated,
2412  ** then an error can be returned from this function. mod_dav will
2413  ** construct an appropriate error response. Once some output has
2414  ** been placed into the filter, however, the provider should not
2415  ** return an error -- there is no way that mod_dav can deliver it
2416  ** properly.
2417  **
2418  ** ### maybe we need a way to signal an error anyways, and then
2419  ** ### apache can abort the connection?
2420  **
2421  ** API ISSUE: don't use the passed-in 'output' filter.
2422  **
2423  ** Instead, generate the response into the output filter stack for the
2424  ** request (r->output_filters). An implementation can use the request_rec
2425  ** that was passed to get_resource() for this purpose. Using 'output'
2426  ** filter for the response can cause unbounded memory usage.
2427  **
2428  ** See https://mail-archives.apache.org/mod_mbox/httpd-dev/201608.mbox/%3C20160822151917.GA22369%40redhat.com%3E
2429  */
2430  dav_error * (*deliver_report)(request_rec *r,
2431  const dav_resource *resource,
2432  const apr_xml_doc *doc,
2433  ap_filter_t *output);
2434 
2435  /*
2436  ** OPTIONAL HOOKS
2437  ** The following hooks are optional; if not defined, then the
2438  ** corresponding protocol methods will be unsupported.
2439  */
2440 
2441  /*
2442  ** Set the state of a checked-in version-controlled resource.
2443  **
2444  ** If the request specified a version, the version resource
2445  ** represents that version. If the request specified a label,
2446  ** then "version" is NULL, and "label" is the label.
2447  **
2448  ** The depth argument is ignored for a file, and can be 0, 1, or
2449  ** DAV_INFINITY for a collection. The depth argument only applies
2450  ** with a label, not a version.
2451  **
2452  ** If an error occurs in a child resource, then the return value is
2453  ** non-NULL, and *response is set to a multistatus response.
2454  **
2455  ** This hook is optional; if not defined, then the UPDATE method
2456  ** will not be supported.
2457  */
2458  dav_error * (*update)(const dav_resource *resource,
2459  const dav_resource *version,
2460  const char *label,
2461  int depth,
2462  dav_response **response);
2463 
2464  /*
2465  ** Add a label to a version. The resource is either a specific
2466  ** version, or a version selector, in which case the label should
2467  ** be added to the current target of the version selector. The
2468  ** version selector cannot be checked out.
2469  **
2470  ** If replace != 0, any existing label by the same name is
2471  ** effectively deleted first. Otherwise, it is an error to
2472  ** attempt to add a label which already exists on some version
2473  ** of the same history resource.
2474  **
2475  ** This hook is optional; if not defined, then the LABEL method
2476  ** will not be supported. If it is defined, then the remove_label
2477  ** hook must be defined also.
2478  */
2479  dav_error * (*add_label)(const dav_resource *resource,
2480  const char *label,
2481  int replace);
2482 
2483  /*
2484  ** Remove a label from a version. The resource is either a specific
2485  ** version, or a version selector, in which case the label should
2486  ** be added to the current target of the version selector. The
2487  ** version selector cannot be checked out.
2488  **
2489  ** It is an error if no such label exists on the specified version.
2490  **
2491  ** This hook is optional, but if defined, the add_label hook
2492  ** must be defined also.
2493  */
2494  dav_error * (*remove_label)(const dav_resource *resource,
2495  const char *label);
2496 
2497  /*
2498  ** Determine whether a null resource can be created as a workspace.
2499  ** The provider may restrict workspaces to certain locations.
2500  ** Returns 0 if the resource cannot be a workspace.
2501  **
2502  ** This hook is optional; if the provider does not support workspaces,
2503  ** it should be set to NULL.
2504  */
2506 
2507  /*
2508  ** Create a workspace resource. The resource must not already
2509  ** exist. Any <DAV:mkworkspace> element is passed to the provider
2510  ** in the "doc" structure; it may be empty.
2511  **
2512  ** If workspace creation is successful, the state of the resource
2513  ** object is updated appropriately.
2514  **
2515  ** This hook is optional; if the provider does not support workspaces,
2516  ** it should be set to NULL.
2517  */
2518  dav_error * (*make_workspace)(dav_resource *resource,
2519  apr_xml_doc *doc);
2520 
2521  /*
2522  ** Determine whether a null resource can be created as an activity.
2523  ** The provider may restrict activities to certain locations.
2524  ** Returns 0 if the resource cannot be an activity.
2525  **
2526  ** This hook is optional; if the provider does not support activities,
2527  ** it should be set to NULL.
2528  */
2530 
2531  /*
2532  ** Create an activity resource. The resource must not already
2533  ** exist.
2534  **
2535  ** If activity creation is successful, the state of the resource
2536  ** object is updated appropriately.
2537  **
2538  ** This hook is optional; if the provider does not support activities,
2539  ** it should be set to NULL.
2540  */
2541  dav_error * (*make_activity)(dav_resource *resource);
2542 
2543  /*
2544  ** Merge a resource (tree) into target resource (tree).
2545  **
2546  ** ### more doc...
2547  **
2548  ** This hook is optional; if the provider does not support merging,
2549  ** then this should be set to NULL.
2550  **
2551  ** API ISSUE: don't use the passed-in 'output' filter.
2552  **
2553  ** Instead, generate the response into the output filter stack for the
2554  ** request (r->output_filters). An implementation can use the request_rec
2555  ** that was passed to get_resource() for this purpose. Using 'output'
2556  ** filter for the response can cause unbounded memory usage.
2557  **
2558  ** See https://mail-archives.apache.org/mod_mbox/httpd-dev/201608.mbox/%3C20160822151917.GA22369%40redhat.com%3E
2559  */
2560  dav_error * (*merge)(dav_resource *target, dav_resource *source,
2561  int no_auto_merge, int no_checkout,
2562  apr_xml_elem *prop_elem,
2563  ap_filter_t *output);
2564 
2565  /*
2566  ** If a provider needs a context to associate with this hooks structure,
2567  ** then this field may be used. In most cases, it will just be NULL.
2568  */
2569  void *ctx;
2570 };
2571 
2572 
2573 /* --------------------------------------------------------------------
2574 **
2575 ** BINDING FUNCTIONS
2576 */
2577 
2578 /* binding provider hooks */
2580 
2581  /* Determine whether a resource can be the target of a binding.
2582  * Returns 0 if the resource cannot be a binding target.
2583  */
2585 
2586  /* Create a binding to a resource.
2587  * The resource argument is the target of the binding;
2588  * the binding argument must be a resource which does not already
2589  * exist.
2590  */
2591  dav_error * (*bind_resource)(const dav_resource *resource,
2592  dav_resource *binding);
2593 
2594  /*
2595  ** If a provider needs a context to associate with this hooks structure,
2596  ** then this field may be used. In most cases, it will just be NULL.
2597  */
2598  void *ctx;
2599 
2600 };
2601 
2602 
2603 /* --------------------------------------------------------------------
2604 **
2605 ** SEARCH(DASL) FUNCTIONS
2606 */
2607 
2608 /* search provider hooks */
2610  /* Set header for a OPTION method
2611  * An error may be returned.
2612  * To set a hadder, this function might call
2613  * apr_table_setn(r->headers_out, "DASL", dasl_optin1);
2614  *
2615  * Examples:
2616  * DASL: <DAV:basicsearch>
2617  * DASL: <http://foo.bar.com/syntax1>
2618  * DASL: <http://akuma.com/syntax2>
2619  */
2620  dav_error * (*set_option_head)(request_rec *r);
2621 
2622  /* Search resources
2623  * An error may be returned. *response will contain multistatus
2624  * responses (if any) suitable for the body of the error. It is also
2625  * possible to return NULL, yet still have multistatus responses.
2626  * In this case, typically the caller should return a 207 (Multistatus)
2627  * and the responses (in the body) as the HTTP response.
2628  */
2629  dav_error * (*search_resource)(request_rec *r,
2630  dav_response **response);
2631 
2632  /*
2633  ** If a provider needs a context to associate with this hooks structure,
2634  ** then this field may be used. In most cases, it will just be NULL.
2635  */
2636  void *ctx;
2637 
2638 };
2639 
2640 
2641 /* --------------------------------------------------------------------
2642 **
2643 ** MISCELLANEOUS STUFF
2644 */
2645 
2646 typedef struct {
2647  int propid; /* live property ID */
2648  const dav_hooks_liveprop *provider; /* the provider defining this prop */
2650 
2651 
2652 /* --------------------------------------------------------------------
2653 **
2654 ** DAV ACL HOOKS
2655 */
2656 
2658 {
2659  dav_error * (*acl_check_method)(request_rec *r,
2660  const dav_resource *resource);
2661 
2662  dav_error * (*acl_check_read)(request_rec *r,
2663  const dav_resource *resource);
2664 
2665  dav_error * (*acl_check_prop)(request_rec *r,
2666  const dav_resource *resource,
2667  const dav_prop_name *name,
2669 
2671  const dav_resource *resource,
2672  int new_resource_created);
2673  void *ctx;
2674 };
2675 
2676 DAV_DECLARE(void) dav_acl_provider_register(apr_pool_t *p,
2678 
2679 DAV_DECLARE(const dav_acl_provider *) dav_get_acl_providers(void);
2680 
2681 
2682 /* --------------------------------------------------------------------
2683 **
2684 ** DAV OPTIONS
2685 */
2686 #define DAV_OPTIONS_EXTENSION_GROUP "dav_options"
2687 
2688 typedef struct dav_options_provider
2689 {
2690  dav_error* (*dav_header)(request_rec *r,
2691  const dav_resource *resource,
2693 
2694  dav_error* (*dav_method)(request_rec *r,
2695  const dav_resource *resource,
2697 
2698  void *ctx;
2700 
2701 extern DAV_DECLARE(const dav_options_provider *) dav_get_options_providers(const char *name);
2702 
2703 extern DAV_DECLARE(void) dav_options_provider_register(apr_pool_t *p,
2704  const char *name,
2706 
2707 /* --------------------------------------------------------------------
2708 **
2709 ** DAV RESOURCE TYPE HOOKS
2710 */
2711 
2713 {
2714  int (*get_resource_type)(const dav_resource *resource,
2715  const char **name,
2716  const char **uri);
2718 
2719 #define DAV_RESOURCE_TYPE_GROUP "dav_resource_type"
2720 
2721 DAV_DECLARE(void) dav_resource_type_provider_register(apr_pool_t *p,
2722  const char *name,
2724 
2725 DAV_DECLARE(const dav_resource_type_provider *) dav_get_resource_type_providers(const char *name);
2726 
2727 #ifdef __cplusplus
2728 }
2729 #endif
2730 
2731 #endif /* _MOD_DAV_H_ */
2732 
const dav_hooks_propdb * propdb
Definition: mod_dav.h:681
int label_allowed
Definition: mod_dav.h:436
size_t apr_size_t
Definition: apr.h:397
struct dav_if_state_list * state
Definition: mod_dav.h:871
dav_response * response
Definition: mod_dav.h:1821
dav_buffer work_buf
Definition: mod_dav.h:1880
void(* close)(dav_db *db)
Definition: mod_dav.h:1218
Definition: mod_dav.h:1164
apr_text * propstats
Definition: mod_dav.h:493
#define DAV_DECLARE_NONSTD(type)
Definition: mod_dav.h:86
Definition: mod_dav.h:1155
Definition: mod_dav.h:511
struct dav_if_header * next
Definition: mod_dav.h:872
void * ctx
Definition: mod_dav.h:1011
Definition: apr_xml.h:148
dav_buffer * pbuf
Definition: mod_dav.h:460
struct dav_lockdb_private dav_lockdb_private
Definition: mod_dav.h:1330
const dav_hooks_repository * repos
Definition: mod_dav.h:680
Definition: mod_dav.h:1141
Definition: apr_xml.h:200
Definition: mod_dav.h:679
const char *const * namespace_uris
Definition: mod_dav.h:950
Definition: mod_dav.h:1143
struct dav_prop_ctx dav_prop_ctx
Definition: apr_tables.h:62
void * liveprop_ctx
Definition: mod_dav.h:1780
const dav_resource dav_lockdb const apr_xml_doc dav_lock ** lock_request
Definition: mod_dav.h:1430
int versioned
Definition: mod_dav.h:398
Definition: mod_dav.h:849
void * ctx
Definition: mod_dav.h:2569
APR-UTIL DBM library.
Definition: mod_dav.h:1174
const char const char apr_text_header * body
Definition: mod_dav.h:1727
void(* get_vsn_options)(apr_pool_t *p, apr_text_header *phdr)
Definition: mod_dav.h:2287
Definition: mod_dav.h:1909
const dav_acl_provider * acls
Definition: mod_dav.h:423
const dav_resource * resrouce
Definition: mod_dav.h:1430
Definition: mod_dav.h:305
Definition: mod_dav.h:2609
dav_resource int undo
Definition: mod_dav.h:2255
Definition: mod_dav.h:1147
apr_pool_t * scratchpool
Definition: mod_dav.h:1860
Definition: mod_dav.h:1804
apr_array_header_t * prop_ctx
Definition: mod_dav.h:578
Definition: mod_dav.h:1151
The representation of a filter chain.
Definition: util_filter.h:278
Definition: mod_dav.h:1481
const dav_resource * root
Definition: mod_dav.h:1840
const char * uri
Definition: mod_dav.h:869
Definition: mod_dav.h:299
Definition: mod_dav.h:618
int operation
Definition: mod_dav.h:1773
dav_lock_type
Definition: mod_dav.h:1356
int(* can_be_workspace)(const dav_resource *resource)
Definition: mod_dav.h:2505
apr_bucket_brigade request_rec apr_pool_t * pool
Definition: mod_dav.h:555
Definition: mod_dav.h:1163
Definition: mod_dav.h:1397
int propid
Definition: mod_dav.h:2647
void * ctx
Definition: mod_dav.h:2636
void * ctx
Definition: mod_dav.h:687
Definition: mod_dav.h:1140
int int use_checked_in
Definition: mod_dav.h:436
const dav_resource dav_lockdb dav_lock * request
Definition: mod_dav.h:1438
int propfind_type
Definition: mod_dav.h:1866
dav_auto_version
Definition: mod_dav.h:2196
Definition: mod_dav.h:1767
Definition: mod_dav.h:1150
const apr_xml_doc * doc
Definition: mod_dav.h:1081
void * ctx
Definition: mod_dav.h:2150
Definition: mod_dav.h:1160
Definition: apr_xml.h:162
Definition: mod_dav.h:2657
Apache XML library.
struct dav_error * prev
Definition: mod_dav.h:131
const char * desc
Definition: mod_dav.h:124
Definition: mod_dav.h:535
Definition: mod_dav.h:1173
Definition: mod_dav.h:1130
apr_text * xmlns
Definition: mod_dav.h:494
dav_resource_type
Definition: mod_dav.h:296
int parent_checkedout
Definition: mod_dav.h:2210
APR Hash Tables.
struct dav_rollback_item * rollback
Definition: mod_dav.h:1781
int dummy_header
Definition: mod_dav.h:874
Definition: mod_dav.h:1132
Definition: mod_dav.h:1169
Definition: mod_dav.h:309
Definition: mod_dav.h:1135
struct dav_resource_type_provider dav_resource_type_provider
Definition: mod_dav.h:2712
Definition: mod_dav.h:531
apr_pool_t * pool
Definition: mod_dav.h:421
Definition: mod_dav.h:389
Definition: mod_dav.h:1152
Definition: mod_dav.h:303
Definition: mod_dav.h:1809
Definition: mod_dav.h:2579
int(* exists)(dav_db *db, const dav_prop_name *name)
Definition: mod_dav.h:1285
apr_hash_t * prefix_uri
Definition: mod_dav.h:621
dav_locktoken_list ** ltl
Definition: mod_dav.h:884
Definition: mod_dav.h:1139
Definition: mod_dav.h:1214
const char * name
Definition: mod_dav.h:1026
const dav_hooks_search * search
Definition: mod_dav.h:685
const dav_resource const dav_locktoken * locktoken
Definition: mod_dav.h:1435
void * ctx
Definition: mod_dav.h:425
Definition: apr_xml.h:53
int count
Definition: mod_dav.h:622
apr_pool_t int strip_white
Definition: mod_dav.h:604
apr_pool_t * pool
Definition: mod_dav.h:1837
const char const char * uri
Definition: mod_dav.h:631
int baselined
Definition: mod_dav.h:402
dav_lock * locks
Definition: mod_dav.h:1421
Definition: mod_dav.h:1128
void * ctx
Definition: mod_dav.h:2698
Definition: apr_buckets.h:258
int skip_root
Definition: mod_dav.h:1876
const char * nmspace
Definition: mod_dav.h:2267
dav_if_state_type
Definition: mod_dav.h:846
const char * name
Definition: mod_dav.h:1210
const char * prefix
Definition: mod_dav.h:631
Definition: mod_dav.h:1167
Definition: mod_dav.h:528
Definition: mod_dav.h:2199
apr_xml_doc * doc
Definition: mod_dav.h:1865
int is_liveprop
Definition: mod_dav.h:1779
struct dav_if_state_list * next
Definition: mod_dav.h:864
Definition: mod_dav.h:1908
Definition: mod_dav.h:850
dav_lockdb const dav_resource int apr_array_header_t dav_propdb ** propdb
Definition: mod_dav.h:1699
dav_lockdb const dav_resource int int depth
Definition: mod_dav.h:1442
Definition: mod_dav.h:1146
Definition: mod_dav.h:1919
request_rec * r
Definition: mod_dav.h:1862
int dav_get_props_result * propstats
Definition: mod_dav.h:1885
Definition: mod_dav.h:1157
dav_buffer apr_size_t size
Definition: mod_dav.h:460
request_rec int apr_array_header_t * namespaces
Definition: mod_dav.h:565
Definition: mod_dav.h:1153
Definition: mod_dav.h:1125
Definition: mod_dav.h:895
int int apr_status_t const char * desc
Definition: mod_dav.h:141
void * ctx
Definition: mod_dav.h:2673
void * ctx
Definition: mod_dav.h:1679
const char * name
Definition: mod_dav.h:2268
Definition: mod_dav.h:1165
Definition: mod_dav.h:1341
Definition: mod_dav.h:1357
Definition: mod_dav.h:2207
apr_bucket_brigade * bb
Definition: mod_dav.h:555
dav_lock_rectype
Definition: mod_dav.h:1361
const dav_lock * lock
Definition: mod_dav.h:1875
struct dav_walker_ctx dav_walker_ctx
Definition: mod_dav.h:1024
HTTP Daemon routines.
apr_size_t alloc_len
Definition: mod_dav.h:452
int dav_lockdb ** lockdb
Definition: mod_dav.h:1426
Apache hook functions.
request_rec * r
Definition: mod_dav.h:1786
Definition: mod_dav.h:1148
dav_lockdb const dav_resource int apr_array_header_t * ns_xlate
Definition: mod_dav.h:1699
apr_text * propstat_404
Definition: mod_dav.h:1871
int int apr_status_t aprerr
Definition: mod_dav.h:141
int(* is_same_resource)(const dav_resource *res1, const dav_resource *res2)
Definition: mod_dav.h:1976
Definition: mod_dav.h:1362
int int error_id
Definition: mod_dav.h:141
const char * etag
Definition: mod_dav.h:861
Definition: mod_dav.h:2198
int
Definition: mod_proxy.h:652
dav_lock_rectype rectype
Definition: mod_dav.h:1399
Definition: mod_dav.h:2646
struct dav_options_provider dav_options_provider
Definition: mod_dav.h:491
Definition: mod_dav.h:1177
Definition: mod_dav.h:1806
Definition: mod_dav.h:1126
Definition: mod_dav.h:1848
const dav_acl_provider * acl
Definition: mod_dav.h:2677
#define APR_DECLARE_EXTERNAL_HOOK(ns, link, ret, name, args)
Definition: apr_hooks.h:118
Definition: mod_dav.h:1080
struct dav_db dav_db
Definition: mod_dav.h:1204
int(* versionable)(const dav_resource *resource)
Definition: mod_dav.h:2301
const char * childtags
Definition: mod_dav.h:133
dav_buffer const void apr_size_t amt
Definition: mod_dav.h:480
apr_xml_elem * prop
Definition: mod_dav.h:1771
namespace const char * tagname
Definition: mod_dav.h:153
dav_error * src
Definition: mod_dav.h:186
dav_error * err
Definition: mod_dav.h:203
const char const dav_liveprop_group * group
Definition: mod_dav.h:1048
int ro
Definition: mod_dav.h:1426
int error_id
Definition: mod_dav.h:123
int(* is_bindable)(const dav_resource *resource)
Definition: mod_dav.h:2584
APR Table library.
apr_bucket_brigade * bb
Definition: mod_dav.h:1857
struct dav_stream dav_stream
Definition: mod_dav.h:1905
time_t timeout
Definition: mod_dav.h:1407
void * walk_ctx
Definition: mod_dav.h:1812
Definition: mod_dav.h:1166
const char const char * propname
Definition: mod_dav.h:1727
const dav_resource * resource
Definition: mod_dav.h:1818
dav_if_state_type type
Definition: mod_dav.h:855
dav_lockdb const dav_resource int resource_state
Definition: mod_dav.h:1442
Definition: mod_dav.h:1208
int flags
Definition: mod_dav.h:1878
apr_size_t uri_len
Definition: mod_dav.h:870
Definition: mod_dav.h:1158
const dav_locktoken * locktoken
Definition: mod_dav.h:1874
Definition: mod_dav.h:2197
int dav_response * first
Definition: mod_dav.h:573
Definition: mod_dav.h:1127
dav_lockdb_private * info
Definition: mod_dav.h:1346
Definition: mod_dav.h:1161
Definition: mod_dav.h:853
const dav_hooks_liveprop * provider
Definition: mod_dav.h:2648
dav_locktoken * locktoken
Definition: mod_dav.h:862
dav_propdb * propdb
Definition: mod_dav.h:1769
int status
Definition: mod_dav.h:122
Definition: mod_dav.h:1358
struct dav_if_header dav_if_header
char * buf
Definition: mod_dav.h:454
Definition: mod_dav.h:1154
dav_resource_type type
Definition: mod_dav.h:390
#define DAV_DECLARE(type)
Definition: mod_dav.h:85
int is_locknull
Definition: mod_dav.h:1400
dav_auto_version(* auto_versionable)(const dav_resource *resource)
Definition: mod_dav.h:2312
struct dav_liveprop_rollback dav_liveprop_rollback
Definition: mod_dav.h:893
const char * desc
Definition: mod_dav.h:501
struct apr_hash_t apr_hash_t
Definition: apr_hash.h:52
dav_error dav_response * response
Definition: mod_dav.h:203
const apr_xml_elem * elem
Definition: mod_dav.h:1082
const dav_liveprop_group const dav_liveprop_spec ** info
Definition: mod_dav.h:1054
Definition: mod_dav.h:311
Definition: mod_dav.h:1138
Definition: mod_dav.h:1352
dav_buffer apr_size_t extra_needed
Definition: mod_dav.h:468
Definition: mod_dav.h:867
Definition: mod_dav.h:1162
request_rec int must_be_absolute
Definition: mod_dav.h:518
apr_pool_t * p
struct dav_if_state_list dav_if_state_list
int resource_versioned
Definition: mod_dav.h:2208
const dav_locktoken * locktoken
Definition: mod_dav.h:1409
Definition: mod_dav.h:1159
dav_hooks_propdb dav_hooks_db
Definition: mod_dav.h:276
int ro
Definition: mod_dav.h:1344
Definition: mod_dav.h:1805
const char * uri
Definition: mod_dav.h:410
int working
Definition: mod_dav.h:406
dav_stream_mode
Definition: mod_dav.h:1907
dav_lock_scope
Definition: mod_dav.h:1350
struct dav_lock_private dav_lock_private
Definition: mod_dav.h:1335
int is_writable
Definition: mod_dav.h:1030
const char const dav_provider * hooks
Definition: mod_dav.h:805
const char const dav_options_provider * provider
Definition: mod_dav.h:2704
Definition: mod_dav.h:297
struct dav_lock * next
Definition: mod_dav.h:1416
dav_resource int dav_auto_version_info * av_info
Definition: mod_dav.h:2234
dav_lock_type type
Definition: mod_dav.h:1405
struct dav_propdb dav_propdb
Definition: mod_dav.h:1694
dav_resource_private * info
Definition: mod_dav.h:414
struct dav_namespace_map dav_namespace_map
Definition: mod_dav.h:1205
Definition: mod_dav.h:1129
void(* acl_post_processing)(request_rec *r, const dav_resource *resource, int new_resource_created)
Definition: mod_dav.h:2670
int ns
Definition: mod_dav.h:1025
apr_hash_t * uri_prefix
Definition: mod_dav.h:620
Definition: mod_dav.h:1175
struct dav_error dav_error
struct dav_resource_private dav_resource_private
Definition: mod_dav.h:320
Definition: mod_dav.h:1168
struct dav_deadprop_rollback dav_deadprop_rollback
Definition: mod_dav.h:1206
Definition: mod_dav.h:1364
const dav_liveprop_spec * specs
Definition: mod_dav.h:1041
A structure that represents the current request.
Definition: httpd.h:860
Definition: mod_dav.h:1156
Definition: mod_dav.h:1825
const dav_resource dav_lockdb const apr_xml_doc * doc
Definition: mod_dav.h:1430
Definition: mod_dav.h:121
Apache filter library.
int status
Definition: mod_dav.h:506
const char * ns
Definition: mod_dav.h:1209
dav_buffer const void apr_size_t apr_size_t pad
Definition: mod_dav.h:480
int condition
Definition: mod_dav.h:857
apr_status_t aprerr
Definition: mod_dav.h:126
apr_pool_t * pool
Definition: mod_dav.h:619
const dav_hooks_binding * binding
Definition: mod_dav.h:684
const dav_if_header * if_header
Definition: mod_dav.h:1873
Definition: mod_dav.h:1122
int(* can_be_activity)(const dav_resource *resource)
Definition: mod_dav.h:2529
void * ctx
Definition: mod_dav.h:1313
struct dav_resource dav_resource
apr_size_t cur_len
Definition: mod_dav.h:453
struct dav_locktoken dav_locktoken
Definition: mod_dav.h:434
const char *const * namespace_uris
Definition: mod_dav.h:1042
int depth
Definition: mod_dav.h:1406
dav_buffer const char * str
Definition: mod_dav.h:464
dav_error err
Definition: mod_dav.h:514
const dav_resource * resource
Definition: mod_dav.h:1096
int status
Definition: mod_dav.h:141
const dav_resource dav_prop_insert what
Definition: mod_dav.h:1096
int int const char dav_error * prev
Definition: mod_dav.h:170
Definition: mod_dav.h:1172
dav_buffer const void * mem
Definition: mod_dav.h:480
dav_resource * parent_resource
Definition: mod_dav.h:2211
const char * name
Definition: mod_dav.h:805
dav_lock_scope scope
Definition: mod_dav.h:1404
Definition: apr_xml.h:64
const dav_hooks_repository * hooks
Definition: mod_dav.h:416
dav_walk_params w
Definition: mod_dav.h:1851
const char * tagname
Definition: mod_dav.h:128
int handle_get
Definition: mod_dav.h:1927
int walk_type
Definition: mod_dav.h:1827
struct apr_pool_t apr_pool_t
Definition: apr_pools.h:60
Definition: mod_dav.h:1131
struct dav_locktoken_list * next
Definition: mod_dav.h:880
typedef void(APR_THREAD_FUNC *PFN_HSE_IO_COMPLETION)(EXTENSION_CONTROL_BLOCK *ecb
const dav_hooks_vsn * vsn
Definition: mod_dav.h:683
int int dav_resource ** res_p
Definition: mod_dav.h:436
int apr_status_t
Definition: apr_errno.h:44
int collection
Definition: mod_dav.h:394
request_rec * out_req
Definition: mod_dav.h:2172
request_rec * r
Definition: mod_dav.h:518
dav_get_props_result propresult
Definition: mod_dav.h:504
Definition: mod_dav.h:1040
dav_lockdb * lockdb
Definition: mod_dav.h:1843
request_rec * rnew
Definition: mod_dav.h:513
Definition: mod_dav.h:523
Definition: mod_dav.h:1133
void * walk_ctx
Definition: mod_dav.h:1834
void * ctx
Definition: mod_dav.h:2598
const dav_hooks_liveprop * hooks
Definition: mod_dav.h:1043
dav_resource int parent_only
Definition: mod_dav.h:2234
Definition: mod_dav.h:313
struct dav_response * next
Definition: mod_dav.h:508
Definition: mod_dav.h:533
apr_text_header * phdr
Definition: mod_dav.h:649
int def_depth
Definition: mod_dav.h:582
Definition: mod_dav.h:1351
dav_prop_insert
Definition: mod_dav.h:522
Definition: mod_dav.h:1149
int ns
Definition: mod_dav.h:587
Definition: mod_dav.h:1134
int const char * attrname
Definition: mod_dav.h:597
struct dav_locktoken_list dav_locktoken_list
int propid
Definition: mod_dav.h:1028
const dav_hooks_locks * locks
Definition: mod_dav.h:682
int exists
Definition: mod_dav.h:392
apr_pool_t * pool
Definition: mod_dav.h:1815
Definition: mod_dav.h:1363
Definition: mod_dav.h:1353
int(* report_label_header_allowed)(const apr_xml_doc *doc)
Definition: mod_dav.h:2399
const dav_hooks_locks * hooks
Definition: mod_dav.h:1343
Definition: mod_dav.h:2688
dav_error * err
Definition: mod_dav.h:1783
Definition: mod_dav.h:848
const char * auth_user
Definition: mod_dav.h:1412
const char * href
Definition: mod_dav.h:500
dav_resource int dav_locktoken dav_response int flags
Definition: mod_dav.h:1452
Definition: mod_dav.h:498
int resource_checkedout
Definition: mod_dav.h:2209
int(* is_parent_resource)(const dav_resource *res1, const dav_resource *res2)
Definition: mod_dav.h:1986
dav_lock_private * info
Definition: mod_dav.h:1414
struct dav_lock dav_lock
Definition: mod_dav.h:307
Definition: mod_dav.h:877
dav_resource int int unlock
Definition: mod_dav.h:2255
off_t apr_off_t
Definition: apr.h:399
Definition: mod_dav.h:1142
dav_locktoken * locktoken
Definition: mod_dav.h:879
const char * ns_uri
Definition: mod_dav.h:1091
Definition: mod_dav.h:2273
Definition: mod_dav.h:450
const char * owner
Definition: mod_dav.h:1411
Definition: mod_dav.h:2266