2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2003-2007 Michael Rasmussen and the Claws Mail team
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 3 of the License, or
8 * (at your option) any later version.
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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * Functions necessary to access LDAP servers.
26 * 1) When adding a contact to an empty addressbook from the pop-up menu
27 * when right-clicking on an email address causes claws-mail to crash in
28 * addritem.c line 965. Severity: Show stopper. Solved in 2.9.2cvs17
29 * 2) Updating a contact gets lost if the user makes a new search on the
30 * same LdapServer. Severity: Medium. Solved in 2.9.2cvs17 (patch added to solve 1) also solved this bug)
31 * 3) After adding a new contact the displayName for the contact is empty
32 * until the user makes a reread from the LdapServer. Severity: minor.
33 * Solved in 2.9.2cvs24
43 #include <glib/gi18n.h>
49 #include "ldapupdate.h"
52 #include "addrcache.h"
54 #include "ldapquery.h"
55 #include "ldapserver.h"
58 #include "adbookbase.h"
59 #include "editaddress_other_attributes_ldap.h"
62 * Structure to hold user defined attributes
65 typedef struct _AttrKeyValue AttrKeyValue;
66 struct _AttrKeyValue {
72 * Structure to hold contact information.
73 * Each addressbook will have 0..N contacts.
75 typedef struct _EmailKeyValue EmailKeyValue;
76 struct _EmailKeyValue {
83 * Structure to hold information about RDN.
85 typedef struct _Rdn Rdn;
93 * Retrieve address group item for update.
94 * \param group Group to print.
95 * \param array GHashTAble of item_group, or <i>NULL</i> if none created.
97 void ldapsvr_retrieve_item_group(ItemGroup *group, GHashTable *array) {
98 /* Not implemented in this release */
99 g_return_if_fail(group != NULL);
103 * Create an initial EmailKeyValue structure
104 * \return empty structure
106 EmailKeyValue *emailkeyvalue_create() {
109 buf = g_new0(EmailKeyValue, 1);
117 * Create an initial AttrKeyValue structure
118 * \return empty structure
120 AttrKeyValue *attrkeyvalue_create() {
123 buf = g_new0(AttrKeyValue, 1);
130 * Free created AttrKeyValue structure
131 * \param akv AttrKeyValue structure to free
133 void attrkeyvalue_free(AttrKeyValue *akv) {
147 * Retrieve E-Mail address object for update.
148 * \param item ItemEmail to update.
149 * \return object, or <i>NULL</i> if none created.
151 EmailKeyValue *ldapsvr_retrieve_item_email(ItemEMail *item) {
152 EmailKeyValue *newItem;
153 g_return_val_if_fail(item != NULL, NULL);
154 newItem = emailkeyvalue_create();
155 newItem->alias = g_strdup(ADDRITEM_NAME(item));
156 newItem->mail = g_strdup(item->address);
157 newItem->remarks = g_strdup(item->remarks);
162 * Retrieve user attribute object for update.
163 * \param item UserAttribute to update.
164 * \return object, or <i>NULL</i> if none created.
166 AttrKeyValue *ldapsvr_retrieve_attribute(UserAttribute *item) {
167 AttrKeyValue *newItem;
168 g_return_val_if_fail(item != NULL, NULL);
169 newItem = attrkeyvalue_create();
170 newItem->key = g_strdup(item->name);
171 newItem->value = g_strdup(item->value);
176 * Retrieve person object for update.
177 * \param person ItemPerson to update.
178 * \param array GHashTable with user input.
179 * \return false if update is not needed, or true if update is needed.
181 gboolean ldapsvr_retrieve_item_person(ItemPerson *person, GHashTable *array) {
184 g_return_val_if_fail(person != NULL, FALSE);
185 switch (person->status) {
186 case NONE: return FALSE;
187 case ADD_ENTRY: g_hash_table_insert(array, "status", "new"); break;
188 case UPDATE_ENTRY: g_hash_table_insert(array, "status", "update"); break;
189 case DELETE_ENTRY: g_hash_table_insert(array, "status", "delete"); break;
190 default: g_critical(_("ldapsvr_retrieve_item_person->Unknown status: %d"), person->status);
192 g_hash_table_insert(array, "uid", ADDRITEM_ID(person));
193 g_hash_table_insert(array, "cn", ADDRITEM_NAME(person));
194 g_hash_table_insert(array, "givenName", person->firstName);
195 g_hash_table_insert(array, "sn", person->lastName);
196 g_hash_table_insert(array, "nickName", person->nickName);
197 g_hash_table_insert(array, "dn", person->externalID);
198 node = person->listEMail;
201 EmailKeyValue *newEmail = ldapsvr_retrieve_item_email(node->data);
203 attr = g_list_append(attr, newEmail);
204 node = g_list_next(node);
206 g_hash_table_insert(array, "mail", attr);
207 node = person->listAttrib;
210 AttrKeyValue *newAttr = ldapsvr_retrieve_attribute(node->data);
212 attr = g_list_append(attr, newAttr);
213 node = g_list_next(node);
215 g_hash_table_insert(array, "attribute", attr);
220 * Print contents of contacts hashtable for debug.
221 * This function must be called with g_hash_table_foreach.
222 * \param key Key to process.
223 * \param data Data to process.
224 * \param fd Output stream.
226 void ldapsvr_print_contacts_hashtable(gpointer key, gpointer data, gpointer fd) {
227 gchar *keyName = (gchar *) key;
230 if (g_ascii_strcasecmp("mail", keyName) == 0) {
231 node = (GList *) data;
233 EmailKeyValue *item = node->data;
234 if (debug_get_mode()) {
235 debug_print("\t\talias = %s\n", item->alias?item->alias:"null");
236 debug_print("\t\tmail = %s\n", item->mail?item->mail:"null");
237 debug_print("\t\tremarks = %s\n", item->remarks?item->remarks:"null");
240 FILE *stream = (FILE *) fd;
241 fprintf(stream, "\t\talias = %s\n", item->alias?item->alias:"null");
242 fprintf(stream, "\t\tmail = %s\n", item->mail?item->mail:"null");
243 fprintf(stream, "\t\tremarks = %s\n", item->remarks?item->remarks:"null");
245 node = g_list_next(node);
248 else if (g_ascii_strcasecmp("attribute", keyName) == 0) {
249 node = (GList *) data;
251 AttrKeyValue *item = node->data;
252 if (debug_get_mode()) {
253 debug_print("\t\t%s = %s\n", item->key?item->key:"null",
254 item->value?item->value:"null");
257 FILE *stream = (FILE *) fd;
258 fprintf(stream, "\t\t%s = %s\n", item->key?item->key:"null",
259 item->value?item->value:"null");
261 node = g_list_next(node);
265 if (debug_get_mode())
266 debug_print("\t\t%s = %s\n", keyName?keyName:"null", data?(gchar *)data:"null");
268 FILE *stream = (FILE *) fd;
269 fprintf(stream, "\t\t%s = %s\n", keyName?keyName:"null", data?(gchar *)data:"null");
275 * Free list of changed contacts
277 * \param list List of GHashTable
279 void ldapsvr_free_hashtable(GList *list) {
282 g_hash_table_destroy(tmp->data);
284 tmp = g_list_next(tmp);
291 * Get person object from cache
293 * \param server Resource to LDAP
294 * \param uid PersonID in cache
295 * \return person object, or <i>NULL</i> if fail
297 ItemPerson *ldapsvr_get_contact(LdapServer *server, gchar *uid) {
299 g_return_val_if_fail(server != NULL || uid != NULL, NULL);
300 aio = addrcache_get_object(server->addressCache, uid);
302 if(aio->type == ITEMTYPE_PERSON) {
303 return (ItemPerson *) aio;
310 * Connect to LDAP server.
311 * \param ctl Control object to process.
312 * \return LDAP Resource to LDAP.
314 LDAP *ldapsvr_connect(LdapControl *ctl) {
320 g_return_val_if_fail(ctl != NULL, NULL);
322 ldapsrv_set_options (ctl->timeOut, NULL);
323 uri = g_strdup_printf("ldap%s://%s:%d",
324 ctl->enableSSL?"s":"",
325 ctl->hostName, ctl->port);
326 ldap_initialize(&ld, uri);
333 debug_print("connected to LDAP host %s on port %d\n", ctl->hostName, ctl->port);
337 version = LDAP_VERSION3;
338 rc = ldap_set_option(ld, LDAP_OPT_PROTOCOL_VERSION, &version);
339 if (rc == LDAP_OPT_SUCCESS) {
340 ctl->version = LDAP_VERSION3;
343 if (ctl->version == LDAP_VERSION3) {
344 if (ctl->enableTLS && !ctl->enableSSL) {
345 rc = ldap_start_tls_s(ld, NULL, NULL);
347 if (rc != LDAP_SUCCESS) {
348 g_printerr("LDAP Error(tls): ldap_simple_bind_s: %s\n",
349 ldap_err2string(rc));
356 /* Bind to the server, if required */
358 if (* ctl->bindDN != '\0') {
359 rc = claws_ldap_simple_bind_s(ld, ctl->bindDN, ctl->bindPass);
360 if (rc != LDAP_SUCCESS) {
361 g_printerr("bindDN: %s, bindPass: %s\n", ctl->bindDN, ctl->bindPass);
362 g_printerr("LDAP Error(bind): ldap_simple_bind_s: %s\n",
363 ldap_err2string(rc));
372 * Disconnect to LDAP server.
373 * \param ld Resource to LDAP.
375 void ldapsvr_disconnect(LDAP *ld) {
377 g_return_if_fail(ld != NULL);
378 ldap_unbind_ext(ld, NULL, NULL);
382 * Create an initial Rdn structure
384 * \return empty structure
389 buf = g_new0(Rdn, 1);
390 buf->attribute = NULL;
397 * Free a created Rdn structure
398 * \param rdn Structure to free
400 void rdn_free(Rdn *rdn) {
401 if (rdn->attribute) {
402 g_free(rdn->attribute);
403 rdn->attribute = NULL;
418 * update Rdn structure
420 * \param rdn Rdn structure to update
421 * \param head Uniq part of dn
422 * \param tail Common part of dn
424 void update_rdn(Rdn *rdn, gchar *head, gchar *tail) {
425 rdn->value = g_strdup(head);
426 rdn->new_dn = g_strdup_printf("mail=%s%s", head, tail);
430 * Deside if dn needs to be changed
432 * \param hash GHashTable with user input.
433 * \param dn dn for current object
434 * \return Rdn structure
436 Rdn *ldapsvr_modify_dn(GHashTable *hash, gchar *dn) {
438 gchar *pos, *compare;
441 g_return_val_if_fail(hash != NULL || dn != NULL, NULL);
443 pos = g_strstr_len(dn, strlen(dn), "=");
444 compare = g_strndup(dn, pos - dn);
449 rest = g_strstr_len(pos, strlen(pos), ",");
450 val = g_strndup(pos, rest - pos);
457 rdn->value = g_strdup(val);
458 rdn->attribute = g_strdup(compare);
460 if (strcmp("mail", rdn->attribute) == 0) {
461 GList *list = g_hash_table_lookup(hash, rdn->attribute);
463 EmailKeyValue *item = list->data;
464 compare = g_strdup((gchar *) item->mail);
465 if (strcmp(compare, rdn->value) == 0) {
466 update_rdn(rdn, compare, rest);
470 list = g_list_next(list);
472 /* if compare and rdn->attribute are equal then last email removed/empty */
473 if (strcmp(compare, rdn->attribute) != 0) {
474 /* RDN changed. Find new */
475 update_rdn(rdn, compare, rest);
480 /* We cannot remove dn */
487 compare = g_hash_table_lookup(hash, rdn->attribute);
488 /* if compare and rdn->attribute are equal then dn removed/empty */
489 if (strcmp(compare, rdn->attribute) != 0) {
490 update_rdn(rdn, compare, rest);
494 /* We cannot remove dn */
504 * This macro is borrowed from the Balsa project
505 * Creates a LDAPMod structure
507 * \param mods Empty LDAPMod structure
508 * \param modarr Array with values to insert
509 * \param op Operation to perform on LDAP
510 * \param attr Attribute to insert
511 * \param strv Empty array which is NULL terminated
512 * \param val Value for attribute
514 #define SETMOD(mods,modarr,op,attr,strv,val) \
515 do { (mods) = &(modarr); (modarr).mod_type=attr; (modarr).mod_op=op;\
516 (strv)[0]=(val); (modarr).mod_values=strv; \
520 * Creates a LDAPMod structure
522 * \param mods Empty LDAPMod structure
523 * \param modarr Array with values to insert
524 * \param op Operation to perform on LDAP
525 * \param attr Attribute to insert
526 * \param strv Array with values to insert. Must be NULL terminated
528 #define SETMODS(mods,modarr,op,attr,strv) \
529 do { (mods) = &(modarr); (modarr).mod_type=attr; \
530 (modarr).mod_op=op; (modarr).mod_values=strv; \
535 * Clean up, close LDAP connection, and refresh cache
537 * \param ld Resource to LDAP
538 * \param server AddressBook resource
539 * \param contact GHashTable with current changed object
541 void clean_up(LDAP *ld, LdapServer *server, GHashTable *contact) {
543 ldapsvr_get_contact(server, g_hash_table_lookup(contact , "uid"));
546 person->status = NONE;
547 displayName = g_hash_table_lookup(contact, "displayName");
549 person->nickName = g_strdup(displayName);
551 if (server->retVal != LDAPRC_SUCCESS) {
554 addrcache_remove_person(server->addressCache, person);
556 g_critical(N_("ldapsvr_update_book: Could not clean cache\n"));
558 addritem_free_item_person(res);
562 ldapsvr_disconnect(ld);
566 * Get cn attribute from dn
568 * \param dn Distinguesh Name for current object
569 * \return AttrKeyValue, or <i>NULL</i> if none created
571 AttrKeyValue *get_cn(gchar *dn) {
577 g_return_val_if_fail(dn != NULL, NULL);
579 cn = attrkeyvalue_create();
580 start = g_strstr_len(dn, strlen(dn), "cn");
582 attrkeyvalue_free(cn);
585 end = g_strstr_len(start, strlen(start), ",");
586 item = g_strndup(start, end - start);
588 attrkeyvalue_free(cn);
591 key_value = g_strsplit(item, "=", 2);
592 cn->key = g_strdup(key_value[0]);
593 cn->value = g_strdup(key_value[1]);
594 g_strfreev(key_value);
600 * Get mail attribute from dn
602 * \param dn Distinguesh Name for current object
603 * \return AttrKeyValue, or <i>NULL</i> if none created
605 AttrKeyValue *get_mail(gchar *dn) {
611 g_return_val_if_fail(dn != NULL, NULL);
613 mail = attrkeyvalue_create();
614 start = g_strstr_len(dn, strlen(dn), "mail");
616 attrkeyvalue_free(mail);
619 end = g_strstr_len(start, strlen(start), ",");
620 item = g_strndup(start, end - start);
622 attrkeyvalue_free(mail);
625 key_value = g_strsplit(item, "=", 2);
626 mail->key = g_strdup(key_value[0]);
627 mail->value = g_strdup(key_value[1]);
628 g_strfreev(key_value);
634 * Get ou or o attribute from dn
636 * \param dn Distinguesh Name for current object
637 * \return AttrKeyValue, or <i>NULL</i> if none created
639 AttrKeyValue *get_ou(gchar *dn) {
646 g_return_val_if_fail(dn != NULL, NULL);
647 ou = attrkeyvalue_create();
648 start = g_strstr_len(dn, strlen(dn), ",o=");
650 start = g_strstr_len(dn, strlen(dn), ",ou=");
652 attrkeyvalue_free(ou);
656 end = g_strstr_len(start, strlen(start), ",");
657 item = g_strndup(start, end - start);
659 attrkeyvalue_free(ou);
662 key_value = g_strsplit(item, "=", 2);
663 ou->key = g_strdup(key_value[0]);
664 ou->value = g_strdup(key_value[1]);
665 g_strfreev(key_value);
671 * Print the contents of a LDAPMod structure for debuging purposes
673 * \param mods LDAPMod structure
675 void ldapsvr_print_ldapmod(LDAPMod *mods[]) {
679 g_return_if_fail(mods != NULL);
680 g_printerr( "Type\n");
681 for (i = 0; NULL != mods[i]; i++) {
682 LDAPMod *mod = (LDAPMod *) mods[i];
684 switch (mod->mod_op) {
685 case LDAP_MOD_ADD: mod_op = g_strdup("ADD"); break;
686 case LDAP_MOD_REPLACE: mod_op = g_strdup("MODIFY"); break;
687 case LDAP_MOD_DELETE: mod_op = g_strdup("DELETE"); break;
688 default: mod_op = g_strdup("UNKNOWN");
690 g_printerr( "Operation: %s\tType:%s\nValues:\n", mod_op, mod->mod_type);
691 vals = mod->mod_vals.modv_strvals;
693 g_printerr( "\t%s\n", *vals++);
699 * Make a compare for every new value we want to store in the
700 * directory with the current values. Great tool for debugging
701 * against invalid syntax in attributes
703 * \param ld AddressBook resource
704 * \param dn dn for the entry
705 * \param cnt Number of attributes to compare
706 * \param mods LDAPMod structure
708 void ldapsvr_compare_attr(LDAP *ld, gchar *dn, gint cnt, LDAPMod *mods[]) {
711 g_return_if_fail(ld != NULL || dn != NULL || cnt >= 0 || mods != NULL);
712 for (i = 0; i < cnt; i++) {
713 gchar *value = g_strdup(mods[i]->mod_vals.modv_strvals[0]);
714 if (!value || strcmp(value, "") == 0)
715 value = g_strdup("thisisonlyadummy");
716 rc = ldap_compare_s(ld, dn, mods[i]->mod_type, value);
717 g_printerr("ldap_compare for (%s:%s)\" failed[0x%x]: %s\n",
718 mods[i]->mod_type, value, rc, ldap_err2string(rc));
724 * compare attribute to LDAP in case of LDAP_INAPPROPRIATE_MATCHING
726 * \param ld AddressBook resource
727 * \param server Reference to server
728 * \param dn dn for the entry
729 * \param attr Attribute
730 * \param value New value
731 * \return int, return will be LDAP_MOD_ADD, LDAP_MOD_REPLACE, or LDAP_MOD_DELETE
733 int ldapsvr_compare_manual_attr(LDAP *ld, LdapServer *server, gchar *dn, char *attr, char *value) {
734 LDAPMessage *res, *e = NULL;
736 struct berval **vals;
744 g_return_val_if_fail(ld != NULL || server != NULL || attr != NULL, -1);
745 ctl = server->control;
749 filter = g_strdup_printf("(&(mail=%s)(%s=*))", mail->value, attr);
750 attrkeyvalue_free(mail);
752 rc = ldap_search_s(ld, ctl->baseDN, /*LDAP_SCOPE_SUBTREE*/LDAP_SCOPE_ONELEVEL, filter, NULL, 0, &res);
754 g_printerr("ldap_search for attr=%s\" failed[0x%x]: %s\n",attr, rc, ldap_err2string(rc));
758 e = ldap_first_entry(ld, res);
759 /* entry has this attribute */
761 attribute = ldap_first_attribute( ld, e, &ber );
764 if( ( vals = ldap_get_values_len( ld, e, attr ) ) != NULL ) {
765 for( i = 0; vals[i] != NULL; i++ ) {
766 debug_print("Compare: %s=%s\n", attr, vals[i]->bv_val);
767 /* attribute has same value */
768 if (strcmp(vals[i]->bv_val, value) == 0)
770 /* attribute has new value */
772 retVal = LDAP_MOD_REPLACE;
775 ldap_value_free_len(vals);
778 retVal = LDAP_MOD_DELETE;
783 ldap_memfree(attribute);
785 /* entry does not have this attribute */
787 /* Only add if this is a real attribute */
789 retVal = LDAP_MOD_ADD;
790 /* This is dummy value used to avoid ldap_compare error */
803 * Deside which kind of operation is required to handle
804 * updating the specified attribute
806 * \param ld AddressBook resource
807 * \param server Reference to server
808 * \param dn dn for the entry
809 * \param attr Attribute
810 * \param value New value
811 * \return int, return will be LDAP_MOD_ADD, LDAP_MOD_REPLACE, or LDAP_MOD_DELETE
813 int ldapsvr_deside_operation(LDAP *ld, LdapServer *server, char *dn, char *attr, char *value) {
815 gboolean dummy = FALSE;
817 g_return_val_if_fail(ld != NULL || server != NULL || dn != NULL || attr != NULL, -1);
820 /* value containing empty string cause invalid syntax. A bug in
821 * the LDAP library? Therefore we add a dummy value
823 if (strcmp(value,"") == 0) {
824 value = g_strdup("thisisonlyadummy");
827 rc = ldap_compare_s(ld, dn, attr, value);
828 debug_print("ldap_compare for (%s:%s)\" error_code[0x%x]: %s\n",
829 attr, value, rc, ldap_err2string(rc));
831 case LDAP_COMPARE_FALSE:
833 return LDAP_MOD_DELETE;
835 return LDAP_MOD_REPLACE;
836 case LDAP_COMPARE_TRUE: return -1;
837 case LDAP_NO_SUCH_ATTRIBUTE: return LDAP_MOD_ADD;
838 /* LDAP_INAPPROPRIATE_MATCHING needs extensive testing because I
839 * am not aware off the condition causing this return value!
841 case LDAP_INAPPROPRIATE_MATCHING:
844 return ldapsvr_compare_manual_attr(ld, server, dn, attr, value);
845 case LDAP_UNDEFINED_TYPE: return -2;
846 case LDAP_INVALID_SYNTAX: return -2;
852 * Check if attribute is part of the current search criteria
854 * \param list Array containing attributes in the current search criteria
855 * \param attr Attribute to check
856 * \result <i>TRUE</i> if attribute is found in the current search criteria
858 gboolean ldapsvr_check_search_attributes(char **list, char *attr) {
860 if (strcmp(*list++, attr) == 0)
867 * Deside which other attributes needs updating
869 * \param ld LDAP resource
870 * \param server AddressBook resource
871 * \param dn dn for the entry
872 * \param contact GHashTable with information for the current contact
874 void ldapsvr_handle_other_attributes(LDAP *ld, LdapServer *server, char *dn, GHashTable *contact) {
876 gboolean CHECKED_ATTRIBUTE[ATTRIBUTE_SIZE + 1];
877 LDAPMod *mods[ATTRIBUTE_SIZE + 1];
878 LDAPMod modarr[ATTRIBUTE_SIZE];
880 char *attr[ATTRIBUTE_SIZE + 1][2];
883 g_return_if_fail(server != NULL || dn != NULL || contact != NULL);
884 for (i = 0; i <= ATTRIBUTE_SIZE; i++) {
885 CHECKED_ATTRIBUTE[i] = FALSE;
886 attr[i][0] = attr[i][1] = NULL;
888 node = g_hash_table_lookup(contact , "attribute");
890 AttrKeyValue *item = node->data;
892 int index = get_attribute_index(item->key);
894 debug_print("Found other attribute: %s = %s\n",
895 item->key?item->key:"null", item->value?item->value:"null");
896 mod_op = ldapsvr_deside_operation(ld, server, dn, item->key, item->value);
897 /* Only consider attributes which we no how to handle.
898 * Set to TRUE in CHECKED_ATTRIBUTE array to indicate no further action
901 CHECKED_ATTRIBUTE[index] = TRUE;
902 node = g_list_next(node);
905 if (mod_op == LDAP_MOD_DELETE) {
906 /* Setting param to NULL instructs OpenLDAP to remove any
907 * value stored for this attribute and remove the attribute
908 * completely. Should multiple instances of an attribute be
909 * allowed in the future param is required to have the value
910 * store for the attribute which is going to be deleted
914 if (mod_op == LDAP_MOD_REPLACE && strcmp(item->value, "") == 0) {
915 /* Having an empty string is considered a syntax error in
916 * ldap. E.g attributes with empty strings are not allowed
917 * in which case we treate this as a request for deleting
920 mod_op = LDAP_MOD_DELETE;
923 if (mod_op == LDAP_MOD_ADD && strcmp(item->value, "") == 0) {
924 /* Adding an empty string is considered a syntax error in
925 * ldap. E.g attributes with empty strings are not allowed
926 * in which case we silently refuse to add this entry
930 SETMOD(mods[cnt], modarr[cnt], mod_op, g_strdup(item->key), attr[cnt], g_strdup(item->value));
932 CHECKED_ATTRIBUTE[index] = TRUE;
936 node = g_list_next(node);
938 char **attribs = ldapctl_full_attribute_array(server->control);
939 for (i = 0; i < ATTRIBUTE_SIZE; i++) {
940 /* Attributes which holds no information are to be removed */
941 if (CHECKED_ATTRIBUTE[i] == FALSE) {
942 /* Only consider those attributes which is currently part of the search criteria.
943 * If attributes are not part of the search criteria they would seem to hold
944 * no information since their values will not be populated in the GUI
946 if (ldapsvr_check_search_attributes(attribs, (char *) ATTRIBUTE[i])) {
947 mod_op = ldapsvr_deside_operation(ld, server, dn, (char *) ATTRIBUTE[i], "");
948 if (mod_op == LDAP_MOD_DELETE) {
949 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_DELETE, g_strdup((char *) ATTRIBUTE[i]), attr[cnt], NULL);
955 ldapctl_free_attribute_array(attribs);
957 if (debug_get_mode())
958 ldapsvr_print_ldapmod(mods);
959 server->retVal = LDAPRC_SUCCESS;
960 rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
963 case LDAP_ALREADY_EXISTS:
964 server->retVal = LDAPRC_ALREADY_EXIST;
967 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n", dn, rc, ldap_err2string(rc));
969 server->retVal = LDAPRC_STRONG_AUTH;
971 server->retVal = LDAPRC_NAMING_VIOLATION;
975 char **attribs = ldapctl_full_attribute_array(server->control);
976 for (i = 0; i < ATTRIBUTE_SIZE; i++) {
977 if (ldapsvr_check_search_attributes(attribs, (char *) ATTRIBUTE[i])) {
978 if (CHECKED_ATTRIBUTE[i] == FALSE) {
979 AddrItemObject *aio = addrcache_get_object(server->addressCache, g_hash_table_lookup(contact , "uid"));
980 ItemPerson *person = (ItemPerson *) aio;
981 addritem_person_remove_attribute(person, (const gchar *) ATTRIBUTE[i]);
985 ldapctl_free_attribute_array(attribs);
990 * Add new contact to LDAP
992 * \param server AddressBook resource
993 * \param contact GHashTable with object to add
995 void ldapsvr_add_contact(LdapServer *server, GHashTable *contact) {
996 gchar *email = NULL, *param = NULL;
998 LDAPMod *mods[MODSIZE];
1001 char *cn[] = {NULL, NULL};
1002 char *displayName[] = {NULL, NULL};
1003 char *givenName[] = {NULL, NULL};
1005 char *sn[] = {NULL, NULL};
1006 char *org[] = {NULL, NULL};
1007 char *obj[] = {/*"top",*/ "person", "organizationalPerson", "inetOrgPerson", NULL};
1010 AttrKeyValue *ou, *commonName;
1015 g_return_if_fail(server != NULL || contact != NULL);
1016 node = g_hash_table_lookup(contact , "mail");
1018 EmailKeyValue *newEmail = node->data;
1019 email = g_strdup(newEmail->mail);
1021 if (email == NULL) {
1022 server->retVal = LDAPRC_NODN;
1023 clean_up(ld, server, contact);
1026 base_dn = g_strdup_printf("mail=%s,%s",
1027 email, server->control->baseDN?server->control->baseDN:"null");
1030 ldapsvr_get_contact(server, g_hash_table_lookup(contact , "uid"));
1031 person->externalID = g_strdup(base_dn);
1032 debug_print("dn: %s\n", base_dn);
1033 ld = ldapsvr_connect(server->control);
1035 clean_up(ld, server, contact);
1036 debug_print("no ldap found\n");
1039 SETMODS(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "objectClass", obj);
1041 ou = get_ou(base_dn);
1043 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, g_strdup(ou->key), org, g_strdup(ou->value));
1045 attrkeyvalue_free(ou);
1048 commonName = get_cn(base_dn);
1049 if (commonName == NULL) {
1050 param = g_hash_table_lookup(contact , "cn");
1052 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "cn", cn, param);
1055 clean_up(ld, server, contact);
1056 debug_print("no CN found\n");
1061 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, g_strdup(commonName->key), cn, g_strdup(commonName->value));
1063 param = g_hash_table_lookup(contact , "cn");
1064 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "displayName", displayName, param);
1065 g_hash_table_insert(contact, "displayName", param);
1066 attrkeyvalue_free(commonName);
1069 param = g_hash_table_lookup(contact , "givenName");
1071 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "givenName", givenName, param);
1074 mailList = g_hash_table_lookup(contact , "mail");
1077 tmp = g_malloc(sizeof(*tmp) * (g_list_length(mailList)+1));
1080 EmailKeyValue *item = mailList->data;
1081 *tmp++ = g_strdup((gchar *) item->mail);
1082 mailList = g_list_next(mailList);
1085 SETMODS(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "mail", mail);
1088 param = g_hash_table_lookup(contact, "sn");
1090 param = g_strdup(N_("Some SN"));
1091 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "sn", sn, param);
1094 if (debug_get_mode()) {
1095 ldapsvr_print_ldapmod(mods);
1097 server->retVal = LDAPRC_SUCCESS;
1098 rc = ldap_add_ext_s(ld, base_dn, mods, NULL, NULL);
1101 case LDAP_ALREADY_EXISTS:
1102 server->retVal = LDAPRC_ALREADY_EXIST;
1105 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n",
1106 base_dn, rc, ldap_err2string(rc));
1108 server->retVal = LDAPRC_STRONG_AUTH;
1110 server->retVal = LDAPRC_NAMING_VIOLATION;
1113 ldapsvr_handle_other_attributes(ld, server, base_dn, contact);
1115 clean_up(ld, server, contact);
1119 * Update contact to LDAP
1121 * \param server AddressBook resource
1122 * \param contact GHashTable with object to update
1124 void ldapsvr_update_contact(LdapServer *server, GHashTable *contact) {
1126 LDAPMod *mods[MODSIZE];
1130 Rdn *NoRemove = NULL;
1131 char *cn[] = {NULL, NULL};
1132 char *givenName[] = {NULL, NULL};
1134 char *sn[] = {NULL, NULL};
1138 g_return_if_fail(server != NULL || contact != NULL);
1139 ld = ldapsvr_connect(server->control);
1141 clean_up(ld, server, contact);
1144 dn = g_hash_table_lookup(contact, "dn");
1146 clean_up(ld, server, contact);
1149 NoRemove = ldapsvr_modify_dn(contact, dn);
1151 /* We are trying to change RDN */
1152 gchar *newRdn = g_strdup_printf("%s=%s", NoRemove->attribute, NoRemove->value);
1153 int rc = ldap_modrdn2_s(ld, dn, newRdn, 1);
1154 if(rc != LDAP_SUCCESS) {
1155 if (rc == LDAP_ALREADY_EXISTS) {
1156 /* We are messing with a contact with more than one listed email
1157 * address and the email we are changing is not the one used for dn
1159 /* It needs to be able to handle renaming errors to an already defined
1160 * dn. For now we just refuse the update. It will be caught later on as
1161 * a LDAPRC_NAMING_VIOLATION error.
1165 g_printerr("Current dn: %s\n", dn);
1166 g_printerr("new dn: %s\n", newRdn);
1167 g_printerr("LDAP Error(ldap_modrdn2_s) failed[0x%x]: %s\n", rc, ldap_err2string(rc));
1169 clean_up(ld, server, contact);
1175 dn = g_strdup(NoRemove->new_dn);
1179 server->retVal = LDAPRC_NODN;
1180 clean_up(ld, server, contact);
1183 param = g_hash_table_lookup(contact , "cn");
1184 mod_op = ldapsvr_deside_operation(ld, server, dn, "displayName", param);
1185 if (mod_op >= 0 && (strcmp(param, NoRemove->value) != 0 && strcmp("cn", NoRemove->attribute) != 0)) {
1186 if (mod_op == LDAP_MOD_DELETE) {
1187 /* Setting param to NULL instructs OpenLDAP to remove any
1188 * value stored for this attribute and remove the attribute
1189 * completely. Should multiple instances of an attribute be
1190 * allowed in the future param is required to have the value
1191 * store for the attribute which is going to be deleted
1195 if (mod_op == LDAP_MOD_REPLACE && strcmp(param, "") == 0) {
1196 /* Having an empty string is considered a syntax error in
1197 * ldap. E.g attributes with empty strings are not allowed
1198 * in which case we treate this as a request for deleting
1201 mod_op = LDAP_MOD_DELETE;
1204 if (mod_op == LDAP_MOD_ADD && strcmp(param, "") == 0) {
1205 /* Adding an empty string is considered a syntax error in
1206 * ldap. E.g attributes with empty strings are not allowed
1207 * in which case we silently refuse to add this entry
1211 SETMOD(mods[cnt], modarr[cnt], mod_op, "displayName", cn, param);
1213 g_hash_table_insert(contact, "displayName", param);
1216 param = g_hash_table_lookup(contact , "givenName");
1217 mod_op = ldapsvr_deside_operation(ld, server, dn, "givenName", param);
1218 if (mod_op >= 0 && (strcmp(param, NoRemove->value) != 0 && strcmp("givenName", NoRemove->attribute) != 0)) {
1219 if (mod_op == LDAP_MOD_DELETE) {
1220 /* Setting param to NULL instructs OpenLDAP to remove any
1221 * value stored for this attribute and remove the attribute
1222 * completely. Should multiple instances of an attribute be
1223 * allowed in the future param is required to have the value
1224 * store for the attribute which is going to be deleted
1228 if (mod_op == LDAP_MOD_REPLACE && strcmp(param, "") == 0) {
1229 /* Having an empty string is considered a syntax error in
1230 * ldap. E.g attributes with empty strings are not allowed
1231 * in which case we treate this as a request for deleting
1234 mod_op = LDAP_MOD_DELETE;
1237 if (mod_op == LDAP_MOD_ADD && strcmp(param, "") == 0) {
1238 /* Adding an empty string is considered a syntax error in
1239 * ldap. E.g attributes with empty strings are not allowed
1240 * in which case we silently refuse to add this entry
1244 SETMOD(mods[cnt], modarr[cnt], mod_op, "givenName", givenName, param);
1248 mailList = g_hash_table_lookup(contact , "mail");
1250 debug_print("# of mail: %d\n", g_list_length(mailList));
1251 if (!(strcmp("mail", NoRemove->attribute) == 0 && g_list_length(mailList) == 1)) {
1253 tmp = g_malloc(sizeof(*tmp) * (g_list_length(mailList)+1));
1256 EmailKeyValue *item = mailList->data;
1257 *tmp++ = g_strdup((gchar *) item->mail);
1258 mailList = g_list_next(mailList);
1262 * At least one email address is required
1263 * in which case it will always be a replace
1265 SETMODS(mods[cnt], modarr[cnt], LDAP_MOD_REPLACE, "mail", mail);
1271 * an error condition since at least one email adress
1272 * is required. Should never occur though.
1275 param = g_hash_table_lookup(contact , "sn");
1276 mod_op = ldapsvr_deside_operation(ld, server, dn, "sn", param);
1277 if (mod_op >= 0 && (strcmp(param, NoRemove->value) != 0 && strcmp("sn", NoRemove->attribute) != 0)) {
1278 if (mod_op == LDAP_MOD_DELETE) {
1279 /* Setting param to NULL instructs OpenLDAP to remove any
1280 * value stored for this attribute and remove the attribute
1281 * completely. Should multiple instances of an attribute be
1282 * allowed in the future param is required to have the value
1283 * store for the attribute which is going to be deleted
1287 if (mod_op == LDAP_MOD_REPLACE && strcmp(param, "") == 0) {
1288 /* Having an empty string is considered a syntax error in
1289 * ldap. E.g attributes with empty strings are not allowed
1290 * in which case we treate this as a request for deleting
1293 mod_op = LDAP_MOD_DELETE;
1296 if (mod_op == LDAP_MOD_ADD && strcmp(param, "") == 0) {
1297 /* Adding an empty string is considered a syntax error in
1298 * ldap. E.g attributes with empty strings are not allowed
1299 * in which case we silently refuse to add this entry
1303 SETMOD(mods[cnt], modarr[cnt], mod_op, "sn", sn, param);
1307 debug_print("newDN: %s\n", dn);
1310 server->retVal = LDAPRC_SUCCESS;
1314 rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
1316 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n",
1317 dn, rc, ldap_err2string(rc));
1318 server->retVal = LDAPRC_NAMING_VIOLATION;
1323 ldapsvr_handle_other_attributes(ld, server, dn, contact);
1324 /* If we do not make changes persistent at this point then changes
1325 * will be lost if the user makes new search on the same server since
1326 * changes are only present in Claws' internal cache. This issue has to
1327 * be solved in addressbook.c since this involves access to structures
1328 * which are only accessible in addressbook.c */
1329 clean_up(ld, server, contact);
1333 * Delete contact from LDAP
1335 * \param server AddressBook resource
1336 * \param contact GHashTable with object to delete
1338 void ldapsvr_delete_contact(LdapServer *server, GHashTable *contact) {
1343 g_return_if_fail(server != NULL || contact != NULL);
1344 ld = ldapsvr_connect(server->control);
1346 clean_up(ld, server, contact);
1349 dn = g_hash_table_lookup(contact, "dn");
1351 clean_up(ld, server, contact);
1354 server->retVal = LDAPRC_SUCCESS;
1355 rc = ldap_delete_ext_s(ld, dn, NULL, NULL);
1357 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n",
1358 dn, rc, ldap_err2string(rc));
1359 server->retVal = LDAPRC_NODN;
1361 clean_up(ld, server, contact);
1365 * Update any changes to the server.
1367 * \param server AddressBook resource.
1368 * \param person ItemPerson holding user input.
1370 void ldapsvr_update_book(LdapServer *server, ItemPerson *item) {
1372 GHashTable *contact = NULL;
1373 GList *contacts = NULL, *head = NULL;
1375 g_return_if_fail(server != NULL);
1376 debug_print("updating ldap addressbook\n");
1378 contact = g_hash_table_new(g_str_hash, g_str_equal);
1380 gboolean result = ldapsvr_retrieve_item_person(item, contact);
1381 debug_print("Found contact to update: %s\n", result? "Yes" : "No");
1383 if (debug_get_mode()) {
1384 addritem_print_item_person(item, stdout);
1386 contacts = g_list_append(contacts, contact);
1390 ItemFolder *folder = server->addressCache->rootFolder;
1391 node = folder->listFolder;
1394 AddrItemObject *aio = node->data;
1396 if (aio->type == ITEMTYPE_FOLDER) {
1397 ItemFolder *folder = (ItemFolder *) aio;
1398 GList *persons = folder->listPerson;
1400 AddrItemObject *aio = persons->data;
1402 if (aio->type == ITEMTYPE_PERSON) {
1403 ItemPerson *item = (ItemPerson *) aio;
1404 gboolean result = ldapsvr_retrieve_item_person(item, contact);
1405 debug_print("Found contact to update: %s\n", result? "Yes" : "No");
1407 if (debug_get_mode()) {
1408 gchar *uid = g_hash_table_lookup(contact, "uid");
1409 item = ldapsvr_get_contact(server, uid);
1410 addritem_print_item_person(item, stdout);
1412 contacts = g_list_append(contacts, contact);
1416 persons = g_list_next(persons);
1421 g_printerr("\t\tpid : ???\n");
1423 node = g_list_next(node);
1428 if (debug_get_mode()) {
1430 debug_print("Contacts which must be updated in LDAP:\n");
1432 debug_print("\tContact:\n");
1433 g_hash_table_foreach(contacts->data,
1434 ldapsvr_print_contacts_hashtable, stderr);
1435 contacts = g_list_next(contacts);
1438 if (contacts == NULL)
1442 contact = (GHashTable *) contacts->data;
1443 status = (gchar *) g_hash_table_lookup(contact, "status");
1445 status = g_strdup("NULL");
1446 if (g_ascii_strcasecmp(status, "new") == 0) {
1447 ldapsvr_add_contact(server, contact);
1449 else if (g_ascii_strcasecmp(status, "update") == 0) {
1450 ldapsvr_update_contact(server, contact);
1452 else if (g_ascii_strcasecmp(status, "delete") == 0) {
1453 ldapsvr_delete_contact(server, contact);
1456 g_critical(_("ldapsvr_update_book->Unknown status: %s\n"), status);
1457 contacts = g_list_next(contacts);
1459 ldapsvr_free_hashtable(head);
1462 #endif /* USE_LDAP */