/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 2003 Match Grun
+ * Copyright (C) 2003-2007 Match Grun and the Claws Mail team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
*/
/*
#include "ldapctrl.h"
#include "mgutils.h"
+#include "editaddress_other_attributes_ldap.h"
+#include "common/utils.h"
/**
* Create new LDAP control block object.
ctl->attribCName = g_strdup( LDAPCTL_ATTR_COMMONNAME );
ctl->attribFName = g_strdup( LDAPCTL_ATTR_GIVENNAME );
ctl->attribLName = g_strdup( LDAPCTL_ATTR_SURNAME );
+ ctl->attribDName = g_strdup( LDAPCTL_ATTR_DISPLAYNAME );
ctl->maxEntries = LDAPCTL_MAX_ENTRIES;
ctl->timeOut = LDAPCTL_DFL_TIMEOUT;
ctl->maxQueryAge = LDAPCTL_DFL_QUERY_AGE;
+ ctl->matchingOption = LDAPCTL_MATCH_BEGINWITH;
+ ctl->version = 0;
+ ctl->enableTLS = FALSE;
+ ctl->enableSSL = FALSE;
/* Mutex to protect control block */
ctl->mutexCtl = g_malloc0( sizeof( pthread_mutex_t ) );
void ldapctl_set_host( LdapControl* ctl, const gchar *value ) {
ctl->hostName = mgu_replace_string( ctl->hostName, value );
g_strstrip( ctl->hostName );
+ debug_print("setting hostname: %s\n", ctl->hostName);
}
/**
else {
ctl->port = LDAPCTL_DFL_PORT;
}
+ debug_print("setting port: %d\n", ctl->port);
}
/**
void ldapctl_set_base_dn( LdapControl* ctl, const gchar *value ) {
ctl->baseDN = mgu_replace_string( ctl->baseDN, value );
g_strstrip( ctl->baseDN );
+ debug_print("setting baseDN: %s\n", ctl->baseDN);
}
/**
void ldapctl_set_bind_dn( LdapControl* ctl, const gchar *value ) {
ctl->bindDN = mgu_replace_string( ctl->bindDN, value );
g_strstrip( ctl->bindDN );
+ debug_print("setting bindDN: %s\n", ctl->bindDN);
}
/**
void ldapctl_set_bind_password( LdapControl* ctl, const gchar *value ) {
ctl->bindPass = mgu_replace_string( ctl->bindPass, value );
g_strstrip( ctl->bindPass );
+ debug_print("setting bindPassword");
}
/**
else {
ctl->maxEntries = LDAPCTL_MAX_ENTRIES;
}
+ debug_print("setting maxEntries: %d\n", ctl->maxEntries);
}
/**
else {
ctl->timeOut = LDAPCTL_DFL_TIMEOUT;
}
+ debug_print("setting timeOut: %d\n", ctl->timeOut);
}
/**
else {
ctl->maxQueryAge = value;
}
+ debug_print("setting maxAge: %d\n", ctl->maxQueryAge);
}
/**
- * Specify search criteria list to be used.
- * \param ctl Control data object.
- * \param value Linked list of LDAP attribute names to use for search.
+ * Specify matching option to be used for searches.
+ * \param ctl Control object to process.
+ * \param value Matching option, as follows:
+ * <ul>
+ * <li><code>LDAPCTL_MATCH_BEGINWITH</code> for "begins with" search</li>
+ * <li><code>LDAPCTL_MATCH_CONTAINS</code> for "contains" search</li>
+ * </ul>
*/
-void ldapctl_set_criteria_list( LdapControl* ctl, GList *value ) {
- g_return_if_fail( ctl != NULL );
- mgu_free_dlist( ctl->listCriteria );
- ctl->listCriteria = value;
+void ldapctl_set_matching_option( LdapControl* ctl, const gint value ) {
+ if( value < LDAPCTL_MATCH_BEGINWITH ) {
+ ctl->matchingOption = LDAPCTL_MATCH_BEGINWITH;
+ }
+ else if( value > LDAPCTL_MATCH_CONTAINS ) {
+ ctl->matchingOption = LDAPCTL_MATCH_BEGINWITH;
+ }
+ else {
+ ctl->matchingOption = value;
+ }
+ debug_print("setting matchingOption: %d\n", ctl->matchingOption);
+}
+
+/**
+ * Specify TLS option.
+ * \param ctl Control object to process.
+ * \param value <i>TRUE</i> to enable TLS.
+ */
+void ldapctl_set_tls( LdapControl* ctl, const gboolean value ) {
+ ctl->enableTLS = value;
+ debug_print("setting TLS: %d\n", ctl->enableTLS);
+}
+
+void ldapctl_set_ssl( LdapControl* ctl, const gboolean value ) {
+ ctl->enableSSL = value;
+ debug_print("setting SSL: %d\n", ctl->enableSSL);
}
/**
g_return_if_fail( ctl != NULL );
if( attr != NULL ) {
if( mgu_list_test_unq_nc( ctl->listCriteria, attr ) ) {
+ debug_print("adding to criteria list: %s\n", attr);
ctl->listCriteria = g_list_append(
ctl->listCriteria, g_strdup( attr ) );
}
}
}
-/**
- * Build criteria list using default attributes.
- * \param ctl Control object to process.
- */
-void ldapctl_default_attributes( LdapControl *ctl ) {
- g_return_if_fail( ctl != NULL );
-
- ldapctl_criteria_list_clear( ctl );
- ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_COMMONNAME );
- ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_GIVENNAME );
- ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_SURNAME );
- ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_EMAIL );
-}
-
/**
* Clear LDAP server member variables.
* \param ctl Control object to clear.
*/
-void ldapctl_clear( LdapControl *ctl ) {
+static void ldapctl_clear( LdapControl *ctl ) {
g_return_if_fail( ctl != NULL );
+ debug_print("clearing ldap controller members\n");
/* Free internal stuff */
g_free( ctl->hostName );
g_free( ctl->baseDN );
g_free( ctl->attribCName );
g_free( ctl->attribFName );
g_free( ctl->attribLName );
+ g_free( ctl->attribDName );
ldapctl_criteria_list_clear( ctl );
ctl->attribCName = NULL;
ctl->attribFName = NULL;
ctl->attribLName = NULL;
+ ctl->attribDName = NULL;
ctl->maxEntries = 0;
ctl->timeOut = 0;
ctl->maxQueryAge = 0;
+ ctl->matchingOption = LDAPCTL_MATCH_BEGINWITH;
+ ctl->version = 0;
+ ctl->enableTLS = FALSE;
+ ctl->enableSSL = FALSE;
}
/**
void ldapctl_free( LdapControl *ctl ) {
g_return_if_fail( ctl != NULL );
+ debug_print("releasing requested memory for ldap controller\n");
/* Free internal stuff */
ldapctl_clear( ctl );
g_free( ctl );
}
-/**
- * Setup default (empty) values for specified object.
- * \param ctl Control object to process.
- */
-void ldapctl_default_values( LdapControl *ctl ) {
- g_return_if_fail( ctl != NULL );
-
- /* Clear our destination */
- ldapctl_clear( ctl );
-
- /* Copy strings */
- ctl->hostName = g_strdup( "" );
- ctl->baseDN = g_strdup( "" );
- ctl->bindDN = g_strdup( "" );
- ctl->bindPass = g_strdup( "" );
- ctl->port = LDAPCTL_DFL_PORT;
- ctl->maxEntries = LDAPCTL_MAX_ENTRIES;
- ctl->timeOut = LDAPCTL_DFL_TIMEOUT;
- ctl->maxQueryAge = LDAPCTL_DFL_QUERY_AGE;
-
- ldapctl_default_attributes( ctl );
-}
-
/**
* Display object to specified stream.
* \param ctl Control object to process.
fprintf( stream, "attr comn: '%s'\n", ctl->attribCName );
fprintf( stream, "attr frst: '%s'\n", ctl->attribFName );
fprintf( stream, "attr last: '%s'\n", ctl->attribLName );
+ fprintf( stream, "attr disn: '%s'\n", ctl->attribDName );
fprintf( stream, "max entry: %d\n", ctl->maxEntries );
fprintf( stream, " timeout: %d\n", ctl->timeOut );
fprintf( stream, " max age: %d\n", ctl->maxQueryAge );
+ fprintf( stream, "match opt: %d\n", ctl->matchingOption );
+ fprintf( stream, " version: %d\n", ctl->version );
+ fprintf( stream, " TLS: %s\n", ctl->enableTLS ? "yes" : "no" );
+ fprintf( stream, " SSL: %s\n", ctl->enableSSL ? "yes" : "no" );
fprintf( stream, "crit list:\n" );
if( ctl->listCriteria ) {
mgu_print_dlist( ctl->listCriteria, stream );
g_return_if_fail( ctlFrom != NULL );
g_return_if_fail( ctlTo != NULL );
+ debug_print("ldap controller copy\n");
/* Lock both objects */
pthread_mutex_lock( ctlFrom->mutexCtl );
pthread_mutex_lock( ctlTo->mutexCtl );
ctlTo->attribCName = g_strdup( ctlFrom->attribCName );
ctlTo->attribFName = g_strdup( ctlFrom->attribFName );
ctlTo->attribLName = g_strdup( ctlFrom->attribLName );
+ ctlTo->attribDName = g_strdup( ctlFrom->attribDName );
/* Copy search criteria */
node = ctlFrom->listCriteria;
ctlTo->maxEntries = ctlFrom->maxEntries;
ctlTo->timeOut = ctlFrom->timeOut;
ctlTo->maxQueryAge = ctlFrom->maxQueryAge;
+ ctlTo->matchingOption = ctlFrom->matchingOption;
+ ctlTo->version = ctlFrom->version;
+ ctlTo->enableTLS = ctlFrom->enableTLS;
+ ctlTo->enableSSL = ctlFrom->enableSSL;
/* Unlock */
pthread_mutex_unlock( ctlTo->mutexCtl );
pthread_mutex_unlock( ctlFrom->mutexCtl );
}
+/**
+ * Search criteria fragment - two terms - begin with (default).
+ */
+static gchar *_criteria2BeginWith = "(&(givenName=%s*)(sn=%s*))";
+
+/**
+ * Search criteria fragment - two terms - contains.
+ */
+static gchar *_criteria2Contains = "(&(givenName=*%s*)(sn=*%s*))";
+
/**
* Create an LDAP search criteria by parsing specified search term. The search
* term may contain two names separated by the first embedded space found in
* the search term. It is assumed that the two tokens are first name and last
* name, or vice versa. An appropriate search criteria will be constructed.
*
- * \param searchTerm Reference to search term to process.
+ * \param searchTerm Reference to search term to process.
+ * \param matchOption Set to the following:
+ * <ul>
+ * <li><code>LDAPCTL_MATCH_BEGINWITH</code> for "begins with" search</li>
+ * <li><code>LDAPCTL_MATCH_CONTAINS</code> for "contains" search</li>
+ * </ul>
+ *
* \return Formatted search criteria, or <code>NULL</code> if there is no
* embedded spaces. The search term should be g_free() when no
* longer required.
*/
-static gchar *ldapctl_build_ldap_criteria( gchar *searchTerm ) {
+static gchar *ldapctl_build_ldap_criteria(
+ const gchar *searchTerm, const gint matchOption )
+{
gchar *p;
gchar *t1;
gchar *t2 = NULL;
gchar *term;
gchar *crit = NULL;
+ gchar *criteriaFmt;
+
+ if( matchOption == LDAPCTL_MATCH_CONTAINS ) {
+ criteriaFmt = _criteria2Contains;
+ }
+ else {
+ criteriaFmt = _criteria2BeginWith;
+ }
term = g_strdup( searchTerm );
g_strstrip( term );
gchar *p1, *p2;
g_strstrip( t2 );
- p1 = g_strdup_printf( "(&(givenName=%s*)(sn=%s*))", t1, t2 );
- p2 = g_strdup_printf( "(&(givenName=%s*)(sn=%s*))", t2, t1 );
+ p1 = g_strdup_printf( criteriaFmt, t1, t2 );
+ p2 = g_strdup_printf( criteriaFmt, t2, t1 );
crit = g_strdup_printf( "(&(|%s%s)(mail=*))", p1, p2 );
g_free( t2 );
g_free( p2 );
}
g_free( term );
+ debug_print("search criteria: %s\n", crit);
return crit;
}
+
+/**
+ * Search criteria fragment - single term - begin with (default).
+ */
+static gchar *_criteriaBeginWith = "(%s=%s*)";
+
+/**
+ * Search criteria fragment - single term - contains.
+ */
+static gchar *_criteriaContains = "(%s=*%s*)";
+
/**
* Build a formatted LDAP search criteria string from criteria list.
* \param ctl Control object to process.
gchar *ldapctl_format_criteria( LdapControl *ctl, const gchar *searchVal ) {
GList *node;
gchar *p1, *p2, *retVal;
+ gchar *criteriaFmt;
g_return_val_if_fail( ctl != NULL, NULL );
g_return_val_if_fail( searchVal != NULL, NULL );
/* Test whether there are more that one search terms */
- retVal = ldapctl_build_ldap_criteria( searchVal );
+ retVal = ldapctl_build_ldap_criteria( searchVal, ctl->matchingOption );
if( retVal ) return retVal;
+ if( ctl->matchingOption == LDAPCTL_MATCH_CONTAINS ) {
+ criteriaFmt = _criteriaContains;
+ }
+ else {
+ criteriaFmt = _criteriaBeginWith;
+ }
+
/* No - just a simple search */
/* p1 contains previous formatted criteria */
/* p2 contains next formatted criteria */
node = ctl->listCriteria;
while( node ) {
gchar *attr, *tmp;
-
attr = node->data;
node = g_list_next( node );
gchar *crit;
/* Format query criteria */
- crit = g_strdup_printf( "(%s=%s*)", attr, searchVal );
+ crit = g_strdup_printf( criteriaFmt, attr, searchVal );
/* Append to existing criteria */
g_free( p2 );
}
else {
/* First time through - Format query criteria */
- p2 = g_strdup_printf( "(%s=%s*)", attr, searchVal );
+ p2 = g_strdup_printf( criteriaFmt, attr, searchVal );
}
}
retVal = p2;
g_free( p1 );
}
+ debug_print("current search string: %s\n", retVal);
return retVal;
}
*/
char **ldapctl_attribute_array( LdapControl *ctl ) {
char **ptrArray;
- GList *node;
+ GList *node, *def;
gint cnt, i;
g_return_val_if_fail( ctl != NULL, NULL );
+ def = ldapctl_get_default_criteria_list();
+ /* check if this servers config is updated to the new
+ * default list of search criteria. If not update the list */
+ if (! ldapctl_compare_list(ctl->listCriteria, def)) {
+ /* Deep copy search criteria */
+ ldapctl_criteria_list_clear(ctl);
+ while(def) {
+ ctl->listCriteria = g_list_append(
+ ctl->listCriteria, g_strdup(def->data));
+ def = g_list_next(def);
+ }
+ }
+ node = ctl->listCriteria;
cnt = g_list_length( ctl->listCriteria );
ptrArray = g_new0( char *, 1 + cnt );
i = 0;
- node = ctl->listCriteria;
while( node ) {
ptrArray[ i++ ] = node->data;
+ /*debug_print("adding search attribute: %s\n", (gchar *) node->data);*/
node = g_list_next( node );
}
ptrArray[ i ] = NULL;
}
}
+/**
+ * Return the default LDAP search criteria string.
+ * \return Formatted string or <i>""</i>. Should be g_free() when done.
+ */
+gchar *ldapctl_get_default_criteria() {
+ gchar *retVal = g_strdup(LDAPCTL_DFL_ATTR_LIST);
+ const gchar **attrs = ATTRIBUTE;
+
+ while (*attrs) {
+ gchar *tmp = g_strdup_printf("%s, %s", retVal, *attrs++);
+ g_free(retVal);
+ retVal = tmp;
+ }
+ debug_print("default search criteria: %s\n", retVal);
+ return retVal;
+}
+
+/**
+ * Return the default LDAP search criteria list.
+ * \return GList or <i>NULL</i>.
+ */
+GList *ldapctl_get_default_criteria_list() {
+ gchar *criteria, *item;
+ gchar **c_list, **w_list;
+ GList *attr_list = NULL;
+
+ criteria = ldapctl_get_default_criteria();
+ c_list = g_strsplit(criteria, " ", 0);
+ g_free(criteria);
+ criteria = NULL;
+ w_list = c_list;
+ while ((criteria = *w_list++) != 0) {
+ /* copy string elimination <,> */
+ if (*w_list)
+ item = g_strndup(criteria, strlen(criteria) - 1);
+ else
+ item = g_strdup(criteria);
+ debug_print("adding attribute to list: %s\n", item);
+ attr_list = g_list_append(attr_list, g_strdup(item));
+ g_free(item);
+ }
+ g_strfreev(c_list);
+ return attr_list;
+}
+
+/**
+ * Compare to GList for equality.
+ * \param l1 First GList
+ * \param l2 Second GList
+ * \Return TRUE or FALSE
+ */
+gboolean ldapctl_compare_list(GList *l1, GList *l2) {
+ gchar *first, *second;
+ if (! l1 && ! l2)
+ return TRUE;
+ if ((! l1 && l2) || (l1 && ! l2))
+ return FALSE;
+ while (l1 && l2) {
+ first = (gchar *) l1->data;
+ second = (gchar *) l2->data;
+ /*debug_print("comparing: %s = %s\n", first, second);*/
+ if ( ! (first && second) || strcmp(first, second) != 0) {
+ return FALSE;
+ }
+ l1 = g_list_next(l1);
+ l2 = g_list_next(l2);
+ }
+ return TRUE;
+}
+
#endif /* USE_LDAP */
/*
projects / claws.git / blobdiff