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 ) {
102 /* Replace delimiters with spaces */
105 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
109 debug_print("cleaned criteria list: %s\n", criteria);
112 splitStr = g_strsplit( criteria, " ", 0 );
126 g_strfreev( splitStr );
133 static void edit_ldap_status_show( gchar *msg ) {
134 if( ldapedit.statusbar != NULL ) {
135 gtk_statusbar_pop( GTK_STATUSBAR(ldapedit.statusbar), ldapedit.status_cid );
137 gtk_statusbar_push( GTK_STATUSBAR(ldapedit.statusbar),
138 ldapedit.status_cid, msg );
143 static gboolean edit_ldap_validate( void ) {
149 str = gtk_editable_get_chars(
150 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
153 gtk_widget_grab_focus( ldapedit.entry_name );
154 edit_ldap_status_show( _( "A Name must be supplied." ) );
160 str = gtk_editable_get_chars(
161 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
164 gtk_widget_grab_focus( ldapedit.entry_server );
165 edit_ldap_status_show(
166 _( "A Hostname must be supplied for the server." ) );
173 str = gtk_editable_get_chars(
174 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
175 if( editldap_validate_criteria( str ) ) {
177 gtk_widget_grab_focus( ldapedit.entry_criteria );
178 edit_ldap_status_show(
179 _( "At least one LDAP search attribute should be supplied." ) );
185 /* Switch to page with error */
187 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), page );
193 static void edit_ldap_ok( GtkWidget *widget, gboolean *cancelled ) {
194 if( ! edit_ldap_validate() ) {
200 static void edit_ldap_cancel( GtkWidget *widget, gboolean *cancelled ) {
205 static gint edit_ldap_delete_event( GtkWidget *widget, GdkEventAny *event, gboolean *cancelled ) {
211 static gboolean edit_ldap_key_pressed( GtkWidget *widget, GdkEventKey *event, gboolean *cancelled ) {
212 if (event && event->keyval == GDK_Escape) {
219 static void edit_ldap_server_check( void ) {
220 gchar *sHost, *sBind, *sPass;
223 gchar *sBaseDN = NULL;
226 gboolean tls = FALSE, ssl = FALSE;
227 GList *baseDN = NULL;
229 edit_ldap_status_show( "" );
231 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
232 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
233 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
234 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
235 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
237 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
238 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
241 g_strchomp( sHost ); g_strchug( sHost );
242 g_strchomp( sBind ); g_strchug( sBind );
243 g_strchomp( sPass ); g_strchug( sPass );
244 if( *sHost != '\0' ) {
245 /* Test connection to server */
246 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
247 if( ldaputil_test_connect( sHost, iPort, ssl, tls ) ) {
248 /* Attempt to read base DN */
249 baseDN = ldaputil_read_basedn( sHost, iPort, sBind, sPass, iTime, ssl, tls );
251 GList *node = baseDN;
255 sBaseDN = g_strdup( node->data );
257 node = g_list_next( node );
259 mgu_free_dlist( baseDN );
260 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 ) );
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() {
319 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), ldapctl_get_default_criteria());
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 gtk_window_set_modal(GTK_WINDOW(window), TRUE);
339 g_signal_connect(G_OBJECT(window), "delete_event",
340 G_CALLBACK(edit_ldap_delete_event),
342 g_signal_connect(G_OBJECT(window), "key_press_event",
343 G_CALLBACK(edit_ldap_key_pressed),
346 vbox = gtk_vbox_new( FALSE, 6 );
347 gtk_widget_show( vbox );
348 gtk_container_add( GTK_CONTAINER( window ), vbox );
351 notebook = gtk_notebook_new();
352 gtk_widget_show( notebook );
353 gtk_box_pack_start( GTK_BOX( vbox ), notebook, TRUE, TRUE, 0 );
354 gtk_container_set_border_width( GTK_CONTAINER( notebook ), 6 );
357 hsbox = gtk_hbox_new(FALSE, 0);
358 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
359 statusbar = gtk_statusbar_new();
360 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
363 gtkut_stock_button_set_create(&hbbox, &cancel_btn, GTK_STOCK_CANCEL,
364 &ok_btn, GTK_STOCK_OK,
366 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
367 gtk_widget_grab_default(ok_btn);
369 g_signal_connect(G_OBJECT(ok_btn), "clicked",
370 G_CALLBACK(edit_ldap_ok), cancelled);
371 g_signal_connect(G_OBJECT(cancel_btn), "clicked",
372 G_CALLBACK(edit_ldap_cancel), cancelled);
374 gtk_widget_show_all(vbox);
376 ldapedit.window = window;
377 ldapedit.notebook = notebook;
378 ldapedit.ok_btn = ok_btn;
379 ldapedit.cancel_btn = cancel_btn;
380 ldapedit.statusbar = statusbar;
381 ldapedit.status_cid =
382 gtk_statusbar_get_context_id(
383 GTK_STATUSBAR(statusbar), "Edit LDAP Server Dialog" );
386 static void editldap_update_port (GtkToggleButton *ssl_btn, gpointer data) {
387 gboolean val = gtk_toggle_button_get_active(ssl_btn);
388 gtk_spin_button_set_value(
389 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ),
390 val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT );
391 debug_print("Setting port: %d\n", val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT);
394 static void addressbook_edit_ldap_page_basic( gint pageNum, gchar *pageLbl ) {
398 GtkWidget *entry_name;
399 GtkWidget *entry_server;
400 GtkWidget *hbox_spin;
401 GtkObject *spinbtn_port_adj;
402 GtkWidget *spinbtn_port;
404 GtkWidget *enable_ssl_checkbtn, *enable_tls_checkbtn;
406 GtkWidget *entry_baseDN;
407 GtkWidget *check_btn;
408 GtkWidget *lookdn_btn;
409 GtkTooltips *toolTip;
412 vbox = gtk_vbox_new( FALSE, 8 );
413 gtk_widget_show( vbox );
414 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
416 label = gtk_label_new( pageLbl );
417 gtk_widget_show( label );
418 gtk_notebook_set_tab_label(
419 GTK_NOTEBOOK( ldapedit.notebook ),
420 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
422 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
423 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
424 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
425 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
426 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
430 label = gtk_label_new(_("Name"));
431 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
432 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
434 entry_name = gtk_entry_new();
435 gtk_table_attach(GTK_TABLE(table), entry_name, 1, 2, top, (top + 1),
436 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
438 toolTip = gtk_tooltips_new();
439 gtk_tooltips_set_tip( toolTip, entry_name, _(
440 "A name that you wish to call the server." ),
445 label = gtk_label_new(_("Hostname"));
446 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
447 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
449 entry_server = gtk_entry_new();
450 gtk_table_attach(GTK_TABLE(table), entry_server, 1, 2, top, (top + 1),
451 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
453 toolTip = gtk_tooltips_new();
454 gtk_tooltips_set_tip( toolTip, entry_server, _(
455 "This is the hostname of the server. For example, " \
456 "\"ldap.mydomain.com\" may be appropriate for the " \
457 "\"mydomain.com\" organization. An IP address may also be " \
458 "used. You may specify \"localhost\" if running an LDAP " \
459 "server on the same computer as Claws Mail." ),
464 label = gtk_label_new(_("Port"));
465 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
466 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
468 hbox_spin = gtk_hbox_new (FALSE, 8);
469 spinbtn_port_adj = gtk_adjustment_new (389, 1, 65535, 1, 1000, 1000);
470 spinbtn_port = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_port_adj), 1, 0);
471 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_port, TRUE, FALSE, 0);
472 gtk_widget_set_size_request (spinbtn_port, 64, -1);
473 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_port), TRUE);
476 enable_tls_checkbtn = gtk_check_button_new_with_label(_("TLS"));
477 enable_ssl_checkbtn = gtk_check_button_new_with_label(_("SSL"));
478 SET_TOGGLE_SENSITIVITY_REVERSE(enable_tls_checkbtn, enable_ssl_checkbtn);
479 SET_TOGGLE_SENSITIVITY_REVERSE(enable_ssl_checkbtn, enable_tls_checkbtn);
480 gtk_tooltips_set_tip( toolTip, enable_tls_checkbtn, _(
481 "Enable secure connection to the LDAP server via TLS."
482 "If connection fails, be sure to check the correct "
483 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ),
485 gtk_tooltips_set_tip( toolTip, enable_ssl_checkbtn, _(
486 "Enable secure connection to the LDAP server via SSL."
487 "If connection fails, be sure to check the correct "
488 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ),
491 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_tls_checkbtn, TRUE, FALSE, 0);
492 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_ssl_checkbtn, TRUE, FALSE, 0);
495 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
496 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
498 toolTip = gtk_tooltips_new();
499 gtk_tooltips_set_tip( toolTip, spinbtn_port, _(
500 "The port number that the server listens on. Port 389 is " \
504 check_btn = gtk_button_new_with_label( _(" Check Server "));
505 gtk_table_attach(GTK_TABLE(table), check_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
507 toolTip = gtk_tooltips_new();
508 gtk_tooltips_set_tip( toolTip, check_btn, _(
509 "Press this button to test the connection to the server." ),
514 label = gtk_label_new(_("Search Base"));
515 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
516 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
518 entry_baseDN = gtk_entry_new();
519 gtk_table_attach(GTK_TABLE(table), entry_baseDN, 1, 2, top, (top + 1),
520 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
522 toolTip = gtk_tooltips_new();
523 gtk_tooltips_set_tip( toolTip, entry_baseDN, _(
524 "This specifies the name of the directory to be searched " \
525 "on the server. Examples include:\n" \
526 " dc=claws-mail,dc=org\n" \
527 " ou=people,dc=domainname,dc=com\n" \
528 " o=Organization Name,c=Country\n"
532 lookdn_btn = gtkut_get_browse_file_btn(_("_Browse"));
533 gtk_table_attach(GTK_TABLE(table), lookdn_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
535 toolTip = gtk_tooltips_new();
536 gtk_tooltips_set_tip( toolTip, lookdn_btn, _(
537 "Press this button to lookup the name of available " \
538 "directory names on the server." ),
541 /* Signal handlers */
542 g_signal_connect(G_OBJECT(check_btn), "clicked",
543 G_CALLBACK(edit_ldap_server_check), NULL);
544 g_signal_connect(G_OBJECT(lookdn_btn), "clicked",
545 G_CALLBACK(edit_ldap_basedn_select), NULL);
548 gtk_widget_show_all(vbox);
550 ldapedit.entry_name = entry_name;
551 ldapedit.entry_server = entry_server;
552 ldapedit.spinbtn_port = spinbtn_port;
553 ldapedit.entry_baseDN = entry_baseDN;
555 ldapedit.enable_ssl = enable_ssl_checkbtn;
556 ldapedit.enable_tls = enable_tls_checkbtn;
558 g_signal_connect(G_OBJECT(enable_ssl_checkbtn), "toggled", \
559 G_CALLBACK(editldap_update_port), NULL);
563 static void addressbook_edit_ldap_page_search( gint pageNum, gchar *pageLbl ) {
567 GtkWidget *entry_criteria;
568 GtkWidget *hbox_spin;
569 GtkObject *spinbtn_queryage_adj;
570 GtkWidget *spinbtn_queryage;
571 GtkWidget *check_dynsearch;
572 GtkWidget *check_matchoption;
573 GtkWidget *reset_btn;
574 GtkTooltips *toolTip;
577 vbox = gtk_vbox_new( FALSE, 8 );
578 gtk_widget_show( vbox );
579 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
581 label = gtk_label_new( pageLbl );
582 gtk_widget_show( label );
583 gtk_notebook_set_tab_label(
584 GTK_NOTEBOOK( ldapedit.notebook ),
585 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
587 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
588 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
589 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
590 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
591 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
595 label = gtk_label_new(_("Search Attributes"));
596 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
597 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
599 entry_criteria = gtk_entry_new();
600 gtk_editable_set_editable(GTK_EDITABLE(entry_criteria), FALSE);
601 gtk_table_attach(GTK_TABLE(table), entry_criteria, 1, 2, top, (top + 1),
602 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
604 toolTip = gtk_tooltips_new();
605 gtk_tooltips_set_tip( toolTip, entry_criteria, _(
606 "A list of LDAP attribute names that should be searched " \
607 "when attempting to find a name or address." ),
610 reset_btn = gtk_button_new_with_label( _(" Defaults "));
611 gtk_table_attach(GTK_TABLE(table), reset_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
613 toolTip = gtk_tooltips_new();
614 gtk_tooltips_set_tip( toolTip, reset_btn, _(
615 "This resets the attribute names to a default value " \
616 "that should find most names and addresses during a " \
617 "name or address search process." ),
622 label = gtk_label_new(_("Max Query Age (secs)"));
623 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
624 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
626 hbox_spin = gtk_hbox_new (FALSE, 8);
627 spinbtn_queryage_adj = gtk_adjustment_new(
628 LDAPCTL_DFL_QUERY_AGE, 1, LDAPCTL_MAX_QUERY_AGE, 10, 1000, 1000 );
629 spinbtn_queryage = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_queryage_adj), 1, 0);
630 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_queryage, FALSE, FALSE, 0);
631 gtk_widget_set_size_request (spinbtn_queryage, 64, -1);
632 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_queryage), TRUE);
633 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
634 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
636 toolTip = gtk_tooltips_new();
637 gtk_tooltips_set_tip( toolTip, spinbtn_queryage, _(
638 "This defines the maximum period of time (in seconds) that " \
639 "an address search result is valid for address completion " \
640 "purposes. Search results are stored in a cache until this " \
641 "period of time has passed and then retired. This will " \
642 "improve the response time when attempting to search for " \
643 "the same name or address on subsequent address completion " \
644 "requests. The cache will be searched in preference to " \
645 "performing a new server search request. The default value " \
646 "of 600 seconds (10 minutes), should be sufficient for most " \
647 "servers. A larger value will reduce the search time for " \
648 "subsequent searches. This is useful for servers that have " \
649 "slow response times at the expense of more memory to cache " \
655 check_dynsearch = gtk_check_button_new_with_label(
656 _("Include server in dynamic search") );
657 gtk_table_attach(GTK_TABLE(table), check_dynsearch, 1, 3, top, (top + 1),
658 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
660 toolTip = gtk_tooltips_new();
661 gtk_tooltips_set_tip( toolTip, check_dynsearch, _(
662 "Check this option to include this server for dynamic " \
663 "searches when using address completion." ),
668 check_matchoption = gtk_check_button_new_with_label(
669 _("Match names 'containing' search term") );
670 gtk_table_attach(GTK_TABLE(table), check_matchoption, 1, 3, top, (top + 1),
671 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
673 toolTip = gtk_tooltips_new();
674 gtk_tooltips_set_tip( toolTip, check_matchoption, _(
675 "Searches for names and addresses can be performed either " \
676 "using \"begins-with\" or \"contains\" search term. Check " \
677 "this option to perform a \"contains\" search; this type of " \
678 "search usually takes longer to complete. Note that for " \
679 "performance reasons, address completion uses " \
680 "\"begins-with\" for all searches against other address " \
685 /* Signal handlers */
686 g_signal_connect(G_OBJECT(reset_btn), "clicked",
687 G_CALLBACK(edit_ldap_search_reset), NULL);
690 gtk_widget_show_all(vbox);
692 ldapedit.entry_criteria = entry_criteria;
693 ldapedit.spinbtn_queryage = spinbtn_queryage;
694 ldapedit.check_dynsearch = check_dynsearch;
695 ldapedit.check_matchoption = check_matchoption;
698 static void addressbook_edit_ldap_page_extended( gint pageNum, gchar *pageLbl ) {
702 GtkWidget *entry_bindDN;
703 GtkWidget *entry_bindPW;
704 GtkWidget *hbox_spin;
705 GtkObject *spinbtn_timeout_adj;
706 GtkWidget *spinbtn_timeout;
707 GtkObject *spinbtn_maxentry_adj;
708 GtkWidget *spinbtn_maxentry;
709 GtkTooltips *toolTip;
712 vbox = gtk_vbox_new( FALSE, 8 );
713 gtk_widget_show( vbox );
714 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
716 label = gtk_label_new( pageLbl );
717 gtk_widget_show( label );
718 gtk_notebook_set_tab_label(
719 GTK_NOTEBOOK( ldapedit.notebook ),
720 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
722 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
723 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
724 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
725 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
726 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
730 label = gtk_label_new(_("Bind DN"));
731 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
732 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
734 entry_bindDN = gtk_entry_new();
735 gtk_table_attach(GTK_TABLE(table), entry_bindDN, 1, 2, top, (top + 1),
736 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
738 toolTip = gtk_tooltips_new();
739 gtk_tooltips_set_tip( toolTip, entry_bindDN, _(
740 "The LDAP user account name to be used to connect to the server. " \
741 "This is usually only used for protected servers. This name " \
742 "is typically formatted as: \"cn=user,dc=claws-mail,dc=org\". " \
743 "This is usually left empty when performing a search." ),
748 label = gtk_label_new(_("Bind Password"));
749 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
750 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
752 entry_bindPW = gtk_entry_new();
753 gtk_table_attach(GTK_TABLE(table), entry_bindPW, 1, 2, top, (top + 1),
754 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
755 gtk_entry_set_visibility(GTK_ENTRY(entry_bindPW), FALSE);
757 toolTip = gtk_tooltips_new();
758 gtk_tooltips_set_tip( toolTip, entry_bindPW, _(
759 "The password to be used when connecting as the \"Bind DN\" " \
765 label = gtk_label_new(_("Timeout (secs)"));
766 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
767 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
769 hbox_spin = gtk_hbox_new (FALSE, 8);
770 spinbtn_timeout_adj = gtk_adjustment_new (0, 0, 300, 1, 10, 10);
771 spinbtn_timeout = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_timeout_adj), 1, 0);
772 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_timeout, FALSE, FALSE, 0);
773 gtk_widget_set_size_request (spinbtn_timeout, 64, -1);
774 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_timeout), TRUE);
775 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
776 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
778 toolTip = gtk_tooltips_new();
779 gtk_tooltips_set_tip( toolTip, spinbtn_timeout, _(
780 "The timeout period in seconds." ), NULL );
784 label = gtk_label_new(_("Maximum Entries"));
785 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
786 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
788 hbox_spin = gtk_hbox_new (FALSE, 8);
789 spinbtn_maxentry_adj = gtk_adjustment_new (0, 0, 500, 1, 10, 10);
790 spinbtn_maxentry = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_maxentry_adj), 1, 0);
791 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_maxentry, FALSE, FALSE, 0);
792 gtk_widget_set_size_request (spinbtn_maxentry, 64, -1);
793 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_maxentry), TRUE);
794 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
795 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
797 toolTip = gtk_tooltips_new();
798 gtk_tooltips_set_tip( toolTip, spinbtn_maxentry, _(
799 "The maximum number of entries that should be returned " \
800 "in the search result." ),
804 gtk_widget_show_all(vbox);
806 ldapedit.entry_bindDN = entry_bindDN;
807 ldapedit.entry_bindPW = entry_bindPW;
808 ldapedit.spinbtn_timeout = spinbtn_timeout;
809 ldapedit.spinbtn_maxentry = spinbtn_maxentry;
812 static void addressbook_edit_ldap_create( gboolean *cancelled ) {
814 addressbook_edit_ldap_dialog_create( cancelled );
815 addressbook_edit_ldap_page_basic( page++, _( "Basic" ) );
816 addressbook_edit_ldap_page_search( page++, _( "Search" ) );
817 addressbook_edit_ldap_page_extended( page++, _( "Extended" ) );
818 gtk_widget_show_all( ldapedit.window );
822 * Format criteria list for display.
823 * \param ctl Control object.
824 * \return Formatted string, or <i>NULL</i> if no attributes found.
826 static gchar *editldap_build_criteria_list( const LdapControl *ctl ) {
831 node = ldapctl_get_criteria_list( ctl );
833 gchar *attr = node->data;
835 tmp = g_strdup_printf( "%s, %s", str, attr );
841 str = g_strdup( attr );
843 node = g_list_next( node );
850 * Parse out individual attribute names from criteria string.
851 * \param criteria Criteria string.
852 * \ctl Control object.
854 static void editldap_parse_criteria( gchar *criteria, LdapControl *ctl ) {
859 /* Replace delimiters with spaces */
862 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
868 ldapctl_criteria_list_clear( ctl );
869 splitStr = g_strsplit( criteria, " ", 0 );
874 ldapctl_criteria_list_add( ctl, splitStr[i] );
882 g_strfreev( splitStr );
886 * Clear entry fields to reasonable defaults (for a new server entry).
888 static void edit_ldap_clear_fields() {
890 GTK_ENTRY(ldapedit.entry_name), ADDRESSBOOK_GUESS_LDAP_NAME );
892 GTK_ENTRY(ldapedit.entry_server), ADDRESSBOOK_GUESS_LDAP_SERVER );
893 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), "");
894 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindDN), "");
895 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindPW), "");
896 gtk_spin_button_set_value(
897 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ), LDAPCTL_DFL_PORT );
898 gtk_spin_button_set_value(
899 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ), LDAPCTL_DFL_TIMEOUT );
900 gtk_spin_button_set_value(
901 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ), LDAPCTL_DFL_TIMEOUT );
903 GTK_ENTRY(ldapedit.entry_criteria), ldapctl_get_default_criteria());
904 gtk_spin_button_set_value(
905 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), LDAPCTL_DFL_QUERY_AGE );
906 gtk_toggle_button_set_active(
907 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), TRUE );
908 gtk_toggle_button_set_active(
909 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption), FALSE );
911 gtk_toggle_button_set_active(
912 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl), FALSE );
913 gtk_toggle_button_set_active(
914 GTK_TOGGLE_BUTTON( ldapedit.enable_tls), FALSE );
919 * Load entry fields from server control data.
920 * \param server Server object.
922 static void edit_ldap_set_fields( LdapServer *server ) {
926 if( ldapsvr_get_name( server ) )
927 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_name),
928 ldapsvr_get_name( server ) );
930 ctl = server->control;
933 GTK_ENTRY(ldapedit.entry_server), ctl->hostName);
936 GTK_ENTRY(ldapedit.entry_baseDN), ctl->baseDN );
939 GTK_ENTRY(ldapedit.entry_bindDN), ctl->bindDN );
942 GTK_ENTRY(ldapedit.entry_bindPW), ctl->bindPass );
943 gtk_spin_button_set_value(
944 GTK_SPIN_BUTTON(ldapedit.spinbtn_timeout), ctl->timeOut );
945 gtk_spin_button_set_value(
946 GTK_SPIN_BUTTON(ldapedit.spinbtn_maxentry), ctl->maxEntries );
948 gtk_toggle_button_set_active(
949 GTK_TOGGLE_BUTTON(ldapedit.enable_tls), ctl->enableTLS );
950 gtk_toggle_button_set_active(
951 GTK_TOGGLE_BUTTON(ldapedit.enable_ssl), ctl->enableSSL );
953 gtk_spin_button_set_value(
954 GTK_SPIN_BUTTON(ldapedit.spinbtn_port), ctl->port );
955 /* Format criteria */
956 crit = editldap_build_criteria_list( ctl );
958 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), crit );
962 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), "" );
964 gtk_spin_button_set_value(
965 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), ctl->maxQueryAge );
966 gtk_toggle_button_set_active(
967 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), server->searchFlag );
968 gtk_toggle_button_set_active(
969 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption),
970 ( ctl->matchingOption == LDAPCTL_MATCH_CONTAINS ) );
974 * Edit LDAP server datasource that appears addressbook.
975 * \param addrIndex Address index object.
976 * \param ads Data source adapter.
977 * \return Update data source adapter, or <code>NULL</code> if user cancelled
980 AdapterDSource *addressbook_edit_ldap(
981 AddressIndex *addrIndex, AdapterDSource *ads )
983 static gboolean cancelled;
984 gchar *sName, *sHost, *sBase, *sBind, *sPass, *sCrit;
985 gint iPort, iMaxE, iTime, iAge;
986 gboolean bSrch, bMatch;
987 AddressDataSource *ds = NULL;
988 LdapServer *server = NULL;
989 LdapControl *ctl = NULL;
990 gboolean fin, ssl = FALSE, tls = FALSE;
992 if (!ldapedit.window)
993 addressbook_edit_ldap_create(&cancelled);
994 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), PAGE_BASIC );
995 gtk_widget_grab_focus(ldapedit.ok_btn);
996 gtk_widget_grab_focus(ldapedit.entry_name);
997 gtk_widget_show(ldapedit.window);
998 manage_window_set_transient(GTK_WINDOW(ldapedit.window));
1000 edit_ldap_status_show( "" );
1002 ds = ads->dataSource;
1003 server = ds->rawDataSource;
1004 edit_ldap_set_fields( server );
1005 gtk_window_set_title(
1006 GTK_WINDOW(ldapedit.window), _("Edit LDAP Server"));
1009 edit_ldap_clear_fields(NULL);
1010 gtk_window_set_title(
1011 GTK_WINDOW(ldapedit.window), _("Add New LDAP Server"));
1015 gtk_widget_hide(ldapedit.window);
1016 if (cancelled == TRUE) return NULL;
1018 sName = gtk_editable_get_chars(
1019 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
1020 sHost = gtk_editable_get_chars(
1021 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
1022 sBase = gtk_editable_get_chars(
1023 GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
1024 sCrit = gtk_editable_get_chars(
1025 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
1026 sBind = gtk_editable_get_chars(
1027 GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
1028 sPass = gtk_editable_get_chars(
1029 GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
1030 iPort = gtk_spin_button_get_value_as_int(
1031 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
1032 iTime = gtk_spin_button_get_value_as_int(
1033 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
1034 iMaxE = gtk_spin_button_get_value_as_int(
1035 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ) );
1036 iAge = gtk_spin_button_get_value_as_int(
1037 GTK_SPIN_BUTTON( ldapedit.spinbtn_queryage ) );
1038 bSrch = gtk_toggle_button_get_active(
1039 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch ) );
1040 bMatch = gtk_toggle_button_get_active(
1041 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption ) );
1043 ssl = gtk_toggle_button_get_active(
1044 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl ) );
1045 tls = gtk_toggle_button_get_active(
1046 GTK_TOGGLE_BUTTON( ldapedit.enable_tls ) );
1048 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",sName, sHost, sBase, sCrit, sBind, iPort, iTime, iMaxE, iAge, bSrch, bMatch);
1050 if( *sName == '\0' ) fin = TRUE;
1051 if( *sHost == '\0' ) fin = TRUE;
1057 server = ldapsvr_create();
1058 ds = addrindex_index_add_datasource(
1059 addrIndex, ADDR_IF_LDAP, server );
1060 ads = addressbook_create_ds_adapter(
1061 ds, ADDR_LDAP, NULL );
1063 ctl = server->control;
1064 addressbook_ads_set_name( ads, sName );
1065 ldapsvr_set_name( server, sName );
1066 ldapsvr_set_search_flag( server, bSrch );
1067 ldapctl_set_host( ctl, sHost );
1068 ldapctl_set_base_dn( ctl, sBase );
1069 ldapctl_set_bind_dn( ctl, sBind );
1070 ldapctl_set_bind_password( ctl, sPass );
1071 ldapctl_set_port( ctl, iPort );
1072 ldapctl_set_max_entries( ctl, iMaxE );
1073 ldapctl_set_timeout( ctl, iTime );
1074 ldapctl_set_max_query_age( ctl, iAge );
1076 ldapctl_set_tls( ctl, tls );
1077 ldapctl_set_ssl( ctl, ssl );
1079 ldapctl_set_matching_option(
1081 LDAPCTL_MATCH_CONTAINS : LDAPCTL_MATCH_BEGINWITH );
1083 /* Save attributes */
1084 editldap_parse_criteria( sCrit, ctl );
1097 #endif /* USE_LDAP */