|
1 /* |
|
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
|
3 * |
|
4 * Copyright 2019 Olaf Wintermann. All rights reserved. |
|
5 * |
|
6 * Redistribution and use in source and binary forms, with or without |
|
7 * modification, are permitted provided that the following conditions are met: |
|
8 * |
|
9 * 1. Redistributions of source code must retain the above copyright |
|
10 * notice, this list of conditions and the following disclaimer. |
|
11 * |
|
12 * 2. Redistributions in binary form must reproduce the above copyright |
|
13 * notice, this list of conditions and the following disclaimer in the |
|
14 * documentation and/or other materials provided with the distribution. |
|
15 * |
|
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
|
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
|
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
|
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
|
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
|
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
26 * POSSIBILITY OF SUCH DAMAGE. |
|
27 */ |
|
28 #ifndef MULTISTATUS_H |
|
29 #define MULTISTATUS_H |
|
30 |
|
31 #include "../public/webdav.h" |
|
32 |
|
33 #include <ucx/map.h> |
|
34 #include <ucx/buffer.h> |
|
35 #include <libxml/tree.h> |
|
36 #include "../util/writer.h" |
|
37 |
|
38 #ifdef __cplusplus |
|
39 extern "C" { |
|
40 #endif |
|
41 |
|
42 typedef struct Multistatus Multistatus; |
|
43 typedef struct MSResponse MSResponse; |
|
44 |
|
45 typedef struct PropertyOkList PropertyOkList; |
|
46 typedef struct PropertyErrorList PropertyErrorList; |
|
47 |
|
48 /* |
|
49 * implements the WebdavResponse interface |
|
50 */ |
|
51 struct Multistatus { |
|
52 WebdavResponse response; |
|
53 Session *sn; |
|
54 Request *rq; |
|
55 MSResponse *first; |
|
56 MSResponse *current; |
|
57 |
|
58 /* |
|
59 * Map of document namespace definitions |
|
60 * |
|
61 * key: (char*) namespace prefix |
|
62 * value: WSNamespace* |
|
63 */ |
|
64 UcxMap *namespaces; |
|
65 |
|
66 /* |
|
67 * Is this a proppatch request? |
|
68 * |
|
69 * In a proppatch response, when the first property with an error occurs, |
|
70 * all already added properties will be set to 424 Failed Dependency. |
|
71 */ |
|
72 WSBool proppatch; |
|
73 }; |
|
74 |
|
75 /* |
|
76 * implements the WebdavResource interface |
|
77 */ |
|
78 struct MSResponse { |
|
79 WebdavResource resource; |
|
80 Multistatus *multistatus; |
|
81 |
|
82 /* |
|
83 * Contains all properties that were added to the response |
|
84 * key: <href> null-byte <name> |
|
85 * value: WebdavProperty* |
|
86 */ |
|
87 UcxMap *properties; |
|
88 |
|
89 /* |
|
90 * All properties with status != 200 |
|
91 */ |
|
92 PropertyErrorList *errors; |
|
93 |
|
94 /* |
|
95 * All properties with status == 200 |
|
96 */ |
|
97 PropertyOkList *plist_begin; |
|
98 PropertyOkList *plist_end; |
|
99 |
|
100 MSResponse *next; |
|
101 WSBool closing; |
|
102 }; |
|
103 |
|
104 struct PropertyOkList { |
|
105 WebdavProperty *property; |
|
106 WebdavNSList *nsdef; |
|
107 PropertyOkList *next; |
|
108 }; |
|
109 |
|
110 struct PropertyErrorList { |
|
111 /* |
|
112 * next list for different status code |
|
113 */ |
|
114 PropertyErrorList *next; |
|
115 |
|
116 /* |
|
117 * property list for all properties with this status code |
|
118 */ |
|
119 WebdavPList *begin; |
|
120 |
|
121 /* |
|
122 * tail of the property list |
|
123 */ |
|
124 WebdavPList *end; |
|
125 |
|
126 /* |
|
127 * property response status code |
|
128 */ |
|
129 int status; |
|
130 }; |
|
131 |
|
132 Multistatus* multistatus_response(Session *sn, Request *rq); |
|
133 |
|
134 int multistatus_send(Multistatus *ms, SYS_NETFD out); |
|
135 |
|
136 WebdavResource * multistatus_addresource( |
|
137 WebdavResponse *response, |
|
138 const char *path); |
|
139 |
|
140 int msresponse_addproperty( |
|
141 WebdavResource *res, |
|
142 WebdavProperty *property, |
|
143 int status); |
|
144 |
|
145 int msresponse_addproperror( |
|
146 MSResponse *response, |
|
147 WebdavProperty *property, |
|
148 int statuscode); |
|
149 |
|
150 int msresponse_close(WebdavResource *res); |
|
151 |
|
152 #ifdef __cplusplus |
|
153 } |
|
154 #endif |
|
155 |
|
156 #endif /* MULTISTATUS_H */ |
|
157 |