ldif.h 2.98 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-2000 The OpenLDAP Foundation, Redwood City, California, USA
4
5
6
7
8
9
10
11
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms 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.
 */
/* Portions
Kurt Zeilenga's avatar
Kurt Zeilenga committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 * 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
26
27
28
#include <ldap_cdefs.h>

LDAP_BEGIN_DECL
Kurt Zeilenga's avatar
Kurt Zeilenga committed
29

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

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

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

/*
 * 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
48
49
50
#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
51

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

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

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

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


Kurt Zeilenga's avatar
Kurt Zeilenga committed
76
77
78
79
80
81
82
83
84
85
#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 */

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

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

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

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

#endif /* _LDIF_H */