2007-01-03 [paul] 2.6.1cvs96
[claws.git] / src / ldapctrl.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2003-2007 Match Grun and the Claws Mail team
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  */
19
20 /*
21  * Functions for LDAP control data.
22  */
23
24 #ifndef __LDAPCTRL_H__
25 #define __LDAPCTRL_H__
26
27 #ifdef USE_LDAP
28
29 #include <glib.h>
30 #include <stdio.h>
31 #include <pthread.h>
32
33 /*
34  * Constants.
35  */
36 #define LDAPCTL_DFL_PORT        389
37 #define LDAPCTL_DFL_SSL_PORT        636
38 #define LDAPCTL_MAX_ENTRIES     30
39 #define LDAPCTL_DFL_TIMEOUT     30
40 #define LDAPCTL_DFL_QUERY_AGE   600
41 #define LDAPCTL_MAX_QUERY_AGE   86400
42
43 #define LDAPCTL_ATTR_EMAIL      "mail"
44 #define LDAPCTL_ATTR_COMMONNAME "cn"
45 #define LDAPCTL_ATTR_GIVENNAME  "givenName"
46 #define LDAPCTL_ATTR_SURNAME    "sn"
47
48 #define LDAPCTL_DFL_ATTR_LIST   "mail, cn, givenName, sn"
49
50 /*
51  * Search matching options.
52  */
53 #define LDAPCTL_MATCH_BEGINWITH 0
54 #define LDAPCTL_MATCH_CONTAINS  1
55
56 /*
57  * Data structures.
58  */
59 typedef struct _LdapControl LdapControl;
60 struct _LdapControl {
61         gchar     *hostName;
62         gint      port;
63         gchar     *baseDN;
64         gchar     *bindDN;
65         gchar     *bindPass;
66         gint      maxEntries;
67         gint      timeOut;
68         gint      maxQueryAge;
69         gint      matchingOption;
70         gint      version;
71         gboolean  enableTLS;
72         gboolean  enableSSL;
73         gchar     *attribEMail;
74         gchar     *attribCName;
75         gchar     *attribFName;
76         gchar     *attribLName;
77         GList     *listCriteria;
78         pthread_mutex_t *mutexCtl;
79 };
80
81 /* Function prototypes */
82 LdapControl *ldapctl_create     ( void );
83 void ldapctl_set_host           ( LdapControl* ctl, const gchar *value );
84 void ldapctl_set_port           ( LdapControl* ctl, const gint value );
85 void ldapctl_set_base_dn        ( LdapControl* ctl, const gchar *value );
86 void ldapctl_set_bind_dn        ( LdapControl* ctl, const gchar *value );
87 void ldapctl_set_bind_password  ( LdapControl* ctl, const gchar *value );
88 void ldapctl_set_max_entries    ( LdapControl* ctl, const gint value );
89 void ldapctl_set_timeout        ( LdapControl* ctl, const gint value );
90 void ldapctl_set_max_query_age  ( LdapControl* ctl, const gint value );
91 void ldapctl_set_matching_option( LdapControl* ctl, const gint value );
92 void ldapctl_set_tls            ( LdapControl* ctl, const gboolean value );
93 void ldapctl_set_ssl            ( LdapControl* ctl, const gboolean value );
94 void ldapctl_set_criteria_list  ( LdapControl* ctl, GList *value );
95 GList *ldapctl_get_criteria_list( const LdapControl* ctl );
96 void ldapctl_criteria_list_clear( LdapControl *ctl );
97 void ldapctl_criteria_list_add  ( LdapControl *ctl, gchar *attr );
98 void ldapctl_default_attributes ( LdapControl *ctl );
99 void ldapctl_clear              ( LdapControl *ctl );
100 void ldapctl_free               ( LdapControl *ctl );
101 void ldapctl_default_values     ( LdapControl *ctl );
102 void ldapctl_print              ( const LdapControl *ctl, FILE *stream );
103 void ldapctl_copy               ( const LdapControl *ctlFrom,
104                                   LdapControl *ctlTo );
105 gchar *ldapctl_format_criteria  ( LdapControl *ctl, const gchar *searchVal );
106 char **ldapctl_attribute_array  ( LdapControl *ctl );
107 void ldapctl_free_attribute_array( char **ptrArray );
108 void ldapctl_parse_ldap_search  ( LdapControl *ctl, gchar *criteria );
109
110 #endif  /* USE_LDAP */
111
112 #endif /* __LDAPCTRL_H__ */
113