2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2013 Match Grun 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 * Edit LDAP address book data.
26 #include "claws-features.h"
34 #include <glib/gi18n.h>
35 #include <gdk/gdkkeysyms.h>
38 #include "addressbook.h"
39 #include "prefs_common.h"
40 #include "addressitem.h"
42 #include "ldapserver.h"
45 #include "editldap_basedn.h"
46 #include "manage_window.h"
48 #include "prefs_gtk.h"
52 #define PAGE_EXTENDED 2
54 #define ADDRESSBOOK_GUESS_LDAP_NAME "MyServer"
55 #define ADDRESSBOOK_GUESS_LDAP_SERVER "localhost"
57 #define LDAPEDIT_TABLE_ROWS 6
58 #define LDAPEDIT_TABLE_COLS 3
60 static struct _LDAPEdit {
64 GtkWidget *cancel_btn;
67 GtkWidget *entry_name;
68 GtkWidget *entry_server;
69 GtkWidget *spinbtn_port;
70 GtkWidget *entry_baseDN;
71 GtkWidget *spinbtn_timeout;
72 GtkWidget *entry_bindDN;
73 GtkWidget *entry_bindPW;
74 GtkWidget *spinbtn_maxentry;
75 GtkWidget *entry_criteria;
76 GtkWidget *spinbtn_queryage;
77 GtkWidget *check_dynsearch;
78 GtkWidget *check_matchoption;
79 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
80 GtkWidget *enable_ssl;
81 GtkWidget *enable_tls;
86 * Parse out individual attribute names from criteria string.
87 * \param criteria Criteria string.
88 * \ctl Control object.
90 static gboolean editldap_validate_criteria( gchar *criteria ) {
96 cm_return_val_if_fail(criteria != NULL, TRUE);
100 /* Replace delimiters with spaces */
103 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
107 debug_print("cleaned criteria list: %s\n", criteria);
110 splitStr = g_strsplit( criteria, " ", 0 );
124 g_strfreev( splitStr );
131 static void edit_ldap_status_show( gchar *msg ) {
132 if( ldapedit.statusbar != NULL ) {
133 gtk_statusbar_pop( GTK_STATUSBAR(ldapedit.statusbar), ldapedit.status_cid );
135 gtk_statusbar_push( GTK_STATUSBAR(ldapedit.statusbar),
136 ldapedit.status_cid, msg );
141 static gboolean edit_ldap_validate( void ) {
147 str = gtk_editable_get_chars(
148 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
151 gtk_widget_grab_focus( ldapedit.entry_name );
152 edit_ldap_status_show( _( "A Name must be supplied." ) );
158 str = gtk_editable_get_chars(
159 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
162 gtk_widget_grab_focus( ldapedit.entry_server );
163 edit_ldap_status_show(
164 _( "A Hostname must be supplied for the server." ) );
171 str = gtk_editable_get_chars(
172 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
173 if( editldap_validate_criteria( str ) ) {
175 gtk_widget_grab_focus( ldapedit.entry_criteria );
176 edit_ldap_status_show(
177 _( "At least one LDAP search attribute should be supplied." ) );
183 /* Switch to page with error */
185 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), page );
191 static void edit_ldap_ok( GtkWidget *widget, gboolean *cancelled ) {
192 if( ! edit_ldap_validate() ) {
198 static void edit_ldap_cancel( GtkWidget *widget, gboolean *cancelled ) {
203 static gint edit_ldap_delete_event( GtkWidget *widget, GdkEventAny *event, gboolean *cancelled ) {
209 static gboolean edit_ldap_key_pressed( GtkWidget *widget, GdkEventKey *event, gboolean *cancelled ) {
210 if (event && event->keyval == GDK_KEY_Escape) {
217 static void edit_ldap_server_check( void ) {
218 gchar *sHost, *sBind, *sPass;
221 gchar *sBaseDN = NULL;
224 gboolean tls = FALSE, ssl = FALSE;
225 GList *baseDN = NULL;
227 edit_ldap_status_show( "" );
229 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
230 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
231 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
232 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
233 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
234 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
235 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
236 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
239 g_strchomp( sHost ); g_strchug( sHost );
240 g_strchomp( sBind ); g_strchug( sBind );
241 g_strchomp( sPass ); g_strchug( sPass );
242 if( *sHost != '\0' ) {
243 /* Test connection to server */
244 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
245 if( ldaputil_test_connect( sHost, iPort, ssl, tls, iTime ) ) {
246 /* Attempt to read base DN */
247 baseDN = ldaputil_read_basedn(sHost, iPort, sBind, sPass, iTime, ssl, tls);
249 GList *node = baseDN;
253 sBaseDN = g_strdup( node->data );
255 node = g_list_next( node );
257 mgu_free_dlist( baseDN );
258 baseDN = node = NULL;
271 debug_print("baseDN: %s\n", sBaseDN);
272 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), sBaseDN);
276 /* Display appropriate message */
278 sMsg = _( "Connected successfully to server" );
281 sMsg = _( "Could not connect to server" );
283 edit_ldap_status_show( sMsg );
286 static void edit_ldap_basedn_select( void ) {
287 gchar *sHost, *sBind, *sPass, *sBase;
288 gint iPort, iTime, tls = 0, ssl = 0;
291 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
292 sBase = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
293 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
294 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
295 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
296 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
297 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
298 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
299 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
302 g_strchomp( sHost ); g_strchug( sHost );
303 g_strchomp( sBind ); g_strchug( sBind );
304 g_strchomp( sPass ); g_strchug( sPass );
305 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
306 selectDN = edit_ldap_basedn_selection( sHost, iPort, sBase, iTime, sBind, sPass, ssl, tls );
308 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), selectDN);
318 static void edit_ldap_search_reset(void) {
319 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
322 static void addressbook_edit_ldap_dialog_create( gboolean *cancelled ) {
328 GtkWidget *cancel_btn;
330 GtkWidget *statusbar;
332 debug_print("creating edit_ldap_dialog\n");
333 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "editldap");
334 gtk_widget_set_size_request(window, 450, -1);
335 gtk_container_set_border_width(GTK_CONTAINER(window), 0);
336 gtk_window_set_title(GTK_WINDOW(window), _("Edit LDAP Server"));
337 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
338 g_signal_connect(G_OBJECT(window), "delete_event",
339 G_CALLBACK(edit_ldap_delete_event),
341 g_signal_connect(G_OBJECT(window), "key_press_event",
342 G_CALLBACK(edit_ldap_key_pressed),
345 vbox = gtk_vbox_new( FALSE, 6 );
346 gtk_widget_show( vbox );
347 gtk_container_add( GTK_CONTAINER( window ), vbox );
350 notebook = gtk_notebook_new();
351 gtk_widget_show( notebook );
352 gtk_box_pack_start( GTK_BOX( vbox ), notebook, TRUE, TRUE, 0 );
353 gtk_container_set_border_width( GTK_CONTAINER( notebook ), 6 );
356 hsbox = gtk_hbox_new(FALSE, 0);
357 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
358 statusbar = gtk_statusbar_new();
359 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
362 gtkut_stock_button_set_create(&hbbox, &cancel_btn, GTK_STOCK_CANCEL,
363 &ok_btn, GTK_STOCK_OK,
365 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
366 gtk_widget_grab_default(ok_btn);
368 g_signal_connect(G_OBJECT(ok_btn), "clicked",
369 G_CALLBACK(edit_ldap_ok), cancelled);
370 g_signal_connect(G_OBJECT(cancel_btn), "clicked",
371 G_CALLBACK(edit_ldap_cancel), cancelled);
373 gtk_widget_show_all(vbox);
375 ldapedit.window = window;
376 ldapedit.notebook = notebook;
377 ldapedit.ok_btn = ok_btn;
378 ldapedit.cancel_btn = cancel_btn;
379 ldapedit.statusbar = statusbar;
380 ldapedit.status_cid =
381 gtk_statusbar_get_context_id(
382 GTK_STATUSBAR(statusbar), "Edit LDAP Server Dialog" );
385 static void editldap_update_port (GtkToggleButton *ssl_btn, gpointer data) {
386 gboolean val = gtk_toggle_button_get_active(ssl_btn);
387 gtk_spin_button_set_value(
388 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ),
389 val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT );
390 debug_print("Setting port: %d\n", val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT);
393 static void addressbook_edit_ldap_page_basic( gint pageNum, gchar *pageLbl ) {
397 GtkWidget *entry_name;
398 GtkWidget *entry_server;
399 GtkWidget *hbox_spin;
400 GtkAdjustment *spinbtn_port_adj;
401 GtkWidget *spinbtn_port;
402 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
403 GtkWidget *enable_ssl_checkbtn, *enable_tls_checkbtn;
405 GtkWidget *entry_baseDN;
406 GtkWidget *check_btn;
407 GtkWidget *lookdn_btn;
410 vbox = gtk_vbox_new( FALSE, 8 );
411 gtk_widget_show( vbox );
412 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
414 label = gtk_label_new( pageLbl );
415 gtk_widget_show( label );
416 gtk_notebook_set_tab_label(
417 GTK_NOTEBOOK( ldapedit.notebook ),
418 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
420 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
421 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
422 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
423 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
424 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
428 label = gtk_label_new(_("Name"));
429 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
430 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
432 entry_name = gtk_entry_new();
433 gtk_table_attach(GTK_TABLE(table), entry_name, 1, 2, top, (top + 1),
434 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
436 CLAWS_SET_TIP(entry_name, _(
437 "A name that you wish to call the server." ));
441 label = gtk_label_new(_("Hostname"));
442 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
443 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
445 entry_server = gtk_entry_new();
446 gtk_table_attach(GTK_TABLE(table), entry_server, 1, 2, top, (top + 1),
447 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
449 CLAWS_SET_TIP(entry_server, _(
450 "This is the hostname of the server. For example, " \
451 "\"ldap.mydomain.com\" may be appropriate for the " \
452 "\"mydomain.com\" organization. An IP address may also be " \
453 "used. You may specify \"localhost\" if running an LDAP " \
454 "server on the same computer as Claws Mail." ));
458 label = gtk_label_new(_("Port"));
459 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
460 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
462 hbox_spin = gtk_hbox_new (FALSE, 8);
463 spinbtn_port_adj = GTK_ADJUSTMENT(gtk_adjustment_new (389, 1, 65535, 1, 1000, 0));
464 spinbtn_port = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_port_adj), 1, 0);
465 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_port, TRUE, FALSE, 0);
466 gtk_widget_set_size_request (spinbtn_port, 64, -1);
467 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_port), TRUE);
469 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
470 enable_tls_checkbtn = gtk_check_button_new_with_label(_("TLS"));
471 enable_ssl_checkbtn = gtk_check_button_new_with_label(_("SSL"));
472 SET_TOGGLE_SENSITIVITY_REVERSE(enable_tls_checkbtn, enable_ssl_checkbtn);
473 SET_TOGGLE_SENSITIVITY_REVERSE(enable_ssl_checkbtn, enable_tls_checkbtn);
474 CLAWS_SET_TIP(enable_tls_checkbtn, _(
475 "Enable secure connection to the LDAP server via TLS. "
476 "If connection fails, be sure to check the correct "
477 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ));
478 CLAWS_SET_TIP(enable_ssl_checkbtn, _(
479 "Enable secure connection to the LDAP server via SSL. "
480 "If connection fails, be sure to check the correct "
481 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ));
483 #ifdef G_OS_UNIX /* Win32's ldap_start_tls_s() does not work, for some reason. */
484 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_tls_checkbtn, TRUE, FALSE, 0);
486 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_ssl_checkbtn, TRUE, FALSE, 0);
489 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
490 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
492 CLAWS_SET_TIP(spinbtn_port, _(
493 "The port number that the server listens on. Port 389 is " \
496 check_btn = gtk_button_new_with_label( _(" Check Server "));
497 gtk_table_attach(GTK_TABLE(table), check_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
499 CLAWS_SET_TIP(check_btn, _(
500 "Press this button to test the connection to the server." ));
504 label = gtk_label_new(_("Search Base"));
505 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
506 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
508 entry_baseDN = gtk_entry_new();
509 gtk_table_attach(GTK_TABLE(table), entry_baseDN, 1, 2, top, (top + 1),
510 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
512 CLAWS_SET_TIP(entry_baseDN, _(
513 "This specifies the name of the directory to be searched " \
514 "on the server. Examples include:\n" \
515 " dc=claws-mail,dc=org\n" \
516 " ou=people,dc=domainname,dc=com\n" \
517 " o=Organization Name,c=Country\n"
520 lookdn_btn = gtkut_get_browse_file_btn(_("_Browse"));
521 gtk_table_attach(GTK_TABLE(table), lookdn_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
523 CLAWS_SET_TIP(lookdn_btn, _(
524 "Press this button to lookup the name of available " \
525 "directory names on the server." ));
527 /* Signal handlers */
528 g_signal_connect(G_OBJECT(check_btn), "clicked",
529 G_CALLBACK(edit_ldap_server_check), NULL);
530 g_signal_connect(G_OBJECT(lookdn_btn), "clicked",
531 G_CALLBACK(edit_ldap_basedn_select), NULL);
534 gtk_widget_show_all(vbox);
536 ldapedit.entry_name = entry_name;
537 ldapedit.entry_server = entry_server;
538 ldapedit.spinbtn_port = spinbtn_port;
539 ldapedit.entry_baseDN = entry_baseDN;
540 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
541 ldapedit.enable_ssl = enable_ssl_checkbtn;
542 ldapedit.enable_tls = enable_tls_checkbtn;
544 g_signal_connect(G_OBJECT(enable_ssl_checkbtn), "toggled", \
545 G_CALLBACK(editldap_update_port), NULL);
549 static void addressbook_edit_ldap_page_search( gint pageNum, gchar *pageLbl ) {
553 GtkWidget *entry_criteria;
554 GtkWidget *hbox_spin;
555 GtkAdjustment *spinbtn_queryage_adj;
556 GtkWidget *spinbtn_queryage;
557 GtkWidget *check_dynsearch;
558 GtkWidget *check_matchoption;
559 GtkWidget *reset_btn;
562 vbox = gtk_vbox_new( FALSE, 8 );
563 gtk_widget_show( vbox );
564 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
566 label = gtk_label_new( pageLbl );
567 gtk_widget_show( label );
568 gtk_notebook_set_tab_label(
569 GTK_NOTEBOOK( ldapedit.notebook ),
570 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
572 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
573 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
574 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
575 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
576 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
580 label = gtk_label_new(_("Search Attributes"));
581 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
582 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
584 entry_criteria = gtk_entry_new();
585 gtk_table_attach(GTK_TABLE(table), entry_criteria, 1, 2, top, (top + 1),
586 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
588 CLAWS_SET_TIP(entry_criteria, _(
589 "A list of LDAP attribute names that should be searched " \
590 "when attempting to find a name or address." ));
592 reset_btn = gtk_button_new_with_label( _(" Defaults "));
593 gtk_table_attach(GTK_TABLE(table), reset_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
595 CLAWS_SET_TIP(reset_btn, _(
596 "This resets the attribute names to a default value " \
597 "that should find most names and addresses during a " \
598 "name or address search process." ));
602 label = gtk_label_new(_("Max Query Age (secs)"));
603 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
604 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
606 hbox_spin = gtk_hbox_new (FALSE, 8);
607 spinbtn_queryage_adj = GTK_ADJUSTMENT(gtk_adjustment_new(
608 LDAPCTL_DFL_QUERY_AGE, 1, LDAPCTL_MAX_QUERY_AGE, 10, 1000, 0 ));
609 spinbtn_queryage = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_queryage_adj), 1, 0);
610 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_queryage, FALSE, FALSE, 0);
611 gtk_widget_set_size_request (spinbtn_queryage, 64, -1);
612 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_queryage), TRUE);
613 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
614 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
616 CLAWS_SET_TIP(spinbtn_queryage, _(
617 "This defines the maximum period of time (in seconds) that " \
618 "an address search result is valid for address completion " \
619 "purposes. Search results are stored in a cache until this " \
620 "period of time has passed and then retired. This will " \
621 "improve the response time when attempting to search for " \
622 "the same name or address on subsequent address completion " \
623 "requests. The cache will be searched in preference to " \
624 "performing a new server search request. The default value " \
625 "of 600 seconds (10 minutes), should be sufficient for most " \
626 "servers. A larger value will reduce the search time for " \
627 "subsequent searches. This is useful for servers that have " \
628 "slow response times at the expense of more memory to cache " \
633 check_dynsearch = gtk_check_button_new_with_label(
634 _("Include server in dynamic search") );
635 gtk_table_attach(GTK_TABLE(table), check_dynsearch, 1, 3, top, (top + 1),
636 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
638 CLAWS_SET_TIP(check_dynsearch, _(
639 "Check this option to include this server for dynamic " \
640 "searches when using address completion." ));
644 check_matchoption = gtk_check_button_new_with_label(
645 _("Match names 'containing' search term") );
646 gtk_table_attach(GTK_TABLE(table), check_matchoption, 1, 3, top, (top + 1),
647 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
649 CLAWS_SET_TIP(check_matchoption, _(
650 "Searches for names and addresses can be performed either " \
651 "using \"begins-with\" or \"contains\" search term. Check " \
652 "this option to perform a \"contains\" search; this type of " \
653 "search usually takes longer to complete. Note that for " \
654 "performance reasons, address completion uses " \
655 "\"begins-with\" for all searches against other address " \
659 /* Signal handlers */
660 g_signal_connect(G_OBJECT(reset_btn), "clicked",
661 G_CALLBACK(edit_ldap_search_reset), NULL);
664 gtk_widget_show_all(vbox);
666 ldapedit.entry_criteria = entry_criteria;
667 ldapedit.spinbtn_queryage = spinbtn_queryage;
668 ldapedit.check_dynsearch = check_dynsearch;
669 ldapedit.check_matchoption = check_matchoption;
672 static void addressbook_edit_ldap_page_extended( gint pageNum, gchar *pageLbl ) {
676 GtkWidget *entry_bindDN;
677 GtkWidget *entry_bindPW;
678 GtkWidget *hbox_spin;
679 GtkAdjustment *spinbtn_timeout_adj;
680 GtkWidget *spinbtn_timeout;
681 GtkAdjustment *spinbtn_maxentry_adj;
682 GtkWidget *spinbtn_maxentry;
685 vbox = gtk_vbox_new( FALSE, 8 );
686 gtk_widget_show( vbox );
687 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
689 label = gtk_label_new( pageLbl );
690 gtk_widget_show( label );
691 gtk_notebook_set_tab_label(
692 GTK_NOTEBOOK( ldapedit.notebook ),
693 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
695 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
696 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
697 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
698 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
699 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
703 label = gtk_label_new(_("Bind DN"));
704 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
705 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
707 entry_bindDN = gtk_entry_new();
708 gtk_table_attach(GTK_TABLE(table), entry_bindDN, 1, 2, top, (top + 1),
709 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
711 CLAWS_SET_TIP(entry_bindDN, _(
712 "The LDAP user account name to be used to connect to the server. " \
713 "This is usually only used for protected servers. This name " \
714 "is typically formatted as: \"cn=user,dc=claws-mail,dc=org\". " \
715 "This is usually left empty when performing a search." ));
719 label = gtk_label_new(_("Bind Password"));
720 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
721 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
723 entry_bindPW = gtk_entry_new();
724 gtk_table_attach(GTK_TABLE(table), entry_bindPW, 1, 2, top, (top + 1),
725 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
726 gtk_entry_set_visibility(GTK_ENTRY(entry_bindPW), FALSE);
728 CLAWS_SET_TIP(entry_bindPW, _(
729 "The password to be used when connecting as the \"Bind DN\" " \
734 label = gtk_label_new(_("Timeout (secs)"));
735 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
736 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
738 hbox_spin = gtk_hbox_new (FALSE, 8);
739 spinbtn_timeout_adj = GTK_ADJUSTMENT(gtk_adjustment_new (0, 0, 300, 1, 10, 0));
740 spinbtn_timeout = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_timeout_adj), 1, 0);
741 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_timeout, FALSE, FALSE, 0);
742 gtk_widget_set_size_request (spinbtn_timeout, 64, -1);
743 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_timeout), TRUE);
744 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
745 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
747 CLAWS_SET_TIP(spinbtn_timeout, _(
748 "The timeout period in seconds." ));
752 label = gtk_label_new(_("Maximum Entries"));
753 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
754 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
756 hbox_spin = gtk_hbox_new (FALSE, 8);
757 spinbtn_maxentry_adj = GTK_ADJUSTMENT(gtk_adjustment_new (0, 0, 500, 1, 10, 0));
758 spinbtn_maxentry = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_maxentry_adj), 1, 0);
759 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_maxentry, FALSE, FALSE, 0);
760 gtk_widget_set_size_request (spinbtn_maxentry, 64, -1);
761 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_maxentry), TRUE);
762 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
763 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
765 CLAWS_SET_TIP(spinbtn_maxentry, _(
766 "The maximum number of entries that should be returned " \
767 "in the search result." ));
770 gtk_widget_show_all(vbox);
772 ldapedit.entry_bindDN = entry_bindDN;
773 ldapedit.entry_bindPW = entry_bindPW;
774 ldapedit.spinbtn_timeout = spinbtn_timeout;
775 ldapedit.spinbtn_maxentry = spinbtn_maxentry;
778 static void addressbook_edit_ldap_create( gboolean *cancelled ) {
780 addressbook_edit_ldap_dialog_create( cancelled );
781 addressbook_edit_ldap_page_basic( page++, _( "Basic" ) );
782 addressbook_edit_ldap_page_search( page++, _( "Search" ) );
783 addressbook_edit_ldap_page_extended( page++, _( "Extended" ) );
784 gtk_widget_show_all( ldapedit.window );
788 * Format criteria list for display.
789 * \param ctl Control object.
790 * \return Formatted string, or <i>NULL</i> if no attributes found.
792 static gchar *editldap_build_criteria_list( const LdapControl *ctl ) {
797 node = ldapctl_get_criteria_list( ctl );
799 gchar *attr = node->data;
801 tmp = g_strdup_printf( "%s, %s", str, attr );
807 str = g_strdup( attr );
809 node = g_list_next( node );
816 * Parse out individual attribute names from criteria string.
817 * \param criteria Criteria string.
818 * \ctl Control object.
820 static void editldap_parse_criteria( gchar *criteria, LdapControl *ctl ) {
825 /* Replace delimiters with spaces */
828 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
834 ldapctl_criteria_list_clear( ctl );
835 splitStr = g_strsplit( criteria, " ", 0 );
840 ldapctl_criteria_list_add( ctl, splitStr[i] );
848 g_strfreev( splitStr );
852 * Clear entry fields to reasonable defaults (for a new server entry).
854 static void edit_ldap_clear_fields(void) {
856 GTK_ENTRY(ldapedit.entry_name), ADDRESSBOOK_GUESS_LDAP_NAME );
858 GTK_ENTRY(ldapedit.entry_server), ADDRESSBOOK_GUESS_LDAP_SERVER );
859 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), "");
860 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindDN), "");
861 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindPW), "");
862 gtk_spin_button_set_value(
863 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ), LDAPCTL_DFL_PORT );
864 gtk_spin_button_set_value(
865 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ), LDAPCTL_DFL_TIMEOUT );
866 gtk_spin_button_set_value(
867 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ), LDAPCTL_DFL_TIMEOUT );
869 GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
870 gtk_spin_button_set_value(
871 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), LDAPCTL_DFL_QUERY_AGE );
872 gtk_toggle_button_set_active(
873 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), TRUE );
874 gtk_toggle_button_set_active(
875 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption), FALSE );
876 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
877 gtk_toggle_button_set_active(
878 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl), FALSE );
879 gtk_toggle_button_set_active(
880 GTK_TOGGLE_BUTTON( ldapedit.enable_tls), FALSE );
885 * Load entry fields from server control data.
886 * \param server Server object.
888 static void edit_ldap_set_fields( LdapServer *server ) {
893 if( ldapsvr_get_name( server ) )
894 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_name),
895 ldapsvr_get_name( server ) );
897 ctl = server->control;
900 GTK_ENTRY(ldapedit.entry_server), ctl->hostName);
903 GTK_ENTRY(ldapedit.entry_baseDN), ctl->baseDN );
906 GTK_ENTRY(ldapedit.entry_bindDN), ctl->bindDN );
907 if( ctl->bindPass ) {
908 pwd = ldapctl_get_bind_password( ctl );
909 gtk_entry_set_text( GTK_ENTRY(ldapedit.entry_bindPW), pwd );
912 gtk_spin_button_set_value(
913 GTK_SPIN_BUTTON(ldapedit.spinbtn_timeout), ctl->timeOut );
914 gtk_spin_button_set_value(
915 GTK_SPIN_BUTTON(ldapedit.spinbtn_maxentry), ctl->maxEntries );
916 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
917 gtk_toggle_button_set_active(
918 GTK_TOGGLE_BUTTON(ldapedit.enable_tls), ctl->enableTLS );
919 gtk_toggle_button_set_active(
920 GTK_TOGGLE_BUTTON(ldapedit.enable_ssl), ctl->enableSSL );
922 gtk_spin_button_set_value(
923 GTK_SPIN_BUTTON(ldapedit.spinbtn_port), ctl->port );
924 /* Format criteria */
925 crit = editldap_build_criteria_list( ctl );
927 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), crit );
931 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), "" );
933 gtk_spin_button_set_value(
934 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), ctl->maxQueryAge );
935 gtk_toggle_button_set_active(
936 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), server->searchFlag );
937 gtk_toggle_button_set_active(
938 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption),
939 ( ctl->matchingOption == LDAPCTL_MATCH_CONTAINS ) );
943 * Edit LDAP server datasource that appears addressbook.
944 * \param addrIndex Address index object.
945 * \param ads Data source adapter.
946 * \return Update data source adapter, or <code>NULL</code> if user cancelled
949 AdapterDSource *addressbook_edit_ldap(
950 AddressIndex *addrIndex, AdapterDSource *ads )
952 static gboolean cancelled;
953 gchar *sName, *sHost, *sBase, *sBind, *sPass, *sCrit;
954 gint iPort, iMaxE, iTime, iAge;
955 gboolean bSrch, bMatch;
956 AddressDataSource *ds = NULL;
957 LdapServer *server = NULL;
958 LdapControl *ctl = NULL;
959 gboolean fin, ssl = FALSE, tls = FALSE;
961 if (!ldapedit.window)
962 addressbook_edit_ldap_create(&cancelled);
963 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), PAGE_BASIC );
964 gtk_widget_grab_focus(ldapedit.ok_btn);
965 gtk_widget_grab_focus(ldapedit.entry_name);
966 gtk_widget_show(ldapedit.window);
967 manage_window_set_transient(GTK_WINDOW(ldapedit.window));
968 gtk_window_set_modal(GTK_WINDOW(ldapedit.window), TRUE);
970 edit_ldap_status_show( "" );
972 ds = ads->dataSource;
973 server = ds->rawDataSource;
974 edit_ldap_set_fields( server );
975 gtk_window_set_title(
976 GTK_WINDOW(ldapedit.window), _("Edit LDAP Server"));
979 edit_ldap_clear_fields();
980 gtk_window_set_title(
981 GTK_WINDOW(ldapedit.window), _("Add New LDAP Server"));
985 gtk_widget_hide(ldapedit.window);
986 gtk_window_set_modal(GTK_WINDOW(ldapedit.window), FALSE);
987 if (cancelled == TRUE) return NULL;
989 sName = gtk_editable_get_chars(
990 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
991 sHost = gtk_editable_get_chars(
992 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
993 sBase = gtk_editable_get_chars(
994 GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
995 sCrit = gtk_editable_get_chars(
996 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
997 sBind = gtk_editable_get_chars(
998 GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
999 sPass = gtk_editable_get_chars(
1000 GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
1001 iPort = gtk_spin_button_get_value_as_int(
1002 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
1003 iTime = gtk_spin_button_get_value_as_int(
1004 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
1005 iMaxE = gtk_spin_button_get_value_as_int(
1006 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ) );
1007 iAge = gtk_spin_button_get_value_as_int(
1008 GTK_SPIN_BUTTON( ldapedit.spinbtn_queryage ) );
1009 bSrch = gtk_toggle_button_get_active(
1010 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch ) );
1011 bMatch = gtk_toggle_button_get_active(
1012 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption ) );
1013 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
1014 ssl = gtk_toggle_button_get_active(
1015 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl ) );
1016 tls = gtk_toggle_button_get_active(
1017 GTK_TOGGLE_BUTTON( ldapedit.enable_tls ) );
1019 debug_print("saving server config:\nname: %s\nhost: %s\nbase: %s\ncriteria: %s\nbind: %s\nport: %d\ntime: %d\nmax_entries: %d\ntimeout: %d\ndynamic: %d\ncheck_match: %d\n",
1020 sName, sHost, sBase, sCrit, sBind, iPort, iTime, iMaxE, iAge, bSrch, bMatch);
1022 if( *sName == '\0' ) fin = TRUE;
1023 if( *sHost == '\0' ) fin = TRUE;
1029 server = ldapsvr_create();
1030 ds = addrindex_index_add_datasource(
1031 addrIndex, ADDR_IF_LDAP, server );
1032 ads = addressbook_create_ds_adapter(
1033 ds, ADDR_LDAP, NULL );
1035 ctl = server->control;
1036 addressbook_ads_set_name( ads, sName );
1037 ldapsvr_set_name( server, sName );
1038 ldapsvr_set_search_flag( server, bSrch );
1039 ldapctl_set_host( ctl, sHost );
1040 ldapctl_set_base_dn( ctl, sBase );
1041 ldapctl_set_bind_dn( ctl, sBind );
1042 ldapctl_set_bind_password( ctl, sPass, TRUE, TRUE );
1043 ldapctl_set_port( ctl, iPort );
1044 ldapctl_set_max_entries( ctl, iMaxE );
1045 ldapctl_set_timeout( ctl, iTime );
1046 ldapctl_set_max_query_age( ctl, iAge );
1047 ldapctl_set_tls( ctl, tls );
1048 ldapctl_set_ssl( ctl, ssl );
1049 ldapctl_set_matching_option(
1051 LDAPCTL_MATCH_CONTAINS : LDAPCTL_MATCH_BEGINWITH );
1053 addrindex_save_data(addrIndex);
1055 /* Save attributes */
1056 editldap_parse_criteria( sCrit, ctl );
1069 #endif /* USE_LDAP */