ldif.h 3.02 KB
Newer Older
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1
/* $OpenLDAP$ */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
/*
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
 * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
4
5
 * All rights reserved.
 *
6
7
8
9
10
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
 * Public License.  A copy of this license is available at
 * http://www.OpenLDAP.org/license.html or in file LICENSE in the
 * top-level directory of the distribution.
11
12
 */
/* Portions
Kurt Zeilenga's avatar
Kurt Zeilenga committed
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 * Copyright (c) 1996 Regents of the University of Michigan.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms are permitted
 * provided that this notice is preserved and that due credit is given
 * to the University of Michigan at Ann Arbor. The name of the University
 * may not be used to endorse or promote products derived from this
 * software without specific prior written permission. This software
 * is provided ``as is'' without express or implied warranty.
 */

#ifndef _LDIF_H
#define _LDIF_H

Kurt Zeilenga's avatar
Kurt Zeilenga committed
27
28
29
#include <ldap_cdefs.h>

LDAP_BEGIN_DECL
Kurt Zeilenga's avatar
Kurt Zeilenga committed
30

Howard Chu's avatar
Howard Chu committed
31
/* This is NOT a bogus extern declaration (unlike ldap_debug) */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
32
LDAP_LDIF_V (int) ldif_debug;
33

Kurt Zeilenga's avatar
Kurt Zeilenga committed
34
#define LDIF_LINE_WIDTH      76      /* maximum length of LDIF lines */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
35
36
37

/*
 * Macro to calculate maximum number of bytes that the base64 equivalent
Kurt Zeilenga's avatar
Kurt Zeilenga committed
38
 * of an item that is "len" bytes long will take up.  Base64 encoding
Kurt Zeilenga's avatar
Kurt Zeilenga committed
39
40
 * uses one byte for every six bits in the value plus up to two pad bytes.
 */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
41
#define LDIF_BASE64_LEN(len)	(((len) * 4 / 3 ) + 3)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
42
43
44
45
46
47
48

/*
 * Macro to calculate maximum size that an LDIF-encoded type (length
 * tlen) and value (length vlen) will take up:  room for type + ":: " +
 * first newline + base64 value + continued lines.  Each continued line
 * needs room for a newline and a leading space character.
 */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
49
50
51
#define LDIF_SIZE_NEEDED(nlen,vlen) \
    ((nlen) + 4 + LDIF_BASE64_LEN(vlen) \
    + ((LDIF_BASE64_LEN(vlen) + (nlen) + 3) / LDIF_LINE_WIDTH * 2 ))
Kurt Zeilenga's avatar
Kurt Zeilenga committed
52

53
LDAP_LDIF_F( int )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
54
55
ldif_parse_line LDAP_P((
	LDAP_CONST char *line,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
56
57
	char **name,
	char **value,
58
59
	ber_len_t *vlen ));

60
LDAP_LDIF_F( int )
61
62
63
64
ldif_fetch_url LDAP_P((
	LDAP_CONST char *line,
	char **value,
	ber_len_t *vlen ));
65

66
LDAP_LDIF_F( char * )
67
68
ldif_getline LDAP_P(( char **next ));

69
LDAP_LDIF_F( int )
70
71
72
73
74
75
76
ldif_read_record LDAP_P((
	FILE *fp,
	int *lineno,
	char **bufp,
	int *buflen ));


Kurt Zeilenga's avatar
Kurt Zeilenga committed
77
78
79
80
81
82
83
84
85
86
#define LDIF_PUT_NOVALUE	0x0000	/* no value */
#define LDIF_PUT_VALUE		0x0001	/* value w/ auto detection */
#define LDIF_PUT_TEXT		0x0002	/* assume text */
#define	LDIF_PUT_BINARY		0x0004	/* assume binary (convert to base64) */
#define LDIF_PUT_B64		0x0008	/* pre-converted base64 value */

#define LDIF_PUT_COMMENT	0x0010	/* comment */
#define LDIF_PUT_URL		0x0020	/* url */
#define LDIF_PUT_SEP		0x0040	/* separator */

87
LDAP_LDIF_F( void )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
88
ldif_sput LDAP_P((
Kurt Zeilenga's avatar
Kurt Zeilenga committed
89
	char **out,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
90
91
	int type,
	LDAP_CONST char *name,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
92
	LDAP_CONST char *val,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
93
	ber_len_t vlen ));
94

95
LDAP_LDIF_F( char * )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
96
97
98
ldif_put LDAP_P((
	int type,
	LDAP_CONST char *name,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
99
	LDAP_CONST char *val,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
100
	ber_len_t vlen ));
Kurt Zeilenga's avatar
Kurt Zeilenga committed
101

102
LDAP_LDIF_F( int )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
103
104
105
ldif_is_not_printable LDAP_P((
	LDAP_CONST char *val,
	ber_len_t vlen ));
106

Kurt Zeilenga's avatar
Kurt Zeilenga committed
107
LDAP_END_DECL
Kurt Zeilenga's avatar
Kurt Zeilenga committed
108
109

#endif /* _LDIF_H */