2 * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
5 * Redistribution and use in source and binary forms are permitted only
6 * as authorized by the OpenLDAP Public License. A copy of this
7 * license is available at http://www.OpenLDAP.org/license.html or
8 * in file LICENSE in the top-level directory of the distribution.
11 * Copyright (c) 1993, 1994 Regents of the University of Michigan.
12 * All rights reserved.
14 * Redistribution and use in source and binary forms are permitted
15 * provided that this notice is preserved and that due credit is given
16 * to the University of Michigan at Ann Arbor. The name of the University
17 * may not be used to endorse or promote products derived from this
18 * software without specific prior written permission. This software
19 * is provided ``as is'' without express or implied warranty.
21 * disptmpl.h: display template library defines
22 * 7 March 1994 by Mark C Smith
28 #include <ldap_cdefs.h>
32 #define LDAP_TEMPLATE_VERSION 1
35 * general types of items (confined to most significant byte)
37 #define LDAP_SYN_TYPE_TEXT 0x01000000L
38 #define LDAP_SYN_TYPE_IMAGE 0x02000000L
39 #define LDAP_SYN_TYPE_BOOLEAN 0x04000000L
40 #define LDAP_SYN_TYPE_BUTTON 0x08000000L
41 #define LDAP_SYN_TYPE_ACTION 0x10000000L
45 * syntax options (confined to second most significant byte)
47 #define LDAP_SYN_OPT_DEFER 0x00010000L
51 * display template item syntax ids (defined by common agreement)
52 * these are the valid values for the ti_syntaxid of the tmplitem
53 * struct (defined below). A general type is encoded in the
54 * most-significant 8 bits, and some options are encoded in the next
55 * 8 bits. The lower 16 bits are reserved for the distinct types.
57 #define LDAP_SYN_CASEIGNORESTR ( 1 | LDAP_SYN_TYPE_TEXT )
58 #define LDAP_SYN_MULTILINESTR ( 2 | LDAP_SYN_TYPE_TEXT )
59 #define LDAP_SYN_DN ( 3 | LDAP_SYN_TYPE_TEXT )
60 #define LDAP_SYN_BOOLEAN ( 4 | LDAP_SYN_TYPE_BOOLEAN )
61 #define LDAP_SYN_JPEGIMAGE ( 5 | LDAP_SYN_TYPE_IMAGE )
62 #define LDAP_SYN_JPEGBUTTON ( 6 | LDAP_SYN_TYPE_BUTTON | LDAP_SYN_OPT_DEFER )
63 #define LDAP_SYN_FAXIMAGE ( 7 | LDAP_SYN_TYPE_IMAGE )
64 #define LDAP_SYN_FAXBUTTON ( 8 | LDAP_SYN_TYPE_BUTTON | LDAP_SYN_OPT_DEFER )
65 #define LDAP_SYN_AUDIOBUTTON ( 9 | LDAP_SYN_TYPE_BUTTON | LDAP_SYN_OPT_DEFER )
66 #define LDAP_SYN_TIME ( 10 | LDAP_SYN_TYPE_TEXT )
67 #define LDAP_SYN_DATE ( 11 | LDAP_SYN_TYPE_TEXT )
68 #define LDAP_SYN_LABELEDURL ( 12 | LDAP_SYN_TYPE_TEXT )
69 #define LDAP_SYN_SEARCHACTION ( 13 | LDAP_SYN_TYPE_ACTION )
70 #define LDAP_SYN_LINKACTION ( 14 | LDAP_SYN_TYPE_ACTION )
71 #define LDAP_SYN_ADDDNACTION ( 15 | LDAP_SYN_TYPE_ACTION )
72 #define LDAP_SYN_VERIFYDNACTION ( 16 | LDAP_SYN_TYPE_ACTION )
73 #define LDAP_SYN_RFC822ADDR ( 17 | LDAP_SYN_TYPE_TEXT )
79 #define LDAP_GET_SYN_TYPE( syid ) ((syid) & 0xFF000000L )
80 #define LDAP_GET_SYN_OPTIONS( syid ) ((syid) & 0x00FF0000L )
84 * display options for output routines (used by entry2text and friends)
87 * use calculated label width (based on length of longest label in
88 * template) instead of contant width
90 #define LDAP_DISP_OPT_AUTOLABELWIDTH 0x00000001L
91 #define LDAP_DISP_OPT_HTMLBODYONLY 0x00000002L
94 * perform search actions (applies to ldap_entry2text_search only)
96 #define LDAP_DISP_OPT_DOSEARCHACTIONS 0x00000002L
99 * include additional info. relevant to "non leaf" entries only
100 * used by ldap_entry2html and ldap_entry2html_search to include "Browse"
101 * and "Move Up" HREFs
103 #define LDAP_DISP_OPT_NONLEAF 0x00000004L
107 * display template item options (may not apply to all types)
108 * if this bit is set in ti_options, it applies.
110 #define LDAP_DITEM_OPT_READONLY 0x00000001L
111 #define LDAP_DITEM_OPT_SORTVALUES 0x00000002L
112 #define LDAP_DITEM_OPT_SINGLEVALUED 0x00000004L
113 #define LDAP_DITEM_OPT_HIDEIFEMPTY 0x00000008L
114 #define LDAP_DITEM_OPT_VALUEREQUIRED 0x00000010L
115 #define LDAP_DITEM_OPT_HIDEIFFALSE 0x00000020L /* booleans only */
120 * display template item structure
122 struct ldap_tmplitem {
123 unsigned long ti_syntaxid;
124 unsigned long ti_options;
128 struct ldap_tmplitem *ti_next_in_row;
129 struct ldap_tmplitem *ti_next_in_col;
134 #define LDAP_SET_TMPLITEM_APPDATA( ti, datap ) \
135 ( (ti)->ti_appdata = (void *)(datap) )
137 #define LDAP_GET_TMPLITEM_APPDATA( ti, type ) \
138 ( (type)((ti)->ti_appdata) )
140 #define LDAP_IS_TMPLITEM_OPTION_SET( ti, option ) \
141 ( ((ti)->ti_options & (option) ) != 0 )
145 * object class array structure
148 char **oc_objclasses;
149 struct ldap_oclist *oc_next;
156 struct ldap_adddeflist {
158 #define LDAP_ADSRC_CONSTANTVALUE 1
159 #define LDAP_ADSRC_ADDERSDN 2
162 struct ldap_adddeflist *ad_next;
167 * display template global options
168 * if this bit is set in dt_options, it applies.
171 * users should be allowed to try to add objects of these entries
173 #define LDAP_DTMPL_OPT_ADDABLE 0x00000001L
176 * users should be allowed to do "modify RDN" operation of these entries
178 #define LDAP_DTMPL_OPT_ALLOWMODRDN 0x00000002L
181 * this template is an alternate view, not a primary view
183 #define LDAP_DTMPL_OPT_ALTVIEW 0x00000004L
187 * display template structure
189 struct ldap_disptmpl {
193 unsigned long dt_options;
194 char *dt_authattrname;
195 char *dt_defrdnattrname;
196 char *dt_defaddlocation;
197 struct ldap_oclist *dt_oclist;
198 struct ldap_adddeflist *dt_adddeflist;
199 struct ldap_tmplitem *dt_items;
201 struct ldap_disptmpl *dt_next;
204 #define LDAP_SET_DISPTMPL_APPDATA( dt, datap ) \
205 ( (dt)->dt_appdata = (void *)(datap) )
207 #define LDAP_GET_DISPTMPL_APPDATA( dt, type ) \
208 ( (type)((dt)->dt_appdata) )
210 #define LDAP_IS_DISPTMPL_OPTION_SET( dt, option ) \
211 ( ((dt)->dt_options & (option) ) != 0 )
213 #define LDAP_TMPL_ERR_VERSION 1
214 #define LDAP_TMPL_ERR_MEM 2
215 #define LDAP_TMPL_ERR_SYNTAX 3
216 #define LDAP_TMPL_ERR_FILE 4
219 * buffer size needed for entry2text and vals2text
221 #define LDAP_DTMPL_BUFSIZ 8192
224 typedef int (*ldap_writeptype) LDAP_P(( void *writeparm, char *p, int len ));
227 ldap_init_templates LDAP_P(( char *file, struct ldap_disptmpl **tmpllistp ));
230 ldap_init_templates_buf LDAP_P(( char *buf,
232 struct ldap_disptmpl **tmpllistp ));
235 ldap_free_templates LDAP_P(( struct ldap_disptmpl *tmpllist ));
237 LDAP_F( struct ldap_disptmpl * )
238 ldap_first_disptmpl LDAP_P(( struct ldap_disptmpl *tmpllist ));
240 LDAP_F( struct ldap_disptmpl * )
241 ldap_next_disptmpl LDAP_P(( struct ldap_disptmpl *tmpllist,
242 struct ldap_disptmpl *tmpl ));
244 LDAP_F( struct ldap_disptmpl * )
245 ldap_name2template LDAP_P(( char *name,
246 struct ldap_disptmpl *tmpllist ));
248 LDAP_F( struct ldap_disptmpl * )
249 ldap_oc2template LDAP_P(( char **oclist,
250 struct ldap_disptmpl *tmpllist ));
253 ldap_tmplattrs LDAP_P(( struct ldap_disptmpl *tmpl,
256 unsigned long syntaxmask ));
258 LDAP_F( struct ldap_tmplitem * )
259 ldap_first_tmplrow LDAP_P(( struct ldap_disptmpl *tmpl ));
261 LDAP_F( struct ldap_tmplitem * )
262 ldap_next_tmplrow LDAP_P(( struct ldap_disptmpl *tmpl,
263 struct ldap_tmplitem *row ));
265 LDAP_F( struct ldap_tmplitem * )
266 ldap_first_tmplcol LDAP_P(( struct ldap_disptmpl *tmpl,
267 struct ldap_tmplitem *row ));
269 LDAP_F( struct ldap_tmplitem * )
270 ldap_next_tmplcol LDAP_P(( struct ldap_disptmpl *tmpl,
271 struct ldap_tmplitem *row,
272 struct ldap_tmplitem *col ));
275 ldap_entry2text LDAP_P(( LDAP *ld,
276 char *buf, LDAPMessage *entry,
277 struct ldap_disptmpl *tmpl, char **defattrs, char ***defvals,
278 ldap_writeptype writeproc, void *writeparm, char *eol, int rdncount,
279 unsigned long opts ));
282 ldap_vals2text LDAP_P(( LDAP *ld,
283 char *buf, char **vals, char *label, int labelwidth,
284 unsigned long syntaxid, ldap_writeptype writeproc, void *writeparm,
285 char *eol, int rdncount ));
288 ldap_entry2text_search LDAP_P(( LDAP *ld,
289 char *dn, char *base, LDAPMessage *entry,
290 struct ldap_disptmpl *tmpllist, char **defattrs, char ***defvals,
291 ldap_writeptype writeproc, void *writeparm, char *eol, int rdncount,
292 unsigned long opts ));
295 ldap_entry2html LDAP_P(( LDAP *ld,
296 char *buf, LDAPMessage *entry,
297 struct ldap_disptmpl *tmpl, char **defattrs, char ***defvals,
298 ldap_writeptype writeproc, void *writeparm, char *eol, int rdncount,
299 unsigned long opts, char *urlprefix, char *base ));
302 ldap_vals2html LDAP_P(( LDAP *ld,
303 char *buf, char **vals, char *label, int labelwidth,
304 unsigned long syntaxid, ldap_writeptype writeproc, void *writeparm,
305 char *eol, int rdncount, char *urlprefix ));
308 ldap_entry2html_search LDAP_P(( LDAP
309 *ld, char *dn, char *base, LDAPMessage *entry,
310 struct ldap_disptmpl *tmpllist, char **defattrs, char ***defvals,
311 ldap_writeptype writeproc, void *writeparm, char *eol, int rdncount,
312 unsigned long opts, char *urlprefix ));
315 #endif /* _DISPTMPL_H */