2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2007 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.
33 #include <glib/gi18n.h>
34 #include <gdk/gdkkeysyms.h>
35 #include <gtk/gtkwindow.h>
36 #include <gtk/gtksignal.h>
37 #include <gtk/gtklabel.h>
38 #include <gtk/gtkentry.h>
39 #include <gtk/gtktable.h>
40 #include <gtk/gtkbutton.h>
42 #include "addressbook.h"
43 #include "prefs_common.h"
44 #include "addressitem.h"
46 #include "ldapserver.h"
49 #include "editldap_basedn.h"
50 #include "manage_window.h"
52 #include "prefs_gtk.h"
56 #define PAGE_EXTENDED 2
58 #define ADDRESSBOOK_GUESS_LDAP_NAME "MyServer"
59 #define ADDRESSBOOK_GUESS_LDAP_SERVER "localhost"
61 #define LDAPEDIT_TABLE_ROWS 6
62 #define LDAPEDIT_TABLE_COLS 3
64 static struct _LDAPEdit {
68 GtkWidget *cancel_btn;
71 GtkWidget *entry_name;
72 GtkWidget *entry_server;
73 GtkWidget *spinbtn_port;
74 GtkWidget *entry_baseDN;
75 GtkWidget *spinbtn_timeout;
76 GtkWidget *entry_bindDN;
77 GtkWidget *entry_bindPW;
78 GtkWidget *spinbtn_maxentry;
79 GtkWidget *entry_criteria;
80 GtkWidget *spinbtn_queryage;
81 GtkWidget *check_dynsearch;
82 GtkWidget *check_matchoption;
84 GtkWidget *enable_ssl;
85 GtkWidget *enable_tls;
90 * Parse out individual attribute names from criteria string.
91 * \param criteria Criteria string.
92 * \ctl Control object.
94 static gboolean editldap_validate_criteria( gchar *criteria ) {
100 g_return_val_if_fail(criteria != NULL, TRUE);
104 /* Replace delimiters with spaces */
107 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
111 debug_print("cleaned criteria list: %s\n", criteria);
114 splitStr = g_strsplit( criteria, " ", 0 );
128 g_strfreev( splitStr );
135 static void edit_ldap_status_show( gchar *msg ) {
136 if( ldapedit.statusbar != NULL ) {
137 gtk_statusbar_pop( GTK_STATUSBAR(ldapedit.statusbar), ldapedit.status_cid );
139 gtk_statusbar_push( GTK_STATUSBAR(ldapedit.statusbar),
140 ldapedit.status_cid, msg );
145 static gboolean edit_ldap_validate( void ) {
151 str = gtk_editable_get_chars(
152 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
155 gtk_widget_grab_focus( ldapedit.entry_name );
156 edit_ldap_status_show( _( "A Name must be supplied." ) );
162 str = gtk_editable_get_chars(
163 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
166 gtk_widget_grab_focus( ldapedit.entry_server );
167 edit_ldap_status_show(
168 _( "A Hostname must be supplied for the server." ) );
175 str = gtk_editable_get_chars(
176 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
177 if( editldap_validate_criteria( str ) ) {
179 gtk_widget_grab_focus( ldapedit.entry_criteria );
180 edit_ldap_status_show(
181 _( "At least one LDAP search attribute should be supplied." ) );
187 /* Switch to page with error */
189 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), page );
195 static void edit_ldap_ok( GtkWidget *widget, gboolean *cancelled ) {
196 if( ! edit_ldap_validate() ) {
202 static void edit_ldap_cancel( GtkWidget *widget, gboolean *cancelled ) {
207 static gint edit_ldap_delete_event( GtkWidget *widget, GdkEventAny *event, gboolean *cancelled ) {
213 static gboolean edit_ldap_key_pressed( GtkWidget *widget, GdkEventKey *event, gboolean *cancelled ) {
214 if (event && event->keyval == GDK_Escape) {
221 static void edit_ldap_server_check( void ) {
222 gchar *sHost, *sBind, *sPass;
225 gchar *sBaseDN = NULL;
228 gboolean tls = FALSE, ssl = FALSE;
229 GList *baseDN = NULL;
231 edit_ldap_status_show( "" );
233 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
234 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
235 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
236 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
237 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
239 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
240 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
243 g_strchomp( sHost ); g_strchug( sHost );
244 g_strchomp( sBind ); g_strchug( sBind );
245 g_strchomp( sPass ); g_strchug( sPass );
246 if( *sHost != '\0' ) {
247 /* Test connection to server */
248 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
249 if( ldaputil_test_connect( sHost, iPort, ssl, tls, iTime ) ) {
250 /* Attempt to read base DN */
251 baseDN = ldaputil_read_basedn( sHost, iPort, sBind, sPass, iTime, ssl, tls );
253 GList *node = baseDN;
257 sBaseDN = g_strdup( node->data );
259 node = g_list_next( node );
261 mgu_free_dlist( baseDN );
262 baseDN = node = NULL;
275 debug_print("baseDN: %s\n", sBaseDN);
276 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), sBaseDN);
280 /* Display appropriate message */
282 sMsg = _( "Connected successfully to server" );
285 sMsg = _( "Could not connect to server" );
287 edit_ldap_status_show( sMsg );
290 static void edit_ldap_basedn_select( void ) {
291 gchar *sHost, *sBind, *sPass, *sBase;
292 gint iPort, iTime, tls = 0, ssl = 0;
295 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
296 sBase = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
297 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
298 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
299 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
300 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
302 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
303 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
306 g_strchomp( sHost ); g_strchug( sHost );
307 g_strchomp( sBind ); g_strchug( sBind );
308 g_strchomp( sPass ); g_strchug( sPass );
309 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
310 selectDN = edit_ldap_basedn_selection( sHost, iPort, sBase, iTime, sBind, sPass, ssl, tls );
312 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), selectDN);
322 static void edit_ldap_search_reset(void) {
323 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
326 static void addressbook_edit_ldap_dialog_create( gboolean *cancelled ) {
332 GtkWidget *cancel_btn;
334 GtkWidget *statusbar;
336 debug_print("creating edit_ldap_dialog\n");
337 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "editldap");
338 gtk_widget_set_size_request(window, 450, -1);
339 gtk_container_set_border_width(GTK_CONTAINER(window), 0);
340 gtk_window_set_title(GTK_WINDOW(window), _("Edit LDAP Server"));
341 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
342 gtk_window_set_modal(GTK_WINDOW(window), TRUE);
343 g_signal_connect(G_OBJECT(window), "delete_event",
344 G_CALLBACK(edit_ldap_delete_event),
346 g_signal_connect(G_OBJECT(window), "key_press_event",
347 G_CALLBACK(edit_ldap_key_pressed),
350 vbox = gtk_vbox_new( FALSE, 6 );
351 gtk_widget_show( vbox );
352 gtk_container_add( GTK_CONTAINER( window ), vbox );
355 notebook = gtk_notebook_new();
356 gtk_widget_show( notebook );
357 gtk_box_pack_start( GTK_BOX( vbox ), notebook, TRUE, TRUE, 0 );
358 gtk_container_set_border_width( GTK_CONTAINER( notebook ), 6 );
361 hsbox = gtk_hbox_new(FALSE, 0);
362 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
363 statusbar = gtk_statusbar_new();
364 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
367 gtkut_stock_button_set_create(&hbbox, &cancel_btn, GTK_STOCK_CANCEL,
368 &ok_btn, GTK_STOCK_OK,
370 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
371 gtk_widget_grab_default(ok_btn);
373 g_signal_connect(G_OBJECT(ok_btn), "clicked",
374 G_CALLBACK(edit_ldap_ok), cancelled);
375 g_signal_connect(G_OBJECT(cancel_btn), "clicked",
376 G_CALLBACK(edit_ldap_cancel), cancelled);
378 gtk_widget_show_all(vbox);
380 ldapedit.window = window;
381 ldapedit.notebook = notebook;
382 ldapedit.ok_btn = ok_btn;
383 ldapedit.cancel_btn = cancel_btn;
384 ldapedit.statusbar = statusbar;
385 ldapedit.status_cid =
386 gtk_statusbar_get_context_id(
387 GTK_STATUSBAR(statusbar), "Edit LDAP Server Dialog" );
390 static void editldap_update_port (GtkToggleButton *ssl_btn, gpointer data) {
391 gboolean val = gtk_toggle_button_get_active(ssl_btn);
392 gtk_spin_button_set_value(
393 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ),
394 val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT );
395 debug_print("Setting port: %d\n", val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT);
398 static void addressbook_edit_ldap_page_basic( gint pageNum, gchar *pageLbl ) {
402 GtkWidget *entry_name;
403 GtkWidget *entry_server;
404 GtkWidget *hbox_spin;
405 GtkObject *spinbtn_port_adj;
406 GtkWidget *spinbtn_port;
408 GtkWidget *enable_ssl_checkbtn, *enable_tls_checkbtn;
410 GtkWidget *entry_baseDN;
411 GtkWidget *check_btn;
412 GtkWidget *lookdn_btn;
413 GtkTooltips *toolTip;
416 vbox = gtk_vbox_new( FALSE, 8 );
417 gtk_widget_show( vbox );
418 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
420 label = gtk_label_new( pageLbl );
421 gtk_widget_show( label );
422 gtk_notebook_set_tab_label(
423 GTK_NOTEBOOK( ldapedit.notebook ),
424 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
426 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
427 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
428 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
429 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
430 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
434 label = gtk_label_new(_("Name"));
435 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
436 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
438 entry_name = gtk_entry_new();
439 gtk_table_attach(GTK_TABLE(table), entry_name, 1, 2, top, (top + 1),
440 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
442 toolTip = gtk_tooltips_new();
443 gtk_tooltips_set_tip( toolTip, entry_name, _(
444 "A name that you wish to call the server." ),
449 label = gtk_label_new(_("Hostname"));
450 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
451 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
453 entry_server = gtk_entry_new();
454 gtk_table_attach(GTK_TABLE(table), entry_server, 1, 2, top, (top + 1),
455 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
457 toolTip = gtk_tooltips_new();
458 gtk_tooltips_set_tip( toolTip, entry_server, _(
459 "This is the hostname of the server. For example, " \
460 "\"ldap.mydomain.com\" may be appropriate for the " \
461 "\"mydomain.com\" organization. An IP address may also be " \
462 "used. You may specify \"localhost\" if running an LDAP " \
463 "server on the same computer as Claws Mail." ),
468 label = gtk_label_new(_("Port"));
469 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
470 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
472 hbox_spin = gtk_hbox_new (FALSE, 8);
473 spinbtn_port_adj = gtk_adjustment_new (389, 1, 65535, 1, 1000, 1000);
474 spinbtn_port = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_port_adj), 1, 0);
475 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_port, TRUE, FALSE, 0);
476 gtk_widget_set_size_request (spinbtn_port, 64, -1);
477 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_port), TRUE);
480 enable_tls_checkbtn = gtk_check_button_new_with_label(_("TLS"));
481 enable_ssl_checkbtn = gtk_check_button_new_with_label(_("SSL"));
482 SET_TOGGLE_SENSITIVITY_REVERSE(enable_tls_checkbtn, enable_ssl_checkbtn);
483 SET_TOGGLE_SENSITIVITY_REVERSE(enable_ssl_checkbtn, enable_tls_checkbtn);
484 gtk_tooltips_set_tip( toolTip, enable_tls_checkbtn, _(
485 "Enable secure connection to the LDAP server via TLS."
486 "If connection fails, be sure to check the correct "
487 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ),
489 gtk_tooltips_set_tip( toolTip, enable_ssl_checkbtn, _(
490 "Enable secure connection to the LDAP server via SSL."
491 "If connection fails, be sure to check the correct "
492 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ),
495 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_tls_checkbtn, TRUE, FALSE, 0);
496 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_ssl_checkbtn, TRUE, FALSE, 0);
499 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
500 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
502 toolTip = gtk_tooltips_new();
503 gtk_tooltips_set_tip( toolTip, spinbtn_port, _(
504 "The port number that the server listens on. Port 389 is " \
508 check_btn = gtk_button_new_with_label( _(" Check Server "));
509 gtk_table_attach(GTK_TABLE(table), check_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
511 toolTip = gtk_tooltips_new();
512 gtk_tooltips_set_tip( toolTip, check_btn, _(
513 "Press this button to test the connection to the server." ),
518 label = gtk_label_new(_("Search Base"));
519 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
520 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
522 entry_baseDN = gtk_entry_new();
523 gtk_table_attach(GTK_TABLE(table), entry_baseDN, 1, 2, top, (top + 1),
524 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
526 toolTip = gtk_tooltips_new();
527 gtk_tooltips_set_tip( toolTip, entry_baseDN, _(
528 "This specifies the name of the directory to be searched " \
529 "on the server. Examples include:\n" \
530 " dc=claws-mail,dc=org\n" \
531 " ou=people,dc=domainname,dc=com\n" \
532 " o=Organization Name,c=Country\n"
536 lookdn_btn = gtkut_get_browse_file_btn(_("_Browse"));
537 gtk_table_attach(GTK_TABLE(table), lookdn_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
539 toolTip = gtk_tooltips_new();
540 gtk_tooltips_set_tip( toolTip, lookdn_btn, _(
541 "Press this button to lookup the name of available " \
542 "directory names on the server." ),
545 /* Signal handlers */
546 g_signal_connect(G_OBJECT(check_btn), "clicked",
547 G_CALLBACK(edit_ldap_server_check), NULL);
548 g_signal_connect(G_OBJECT(lookdn_btn), "clicked",
549 G_CALLBACK(edit_ldap_basedn_select), NULL);
552 gtk_widget_show_all(vbox);
554 ldapedit.entry_name = entry_name;
555 ldapedit.entry_server = entry_server;
556 ldapedit.spinbtn_port = spinbtn_port;
557 ldapedit.entry_baseDN = entry_baseDN;
559 ldapedit.enable_ssl = enable_ssl_checkbtn;
560 ldapedit.enable_tls = enable_tls_checkbtn;
562 g_signal_connect(G_OBJECT(enable_ssl_checkbtn), "toggled", \
563 G_CALLBACK(editldap_update_port), NULL);
567 static void addressbook_edit_ldap_page_search( gint pageNum, gchar *pageLbl ) {
571 GtkWidget *entry_criteria;
572 GtkWidget *hbox_spin;
573 GtkObject *spinbtn_queryage_adj;
574 GtkWidget *spinbtn_queryage;
575 GtkWidget *check_dynsearch;
576 GtkWidget *check_matchoption;
577 GtkWidget *reset_btn;
578 GtkTooltips *toolTip;
581 vbox = gtk_vbox_new( FALSE, 8 );
582 gtk_widget_show( vbox );
583 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
585 label = gtk_label_new( pageLbl );
586 gtk_widget_show( label );
587 gtk_notebook_set_tab_label(
588 GTK_NOTEBOOK( ldapedit.notebook ),
589 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
591 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
592 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
593 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
594 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
595 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
599 label = gtk_label_new(_("Search Attributes"));
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 entry_criteria = gtk_entry_new();
604 gtk_table_attach(GTK_TABLE(table), entry_criteria, 1, 2, top, (top + 1),
605 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
607 toolTip = gtk_tooltips_new();
608 gtk_tooltips_set_tip( toolTip, entry_criteria, _(
609 "A list of LDAP attribute names that should be searched " \
610 "when attempting to find a name or address." ),
613 reset_btn = gtk_button_new_with_label( _(" Defaults "));
614 gtk_table_attach(GTK_TABLE(table), reset_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
616 toolTip = gtk_tooltips_new();
617 gtk_tooltips_set_tip( toolTip, reset_btn, _(
618 "This resets the attribute names to a default value " \
619 "that should find most names and addresses during a " \
620 "name or address search process." ),
625 label = gtk_label_new(_("Max Query Age (secs)"));
626 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
627 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
629 hbox_spin = gtk_hbox_new (FALSE, 8);
630 spinbtn_queryage_adj = gtk_adjustment_new(
631 LDAPCTL_DFL_QUERY_AGE, 1, LDAPCTL_MAX_QUERY_AGE, 10, 1000, 1000 );
632 spinbtn_queryage = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_queryage_adj), 1, 0);
633 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_queryage, FALSE, FALSE, 0);
634 gtk_widget_set_size_request (spinbtn_queryage, 64, -1);
635 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_queryage), TRUE);
636 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
637 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
639 toolTip = gtk_tooltips_new();
640 gtk_tooltips_set_tip( toolTip, spinbtn_queryage, _(
641 "This defines the maximum period of time (in seconds) that " \
642 "an address search result is valid for address completion " \
643 "purposes. Search results are stored in a cache until this " \
644 "period of time has passed and then retired. This will " \
645 "improve the response time when attempting to search for " \
646 "the same name or address on subsequent address completion " \
647 "requests. The cache will be searched in preference to " \
648 "performing a new server search request. The default value " \
649 "of 600 seconds (10 minutes), should be sufficient for most " \
650 "servers. A larger value will reduce the search time for " \
651 "subsequent searches. This is useful for servers that have " \
652 "slow response times at the expense of more memory to cache " \
658 check_dynsearch = gtk_check_button_new_with_label(
659 _("Include server in dynamic search") );
660 gtk_table_attach(GTK_TABLE(table), check_dynsearch, 1, 3, top, (top + 1),
661 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
663 toolTip = gtk_tooltips_new();
664 gtk_tooltips_set_tip( toolTip, check_dynsearch, _(
665 "Check this option to include this server for dynamic " \
666 "searches when using address completion." ),
671 check_matchoption = gtk_check_button_new_with_label(
672 _("Match names 'containing' search term") );
673 gtk_table_attach(GTK_TABLE(table), check_matchoption, 1, 3, top, (top + 1),
674 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
676 toolTip = gtk_tooltips_new();
677 gtk_tooltips_set_tip( toolTip, check_matchoption, _(
678 "Searches for names and addresses can be performed either " \
679 "using \"begins-with\" or \"contains\" search term. Check " \
680 "this option to perform a \"contains\" search; this type of " \
681 "search usually takes longer to complete. Note that for " \
682 "performance reasons, address completion uses " \
683 "\"begins-with\" for all searches against other address " \
688 /* Signal handlers */
689 g_signal_connect(G_OBJECT(reset_btn), "clicked",
690 G_CALLBACK(edit_ldap_search_reset), NULL);
693 gtk_widget_show_all(vbox);
695 ldapedit.entry_criteria = entry_criteria;
696 ldapedit.spinbtn_queryage = spinbtn_queryage;
697 ldapedit.check_dynsearch = check_dynsearch;
698 ldapedit.check_matchoption = check_matchoption;
701 static void addressbook_edit_ldap_page_extended( gint pageNum, gchar *pageLbl ) {
705 GtkWidget *entry_bindDN;
706 GtkWidget *entry_bindPW;
707 GtkWidget *hbox_spin;
708 GtkObject *spinbtn_timeout_adj;
709 GtkWidget *spinbtn_timeout;
710 GtkObject *spinbtn_maxentry_adj;
711 GtkWidget *spinbtn_maxentry;
712 GtkTooltips *toolTip;
715 vbox = gtk_vbox_new( FALSE, 8 );
716 gtk_widget_show( vbox );
717 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
719 label = gtk_label_new( pageLbl );
720 gtk_widget_show( label );
721 gtk_notebook_set_tab_label(
722 GTK_NOTEBOOK( ldapedit.notebook ),
723 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
725 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
726 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
727 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
728 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
729 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
733 label = gtk_label_new(_("Bind DN"));
734 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
735 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
737 entry_bindDN = gtk_entry_new();
738 gtk_table_attach(GTK_TABLE(table), entry_bindDN, 1, 2, top, (top + 1),
739 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
741 toolTip = gtk_tooltips_new();
742 gtk_tooltips_set_tip( toolTip, entry_bindDN, _(
743 "The LDAP user account name to be used to connect to the server. " \
744 "This is usually only used for protected servers. This name " \
745 "is typically formatted as: \"cn=user,dc=claws-mail,dc=org\". " \
746 "This is usually left empty when performing a search." ),
751 label = gtk_label_new(_("Bind Password"));
752 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
753 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
755 entry_bindPW = gtk_entry_new();
756 gtk_table_attach(GTK_TABLE(table), entry_bindPW, 1, 2, top, (top + 1),
757 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
758 gtk_entry_set_visibility(GTK_ENTRY(entry_bindPW), FALSE);
760 hildon_gtk_entry_set_input_mode(GTK_ENTRY(entry_bindPW),
761 HILDON_GTK_INPUT_MODE_FULL | HILDON_GTK_INPUT_MODE_INVISIBLE);
764 toolTip = gtk_tooltips_new();
765 gtk_tooltips_set_tip( toolTip, entry_bindPW, _(
766 "The password to be used when connecting as the \"Bind DN\" " \
772 label = gtk_label_new(_("Timeout (secs)"));
773 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
774 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
776 hbox_spin = gtk_hbox_new (FALSE, 8);
777 spinbtn_timeout_adj = gtk_adjustment_new (0, 0, 300, 1, 10, 10);
778 spinbtn_timeout = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_timeout_adj), 1, 0);
779 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_timeout, FALSE, FALSE, 0);
780 gtk_widget_set_size_request (spinbtn_timeout, 64, -1);
781 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_timeout), TRUE);
782 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
783 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
785 toolTip = gtk_tooltips_new();
786 gtk_tooltips_set_tip( toolTip, spinbtn_timeout, _(
787 "The timeout period in seconds." ), NULL );
791 label = gtk_label_new(_("Maximum Entries"));
792 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
793 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
795 hbox_spin = gtk_hbox_new (FALSE, 8);
796 spinbtn_maxentry_adj = gtk_adjustment_new (0, 0, 500, 1, 10, 10);
797 spinbtn_maxentry = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_maxentry_adj), 1, 0);
798 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_maxentry, FALSE, FALSE, 0);
799 gtk_widget_set_size_request (spinbtn_maxentry, 64, -1);
800 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_maxentry), TRUE);
801 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
802 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
804 toolTip = gtk_tooltips_new();
805 gtk_tooltips_set_tip( toolTip, spinbtn_maxentry, _(
806 "The maximum number of entries that should be returned " \
807 "in the search result." ),
811 gtk_widget_show_all(vbox);
813 ldapedit.entry_bindDN = entry_bindDN;
814 ldapedit.entry_bindPW = entry_bindPW;
815 ldapedit.spinbtn_timeout = spinbtn_timeout;
816 ldapedit.spinbtn_maxentry = spinbtn_maxentry;
819 static void addressbook_edit_ldap_create( gboolean *cancelled ) {
821 addressbook_edit_ldap_dialog_create( cancelled );
822 addressbook_edit_ldap_page_basic( page++, _( "Basic" ) );
823 addressbook_edit_ldap_page_search( page++, _( "Search" ) );
824 addressbook_edit_ldap_page_extended( page++, _( "Extended" ) );
825 gtk_widget_show_all( ldapedit.window );
829 * Format criteria list for display.
830 * \param ctl Control object.
831 * \return Formatted string, or <i>NULL</i> if no attributes found.
833 static gchar *editldap_build_criteria_list( const LdapControl *ctl ) {
838 node = ldapctl_get_criteria_list( ctl );
840 gchar *attr = node->data;
842 tmp = g_strdup_printf( "%s, %s", str, attr );
848 str = g_strdup( attr );
850 node = g_list_next( node );
857 * Parse out individual attribute names from criteria string.
858 * \param criteria Criteria string.
859 * \ctl Control object.
861 static void editldap_parse_criteria( gchar *criteria, LdapControl *ctl ) {
866 /* Replace delimiters with spaces */
869 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
875 ldapctl_criteria_list_clear( ctl );
876 splitStr = g_strsplit( criteria, " ", 0 );
881 ldapctl_criteria_list_add( ctl, splitStr[i] );
889 g_strfreev( splitStr );
893 * Clear entry fields to reasonable defaults (for a new server entry).
895 static void edit_ldap_clear_fields(void) {
897 GTK_ENTRY(ldapedit.entry_name), ADDRESSBOOK_GUESS_LDAP_NAME );
899 GTK_ENTRY(ldapedit.entry_server), ADDRESSBOOK_GUESS_LDAP_SERVER );
900 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), "");
901 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindDN), "");
902 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindPW), "");
903 gtk_spin_button_set_value(
904 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ), LDAPCTL_DFL_PORT );
905 gtk_spin_button_set_value(
906 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ), LDAPCTL_DFL_TIMEOUT );
907 gtk_spin_button_set_value(
908 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ), LDAPCTL_DFL_TIMEOUT );
910 GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
911 gtk_spin_button_set_value(
912 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), LDAPCTL_DFL_QUERY_AGE );
913 gtk_toggle_button_set_active(
914 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), TRUE );
915 gtk_toggle_button_set_active(
916 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption), FALSE );
918 gtk_toggle_button_set_active(
919 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl), FALSE );
920 gtk_toggle_button_set_active(
921 GTK_TOGGLE_BUTTON( ldapedit.enable_tls), FALSE );
926 * Load entry fields from server control data.
927 * \param server Server object.
929 static void edit_ldap_set_fields( LdapServer *server ) {
933 if( ldapsvr_get_name( server ) )
934 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_name),
935 ldapsvr_get_name( server ) );
937 ctl = server->control;
940 GTK_ENTRY(ldapedit.entry_server), ctl->hostName);
943 GTK_ENTRY(ldapedit.entry_baseDN), ctl->baseDN );
946 GTK_ENTRY(ldapedit.entry_bindDN), ctl->bindDN );
949 GTK_ENTRY(ldapedit.entry_bindPW), ctl->bindPass );
950 gtk_spin_button_set_value(
951 GTK_SPIN_BUTTON(ldapedit.spinbtn_timeout), ctl->timeOut );
952 gtk_spin_button_set_value(
953 GTK_SPIN_BUTTON(ldapedit.spinbtn_maxentry), ctl->maxEntries );
955 gtk_toggle_button_set_active(
956 GTK_TOGGLE_BUTTON(ldapedit.enable_tls), ctl->enableTLS );
957 gtk_toggle_button_set_active(
958 GTK_TOGGLE_BUTTON(ldapedit.enable_ssl), ctl->enableSSL );
960 gtk_spin_button_set_value(
961 GTK_SPIN_BUTTON(ldapedit.spinbtn_port), ctl->port );
962 /* Format criteria */
963 crit = editldap_build_criteria_list( ctl );
965 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), crit );
969 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), "" );
971 gtk_spin_button_set_value(
972 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), ctl->maxQueryAge );
973 gtk_toggle_button_set_active(
974 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), server->searchFlag );
975 gtk_toggle_button_set_active(
976 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption),
977 ( ctl->matchingOption == LDAPCTL_MATCH_CONTAINS ) );
981 * Edit LDAP server datasource that appears addressbook.
982 * \param addrIndex Address index object.
983 * \param ads Data source adapter.
984 * \return Update data source adapter, or <code>NULL</code> if user cancelled
987 AdapterDSource *addressbook_edit_ldap(
988 AddressIndex *addrIndex, AdapterDSource *ads )
990 static gboolean cancelled;
991 gchar *sName, *sHost, *sBase, *sBind, *sPass, *sCrit;
992 gint iPort, iMaxE, iTime, iAge;
993 gboolean bSrch, bMatch;
994 AddressDataSource *ds = NULL;
995 LdapServer *server = NULL;
996 LdapControl *ctl = NULL;
997 gboolean fin, ssl = FALSE, tls = FALSE;
999 if (!ldapedit.window)
1000 addressbook_edit_ldap_create(&cancelled);
1001 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), PAGE_BASIC );
1002 gtk_widget_grab_focus(ldapedit.ok_btn);
1003 gtk_widget_grab_focus(ldapedit.entry_name);
1004 gtk_widget_show(ldapedit.window);
1005 manage_window_set_transient(GTK_WINDOW(ldapedit.window));
1007 edit_ldap_status_show( "" );
1009 ds = ads->dataSource;
1010 server = ds->rawDataSource;
1011 edit_ldap_set_fields( server );
1012 gtk_window_set_title(
1013 GTK_WINDOW(ldapedit.window), _("Edit LDAP Server"));
1016 edit_ldap_clear_fields();
1017 gtk_window_set_title(
1018 GTK_WINDOW(ldapedit.window), _("Add New LDAP Server"));
1022 gtk_widget_hide(ldapedit.window);
1023 if (cancelled == TRUE) return NULL;
1025 sName = gtk_editable_get_chars(
1026 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
1027 sHost = gtk_editable_get_chars(
1028 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
1029 sBase = gtk_editable_get_chars(
1030 GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
1031 sCrit = gtk_editable_get_chars(
1032 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
1033 sBind = gtk_editable_get_chars(
1034 GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
1035 sPass = gtk_editable_get_chars(
1036 GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
1037 iPort = gtk_spin_button_get_value_as_int(
1038 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
1039 iTime = gtk_spin_button_get_value_as_int(
1040 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
1041 iMaxE = gtk_spin_button_get_value_as_int(
1042 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ) );
1043 iAge = gtk_spin_button_get_value_as_int(
1044 GTK_SPIN_BUTTON( ldapedit.spinbtn_queryage ) );
1045 bSrch = gtk_toggle_button_get_active(
1046 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch ) );
1047 bMatch = gtk_toggle_button_get_active(
1048 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption ) );
1050 ssl = gtk_toggle_button_get_active(
1051 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl ) );
1052 tls = gtk_toggle_button_get_active(
1053 GTK_TOGGLE_BUTTON( ldapedit.enable_tls ) );
1055 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",
1056 sName, sHost, sBase, sCrit, sBind, iPort, iTime, iMaxE, iAge, bSrch, bMatch);
1058 if( *sName == '\0' ) fin = TRUE;
1059 if( *sHost == '\0' ) fin = TRUE;
1065 server = ldapsvr_create();
1066 ds = addrindex_index_add_datasource(
1067 addrIndex, ADDR_IF_LDAP, server );
1068 ads = addressbook_create_ds_adapter(
1069 ds, ADDR_LDAP, NULL );
1071 ctl = server->control;
1072 addressbook_ads_set_name( ads, sName );
1073 ldapsvr_set_name( server, sName );
1074 ldapsvr_set_search_flag( server, bSrch );
1075 ldapctl_set_host( ctl, sHost );
1076 ldapctl_set_base_dn( ctl, sBase );
1077 ldapctl_set_bind_dn( ctl, sBind );
1078 ldapctl_set_bind_password( ctl, sPass );
1079 ldapctl_set_port( ctl, iPort );
1080 ldapctl_set_max_entries( ctl, iMaxE );
1081 ldapctl_set_timeout( ctl, iTime );
1082 ldapctl_set_max_query_age( ctl, iAge );
1084 ldapctl_set_tls( ctl, tls );
1085 ldapctl_set_ssl( ctl, ssl );
1087 ldapctl_set_matching_option(
1089 LDAPCTL_MATCH_CONTAINS : LDAPCTL_MATCH_BEGINWITH );
1091 /* Save attributes */
1092 editldap_parse_criteria( sCrit, ctl );
1105 #endif /* USE_LDAP */