2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2015 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/>.
20 * Edit LDAP address book data.
25 #include "claws-features.h"
33 #include <glib/gi18n.h>
34 #include <gdk/gdkkeysyms.h>
37 #include "addressbook.h"
38 #include "prefs_common.h"
39 #include "addressitem.h"
41 #include "ldapserver.h"
44 #include "editldap_basedn.h"
45 #include "manage_window.h"
47 #include "prefs_gtk.h"
51 #define PAGE_EXTENDED 2
53 #define ADDRESSBOOK_GUESS_LDAP_NAME "MyServer"
54 #define ADDRESSBOOK_GUESS_LDAP_SERVER "localhost"
56 #define LDAPEDIT_TABLE_ROWS 6
57 #define LDAPEDIT_TABLE_COLS 3
59 static struct _LDAPEdit {
63 GtkWidget *cancel_btn;
66 GtkWidget *entry_name;
67 GtkWidget *entry_server;
68 GtkWidget *spinbtn_port;
69 GtkWidget *entry_baseDN;
70 GtkWidget *spinbtn_timeout;
71 GtkWidget *entry_bindDN;
72 GtkWidget *entry_bindPW;
73 GtkWidget *spinbtn_maxentry;
74 GtkWidget *entry_criteria;
75 GtkWidget *spinbtn_queryage;
76 GtkWidget *check_dynsearch;
77 GtkWidget *check_matchoption;
78 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
79 GtkWidget *enable_ssl;
80 GtkWidget *enable_tls;
85 * Parse out individual attribute names from criteria string.
86 * \param criteria Criteria string.
87 * \ctl Control object.
89 static gboolean editldap_validate_criteria( gchar *criteria ) {
95 cm_return_val_if_fail(criteria != NULL, TRUE);
99 /* Replace delimiters with spaces */
102 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
106 debug_print("cleaned criteria list: %s\n", criteria);
109 splitStr = g_strsplit( criteria, " ", 0 );
123 g_strfreev( splitStr );
130 static void edit_ldap_status_show( gchar *msg ) {
131 if( ldapedit.statusbar != NULL ) {
132 gtk_statusbar_pop( GTK_STATUSBAR(ldapedit.statusbar), ldapedit.status_cid );
134 gtk_statusbar_push( GTK_STATUSBAR(ldapedit.statusbar),
135 ldapedit.status_cid, msg );
140 static gboolean edit_ldap_validate( void ) {
146 str = gtk_editable_get_chars(
147 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
150 gtk_widget_grab_focus( ldapedit.entry_name );
151 edit_ldap_status_show( _( "A Name must be supplied." ) );
157 str = gtk_editable_get_chars(
158 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
161 gtk_widget_grab_focus( ldapedit.entry_server );
162 edit_ldap_status_show(
163 _( "A Hostname must be supplied for the server." ) );
170 str = gtk_editable_get_chars(
171 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
172 if( editldap_validate_criteria( str ) ) {
174 gtk_widget_grab_focus( ldapedit.entry_criteria );
175 edit_ldap_status_show(
176 _( "At least one LDAP search attribute should be supplied." ) );
182 /* Switch to page with error */
184 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), page );
190 static void edit_ldap_ok( GtkWidget *widget, gboolean *cancelled ) {
191 if( ! edit_ldap_validate() ) {
197 static void edit_ldap_cancel( GtkWidget *widget, gboolean *cancelled ) {
202 static gint edit_ldap_delete_event( GtkWidget *widget, GdkEventAny *event, gboolean *cancelled ) {
208 static gboolean edit_ldap_key_pressed( GtkWidget *widget, GdkEventKey *event, gboolean *cancelled ) {
209 if (event && event->keyval == GDK_KEY_Escape) {
216 static void edit_ldap_server_check( void ) {
217 gchar *sHost, *sBind, *sPass;
220 gchar *sBaseDN = NULL;
223 gboolean tls = FALSE, ssl = FALSE;
224 GList *baseDN = NULL;
226 edit_ldap_status_show( "" );
228 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
229 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
230 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
231 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
232 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
233 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
234 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
235 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
241 if( *sHost != '\0' ) {
242 /* Test connection to server */
243 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
244 if( ldaputil_test_connect( sHost, iPort, ssl, tls, iTime ) ) {
245 /* Attempt to read base DN */
246 baseDN = ldaputil_read_basedn(sHost, iPort, sBind, sPass, iTime, ssl, tls);
248 GList *node = baseDN;
252 sBaseDN = g_strdup( node->data );
254 node = g_list_next( node );
256 mgu_free_dlist( baseDN );
257 baseDN = node = NULL;
270 debug_print("baseDN: %s\n", sBaseDN);
271 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), sBaseDN);
275 /* Display appropriate message */
277 sMsg = _( "Connected successfully to server" );
280 sMsg = _( "Could not connect to server" );
282 edit_ldap_status_show( sMsg );
285 static void edit_ldap_basedn_select( void ) {
286 gchar *sHost, *sBind, *sPass, *sBase;
287 gint iPort, iTime, tls = 0, ssl = 0;
290 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
291 sBase = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
292 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
293 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
294 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
295 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
296 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
297 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
298 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
304 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
305 selectDN = edit_ldap_basedn_selection( sHost, iPort, sBase, iTime, sBind, sPass, ssl, tls );
307 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), selectDN);
317 static void edit_ldap_search_reset(void) {
318 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
321 static void addressbook_edit_ldap_dialog_create( gboolean *cancelled ) {
327 GtkWidget *cancel_btn;
329 GtkWidget *statusbar;
331 debug_print("creating edit_ldap_dialog\n");
332 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "editldap");
333 gtk_widget_set_size_request(window, 450, -1);
334 gtk_container_set_border_width(GTK_CONTAINER(window), 0);
335 gtk_window_set_title(GTK_WINDOW(window), _("Edit LDAP Server"));
336 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
337 g_signal_connect(G_OBJECT(window), "delete_event",
338 G_CALLBACK(edit_ldap_delete_event),
340 g_signal_connect(G_OBJECT(window), "key_press_event",
341 G_CALLBACK(edit_ldap_key_pressed),
344 vbox = gtk_vbox_new( FALSE, 6 );
345 gtk_widget_show( vbox );
346 gtk_container_add( GTK_CONTAINER( window ), vbox );
349 notebook = gtk_notebook_new();
350 gtk_widget_show( notebook );
351 gtk_box_pack_start( GTK_BOX( vbox ), notebook, TRUE, TRUE, 0 );
352 gtk_container_set_border_width( GTK_CONTAINER( notebook ), 6 );
355 hsbox = gtk_hbox_new(FALSE, 0);
356 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
357 statusbar = gtk_statusbar_new();
358 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
361 gtkut_stock_button_set_create(&hbbox, &cancel_btn, GTK_STOCK_CANCEL,
362 &ok_btn, GTK_STOCK_OK,
364 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
365 gtk_widget_grab_default(ok_btn);
367 g_signal_connect(G_OBJECT(ok_btn), "clicked",
368 G_CALLBACK(edit_ldap_ok), cancelled);
369 g_signal_connect(G_OBJECT(cancel_btn), "clicked",
370 G_CALLBACK(edit_ldap_cancel), cancelled);
372 gtk_widget_show_all(vbox);
374 ldapedit.window = window;
375 ldapedit.notebook = notebook;
376 ldapedit.ok_btn = ok_btn;
377 ldapedit.cancel_btn = cancel_btn;
378 ldapedit.statusbar = statusbar;
379 ldapedit.status_cid =
380 gtk_statusbar_get_context_id(
381 GTK_STATUSBAR(statusbar), "Edit LDAP Server Dialog" );
384 static void editldap_update_port (GtkToggleButton *ssl_btn, gpointer data) {
385 gboolean val = gtk_toggle_button_get_active(ssl_btn);
386 gtk_spin_button_set_value(
387 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ),
388 val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT );
389 debug_print("Setting port: %d\n", val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT);
392 static void addressbook_edit_ldap_page_basic( gint pageNum, gchar *pageLbl ) {
396 GtkWidget *entry_name;
397 GtkWidget *entry_server;
398 GtkWidget *hbox_spin;
399 GtkAdjustment *spinbtn_port_adj;
400 GtkWidget *spinbtn_port;
401 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
402 GtkWidget *enable_ssl_checkbtn, *enable_tls_checkbtn;
404 GtkWidget *entry_baseDN;
405 GtkWidget *check_btn;
406 GtkWidget *lookdn_btn;
409 vbox = gtk_vbox_new( FALSE, 8 );
410 gtk_widget_show( vbox );
411 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
413 label = gtk_label_new( pageLbl );
414 gtk_widget_show( label );
415 gtk_notebook_set_tab_label(
416 GTK_NOTEBOOK( ldapedit.notebook ),
417 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
419 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
420 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
421 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
422 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
423 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
427 label = gtk_label_new(_("Name"));
428 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
429 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
431 entry_name = gtk_entry_new();
432 gtk_table_attach(GTK_TABLE(table), entry_name, 1, 2, top, (top + 1),
433 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
435 CLAWS_SET_TIP(entry_name, _(
436 "A name that you wish to call the server." ));
440 label = gtk_label_new(_("Hostname"));
441 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
442 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
444 entry_server = gtk_entry_new();
445 gtk_table_attach(GTK_TABLE(table), entry_server, 1, 2, top, (top + 1),
446 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
448 CLAWS_SET_TIP(entry_server, _(
449 "This is the hostname of the server. For example, " \
450 "\"ldap.mydomain.com\" may be appropriate for the " \
451 "\"mydomain.com\" organization. An IP address may also be " \
452 "used. You may specify \"localhost\" if running an LDAP " \
453 "server on the same computer as Claws Mail." ));
457 label = gtk_label_new(_("Port"));
458 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
459 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
461 hbox_spin = gtk_hbox_new (FALSE, 8);
462 spinbtn_port_adj = GTK_ADJUSTMENT(gtk_adjustment_new (389, 1, 65535, 1, 1000, 0));
463 spinbtn_port = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_port_adj), 1, 0);
464 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_port, TRUE, FALSE, 0);
465 gtk_widget_set_size_request (spinbtn_port, 64, -1);
466 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_port), TRUE);
468 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
469 enable_tls_checkbtn = gtk_check_button_new_with_label(_("TLS"));
470 enable_ssl_checkbtn = gtk_check_button_new_with_label(_("SSL"));
471 SET_TOGGLE_SENSITIVITY_REVERSE(enable_tls_checkbtn, enable_ssl_checkbtn);
472 SET_TOGGLE_SENSITIVITY_REVERSE(enable_ssl_checkbtn, enable_tls_checkbtn);
473 CLAWS_SET_TIP(enable_tls_checkbtn, _(
474 "Enable secure connection to the LDAP server via TLS. "
475 "If connection fails, be sure to check the correct "
476 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ));
477 CLAWS_SET_TIP(enable_ssl_checkbtn, _(
478 "Enable secure connection to the LDAP server via SSL. "
479 "If connection fails, be sure to check the correct "
480 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ));
482 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_tls_checkbtn, TRUE, FALSE, 0);
483 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_ssl_checkbtn, TRUE, FALSE, 0);
486 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
487 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
489 CLAWS_SET_TIP(spinbtn_port, _(
490 "The port number that the server listens on. Port 389 is " \
493 check_btn = gtk_button_new_with_label( _(" Check Server "));
494 gtk_table_attach(GTK_TABLE(table), check_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
496 CLAWS_SET_TIP(check_btn, _(
497 "Press this button to test the connection to the server." ));
501 label = gtk_label_new(_("Search Base"));
502 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
503 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
505 entry_baseDN = gtk_entry_new();
506 gtk_table_attach(GTK_TABLE(table), entry_baseDN, 1, 2, top, (top + 1),
507 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
509 CLAWS_SET_TIP(entry_baseDN, _(
510 "This specifies the name of the directory to be searched " \
511 "on the server. Examples include:\n" \
512 " dc=claws-mail,dc=org\n" \
513 " ou=people,dc=domainname,dc=com\n" \
514 " o=Organization Name,c=Country\n"
517 lookdn_btn = gtkut_get_browse_file_btn(_("_Browse"));
518 gtk_table_attach(GTK_TABLE(table), lookdn_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
520 CLAWS_SET_TIP(lookdn_btn, _(
521 "Press this button to lookup the name of available " \
522 "directory names on the server." ));
524 /* Signal handlers */
525 g_signal_connect(G_OBJECT(check_btn), "clicked",
526 G_CALLBACK(edit_ldap_server_check), NULL);
527 g_signal_connect(G_OBJECT(lookdn_btn), "clicked",
528 G_CALLBACK(edit_ldap_basedn_select), NULL);
531 gtk_widget_show_all(vbox);
533 ldapedit.entry_name = entry_name;
534 ldapedit.entry_server = entry_server;
535 ldapedit.spinbtn_port = spinbtn_port;
536 ldapedit.entry_baseDN = entry_baseDN;
537 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
538 ldapedit.enable_ssl = enable_ssl_checkbtn;
539 ldapedit.enable_tls = enable_tls_checkbtn;
541 g_signal_connect(G_OBJECT(enable_ssl_checkbtn), "toggled", \
542 G_CALLBACK(editldap_update_port), NULL);
546 static void addressbook_edit_ldap_page_search( gint pageNum, gchar *pageLbl ) {
550 GtkWidget *entry_criteria;
551 GtkWidget *hbox_spin;
552 GtkAdjustment *spinbtn_queryage_adj;
553 GtkWidget *spinbtn_queryage;
554 GtkWidget *check_dynsearch;
555 GtkWidget *check_matchoption;
556 GtkWidget *reset_btn;
559 vbox = gtk_vbox_new( FALSE, 8 );
560 gtk_widget_show( vbox );
561 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
563 label = gtk_label_new( pageLbl );
564 gtk_widget_show( label );
565 gtk_notebook_set_tab_label(
566 GTK_NOTEBOOK( ldapedit.notebook ),
567 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
569 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
570 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
571 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
572 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
573 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
577 label = gtk_label_new(_("Search Attributes"));
578 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
579 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
581 entry_criteria = gtk_entry_new();
582 gtk_table_attach(GTK_TABLE(table), entry_criteria, 1, 2, top, (top + 1),
583 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
585 CLAWS_SET_TIP(entry_criteria, _(
586 "A list of LDAP attribute names that should be searched " \
587 "when attempting to find a name or address." ));
589 reset_btn = gtk_button_new_with_label( _(" Defaults "));
590 gtk_table_attach(GTK_TABLE(table), reset_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
592 CLAWS_SET_TIP(reset_btn, _(
593 "This resets the attribute names to a default value " \
594 "that should find most names and addresses during a " \
595 "name or address search process." ));
599 label = gtk_label_new(_("Max Query Age (secs)"));
600 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
601 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
603 hbox_spin = gtk_hbox_new (FALSE, 8);
604 spinbtn_queryage_adj = GTK_ADJUSTMENT(gtk_adjustment_new(
605 LDAPCTL_DFL_QUERY_AGE, 1, LDAPCTL_MAX_QUERY_AGE, 10, 1000, 0 ));
606 spinbtn_queryage = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_queryage_adj), 1, 0);
607 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_queryage, FALSE, FALSE, 0);
608 gtk_widget_set_size_request (spinbtn_queryage, 64, -1);
609 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_queryage), TRUE);
610 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
611 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
613 CLAWS_SET_TIP(spinbtn_queryage, _(
614 "This defines the maximum period of time (in seconds) that " \
615 "an address search result is valid for address completion " \
616 "purposes. Search results are stored in a cache until this " \
617 "period of time has passed and then retired. This will " \
618 "improve the response time when attempting to search for " \
619 "the same name or address on subsequent address completion " \
620 "requests. The cache will be searched in preference to " \
621 "performing a new server search request. The default value " \
622 "of 600 seconds (10 minutes), should be sufficient for most " \
623 "servers. A larger value will reduce the search time for " \
624 "subsequent searches. This is useful for servers that have " \
625 "slow response times at the expense of more memory to cache " \
630 check_dynsearch = gtk_check_button_new_with_label(
631 _("Include server in dynamic search") );
632 gtk_table_attach(GTK_TABLE(table), check_dynsearch, 1, 3, top, (top + 1),
633 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
635 CLAWS_SET_TIP(check_dynsearch, _(
636 "Check this option to include this server for dynamic " \
637 "searches when using address completion." ));
641 check_matchoption = gtk_check_button_new_with_label(
642 _("Match names 'containing' search term") );
643 gtk_table_attach(GTK_TABLE(table), check_matchoption, 1, 3, top, (top + 1),
644 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
646 CLAWS_SET_TIP(check_matchoption, _(
647 "Searches for names and addresses can be performed either " \
648 "using \"begins-with\" or \"contains\" search term. Check " \
649 "this option to perform a \"contains\" search; this type of " \
650 "search usually takes longer to complete. Note that for " \
651 "performance reasons, address completion uses " \
652 "\"begins-with\" for all searches against other address " \
656 /* Signal handlers */
657 g_signal_connect(G_OBJECT(reset_btn), "clicked",
658 G_CALLBACK(edit_ldap_search_reset), NULL);
661 gtk_widget_show_all(vbox);
663 ldapedit.entry_criteria = entry_criteria;
664 ldapedit.spinbtn_queryage = spinbtn_queryage;
665 ldapedit.check_dynsearch = check_dynsearch;
666 ldapedit.check_matchoption = check_matchoption;
669 static void addressbook_edit_ldap_page_extended( gint pageNum, gchar *pageLbl ) {
673 GtkWidget *entry_bindDN;
674 GtkWidget *entry_bindPW;
675 GtkWidget *hbox_spin;
676 GtkAdjustment *spinbtn_timeout_adj;
677 GtkWidget *spinbtn_timeout;
678 GtkAdjustment *spinbtn_maxentry_adj;
679 GtkWidget *spinbtn_maxentry;
682 vbox = gtk_vbox_new( FALSE, 8 );
683 gtk_widget_show( vbox );
684 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
686 label = gtk_label_new( pageLbl );
687 gtk_widget_show( label );
688 gtk_notebook_set_tab_label(
689 GTK_NOTEBOOK( ldapedit.notebook ),
690 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
692 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
693 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
694 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
695 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
696 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
700 label = gtk_label_new(_("Bind DN"));
701 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
702 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
704 entry_bindDN = gtk_entry_new();
705 gtk_table_attach(GTK_TABLE(table), entry_bindDN, 1, 2, top, (top + 1),
706 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
708 CLAWS_SET_TIP(entry_bindDN, _(
709 "The LDAP user account name to be used to connect to the server. " \
710 "This is usually only used for protected servers. This name " \
711 "is typically formatted as: \"cn=user,dc=claws-mail,dc=org\". " \
712 "This is usually left empty when performing a search." ));
716 label = gtk_label_new(_("Bind Password"));
717 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
718 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
720 entry_bindPW = gtk_entry_new();
721 gtk_table_attach(GTK_TABLE(table), entry_bindPW, 1, 2, top, (top + 1),
722 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
723 gtk_entry_set_visibility(GTK_ENTRY(entry_bindPW), FALSE);
725 CLAWS_SET_TIP(entry_bindPW, _(
726 "The password to be used when connecting as the \"Bind DN\" " \
731 label = gtk_label_new(_("Timeout (secs)"));
732 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
733 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
735 hbox_spin = gtk_hbox_new (FALSE, 8);
736 spinbtn_timeout_adj = GTK_ADJUSTMENT(gtk_adjustment_new (0, 0, 300, 1, 10, 0));
737 spinbtn_timeout = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_timeout_adj), 1, 0);
738 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_timeout, FALSE, FALSE, 0);
739 gtk_widget_set_size_request (spinbtn_timeout, 64, -1);
740 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_timeout), TRUE);
741 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
742 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
744 CLAWS_SET_TIP(spinbtn_timeout, _(
745 "The timeout period in seconds." ));
749 label = gtk_label_new(_("Maximum Entries"));
750 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
751 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
753 hbox_spin = gtk_hbox_new (FALSE, 8);
754 spinbtn_maxentry_adj = GTK_ADJUSTMENT(gtk_adjustment_new (0, 0, 500, 1, 10, 0));
755 spinbtn_maxentry = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_maxentry_adj), 1, 0);
756 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_maxentry, FALSE, FALSE, 0);
757 gtk_widget_set_size_request (spinbtn_maxentry, 64, -1);
758 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_maxentry), TRUE);
759 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
760 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
762 CLAWS_SET_TIP(spinbtn_maxentry, _(
763 "The maximum number of entries that should be returned " \
764 "in the search result." ));
767 gtk_widget_show_all(vbox);
769 ldapedit.entry_bindDN = entry_bindDN;
770 ldapedit.entry_bindPW = entry_bindPW;
771 ldapedit.spinbtn_timeout = spinbtn_timeout;
772 ldapedit.spinbtn_maxentry = spinbtn_maxentry;
775 static void addressbook_edit_ldap_create( gboolean *cancelled ) {
777 addressbook_edit_ldap_dialog_create( cancelled );
778 addressbook_edit_ldap_page_basic( page++, _( "Basic" ) );
779 addressbook_edit_ldap_page_search( page++, _( "Search" ) );
780 addressbook_edit_ldap_page_extended( page++, _( "Extended" ) );
781 gtk_widget_show_all( ldapedit.window );
785 * Format criteria list for display.
786 * \param ctl Control object.
787 * \return Formatted string, or <i>NULL</i> if no attributes found.
789 static gchar *editldap_build_criteria_list( const LdapControl *ctl ) {
794 node = ldapctl_get_criteria_list( ctl );
796 gchar *attr = node->data;
798 tmp = g_strdup_printf( "%s, %s", str, attr );
804 str = g_strdup( attr );
806 node = g_list_next( node );
813 * Parse out individual attribute names from criteria string.
814 * \param criteria Criteria string.
815 * \ctl Control object.
817 static void editldap_parse_criteria( gchar *criteria, LdapControl *ctl ) {
822 /* Replace delimiters with spaces */
825 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
831 ldapctl_criteria_list_clear( ctl );
832 splitStr = g_strsplit( criteria, " ", 0 );
837 ldapctl_criteria_list_add( ctl, splitStr[i] );
845 g_strfreev( splitStr );
849 * Clear entry fields to reasonable defaults (for a new server entry).
851 static void edit_ldap_clear_fields(void) {
853 GTK_ENTRY(ldapedit.entry_name), ADDRESSBOOK_GUESS_LDAP_NAME );
855 GTK_ENTRY(ldapedit.entry_server), ADDRESSBOOK_GUESS_LDAP_SERVER );
856 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), "");
857 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindDN), "");
858 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindPW), "");
859 gtk_spin_button_set_value(
860 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ), LDAPCTL_DFL_PORT );
861 gtk_spin_button_set_value(
862 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ), LDAPCTL_DFL_TIMEOUT );
863 gtk_spin_button_set_value(
864 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ), LDAPCTL_DFL_TIMEOUT );
866 GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
867 gtk_spin_button_set_value(
868 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), LDAPCTL_DFL_QUERY_AGE );
869 gtk_toggle_button_set_active(
870 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), TRUE );
871 gtk_toggle_button_set_active(
872 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption), FALSE );
873 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
874 gtk_toggle_button_set_active(
875 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl), FALSE );
876 gtk_toggle_button_set_active(
877 GTK_TOGGLE_BUTTON( ldapedit.enable_tls), FALSE );
882 * Load entry fields from server control data.
883 * \param server Server object.
885 static void edit_ldap_set_fields( LdapServer *server ) {
890 if( ldapsvr_get_name( server ) )
891 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_name),
892 ldapsvr_get_name( server ) );
894 ctl = server->control;
897 GTK_ENTRY(ldapedit.entry_server), ctl->hostName);
900 GTK_ENTRY(ldapedit.entry_baseDN), ctl->baseDN );
903 GTK_ENTRY(ldapedit.entry_bindDN), ctl->bindDN );
904 if( ctl->bindPass ) {
905 pwd = ldapctl_get_bind_password( ctl );
906 gtk_entry_set_text( GTK_ENTRY(ldapedit.entry_bindPW), pwd );
909 gtk_spin_button_set_value(
910 GTK_SPIN_BUTTON(ldapedit.spinbtn_timeout), ctl->timeOut );
911 gtk_spin_button_set_value(
912 GTK_SPIN_BUTTON(ldapedit.spinbtn_maxentry), ctl->maxEntries );
913 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
914 gtk_toggle_button_set_active(
915 GTK_TOGGLE_BUTTON(ldapedit.enable_tls), ctl->enableTLS );
916 gtk_toggle_button_set_active(
917 GTK_TOGGLE_BUTTON(ldapedit.enable_ssl), ctl->enableSSL );
919 gtk_spin_button_set_value(
920 GTK_SPIN_BUTTON(ldapedit.spinbtn_port), ctl->port );
921 /* Format criteria */
922 crit = editldap_build_criteria_list( ctl );
924 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), crit );
928 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), "" );
930 gtk_spin_button_set_value(
931 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), ctl->maxQueryAge );
932 gtk_toggle_button_set_active(
933 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), server->searchFlag );
934 gtk_toggle_button_set_active(
935 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption),
936 ( ctl->matchingOption == LDAPCTL_MATCH_CONTAINS ) );
940 * Edit LDAP server datasource that appears addressbook.
941 * \param addrIndex Address index object.
942 * \param ads Data source adapter.
943 * \return Update data source adapter, or <code>NULL</code> if user cancelled
946 AdapterDSource *addressbook_edit_ldap(
947 AddressIndex *addrIndex, AdapterDSource *ads )
949 static gboolean cancelled;
950 gchar *sName, *sHost, *sBase, *sBind, *sPass, *sCrit;
951 gint iPort, iMaxE, iTime, iAge;
952 gboolean bSrch, bMatch;
953 AddressDataSource *ds = NULL;
954 LdapServer *server = NULL;
955 LdapControl *ctl = NULL;
956 gboolean fin, ssl = FALSE, tls = FALSE;
958 if (!ldapedit.window)
959 addressbook_edit_ldap_create(&cancelled);
960 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), PAGE_BASIC );
961 gtk_widget_grab_focus(ldapedit.ok_btn);
962 gtk_widget_grab_focus(ldapedit.entry_name);
963 gtk_widget_show(ldapedit.window);
964 manage_window_set_transient(GTK_WINDOW(ldapedit.window));
965 gtk_window_set_modal(GTK_WINDOW(ldapedit.window), TRUE);
967 edit_ldap_status_show( "" );
969 ds = ads->dataSource;
970 server = ds->rawDataSource;
971 edit_ldap_set_fields( server );
972 gtk_window_set_title(
973 GTK_WINDOW(ldapedit.window), _("Edit LDAP Server"));
976 edit_ldap_clear_fields();
977 gtk_window_set_title(
978 GTK_WINDOW(ldapedit.window), _("Add New LDAP Server"));
982 gtk_widget_hide(ldapedit.window);
983 gtk_window_set_modal(GTK_WINDOW(ldapedit.window), FALSE);
984 if (cancelled == TRUE) return NULL;
986 sName = gtk_editable_get_chars(
987 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
988 sHost = gtk_editable_get_chars(
989 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
990 sBase = gtk_editable_get_chars(
991 GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
992 sCrit = gtk_editable_get_chars(
993 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
994 sBind = gtk_editable_get_chars(
995 GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
996 sPass = gtk_editable_get_chars(
997 GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
998 iPort = gtk_spin_button_get_value_as_int(
999 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
1000 iTime = gtk_spin_button_get_value_as_int(
1001 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
1002 iMaxE = gtk_spin_button_get_value_as_int(
1003 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ) );
1004 iAge = gtk_spin_button_get_value_as_int(
1005 GTK_SPIN_BUTTON( ldapedit.spinbtn_queryage ) );
1006 bSrch = gtk_toggle_button_get_active(
1007 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch ) );
1008 bMatch = gtk_toggle_button_get_active(
1009 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption ) );
1010 #if (defined USE_LDAP_TLS || defined G_OS_WIN32)
1011 ssl = gtk_toggle_button_get_active(
1012 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl ) );
1013 tls = gtk_toggle_button_get_active(
1014 GTK_TOGGLE_BUTTON( ldapedit.enable_tls ) );
1016 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",
1017 sName, sHost, sBase, sCrit, sBind, iPort, iTime, iMaxE, iAge, bSrch, bMatch);
1019 if( *sName == '\0' ) fin = TRUE;
1020 if( *sHost == '\0' ) fin = TRUE;
1026 server = ldapsvr_create();
1027 ds = addrindex_index_add_datasource(
1028 addrIndex, ADDR_IF_LDAP, server );
1029 ads = addressbook_create_ds_adapter(
1030 ds, ADDR_LDAP, NULL );
1032 ctl = server->control;
1033 addressbook_ads_set_name( ads, sName );
1034 ldapsvr_set_name( server, sName );
1035 ldapsvr_set_search_flag( server, bSrch );
1036 ldapctl_set_host( ctl, sHost );
1037 ldapctl_set_base_dn( ctl, sBase );
1038 ldapctl_set_bind_dn( ctl, sBind );
1039 ldapctl_set_bind_password( ctl, sPass, TRUE, TRUE );
1040 ldapctl_set_port( ctl, iPort );
1041 ldapctl_set_max_entries( ctl, iMaxE );
1042 ldapctl_set_timeout( ctl, iTime );
1043 ldapctl_set_max_query_age( ctl, iAge );
1044 ldapctl_set_tls( ctl, tls );
1045 ldapctl_set_ssl( ctl, ssl );
1046 ldapctl_set_matching_option(
1048 LDAPCTL_MATCH_CONTAINS : LDAPCTL_MATCH_BEGINWITH );
1050 addrindex_save_data(addrIndex);
1052 /* Save attributes */
1053 editldap_parse_criteria( sCrit, ctl );
1066 #endif /* USE_LDAP */