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 g_hash_table_insert(array, "person", person);
199 node = person->listEMail;
202 EmailKeyValue *newEmail = ldapsvr_retrieve_item_email(node->data);
204 attr = g_list_append(attr, newEmail);
205 node = g_list_next(node);
207 g_hash_table_insert(array, "mail", attr);
208 node = person->listAttrib;
211 AttrKeyValue *newAttr = ldapsvr_retrieve_attribute(node->data);
213 attr = g_list_append(attr, newAttr);
214 node = g_list_next(node);
216 g_hash_table_insert(array, "attribute", attr);
221 * Print contents of contacts hashtable for debug.
222 * This function must be called with g_hash_table_foreach.
223 * \param key Key to process.
224 * \param data Data to process.
225 * \param fd Output stream.
227 void ldapsvr_print_contacts_hashtable(gpointer key, gpointer data, gpointer fd) {
228 gchar *keyName = (gchar *) key;
231 if (g_ascii_strcasecmp("mail", keyName) == 0) {
232 node = (GList *) data;
234 EmailKeyValue *item = node->data;
235 if (debug_get_mode()) {
236 debug_print("\t\talias = %s\n", item->alias?item->alias:"null");
237 debug_print("\t\tmail = %s\n", item->mail?item->mail:"null");
238 debug_print("\t\tremarks = %s\n", item->remarks?item->remarks:"null");
241 FILE *stream = (FILE *) fd;
242 fprintf(stream, "\t\talias = %s\n", item->alias?item->alias:"null");
243 fprintf(stream, "\t\tmail = %s\n", item->mail?item->mail:"null");
244 fprintf(stream, "\t\tremarks = %s\n", item->remarks?item->remarks:"null");
246 node = g_list_next(node);
249 else if (g_ascii_strcasecmp("attribute", keyName) == 0) {
250 node = (GList *) data;
252 AttrKeyValue *item = node->data;
253 if (debug_get_mode()) {
254 debug_print("\t\t%s = %s\n", item->key?item->key:"null",
255 item->value?item->value:"null");
258 FILE *stream = (FILE *) fd;
259 fprintf(stream, "\t\t%s = %s\n", item->key?item->key:"null",
260 item->value?item->value:"null");
262 node = g_list_next(node);
266 if (debug_get_mode())
267 debug_print("\t\t%s = %s\n", keyName?keyName:"null", data?(gchar *)data:"null");
269 FILE *stream = (FILE *) fd;
270 fprintf(stream, "\t\t%s = %s\n", keyName?keyName:"null", data?(gchar *)data:"null");
276 * Free list of changed contacts
278 * \param list List of GHashTable
280 void ldapsvr_free_hashtable(GList *list) {
283 g_hash_table_destroy(tmp->data);
285 tmp = g_list_next(tmp);
292 * Get person object from cache
294 * \param server Resource to LDAP
295 * \param uid PersonID in cache
296 * \return person object, or <i>NULL</i> if fail
298 ItemPerson *ldapsvr_get_contact(LdapServer *server, gchar *uid) {
300 g_return_val_if_fail(server != NULL || uid != NULL, NULL);
301 aio = addrcache_get_object(server->addressCache, uid);
303 if(aio->type == ITEMTYPE_PERSON) {
304 return (ItemPerson *) aio;
311 * Connect to LDAP server.
312 * \param ctl Control object to process.
313 * \return LDAP Resource to LDAP.
315 LDAP *ldapsvr_connect(LdapControl *ctl) {
321 g_return_val_if_fail(ctl != NULL, NULL);
323 ldapsrv_set_options (ctl->timeOut, NULL);
324 uri = g_strdup_printf("ldap%s://%s:%d",
325 ctl->enableSSL?"s":"",
326 ctl->hostName, ctl->port);
327 ldap_initialize(&ld, uri);
334 debug_print("connected to LDAP host %s on port %d\n", ctl->hostName, ctl->port);
338 version = LDAP_VERSION3;
339 rc = ldap_set_option(ld, LDAP_OPT_PROTOCOL_VERSION, &version);
340 if (rc == LDAP_OPT_SUCCESS) {
341 ctl->version = LDAP_VERSION3;
344 if (ctl->version == LDAP_VERSION3) {
345 if (ctl->enableTLS && !ctl->enableSSL) {
346 rc = ldap_start_tls_s(ld, NULL, NULL);
348 if (rc != LDAP_SUCCESS) {
349 g_printerr("LDAP Error(tls): ldap_simple_bind_s: %s\n",
350 ldap_err2string(rc));
357 /* Bind to the server, if required */
359 if (* ctl->bindDN != '\0') {
360 rc = claws_ldap_simple_bind_s(ld, ctl->bindDN, ctl->bindPass);
361 if (rc != LDAP_SUCCESS) {
362 g_printerr("bindDN: %s, bindPass: %s\n", ctl->bindDN, ctl->bindPass);
363 g_printerr("LDAP Error(bind): ldap_simple_bind_s: %s\n",
364 ldap_err2string(rc));
373 * Disconnect to LDAP server.
374 * \param ld Resource to LDAP.
376 void ldapsvr_disconnect(LDAP *ld) {
378 g_return_if_fail(ld != NULL);
379 ldap_unbind_ext(ld, NULL, NULL);
383 * Create an initial Rdn structure
385 * \return empty structure
390 buf = g_new0(Rdn, 1);
391 buf->attribute = NULL;
398 * Free a created Rdn structure
399 * \param rdn Structure to free
401 void rdn_free(Rdn *rdn) {
402 if (rdn->attribute) {
403 g_free(rdn->attribute);
404 rdn->attribute = NULL;
419 * update Rdn structure
421 * \param rdn Rdn structure to update
422 * \param head Uniq part of dn
423 * \param tail Common part of dn
425 void update_rdn(Rdn *rdn, gchar *head, gchar *tail) {
426 rdn->value = g_strdup(head);
427 rdn->new_dn = g_strdup_printf("%s=%s%s", rdn->attribute, head, tail);
431 * Deside if dn needs to be changed
433 * \param hash GHashTable with user input.
434 * \param dn dn for current object
435 * \return Rdn structure
437 Rdn *ldapsvr_modify_dn(GHashTable *hash, gchar *dn) {
439 gchar *pos, *compare;
442 g_return_val_if_fail(hash != NULL || dn != NULL, NULL);
444 pos = g_strstr_len(dn, strlen(dn), "=");
445 compare = g_strndup(dn, pos - dn);
450 rest = g_strstr_len(pos, strlen(pos), ",");
451 val = g_strndup(pos, rest - pos);
458 rdn->value = g_strdup(val);
459 rdn->attribute = g_strdup(compare);
461 if (strcmp("mail", rdn->attribute) == 0) {
462 GList *list = g_hash_table_lookup(hash, rdn->attribute);
464 EmailKeyValue *item = list->data;
465 compare = g_strdup((gchar *) item->mail);
466 if (strcmp(compare, rdn->value) == 0) {
467 update_rdn(rdn, compare, rest);
471 list = g_list_next(list);
473 /* if compare and rdn->attribute are equal then last email removed/empty */
474 if (strcmp(compare, rdn->attribute) != 0) {
475 /* RDN changed. Find new */
476 update_rdn(rdn, compare, rest);
481 /* We cannot remove dn */
488 compare = g_hash_table_lookup(hash, rdn->attribute);
489 /* if compare and rdn->attribute are equal then dn removed/empty */
490 if (strcmp(compare, rdn->attribute) != 0) {
491 update_rdn(rdn, compare, rest);
495 /* We cannot remove dn */
505 * This macro is borrowed from the Balsa project
506 * Creates a LDAPMod structure
508 * \param mods Empty LDAPMod structure
509 * \param modarr Array with values to insert
510 * \param op Operation to perform on LDAP
511 * \param attr Attribute to insert
512 * \param strv Empty array which is NULL terminated
513 * \param val Value for attribute
515 #define SETMOD(mods,modarr,op,attr,strv,val) \
516 do { (mods) = &(modarr); (modarr).mod_type=attr; (modarr).mod_op=op;\
517 (strv)[0]=(val); (modarr).mod_values=strv; \
521 * Creates a LDAPMod structure
523 * \param mods Empty LDAPMod structure
524 * \param modarr Array with values to insert
525 * \param op Operation to perform on LDAP
526 * \param attr Attribute to insert
527 * \param strv Array with values to insert. Must be NULL terminated
529 #define SETMODS(mods,modarr,op,attr,strv) \
530 do { (mods) = &(modarr); (modarr).mod_type=attr; \
531 (modarr).mod_op=op; (modarr).mod_values=strv; \
536 * Clean up, close LDAP connection, and refresh cache
538 * \param ld Resource to LDAP
539 * \param server AddressBook resource
540 * \param contact GHashTable with current changed object
542 void clean_up(LDAP *ld, LdapServer *server, GHashTable *contact) {
544 ldapsvr_get_contact(server, g_hash_table_lookup(contact , "uid"));
547 person->status = NONE;
548 displayName = g_hash_table_lookup(contact, "displayName");
550 person->nickName = g_strdup(displayName);
552 if (server->retVal != LDAPRC_SUCCESS) {
555 addrcache_remove_person(server->addressCache, person);
557 g_critical(N_("ldapsvr_update_book: Could not clean cache\n"));
559 addritem_free_item_person(res);
563 ldapsvr_disconnect(ld);
567 * Get cn attribute from dn
569 * \param dn Distinguesh Name for current object
570 * \return AttrKeyValue, or <i>NULL</i> if none created
572 AttrKeyValue *get_cn(gchar *dn) {
578 g_return_val_if_fail(dn != NULL, NULL);
580 cn = attrkeyvalue_create();
581 start = g_strstr_len(dn, strlen(dn), "cn");
583 attrkeyvalue_free(cn);
586 end = g_strstr_len(start, strlen(start), ",");
587 item = g_strndup(start, end - start);
589 attrkeyvalue_free(cn);
592 key_value = g_strsplit(item, "=", 2);
593 cn->key = g_strdup(key_value[0]);
594 cn->value = g_strdup(key_value[1]);
595 g_strfreev(key_value);
601 * Get mail attribute from dn
603 * \param dn Distinguesh Name for current object
604 * \return AttrKeyValue, or <i>NULL</i> if none created
606 AttrKeyValue *get_mail(gchar *dn) {
612 g_return_val_if_fail(dn != NULL, NULL);
614 mail = attrkeyvalue_create();
615 start = g_strstr_len(dn, strlen(dn), "mail");
617 attrkeyvalue_free(mail);
620 end = g_strstr_len(start, strlen(start), ",");
621 item = g_strndup(start, end - start);
623 attrkeyvalue_free(mail);
626 key_value = g_strsplit(item, "=", 2);
627 mail->key = g_strdup(key_value[0]);
628 mail->value = g_strdup(key_value[1]);
629 g_strfreev(key_value);
635 * Get ou or o attribute from dn
637 * \param dn Distinguesh Name for current object
638 * \return AttrKeyValue, or <i>NULL</i> if none created
640 AttrKeyValue *get_ou(gchar *dn) {
647 g_return_val_if_fail(dn != NULL, NULL);
648 ou = attrkeyvalue_create();
649 start = g_strstr_len(dn, strlen(dn), ",o=");
651 start = g_strstr_len(dn, strlen(dn), ",ou=");
653 attrkeyvalue_free(ou);
657 end = g_strstr_len(start, strlen(start), ",");
658 item = g_strndup(start, end - start);
660 attrkeyvalue_free(ou);
663 key_value = g_strsplit(item, "=", 2);
664 ou->key = g_strdup(key_value[0]);
665 ou->value = g_strdup(key_value[1]);
666 g_strfreev(key_value);
672 * Print the contents of a LDAPMod structure for debuging purposes
674 * \param mods LDAPMod structure
676 void ldapsvr_print_ldapmod(LDAPMod *mods[]) {
680 g_return_if_fail(mods != NULL);
681 g_printerr( "Type\n");
682 for (i = 0; NULL != mods[i]; i++) {
683 LDAPMod *mod = (LDAPMod *) mods[i];
685 switch (mod->mod_op) {
686 case LDAP_MOD_ADD: mod_op = g_strdup("ADD"); break;
687 case LDAP_MOD_REPLACE: mod_op = g_strdup("MODIFY"); break;
688 case LDAP_MOD_DELETE: mod_op = g_strdup("DELETE"); break;
689 default: mod_op = g_strdup("UNKNOWN");
691 g_printerr( "Operation: %s\tType:%s\nValues:\n", mod_op, mod->mod_type);
692 vals = mod->mod_vals.modv_strvals;
694 g_printerr( "\t%s\n", *vals++);
700 * Make a compare for every new value we want to store in the
701 * directory with the current values. Great tool for debugging
702 * against invalid syntax in attributes
704 * \param ld AddressBook resource
705 * \param dn dn for the entry
706 * \param cnt Number of attributes to compare
707 * \param mods LDAPMod structure
709 void ldapsvr_compare_attr(LDAP *ld, gchar *dn, gint cnt, LDAPMod *mods[]) {
712 #ifdef OPEN_LDAP_API_AT_LEAST_3000
718 g_return_if_fail(ld != NULL || dn != NULL || cnt >= 0 || mods != NULL);
719 for (i = 0; i < cnt; i++) {
720 gchar *value = g_strdup(mods[i]->mod_vals.modv_strvals[0]);
721 if (!value || strcmp(value, "") == 0)
722 value = g_strdup("thisisonlyadummy");
724 #ifdef OPEN_LDAP_API_AT_LEAST_3000
727 val.bv_len = strlen(value);
729 rc = ldap_compare_ext_s(ld, dn, mods[i]->mod_type, &val, NULL, NULL);
733 /* This is deprecated as of OpenLDAP-2.3.0 */
734 rc = ldap_compare_s(ld, dn, mods[i]->mod_type, value);
738 g_printerr("ldap_compare for (%s:%s)\" failed[0x%x]: %s\n",
739 mods[i]->mod_type, value, rc, ldap_err2string(rc));
745 * compare attribute to LDAP in case of LDAP_INAPPROPRIATE_MATCHING
747 * \param ld AddressBook resource
748 * \param server Reference to server
749 * \param dn dn for the entry
750 * \param attr Attribute
751 * \param value New value
752 * \return int, return will be LDAP_MOD_ADD, LDAP_MOD_REPLACE, or LDAP_MOD_DELETE
754 int ldapsvr_compare_manual_attr(LDAP *ld, LdapServer *server, gchar *dn, char *attr, char *value) {
755 LDAPMessage *res, *e = NULL;
757 struct berval **vals;
765 g_return_val_if_fail(ld != NULL || server != NULL || attr != NULL, -1);
766 ctl = server->control;
770 filter = g_strdup_printf("(&(mail=%s)(%s=*))", mail->value, attr);
771 attrkeyvalue_free(mail);
774 #ifdef OPEN_LDAP_API_AT_LEAST_3000
776 rc = ldap_search_ext_s(ld, ctl->baseDN, LDAP_SCOPE_ONELEVEL, filter, NULL, 0, NULL, NULL, NULL, 0, &res);
780 /* This is deprecated as of OpenLDAP-2.3.0 */
781 rc = ldap_search_s(ld, ctl->baseDN, LDAP_SCOPE_ONELEVEL, filter, NULL, 0, &res);
786 g_printerr("ldap_search for attr=%s\" failed[0x%x]: %s\n",attr, rc, ldap_err2string(rc));
790 e = ldap_first_entry(ld, res);
791 /* entry has this attribute */
793 attribute = ldap_first_attribute( ld, e, &ber );
796 if( ( vals = ldap_get_values_len( ld, e, attr ) ) != NULL ) {
797 for( i = 0; vals[i] != NULL; i++ ) {
798 debug_print("Compare: %s=%s\n", attr, vals[i]->bv_val);
799 /* attribute has same value */
800 if (strcmp(vals[i]->bv_val, value) == 0)
802 /* attribute has new value */
804 retVal = LDAP_MOD_REPLACE;
807 ldap_value_free_len(vals);
810 retVal = LDAP_MOD_DELETE;
815 ldap_memfree(attribute);
817 /* entry does not have this attribute */
819 /* Only add if this is a real attribute */
821 retVal = LDAP_MOD_ADD;
822 /* This is dummy value used to avoid ldap_compare error */
835 * Deside which kind of operation is required to handle
836 * updating the specified attribute
838 * \param ld AddressBook resource
839 * \param server Reference to server
840 * \param dn dn for the entry
841 * \param attr Attribute
842 * \param value New value
843 * \return int, return will be LDAP_MOD_ADD, LDAP_MOD_REPLACE, or LDAP_MOD_DELETE
845 int ldapsvr_deside_operation(LDAP *ld, LdapServer *server, char *dn, char *attr, char *value) {
847 gboolean dummy = FALSE;
849 #ifdef OPEN_LDAP_API_AT_LEAST_3000
855 g_return_val_if_fail(ld != NULL || server != NULL || dn != NULL || attr != NULL, -1);
858 /* value containing empty string cause invalid syntax. A bug in
859 * the LDAP library? Therefore we add a dummy value
861 if (strcmp(value,"") == 0) {
862 value = g_strdup("thisisonlyadummy");
866 #ifdef OPEN_LDAP_API_AT_LEAST_3000
869 val.bv_len = strlen(value);
871 rc = ldap_compare_ext_s(ld, dn, attr, &val, NULL, NULL);
875 /* This is deprecated as of OpenLDAP-2.3.0 */
876 rc = ldap_compare_s(ld, dn, attr, value);
880 debug_print("ldap_compare for (%s:%s)\" error_code[0x%x]: %s\n",
881 attr, value, rc, ldap_err2string(rc));
883 case LDAP_COMPARE_FALSE:
885 return LDAP_MOD_DELETE;
887 return LDAP_MOD_REPLACE;
888 case LDAP_COMPARE_TRUE: return -1;
889 case LDAP_NO_SUCH_ATTRIBUTE: return LDAP_MOD_ADD;
890 /* LDAP_INAPPROPRIATE_MATCHING needs extensive testing because I
891 * am not aware off the condition causing this return value!
893 case LDAP_INAPPROPRIATE_MATCHING:
896 return ldapsvr_compare_manual_attr(ld, server, dn, attr, value);
897 case LDAP_UNDEFINED_TYPE: return -2;
898 case LDAP_INVALID_SYNTAX: return -2;
904 * Check if attribute is part of the current search criteria
906 * \param list Array containing attributes in the current search criteria
907 * \param attr Attribute to check
908 * \result <i>TRUE</i> if attribute is found in the current search criteria
910 gboolean ldapsvr_check_search_attributes(char **list, char *attr) {
912 if (strcmp(*list++, attr) == 0)
919 * Deside which other attributes needs updating
921 * \param ld LDAP resource
922 * \param server AddressBook resource
923 * \param dn dn for the entry
924 * \param contact GHashTable with information for the current contact
926 void ldapsvr_handle_other_attributes(LDAP *ld, LdapServer *server, char *dn, GHashTable *contact) {
928 gboolean CHECKED_ATTRIBUTE[ATTRIBUTE_SIZE + 1];
929 LDAPMod *mods[ATTRIBUTE_SIZE + 1];
930 LDAPMod modarr[ATTRIBUTE_SIZE];
932 char *attr[ATTRIBUTE_SIZE + 1][2];
935 g_return_if_fail(server != NULL || dn != NULL || contact != NULL);
936 for (i = 0; i <= ATTRIBUTE_SIZE; i++) {
937 CHECKED_ATTRIBUTE[i] = FALSE;
938 attr[i][0] = attr[i][1] = NULL;
940 node = g_hash_table_lookup(contact , "attribute");
942 AttrKeyValue *item = node->data;
944 int index = get_attribute_index(item->key);
946 debug_print("Found other attribute: %s = %s\n",
947 item->key?item->key:"null", item->value?item->value:"null");
948 mod_op = ldapsvr_deside_operation(ld, server, dn, item->key, item->value);
949 /* Only consider attributes which we no how to handle.
950 * Set to TRUE in CHECKED_ATTRIBUTE array to indicate no further action
953 CHECKED_ATTRIBUTE[index] = TRUE;
954 node = g_list_next(node);
957 if (mod_op == LDAP_MOD_DELETE) {
958 /* Setting param to NULL instructs OpenLDAP to remove any
959 * value stored for this attribute and remove the attribute
960 * completely. Should multiple instances of an attribute be
961 * allowed in the future param is required to have the value
962 * store for the attribute which is going to be deleted
966 if (mod_op == LDAP_MOD_REPLACE && strcmp(item->value, "") == 0) {
967 /* Having an empty string is considered a syntax error in
968 * ldap. E.g attributes with empty strings are not allowed
969 * in which case we treate this as a request for deleting
972 mod_op = LDAP_MOD_DELETE;
975 if (mod_op == LDAP_MOD_ADD && strcmp(item->value, "") == 0) {
976 /* Adding an empty string is considered a syntax error in
977 * ldap. E.g attributes with empty strings are not allowed
978 * in which case we silently refuse to add this entry
982 SETMOD(mods[cnt], modarr[cnt], mod_op, g_strdup(item->key), attr[cnt], g_strdup(item->value));
984 CHECKED_ATTRIBUTE[index] = TRUE;
988 node = g_list_next(node);
990 char **attribs = ldapctl_full_attribute_array(server->control);
991 for (i = 0; i < ATTRIBUTE_SIZE; i++) {
992 /* Attributes which holds no information are to be removed */
993 if (CHECKED_ATTRIBUTE[i] == FALSE) {
994 /* Only consider those attributes which is currently part of the search criteria.
995 * If attributes are not part of the search criteria they would seem to hold
996 * no information since their values will not be populated in the GUI
998 if (!strcmp(ATTRIBUTE[i], "jpegPhoto")) {
999 debug_print("not updating jpegPhoto\n");
1002 if (ldapsvr_check_search_attributes(attribs, (char *) ATTRIBUTE[i])) {
1003 mod_op = ldapsvr_deside_operation(ld, server, dn, (char *) ATTRIBUTE[i], "");
1004 if (mod_op == LDAP_MOD_DELETE) {
1005 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_DELETE, g_strdup((char *) ATTRIBUTE[i]), attr[cnt], NULL);
1011 ldapctl_free_attribute_array(attribs);
1013 if (debug_get_mode())
1014 ldapsvr_print_ldapmod(mods);
1015 server->retVal = LDAPRC_SUCCESS;
1016 rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
1019 case LDAP_ALREADY_EXISTS:
1020 server->retVal = LDAPRC_ALREADY_EXIST;
1023 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n", dn, rc, ldap_err2string(rc));
1025 server->retVal = LDAPRC_STRONG_AUTH;
1027 server->retVal = LDAPRC_NAMING_VIOLATION;
1031 char **attribs = ldapctl_full_attribute_array(server->control);
1032 for (i = 0; i < ATTRIBUTE_SIZE; i++) {
1033 if (!strcmp(ATTRIBUTE[i], "jpegPhoto")) {
1034 debug_print("not updating jpegPhoto\n");
1037 if (ldapsvr_check_search_attributes(attribs, (char *) ATTRIBUTE[i])) {
1038 if (CHECKED_ATTRIBUTE[i] == FALSE) {
1039 AddrItemObject *aio = addrcache_get_object(server->addressCache, g_hash_table_lookup(contact , "uid"));
1040 ItemPerson *person = (ItemPerson *) aio;
1041 addritem_person_remove_attribute(person, (const gchar *) ATTRIBUTE[i]);
1045 ldapctl_free_attribute_array(attribs);
1050 * Add new contact to LDAP
1052 * \param server AddressBook resource
1053 * \param contact GHashTable with object to add
1055 void ldapsvr_add_contact(LdapServer *server, GHashTable *contact) {
1056 gchar *email = NULL, *param = NULL;
1058 LDAPMod *mods[MODSIZE];
1061 char *cn[] = {NULL, NULL};
1062 char *displayName[] = {NULL, NULL};
1063 char *givenName[] = {NULL, NULL};
1065 char *sn[] = {NULL, NULL};
1066 char *org[] = {NULL, NULL};
1067 char *obj[] = {/*"top",*/ "person", "organizationalPerson", "inetOrgPerson", NULL};
1070 AttrKeyValue *ou, *commonName;
1075 g_return_if_fail(server != NULL || contact != NULL);
1076 node = g_hash_table_lookup(contact , "mail");
1078 EmailKeyValue *newEmail = node->data;
1079 email = g_strdup(newEmail->mail);
1081 if (email == NULL) {
1082 server->retVal = LDAPRC_NODN;
1083 clean_up(ld, server, contact);
1086 base_dn = g_strdup_printf("mail=%s,%s",
1087 email, server->control->baseDN?server->control->baseDN:"null");
1090 ldapsvr_get_contact(server, g_hash_table_lookup(contact , "uid"));
1091 person->externalID = g_strdup(base_dn);
1092 debug_print("dn: %s\n", base_dn);
1093 ld = ldapsvr_connect(server->control);
1095 clean_up(ld, server, contact);
1096 debug_print("no ldap found\n");
1099 SETMODS(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "objectClass", obj);
1101 ou = get_ou(base_dn);
1103 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, g_strdup(ou->key), org, g_strdup(ou->value));
1105 attrkeyvalue_free(ou);
1108 commonName = get_cn(base_dn);
1109 if (commonName == NULL) {
1110 param = g_hash_table_lookup(contact , "cn");
1112 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "cn", cn, param);
1115 clean_up(ld, server, contact);
1116 debug_print("no CN found\n");
1121 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, g_strdup(commonName->key), cn, g_strdup(commonName->value));
1123 param = g_hash_table_lookup(contact , "cn");
1124 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "displayName", displayName, param);
1125 g_hash_table_insert(contact, "displayName", param);
1126 attrkeyvalue_free(commonName);
1129 param = g_hash_table_lookup(contact , "givenName");
1131 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "givenName", givenName, param);
1134 mailList = g_hash_table_lookup(contact , "mail");
1137 tmp = g_malloc(sizeof(*tmp) * (g_list_length(mailList)+1));
1140 EmailKeyValue *item = mailList->data;
1141 *tmp++ = g_strdup((gchar *) item->mail);
1142 mailList = g_list_next(mailList);
1145 SETMODS(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "mail", mail);
1148 param = g_hash_table_lookup(contact, "sn");
1150 param = g_strdup(N_("Some SN"));
1151 SETMOD(mods[cnt], modarr[cnt], LDAP_MOD_ADD, "sn", sn, param);
1154 if (debug_get_mode()) {
1155 ldapsvr_print_ldapmod(mods);
1157 server->retVal = LDAPRC_SUCCESS;
1158 rc = ldap_add_ext_s(ld, base_dn, mods, NULL, NULL);
1161 case LDAP_ALREADY_EXISTS:
1162 server->retVal = LDAPRC_ALREADY_EXIST;
1165 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n",
1166 base_dn, rc, ldap_err2string(rc));
1168 server->retVal = LDAPRC_STRONG_AUTH;
1170 server->retVal = LDAPRC_NAMING_VIOLATION;
1173 ldapsvr_handle_other_attributes(ld, server, base_dn, contact);
1175 clean_up(ld, server, contact);
1179 * Update contact to LDAP
1181 * \param server AddressBook resource
1182 * \param contact GHashTable with object to update
1184 void ldapsvr_update_contact(LdapServer *server, GHashTable *contact) {
1186 LDAPMod *mods[MODSIZE];
1190 Rdn *NoRemove = NULL;
1191 char *cn[] = {NULL, NULL};
1192 char *givenName[] = {NULL, NULL};
1194 char *sn[] = {NULL, NULL};
1198 g_return_if_fail(server != NULL || contact != NULL);
1199 ld = ldapsvr_connect(server->control);
1201 clean_up(ld, server, contact);
1204 dn = g_hash_table_lookup(contact, "dn");
1207 clean_up(ld, server, contact);
1210 NoRemove = ldapsvr_modify_dn(contact, dn);
1212 /* We are trying to change RDN */
1213 gchar *newRdn = g_strdup_printf("%s=%s", NoRemove->attribute, NoRemove->value);
1215 #ifdef OPEN_LDAP_API_AT_LEAST_3000
1217 int rc = ldap_rename_s(ld, dn, newRdn, NULL, 1, NULL, NULL);
1221 /* This is deprecated as of OpenLDAP-2.3.0 */
1222 int rc = ldap_modrdn2_s(ld, dn, newRdn, 1);
1226 if(rc != LDAP_SUCCESS) {
1227 if (rc == LDAP_ALREADY_EXISTS) {
1228 /* We are messing with a contact with more than one listed email
1229 * address and the email we are changing is not the one used for dn
1231 /* It needs to be able to handle renaming errors to an already defined
1232 * dn. For now we just refuse the update. It will be caught later on as
1233 * a LDAPRC_NAMING_VIOLATION error.
1237 g_printerr("Current dn: %s\n", dn);
1238 g_printerr("new dn: %s\n", newRdn);
1239 g_printerr("LDAP Error(ldap_modrdn2_s) failed[0x%x]: %s\n", rc, ldap_err2string(rc));
1241 clean_up(ld, server, contact);
1246 ItemPerson *person = g_hash_table_lookup(contact, "person");
1248 dn = g_strdup(NoRemove->new_dn);
1249 g_hash_table_replace(contact, "dn", dn);
1251 g_free(person->externalID);
1252 person->externalID = dn;
1257 server->retVal = LDAPRC_NODN;
1258 clean_up(ld, server, contact);
1261 param = g_hash_table_lookup(contact , "cn");
1262 mod_op = ldapsvr_deside_operation(ld, server, dn, "displayName", param);
1263 if (mod_op >= 0 && (strcmp(param, NoRemove->value) != 0 && strcmp("cn", NoRemove->attribute) != 0)) {
1264 if (mod_op == LDAP_MOD_DELETE) {
1265 /* Setting param to NULL instructs OpenLDAP to remove any
1266 * value stored for this attribute and remove the attribute
1267 * completely. Should multiple instances of an attribute be
1268 * allowed in the future param is required to have the value
1269 * store for the attribute which is going to be deleted
1273 if (mod_op == LDAP_MOD_REPLACE && strcmp(param, "") == 0) {
1274 /* Having an empty string is considered a syntax error in
1275 * ldap. E.g attributes with empty strings are not allowed
1276 * in which case we treate this as a request for deleting
1279 mod_op = LDAP_MOD_DELETE;
1282 if (mod_op == LDAP_MOD_ADD && strcmp(param, "") == 0) {
1283 /* Adding an empty string is considered a syntax error in
1284 * ldap. E.g attributes with empty strings are not allowed
1285 * in which case we silently refuse to add this entry
1289 SETMOD(mods[cnt], modarr[cnt], mod_op, "displayName", cn, param);
1291 g_hash_table_insert(contact, "displayName", param);
1294 param = g_hash_table_lookup(contact , "givenName");
1295 mod_op = ldapsvr_deside_operation(ld, server, dn, "givenName", param);
1296 if (mod_op >= 0 && (strcmp(param, NoRemove->value) != 0 && strcmp("givenName", NoRemove->attribute) != 0)) {
1297 if (mod_op == LDAP_MOD_DELETE) {
1298 /* Setting param to NULL instructs OpenLDAP to remove any
1299 * value stored for this attribute and remove the attribute
1300 * completely. Should multiple instances of an attribute be
1301 * allowed in the future param is required to have the value
1302 * store for the attribute which is going to be deleted
1306 if (mod_op == LDAP_MOD_REPLACE && strcmp(param, "") == 0) {
1307 /* Having an empty string is considered a syntax error in
1308 * ldap. E.g attributes with empty strings are not allowed
1309 * in which case we treate this as a request for deleting
1312 mod_op = LDAP_MOD_DELETE;
1315 if (mod_op == LDAP_MOD_ADD && strcmp(param, "") == 0) {
1316 /* Adding an empty string is considered a syntax error in
1317 * ldap. E.g attributes with empty strings are not allowed
1318 * in which case we silently refuse to add this entry
1322 SETMOD(mods[cnt], modarr[cnt], mod_op, "givenName", givenName, param);
1326 mailList = g_hash_table_lookup(contact , "mail");
1328 debug_print("# of mail: %d\n", g_list_length(mailList));
1329 if (!(strcmp("mail", NoRemove->attribute) == 0 && g_list_length(mailList) == 1)) {
1331 tmp = g_malloc(sizeof(*tmp) * (g_list_length(mailList)+1));
1334 EmailKeyValue *item = mailList->data;
1335 *tmp++ = g_strdup((gchar *) item->mail);
1336 mailList = g_list_next(mailList);
1340 * At least one email address is required
1341 * in which case it will always be a replace
1343 SETMODS(mods[cnt], modarr[cnt], LDAP_MOD_REPLACE, "mail", mail);
1349 * an error condition since at least one email adress
1350 * is required. Should never occur though.
1353 param = g_hash_table_lookup(contact , "sn");
1354 mod_op = ldapsvr_deside_operation(ld, server, dn, "sn", param);
1355 if (mod_op >= 0 && (strcmp(param, NoRemove->value) != 0 && strcmp("sn", NoRemove->attribute) != 0)) {
1356 if (mod_op == LDAP_MOD_DELETE) {
1357 /* Setting param to NULL instructs OpenLDAP to remove any
1358 * value stored for this attribute and remove the attribute
1359 * completely. Should multiple instances of an attribute be
1360 * allowed in the future param is required to have the value
1361 * store for the attribute which is going to be deleted
1365 if (mod_op == LDAP_MOD_REPLACE && strcmp(param, "") == 0) {
1366 /* Having an empty string is considered a syntax error in
1367 * ldap. E.g attributes with empty strings are not allowed
1368 * in which case we treate this as a request for deleting
1371 mod_op = LDAP_MOD_DELETE;
1374 if (mod_op == LDAP_MOD_ADD && strcmp(param, "") == 0) {
1375 /* Adding an empty string is considered a syntax error in
1376 * ldap. E.g attributes with empty strings are not allowed
1377 * in which case we silently refuse to add this entry
1381 SETMOD(mods[cnt], modarr[cnt], mod_op, "sn", sn, param);
1385 debug_print("newDN: %s\n", dn);
1388 server->retVal = LDAPRC_SUCCESS;
1392 rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
1394 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n",
1395 dn, rc, ldap_err2string(rc));
1396 server->retVal = LDAPRC_NAMING_VIOLATION;
1401 ldapsvr_handle_other_attributes(ld, server, dn, contact);
1402 /* If we do not make changes persistent at this point then changes
1403 * will be lost if the user makes new search on the same server since
1404 * changes are only present in Claws' internal cache. This issue has to
1405 * be solved in addressbook.c since this involves access to structures
1406 * which are only accessible in addressbook.c */
1407 clean_up(ld, server, contact);
1411 * Delete contact from LDAP
1413 * \param server AddressBook resource
1414 * \param contact GHashTable with object to delete
1416 void ldapsvr_delete_contact(LdapServer *server, GHashTable *contact) {
1421 g_return_if_fail(server != NULL || contact != NULL);
1422 ld = ldapsvr_connect(server->control);
1424 clean_up(ld, server, contact);
1427 dn = g_hash_table_lookup(contact, "dn");
1429 clean_up(ld, server, contact);
1432 server->retVal = LDAPRC_SUCCESS;
1433 rc = ldap_delete_ext_s(ld, dn, NULL, NULL);
1435 g_printerr("ldap_modify for dn=%s\" failed[0x%x]: %s\n",
1436 dn, rc, ldap_err2string(rc));
1437 server->retVal = LDAPRC_NODN;
1439 clean_up(ld, server, contact);
1443 * Update any changes to the server.
1445 * \param server AddressBook resource.
1446 * \param person ItemPerson holding user input.
1448 void ldapsvr_update_book(LdapServer *server, ItemPerson *item) {
1450 GHashTable *contact = NULL;
1451 GList *contacts = NULL, *head = NULL;
1453 g_return_if_fail(server != NULL);
1454 debug_print("updating ldap addressbook\n");
1456 contact = g_hash_table_new(g_str_hash, g_str_equal);
1458 gboolean result = ldapsvr_retrieve_item_person(item, contact);
1459 debug_print("Found contact to update: %s\n", result? "Yes" : "No");
1461 if (debug_get_mode()) {
1462 addritem_print_item_person(item, stdout);
1464 contacts = g_list_append(contacts, contact);
1468 ItemFolder *folder = server->addressCache->rootFolder;
1469 node = folder->listFolder;
1472 AddrItemObject *aio = node->data;
1474 if (aio->type == ITEMTYPE_FOLDER) {
1475 ItemFolder *folder = (ItemFolder *) aio;
1476 GList *persons = folder->listPerson;
1478 AddrItemObject *aio = persons->data;
1480 if (aio->type == ITEMTYPE_PERSON) {
1481 ItemPerson *item = (ItemPerson *) aio;
1482 gboolean result = ldapsvr_retrieve_item_person(item, contact);
1483 debug_print("Found contact to update: %s\n", result? "Yes" : "No");
1485 if (debug_get_mode()) {
1486 gchar *uid = g_hash_table_lookup(contact, "uid");
1487 item = ldapsvr_get_contact(server, uid);
1488 addritem_print_item_person(item, stdout);
1490 contacts = g_list_append(contacts, contact);
1494 persons = g_list_next(persons);
1499 g_printerr("\t\tpid : ???\n");
1501 node = g_list_next(node);
1506 if (debug_get_mode()) {
1508 debug_print("Contacts which must be updated in LDAP:\n");
1510 debug_print("\tContact:\n");
1511 g_hash_table_foreach(contacts->data,
1512 ldapsvr_print_contacts_hashtable, stderr);
1513 contacts = g_list_next(contacts);
1516 if (contacts == NULL)
1520 contact = (GHashTable *) contacts->data;
1521 status = (gchar *) g_hash_table_lookup(contact, "status");
1523 status = g_strdup("NULL");
1524 if (g_ascii_strcasecmp(status, "new") == 0) {
1525 ldapsvr_add_contact(server, contact);
1527 else if (g_ascii_strcasecmp(status, "update") == 0) {
1528 ldapsvr_update_contact(server, contact);
1530 else if (g_ascii_strcasecmp(status, "delete") == 0) {
1531 ldapsvr_delete_contact(server, contact);
1534 g_critical(_("ldapsvr_update_book->Unknown status: %s\n"), status);
1535 contacts = g_list_next(contacts);
1537 ldapsvr_free_hashtable(head);
1540 #endif /* USE_LDAP */