1 /******************************************************************************
3 * Copyright (C) 2000 Pierangelo Masarati, <ando@sys-net.it>
6 * Permission is granted to anyone to use this software for any purpose
7 * on any computer system, and to alter it and redistribute it, subject
8 * to the following restrictions:
10 * 1. The author is not responsible for the consequences of use of this
11 * software, no matter how awful, even if they arise from flaws in it.
13 * 2. The origin of this software must not be misrepresented, either by
14 * explicit claim or by omission. Since few users ever read sources,
15 * credits should appear in the documentation.
17 * 3. Altered versions must be plainly marked as such, and must not be
18 * misrepresented as being the original software. Since few users
19 * ever read sources, credits should appear in the documentation.
21 * 4. This notice may not be removed or altered.
23 ******************************************************************************/
29 * Default rewrite context
31 #define REWRITE_DEFAULT_CONTEXT "default"
34 * Rewrite engine states
36 #define REWRITE_OFF 0x0000
37 #define REWRITE_ON 0x0001
38 #define REWRITE_DEFAULT REWRITE_OFF
41 * Rewrite internal status returns
43 #define REWRITE_SUCCESS LDAP_SUCCESS
44 #define REWRITE_ERR LDAP_OPERATIONS_ERROR
45 #define REWRITE_NO_SUCH_OBJECT LDAP_NO_SUCH_OBJECT
48 * Rewrite modes (input values for rewrite_info_init); determine the
49 * behavior in case a null or non existent context is required:
51 * REWRITE_MODE_ERR error
52 * REWRITE_MODE_OK no error but no rewrite
53 * REWRITE_MODE_COPY_INPUT a copy of the input is returned
54 * REWRITE_MODE_USE_DEFAULT the default context is used.
56 #define REWRITE_MODE_ERR 0x0010
57 #define REWRITE_MODE_OK 0x0011
58 #define REWRITE_MODE_COPY_INPUT 0x0012
59 #define REWRITE_MODE_USE_DEFAULT 0x0013
62 * Rewrite status returns
64 * REWRITE_REGEXEC_OK success (result may be empty in case
66 * REWRITE_REGEXEC_ERR error (internal error,
67 * misconfiguration, map not working ...)
68 * REWRITE_REGEXEC_STOP internal use; never returned
69 * REWRITE_REGEXEC_UNWILLING the server should issue an 'unwilling
72 #define REWRITE_REGEXEC_OK 0x0000
73 #define REWRITE_REGEXEC_ERR 0x0001
74 #define REWRITE_REGEXEC_STOP 0x0002
75 #define REWRITE_REGEXEC_UNWILLING 0x0004
82 struct berval; /* avoid include */
89 LDAP_REWRITE_F (struct rewrite_info *)
95 * Cleans up the info structure
99 struct rewrite_info *info
104 * Parses a config line and takes actions to fit content in rewrite structure;
105 * lines handled are of the form:
107 * rewriteEngine {on|off}
108 * rewriteMaxPasses numPasses
109 * rewriteContext contextName [alias aliasedRewriteContex]
110 * rewriteRule pattern substPattern [ruleFlags]
111 * rewriteMap mapType mapName [mapArgs]
112 * rewriteParam paramName paramValue
116 struct rewrite_info *info,
124 * process a config file that was already opened. Uses rewrite_parse.
129 struct rewrite_info *info
133 * Rewrites a string according to context.
134 * If the engine is off, OK is returned, but the return string will be NULL.
135 * In case of 'unwilling to perform', UNWILLING is returned, and the
136 * return string will also be null. The same in case of error.
137 * Otherwise, OK is returned, and result will hold a newly allocated string
138 * with the rewriting.
140 * What to do in case of non-existing rewrite context is still an issue.
141 * Four possibilities:
143 * - ok with NULL result,
144 * - ok with copy of string as result,
145 * - use the default rewrite context.
149 struct rewrite_info *info,
150 const char *rewriteContext,
156 * Same as above; the cookie relates the rewrite to a session
160 struct rewrite_info *info,
161 const char *rewriteContext,
170 LDAP_REWRITE_F (struct rewrite_session *)
171 rewrite_session_init(
172 struct rewrite_info *info,
177 * Defines and inits a variable with session scope
180 rewrite_session_var_set(
181 struct rewrite_info *info,
191 rewrite_session_delete(
192 struct rewrite_info *info,
202 * Defines and inits a variable with global scope
206 struct rewrite_info *info,
212 * Gets a var with global scope
216 struct rewrite_info *info,
222 * Destroys the parameter tree
225 rewrite_param_destroy(
226 struct rewrite_info *info
231 #endif /* REWRITE_H */