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 ) ) {
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;
273 debug_print("baseDN: %s\n", sBaseDN);
274 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), sBaseDN);
278 /* Display appropriate message */
280 sMsg = _( "Connected successfully to server" );
283 sMsg = _( "Could not connect to server" );
285 edit_ldap_status_show( sMsg );
288 static void edit_ldap_basedn_select( void ) {
289 gchar *sHost, *sBind, *sPass, *sBase;
290 gint iPort, iTime, tls = 0, ssl = 0;
293 sHost = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
294 sBase = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
295 sBind = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
296 sPass = gtk_editable_get_chars( GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
297 iPort = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
298 iTime = gtk_spin_button_get_value_as_int( GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
300 tls = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_tls));
301 ssl = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ldapedit.enable_ssl));
304 g_strchomp( sHost ); g_strchug( sHost );
305 g_strchomp( sBind ); g_strchug( sBind );
306 g_strchomp( sPass ); g_strchug( sPass );
307 debug_print("ldap server: %s\nport: %d\nssl: %d\ntls: %d\nbindDN: %s\n", sHost, iPort, ssl, tls, sBind);
308 selectDN = edit_ldap_basedn_selection( sHost, iPort, sBase, iTime, sBind, sPass, ssl, tls );
310 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), selectDN);
320 static void edit_ldap_search_reset(void) {
321 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
324 static void addressbook_edit_ldap_dialog_create( gboolean *cancelled ) {
330 GtkWidget *cancel_btn;
332 GtkWidget *statusbar;
334 debug_print("creating edit_ldap_dialog\n");
335 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "editldap");
336 gtk_widget_set_size_request(window, 450, -1);
337 gtk_container_set_border_width(GTK_CONTAINER(window), 0);
338 gtk_window_set_title(GTK_WINDOW(window), _("Edit LDAP Server"));
339 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
340 gtk_window_set_modal(GTK_WINDOW(window), TRUE);
341 g_signal_connect(G_OBJECT(window), "delete_event",
342 G_CALLBACK(edit_ldap_delete_event),
344 g_signal_connect(G_OBJECT(window), "key_press_event",
345 G_CALLBACK(edit_ldap_key_pressed),
348 vbox = gtk_vbox_new( FALSE, 6 );
349 gtk_widget_show( vbox );
350 gtk_container_add( GTK_CONTAINER( window ), vbox );
353 notebook = gtk_notebook_new();
354 gtk_widget_show( notebook );
355 gtk_box_pack_start( GTK_BOX( vbox ), notebook, TRUE, TRUE, 0 );
356 gtk_container_set_border_width( GTK_CONTAINER( notebook ), 6 );
359 hsbox = gtk_hbox_new(FALSE, 0);
360 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
361 statusbar = gtk_statusbar_new();
362 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
365 gtkut_stock_button_set_create(&hbbox, &cancel_btn, GTK_STOCK_CANCEL,
366 &ok_btn, GTK_STOCK_OK,
368 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
369 gtk_widget_grab_default(ok_btn);
371 g_signal_connect(G_OBJECT(ok_btn), "clicked",
372 G_CALLBACK(edit_ldap_ok), cancelled);
373 g_signal_connect(G_OBJECT(cancel_btn), "clicked",
374 G_CALLBACK(edit_ldap_cancel), cancelled);
376 gtk_widget_show_all(vbox);
378 ldapedit.window = window;
379 ldapedit.notebook = notebook;
380 ldapedit.ok_btn = ok_btn;
381 ldapedit.cancel_btn = cancel_btn;
382 ldapedit.statusbar = statusbar;
383 ldapedit.status_cid =
384 gtk_statusbar_get_context_id(
385 GTK_STATUSBAR(statusbar), "Edit LDAP Server Dialog" );
388 static void editldap_update_port (GtkToggleButton *ssl_btn, gpointer data) {
389 gboolean val = gtk_toggle_button_get_active(ssl_btn);
390 gtk_spin_button_set_value(
391 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ),
392 val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT );
393 debug_print("Setting port: %d\n", val ? LDAPCTL_DFL_SSL_PORT:LDAPCTL_DFL_PORT);
396 static void addressbook_edit_ldap_page_basic( gint pageNum, gchar *pageLbl ) {
400 GtkWidget *entry_name;
401 GtkWidget *entry_server;
402 GtkWidget *hbox_spin;
403 GtkObject *spinbtn_port_adj;
404 GtkWidget *spinbtn_port;
406 GtkWidget *enable_ssl_checkbtn, *enable_tls_checkbtn;
408 GtkWidget *entry_baseDN;
409 GtkWidget *check_btn;
410 GtkWidget *lookdn_btn;
411 GtkTooltips *toolTip;
414 vbox = gtk_vbox_new( FALSE, 8 );
415 gtk_widget_show( vbox );
416 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
418 label = gtk_label_new( pageLbl );
419 gtk_widget_show( label );
420 gtk_notebook_set_tab_label(
421 GTK_NOTEBOOK( ldapedit.notebook ),
422 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
424 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
425 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
426 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
427 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
428 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
432 label = gtk_label_new(_("Name"));
433 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
434 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
436 entry_name = gtk_entry_new();
437 gtk_table_attach(GTK_TABLE(table), entry_name, 1, 2, top, (top + 1),
438 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
440 toolTip = gtk_tooltips_new();
441 gtk_tooltips_set_tip( toolTip, entry_name, _(
442 "A name that you wish to call the server." ),
447 label = gtk_label_new(_("Hostname"));
448 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
449 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
451 entry_server = gtk_entry_new();
452 gtk_table_attach(GTK_TABLE(table), entry_server, 1, 2, top, (top + 1),
453 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
455 toolTip = gtk_tooltips_new();
456 gtk_tooltips_set_tip( toolTip, entry_server, _(
457 "This is the hostname of the server. For example, " \
458 "\"ldap.mydomain.com\" may be appropriate for the " \
459 "\"mydomain.com\" organization. An IP address may also be " \
460 "used. You may specify \"localhost\" if running an LDAP " \
461 "server on the same computer as Claws Mail." ),
466 label = gtk_label_new(_("Port"));
467 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
468 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
470 hbox_spin = gtk_hbox_new (FALSE, 8);
471 spinbtn_port_adj = gtk_adjustment_new (389, 1, 65535, 1, 1000, 1000);
472 spinbtn_port = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_port_adj), 1, 0);
473 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_port, TRUE, FALSE, 0);
474 gtk_widget_set_size_request (spinbtn_port, 64, -1);
475 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_port), TRUE);
478 enable_tls_checkbtn = gtk_check_button_new_with_label(_("TLS"));
479 enable_ssl_checkbtn = gtk_check_button_new_with_label(_("SSL"));
480 SET_TOGGLE_SENSITIVITY_REVERSE(enable_tls_checkbtn, enable_ssl_checkbtn);
481 SET_TOGGLE_SENSITIVITY_REVERSE(enable_ssl_checkbtn, enable_tls_checkbtn);
482 gtk_tooltips_set_tip( toolTip, enable_tls_checkbtn, _(
483 "Enable secure connection to the LDAP server via TLS."
484 "If connection fails, be sure to check the correct "
485 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ),
487 gtk_tooltips_set_tip( toolTip, enable_ssl_checkbtn, _(
488 "Enable secure connection to the LDAP server via SSL."
489 "If connection fails, be sure to check the correct "
490 "configuration in ldap.conf (TLS_CACERTDIR and TLS_REQCERT fields)." ),
493 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_tls_checkbtn, TRUE, FALSE, 0);
494 gtk_box_pack_start (GTK_BOX (hbox_spin), enable_ssl_checkbtn, TRUE, FALSE, 0);
497 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
498 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
500 toolTip = gtk_tooltips_new();
501 gtk_tooltips_set_tip( toolTip, spinbtn_port, _(
502 "The port number that the server listens on. Port 389 is " \
506 check_btn = gtk_button_new_with_label( _(" Check Server "));
507 gtk_table_attach(GTK_TABLE(table), check_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
509 toolTip = gtk_tooltips_new();
510 gtk_tooltips_set_tip( toolTip, check_btn, _(
511 "Press this button to test the connection to the server." ),
516 label = gtk_label_new(_("Search Base"));
517 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
518 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
520 entry_baseDN = gtk_entry_new();
521 gtk_table_attach(GTK_TABLE(table), entry_baseDN, 1, 2, top, (top + 1),
522 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
524 toolTip = gtk_tooltips_new();
525 gtk_tooltips_set_tip( toolTip, entry_baseDN, _(
526 "This specifies the name of the directory to be searched " \
527 "on the server. Examples include:\n" \
528 " dc=claws-mail,dc=org\n" \
529 " ou=people,dc=domainname,dc=com\n" \
530 " o=Organization Name,c=Country\n"
534 lookdn_btn = gtkut_get_browse_file_btn(_("_Browse"));
535 gtk_table_attach(GTK_TABLE(table), lookdn_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
537 toolTip = gtk_tooltips_new();
538 gtk_tooltips_set_tip( toolTip, lookdn_btn, _(
539 "Press this button to lookup the name of available " \
540 "directory names on the server." ),
543 /* Signal handlers */
544 g_signal_connect(G_OBJECT(check_btn), "clicked",
545 G_CALLBACK(edit_ldap_server_check), NULL);
546 g_signal_connect(G_OBJECT(lookdn_btn), "clicked",
547 G_CALLBACK(edit_ldap_basedn_select), NULL);
550 gtk_widget_show_all(vbox);
552 ldapedit.entry_name = entry_name;
553 ldapedit.entry_server = entry_server;
554 ldapedit.spinbtn_port = spinbtn_port;
555 ldapedit.entry_baseDN = entry_baseDN;
557 ldapedit.enable_ssl = enable_ssl_checkbtn;
558 ldapedit.enable_tls = enable_tls_checkbtn;
560 g_signal_connect(G_OBJECT(enable_ssl_checkbtn), "toggled", \
561 G_CALLBACK(editldap_update_port), NULL);
565 static void addressbook_edit_ldap_page_search( gint pageNum, gchar *pageLbl ) {
569 GtkWidget *entry_criteria;
570 GtkWidget *hbox_spin;
571 GtkObject *spinbtn_queryage_adj;
572 GtkWidget *spinbtn_queryage;
573 GtkWidget *check_dynsearch;
574 GtkWidget *check_matchoption;
575 GtkWidget *reset_btn;
576 GtkTooltips *toolTip;
579 vbox = gtk_vbox_new( FALSE, 8 );
580 gtk_widget_show( vbox );
581 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
583 label = gtk_label_new( pageLbl );
584 gtk_widget_show( label );
585 gtk_notebook_set_tab_label(
586 GTK_NOTEBOOK( ldapedit.notebook ),
587 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
589 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
590 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
591 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
592 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
593 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
597 label = gtk_label_new(_("Search Attributes"));
598 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
599 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
601 entry_criteria = gtk_entry_new();
602 gtk_table_attach(GTK_TABLE(table), entry_criteria, 1, 2, top, (top + 1),
603 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
605 toolTip = gtk_tooltips_new();
606 gtk_tooltips_set_tip( toolTip, entry_criteria, _(
607 "A list of LDAP attribute names that should be searched " \
608 "when attempting to find a name or address." ),
611 reset_btn = gtk_button_new_with_label( _(" Defaults "));
612 gtk_table_attach(GTK_TABLE(table), reset_btn, 2, 3, top, (top + 1), GTK_FILL, 0, 3, 0);
614 toolTip = gtk_tooltips_new();
615 gtk_tooltips_set_tip( toolTip, reset_btn, _(
616 "This resets the attribute names to a default value " \
617 "that should find most names and addresses during a " \
618 "name or address search process." ),
623 label = gtk_label_new(_("Max Query Age (secs)"));
624 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
625 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
627 hbox_spin = gtk_hbox_new (FALSE, 8);
628 spinbtn_queryage_adj = gtk_adjustment_new(
629 LDAPCTL_DFL_QUERY_AGE, 1, LDAPCTL_MAX_QUERY_AGE, 10, 1000, 1000 );
630 spinbtn_queryage = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_queryage_adj), 1, 0);
631 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_queryage, FALSE, FALSE, 0);
632 gtk_widget_set_size_request (spinbtn_queryage, 64, -1);
633 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_queryage), TRUE);
634 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
635 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
637 toolTip = gtk_tooltips_new();
638 gtk_tooltips_set_tip( toolTip, spinbtn_queryage, _(
639 "This defines the maximum period of time (in seconds) that " \
640 "an address search result is valid for address completion " \
641 "purposes. Search results are stored in a cache until this " \
642 "period of time has passed and then retired. This will " \
643 "improve the response time when attempting to search for " \
644 "the same name or address on subsequent address completion " \
645 "requests. The cache will be searched in preference to " \
646 "performing a new server search request. The default value " \
647 "of 600 seconds (10 minutes), should be sufficient for most " \
648 "servers. A larger value will reduce the search time for " \
649 "subsequent searches. This is useful for servers that have " \
650 "slow response times at the expense of more memory to cache " \
656 check_dynsearch = gtk_check_button_new_with_label(
657 _("Include server in dynamic search") );
658 gtk_table_attach(GTK_TABLE(table), check_dynsearch, 1, 3, top, (top + 1),
659 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
661 toolTip = gtk_tooltips_new();
662 gtk_tooltips_set_tip( toolTip, check_dynsearch, _(
663 "Check this option to include this server for dynamic " \
664 "searches when using address completion." ),
669 check_matchoption = gtk_check_button_new_with_label(
670 _("Match names 'containing' search term") );
671 gtk_table_attach(GTK_TABLE(table), check_matchoption, 1, 3, top, (top + 1),
672 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
674 toolTip = gtk_tooltips_new();
675 gtk_tooltips_set_tip( toolTip, check_matchoption, _(
676 "Searches for names and addresses can be performed either " \
677 "using \"begins-with\" or \"contains\" search term. Check " \
678 "this option to perform a \"contains\" search; this type of " \
679 "search usually takes longer to complete. Note that for " \
680 "performance reasons, address completion uses " \
681 "\"begins-with\" for all searches against other address " \
686 /* Signal handlers */
687 g_signal_connect(G_OBJECT(reset_btn), "clicked",
688 G_CALLBACK(edit_ldap_search_reset), NULL);
691 gtk_widget_show_all(vbox);
693 ldapedit.entry_criteria = entry_criteria;
694 ldapedit.spinbtn_queryage = spinbtn_queryage;
695 ldapedit.check_dynsearch = check_dynsearch;
696 ldapedit.check_matchoption = check_matchoption;
699 static void addressbook_edit_ldap_page_extended( gint pageNum, gchar *pageLbl ) {
703 GtkWidget *entry_bindDN;
704 GtkWidget *entry_bindPW;
705 GtkWidget *hbox_spin;
706 GtkObject *spinbtn_timeout_adj;
707 GtkWidget *spinbtn_timeout;
708 GtkObject *spinbtn_maxentry_adj;
709 GtkWidget *spinbtn_maxentry;
710 GtkTooltips *toolTip;
713 vbox = gtk_vbox_new( FALSE, 8 );
714 gtk_widget_show( vbox );
715 gtk_container_add( GTK_CONTAINER( ldapedit.notebook ), vbox );
717 label = gtk_label_new( pageLbl );
718 gtk_widget_show( label );
719 gtk_notebook_set_tab_label(
720 GTK_NOTEBOOK( ldapedit.notebook ),
721 gtk_notebook_get_nth_page( GTK_NOTEBOOK( ldapedit.notebook ), pageNum ), label );
723 table = gtk_table_new( LDAPEDIT_TABLE_ROWS, LDAPEDIT_TABLE_COLS, FALSE);
724 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
725 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
726 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
727 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
731 label = gtk_label_new(_("Bind DN"));
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 entry_bindDN = gtk_entry_new();
736 gtk_table_attach(GTK_TABLE(table), entry_bindDN, 1, 2, top, (top + 1),
737 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
739 toolTip = gtk_tooltips_new();
740 gtk_tooltips_set_tip( toolTip, entry_bindDN, _(
741 "The LDAP user account name to be used to connect to the server. " \
742 "This is usually only used for protected servers. This name " \
743 "is typically formatted as: \"cn=user,dc=claws-mail,dc=org\". " \
744 "This is usually left empty when performing a search." ),
749 label = gtk_label_new(_("Bind Password"));
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 entry_bindPW = gtk_entry_new();
754 gtk_table_attach(GTK_TABLE(table), entry_bindPW, 1, 2, top, (top + 1),
755 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
756 gtk_entry_set_visibility(GTK_ENTRY(entry_bindPW), FALSE);
758 toolTip = gtk_tooltips_new();
759 gtk_tooltips_set_tip( toolTip, entry_bindPW, _(
760 "The password to be used when connecting as the \"Bind DN\" " \
766 label = gtk_label_new(_("Timeout (secs)"));
767 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
768 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
770 hbox_spin = gtk_hbox_new (FALSE, 8);
771 spinbtn_timeout_adj = gtk_adjustment_new (0, 0, 300, 1, 10, 10);
772 spinbtn_timeout = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_timeout_adj), 1, 0);
773 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_timeout, FALSE, FALSE, 0);
774 gtk_widget_set_size_request (spinbtn_timeout, 64, -1);
775 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_timeout), TRUE);
776 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
777 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
779 toolTip = gtk_tooltips_new();
780 gtk_tooltips_set_tip( toolTip, spinbtn_timeout, _(
781 "The timeout period in seconds." ), NULL );
785 label = gtk_label_new(_("Maximum Entries"));
786 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
787 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
789 hbox_spin = gtk_hbox_new (FALSE, 8);
790 spinbtn_maxentry_adj = gtk_adjustment_new (0, 0, 500, 1, 10, 10);
791 spinbtn_maxentry = gtk_spin_button_new(GTK_ADJUSTMENT (spinbtn_maxentry_adj), 1, 0);
792 gtk_box_pack_start (GTK_BOX (hbox_spin), spinbtn_maxentry, FALSE, FALSE, 0);
793 gtk_widget_set_size_request (spinbtn_maxentry, 64, -1);
794 gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_maxentry), TRUE);
795 gtk_table_attach(GTK_TABLE(table), hbox_spin, 1, 2, top, (top + 1),
796 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
798 toolTip = gtk_tooltips_new();
799 gtk_tooltips_set_tip( toolTip, spinbtn_maxentry, _(
800 "The maximum number of entries that should be returned " \
801 "in the search result." ),
805 gtk_widget_show_all(vbox);
807 ldapedit.entry_bindDN = entry_bindDN;
808 ldapedit.entry_bindPW = entry_bindPW;
809 ldapedit.spinbtn_timeout = spinbtn_timeout;
810 ldapedit.spinbtn_maxentry = spinbtn_maxentry;
813 static void addressbook_edit_ldap_create( gboolean *cancelled ) {
815 addressbook_edit_ldap_dialog_create( cancelled );
816 addressbook_edit_ldap_page_basic( page++, _( "Basic" ) );
817 addressbook_edit_ldap_page_search( page++, _( "Search" ) );
818 addressbook_edit_ldap_page_extended( page++, _( "Extended" ) );
819 gtk_widget_show_all( ldapedit.window );
823 * Format criteria list for display.
824 * \param ctl Control object.
825 * \return Formatted string, or <i>NULL</i> if no attributes found.
827 static gchar *editldap_build_criteria_list( const LdapControl *ctl ) {
832 node = ldapctl_get_criteria_list( ctl );
834 gchar *attr = node->data;
836 tmp = g_strdup_printf( "%s, %s", str, attr );
842 str = g_strdup( attr );
844 node = g_list_next( node );
851 * Parse out individual attribute names from criteria string.
852 * \param criteria Criteria string.
853 * \ctl Control object.
855 static void editldap_parse_criteria( gchar *criteria, LdapControl *ctl ) {
860 /* Replace delimiters with spaces */
863 if( *ptr == ',' || *ptr == ';' || *ptr == '|' )
869 ldapctl_criteria_list_clear( ctl );
870 splitStr = g_strsplit( criteria, " ", 0 );
875 ldapctl_criteria_list_add( ctl, splitStr[i] );
883 g_strfreev( splitStr );
887 * Clear entry fields to reasonable defaults (for a new server entry).
889 static void edit_ldap_clear_fields(void) {
891 GTK_ENTRY(ldapedit.entry_name), ADDRESSBOOK_GUESS_LDAP_NAME );
893 GTK_ENTRY(ldapedit.entry_server), ADDRESSBOOK_GUESS_LDAP_SERVER );
894 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_baseDN), "");
895 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindDN), "");
896 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_bindPW), "");
897 gtk_spin_button_set_value(
898 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ), LDAPCTL_DFL_PORT );
899 gtk_spin_button_set_value(
900 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ), LDAPCTL_DFL_TIMEOUT );
901 gtk_spin_button_set_value(
902 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ), LDAPCTL_DFL_TIMEOUT );
904 GTK_ENTRY(ldapedit.entry_criteria), LDAPCTL_DFL_ATTR_LIST);
905 gtk_spin_button_set_value(
906 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), LDAPCTL_DFL_QUERY_AGE );
907 gtk_toggle_button_set_active(
908 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), TRUE );
909 gtk_toggle_button_set_active(
910 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption), FALSE );
912 gtk_toggle_button_set_active(
913 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl), FALSE );
914 gtk_toggle_button_set_active(
915 GTK_TOGGLE_BUTTON( ldapedit.enable_tls), FALSE );
920 * Load entry fields from server control data.
921 * \param server Server object.
923 static void edit_ldap_set_fields( LdapServer *server ) {
927 if( ldapsvr_get_name( server ) )
928 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_name),
929 ldapsvr_get_name( server ) );
931 ctl = server->control;
934 GTK_ENTRY(ldapedit.entry_server), ctl->hostName);
937 GTK_ENTRY(ldapedit.entry_baseDN), ctl->baseDN );
940 GTK_ENTRY(ldapedit.entry_bindDN), ctl->bindDN );
943 GTK_ENTRY(ldapedit.entry_bindPW), ctl->bindPass );
944 gtk_spin_button_set_value(
945 GTK_SPIN_BUTTON(ldapedit.spinbtn_timeout), ctl->timeOut );
946 gtk_spin_button_set_value(
947 GTK_SPIN_BUTTON(ldapedit.spinbtn_maxentry), ctl->maxEntries );
949 gtk_toggle_button_set_active(
950 GTK_TOGGLE_BUTTON(ldapedit.enable_tls), ctl->enableTLS );
951 gtk_toggle_button_set_active(
952 GTK_TOGGLE_BUTTON(ldapedit.enable_ssl), ctl->enableSSL );
954 gtk_spin_button_set_value(
955 GTK_SPIN_BUTTON(ldapedit.spinbtn_port), ctl->port );
956 /* Format criteria */
957 crit = editldap_build_criteria_list( ctl );
959 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), crit );
963 gtk_entry_set_text(GTK_ENTRY(ldapedit.entry_criteria), "" );
965 gtk_spin_button_set_value(
966 GTK_SPIN_BUTTON(ldapedit.spinbtn_queryage), ctl->maxQueryAge );
967 gtk_toggle_button_set_active(
968 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch), server->searchFlag );
969 gtk_toggle_button_set_active(
970 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption),
971 ( ctl->matchingOption == LDAPCTL_MATCH_CONTAINS ) );
975 * Edit LDAP server datasource that appears addressbook.
976 * \param addrIndex Address index object.
977 * \param ads Data source adapter.
978 * \return Update data source adapter, or <code>NULL</code> if user cancelled
981 AdapterDSource *addressbook_edit_ldap(
982 AddressIndex *addrIndex, AdapterDSource *ads )
984 static gboolean cancelled;
985 gchar *sName, *sHost, *sBase, *sBind, *sPass, *sCrit;
986 gint iPort, iMaxE, iTime, iAge;
987 gboolean bSrch, bMatch;
988 AddressDataSource *ds = NULL;
989 LdapServer *server = NULL;
990 LdapControl *ctl = NULL;
991 gboolean fin, ssl = FALSE, tls = FALSE;
993 if (!ldapedit.window)
994 addressbook_edit_ldap_create(&cancelled);
995 gtk_notebook_set_current_page( GTK_NOTEBOOK(ldapedit.notebook), PAGE_BASIC );
996 gtk_widget_grab_focus(ldapedit.ok_btn);
997 gtk_widget_grab_focus(ldapedit.entry_name);
998 gtk_widget_show(ldapedit.window);
999 manage_window_set_transient(GTK_WINDOW(ldapedit.window));
1001 edit_ldap_status_show( "" );
1003 ds = ads->dataSource;
1004 server = ds->rawDataSource;
1005 edit_ldap_set_fields( server );
1006 gtk_window_set_title(
1007 GTK_WINDOW(ldapedit.window), _("Edit LDAP Server"));
1010 edit_ldap_clear_fields();
1011 gtk_window_set_title(
1012 GTK_WINDOW(ldapedit.window), _("Add New LDAP Server"));
1016 gtk_widget_hide(ldapedit.window);
1017 if (cancelled == TRUE) return NULL;
1019 sName = gtk_editable_get_chars(
1020 GTK_EDITABLE(ldapedit.entry_name), 0, -1 );
1021 sHost = gtk_editable_get_chars(
1022 GTK_EDITABLE(ldapedit.entry_server), 0, -1 );
1023 sBase = gtk_editable_get_chars(
1024 GTK_EDITABLE(ldapedit.entry_baseDN), 0, -1 );
1025 sCrit = gtk_editable_get_chars(
1026 GTK_EDITABLE(ldapedit.entry_criteria), 0, -1 );
1027 sBind = gtk_editable_get_chars(
1028 GTK_EDITABLE(ldapedit.entry_bindDN), 0, -1 );
1029 sPass = gtk_editable_get_chars(
1030 GTK_EDITABLE(ldapedit.entry_bindPW), 0, -1 );
1031 iPort = gtk_spin_button_get_value_as_int(
1032 GTK_SPIN_BUTTON( ldapedit.spinbtn_port ) );
1033 iTime = gtk_spin_button_get_value_as_int(
1034 GTK_SPIN_BUTTON( ldapedit.spinbtn_timeout ) );
1035 iMaxE = gtk_spin_button_get_value_as_int(
1036 GTK_SPIN_BUTTON( ldapedit.spinbtn_maxentry ) );
1037 iAge = gtk_spin_button_get_value_as_int(
1038 GTK_SPIN_BUTTON( ldapedit.spinbtn_queryage ) );
1039 bSrch = gtk_toggle_button_get_active(
1040 GTK_TOGGLE_BUTTON( ldapedit.check_dynsearch ) );
1041 bMatch = gtk_toggle_button_get_active(
1042 GTK_TOGGLE_BUTTON( ldapedit.check_matchoption ) );
1044 ssl = gtk_toggle_button_get_active(
1045 GTK_TOGGLE_BUTTON( ldapedit.enable_ssl ) );
1046 tls = gtk_toggle_button_get_active(
1047 GTK_TOGGLE_BUTTON( ldapedit.enable_tls ) );
1049 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",
1050 sName, sHost, sBase, sCrit, sBind, iPort, iTime, iMaxE, iAge, bSrch, bMatch);
1052 if( *sName == '\0' ) fin = TRUE;
1053 if( *sHost == '\0' ) fin = TRUE;
1059 server = ldapsvr_create();
1060 ds = addrindex_index_add_datasource(
1061 addrIndex, ADDR_IF_LDAP, server );
1062 ads = addressbook_create_ds_adapter(
1063 ds, ADDR_LDAP, NULL );
1065 ctl = server->control;
1066 addressbook_ads_set_name( ads, sName );
1067 ldapsvr_set_name( server, sName );
1068 ldapsvr_set_search_flag( server, bSrch );
1069 ldapctl_set_host( ctl, sHost );
1070 ldapctl_set_base_dn( ctl, sBase );
1071 ldapctl_set_bind_dn( ctl, sBind );
1072 ldapctl_set_bind_password( ctl, sPass );
1073 ldapctl_set_port( ctl, iPort );
1074 ldapctl_set_max_entries( ctl, iMaxE );
1075 ldapctl_set_timeout( ctl, iTime );
1076 ldapctl_set_max_query_age( ctl, iAge );
1078 ldapctl_set_tls( ctl, tls );
1079 ldapctl_set_ssl( ctl, ssl );
1081 ldapctl_set_matching_option(
1083 LDAPCTL_MATCH_CONTAINS : LDAPCTL_MATCH_BEGINWITH );
1085 /* Save attributes */
1086 editldap_parse_criteria( sCrit, ctl );
1099 #endif /* USE_LDAP */