ldif.h 3.08 KB
Newer Older
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1
/* $OpenLDAP$ */
2
3
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
 *
Kurt Zeilenga's avatar
Kurt Zeilenga committed
4
 * Copyright 1998-2004 The OpenLDAP Foundation.
5
6
 * All rights reserved.
 *
7
8
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
9
10
11
12
13
 * Public License.
 *
 * A copy of this license is available in file LICENSE in the
 * top-level directory of the distribution or, alternatively, at
 * <http://www.OpenLDAP.org/license.html>.
14
 */
15
/* Portions Copyright (c) 1996 Regents of the University of Michigan.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
16
17
18
19
20
21
22
23
24
25
26
27
28
 * 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
29
30
31
#include <ldap_cdefs.h>

LDAP_BEGIN_DECL
Kurt Zeilenga's avatar
Kurt Zeilenga committed
32

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

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

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

/*
 * 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
51
52
53
#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
54

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

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

68
LDAP_LDIF_F( char * )
69
70
ldif_getline LDAP_P(( char **next ));

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


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

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

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

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

Kurt Zeilenga's avatar
Kurt Zeilenga committed
109
LDAP_END_DECL
Kurt Zeilenga's avatar
Kurt Zeilenga committed
110
111

#endif /* _LDIF_H */