src/server/daemon/location.h

Sun, 23 Nov 2025 12:44:59 +0100

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Sun, 23 Nov 2025 12:44:59 +0100
changeset 635
b85d45fd3b01
child 636
40f069ddda37
permissions
-rw-r--r--

add location config parser

635
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
1 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
3 *
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
4 * Copyright 2025 Olaf Wintermann. All rights reserved.
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
5 *
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
8 *
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
11 *
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
15 *
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
27 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
28
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
29 #ifndef LOCATION_H
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
30 #define LOCATION_H
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
31
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
32 #include <cx/string.h>
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
33 #include <cx/hash_map.h>
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
34 #include <regex.h>
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
35 #include "../public/nsapi.h"
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
36 #include "../config/serverconfig.h"
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
37 #include "../util/strreplace.h"
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
38 #include "../webdav/webdav.h"
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
39
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
40
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
41 #ifdef __cplusplus
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
42 extern "C" {
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
43 #endif
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
44
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
45 typedef struct WSLocation WSLocation;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
46 typedef struct WSLocationConfig WSLocationConfig;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
47
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
48 typedef enum WSLocationMatch {
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
49 WS_LOCATION_MATCH_EXACT = 0,
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
50 WS_LOCATION_MATCH_PREFIX,
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
51 WS_LOCATION_MATCH_CS_REGEX,
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
52 WS_LOCATION_MATCH_CI_REGEX
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
53 } WSLocationMatch;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
54
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
55 struct WSLocationConfig {
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
56 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
57 * Activate dirindex setting
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
58 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
59 WSBool set_dirindex;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
60
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
61 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
62 * Enable/Disable directory index
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
63 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
64 WSBool dirindex;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
65
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
66 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
67 * Activate forcetls setting
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
68 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
69 WSBool set_forcetls;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
70
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
71 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
72 * force TLS
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
73 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
74 WSBool forcetls;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
75
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
76 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
77 * obj.conf object name
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
78 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
79 cxmutstr name;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
80
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
81 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
82 * VFS type
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
83 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
84 cxmutstr vfs;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
85
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
86 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
87 * Document root path
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
88 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
89 cxmutstr docroot;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
90
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
91 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
92 * Redirect URL
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
93 * Can contain references to regex capture groups (redirect match regex,
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
94 * if available, or the location regex)
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
95 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
96 StringTemplate *redirect;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
97
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
98 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
99 * Redirect match regex
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
100 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
101 regex_t redirect_match;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
102
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
103 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
104 * Status code for redirect response
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
105 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
106 int redirect_status;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
107
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
108 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
109 * WebDAV settings
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
110 * If dav is set, "webdav" is added to the obj.conf object list,
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
111 * unless name is also set
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
112 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
113 WebdavRepository *dav;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
114
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
115 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
116 * List of ACL names, that should be added to the request ACL list
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
117 * value: char*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
118 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
119 CxList *acls;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
120 };
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
121
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
122 struct WSLocation {
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
123 WSLocationMatch match;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
124 cxmutstr match_string;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
125 regex_t regex;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
126
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
127 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
128 * standard location settings
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
129 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
130 WSLocationConfig config;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
131
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
132 /*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
133 * extended settings
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
134 * key: directive name
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
135 * value: char*
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
136 */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
137 CxMap *ext_config;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
138
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
139 WSLocation *children_begin;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
140 WSLocation *children_end;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
141 WSLocation *prev;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
142 WSLocation *next;
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
143 };
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
144
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
145 WSLocation* cfg_location_get(const CxAllocator *a, ConfigNode *obj);
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
146
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
147 #ifdef __cplusplus
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
148 }
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
149 #endif
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
150
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
151 #endif /* LOCATION_H */
b85d45fd3b01 add location config parser
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
152

mercurial