2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2003-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/>.
33 #include <glib/gi18n.h>
34 #include <gdk/gdkkeysyms.h>
35 #include <gtk/gtkwindow.h>
36 #include <gtk/gtksignal.h>
37 #include <gtk/gtkhbox.h>
38 #include <gtk/gtklabel.h>
39 #include <gtk/gtkentry.h>
40 #include <gtk/gtkhbbox.h>
41 #include <gtk/gtkbutton.h>
45 #include "stock_pixmap.h"
46 #include "prefs_common.h"
47 #include "browseldap.h"
49 #include "addrindex.h"
50 #include "manage_window.h"
52 #include "ldapquery.h"
53 #include "ldapserver.h"
54 #include "ldaplocate.h"
61 #define BROWSELDAP_WIDTH 450
62 #define BROWSELDAP_HEIGHT 420
65 #define COL_WIDTH_NAME 140
66 #define COL_WIDTH_VALUE 140
68 static struct _LDAPEntry_dlg {
70 GtkWidget *label_server;
71 GtkWidget *label_address;
72 GtkWidget *list_entry;
79 static GList *_displayQueue_ = NULL;
82 * Mutex to protect callback from multiple threads.
84 static pthread_mutex_t _browseMutex_ = PTHREAD_MUTEX_INITIALIZER;
89 static gint _queryID_ = 0;
94 static guint _browseIdleID_ = 0;
97 * Search complete indicator.
99 static gboolean _searchComplete_ = FALSE;
102 * Callback entry point for each LDAP entry processed. The background thread
103 * (if any) appends the address list to the display queue.
105 * \param qry LDAP query object.
106 * \param queryID Query ID of search request.
107 * \param listEMail List of zero of more email objects that met search
109 * \param data User data.
111 static gint browse_callback_entry(
112 LdapQuery *qry, gint queryID, GList *listValues, gpointer data )
117 debug_print("browse_callback_entry...\n");
118 pthread_mutex_lock( & _browseMutex_ );
119 /* Append contents to end of display queue */
122 nvp = ( NameValuePair * ) node->data;
123 debug_print("adding to list: %s->%s\n",
124 nvp->name?nvp->name:"null",
125 nvp->value?nvp->value:"null");
126 _displayQueue_ = g_list_append( _displayQueue_, nvp );
128 node = g_list_next( node );
130 pthread_mutex_unlock( & _browseMutex_ );
131 /* g_print( "browse_callback_entry...done\n" ); */
137 * Callback entry point for end of LDAP locate search.
139 * \param qry LDAP query object.
140 * \param queryID Query ID of search request.
141 * \param status Status/error code.
142 * \param data User data.
144 static gint browse_callback_end(
145 LdapQuery *qry, gint queryID, gint status, gpointer data )
147 debug_print("search completed\n");
148 _searchComplete_ = TRUE;
153 * Clear the display queue.
155 static void browse_clear_queue( void ) {
156 /* Clear out display queue */
157 pthread_mutex_lock( & _browseMutex_ );
159 ldapqry_free_list_name_value( _displayQueue_ );
160 g_list_free( _displayQueue_ );
161 _displayQueue_ = NULL;
163 pthread_mutex_unlock( & _browseMutex_ );
167 * Close window callback.
168 * \param widget Widget.
169 * \param event Event.
170 * \param cancelled Cancelled flag.
172 static gint browse_delete_event(
173 GtkWidget *widget, GdkEventAny *event, gboolean *cancelled )
180 * Respond to key press in window.
181 * \param widget Widget.
182 * \param event Event.
183 * \param cancelled Cancelled flag.
185 static void browse_key_pressed(
186 GtkWidget *widget, GdkEventKey *event, gboolean *cancelled )
188 if (event && event->keyval == GDK_Escape) {
194 * Callback to close window.
195 * \param widget Widget.
196 * \param cancelled Cancelled flag.
198 static void browse_close( GtkWidget *widget, gboolean *cancelled ) {
203 * Create the window to display data.
205 static void browse_create( void ) {
210 GtkWidget *label_server;
211 GtkWidget *label_addr;
212 GtkWidget *list_entry;
216 GtkWidget *close_btn;
219 debug_print("creating browse widget\n");
220 window = gtk_dialog_new();
221 gtk_widget_set_size_request( window, BROWSELDAP_WIDTH, BROWSELDAP_HEIGHT );
222 gtk_container_set_border_width( GTK_CONTAINER(window), 0 );
223 gtk_window_set_title( GTK_WINDOW(window), _("Browse Directory Entry") );
224 gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_MOUSE );
225 gtk_window_set_modal( GTK_WINDOW(window), TRUE );
226 g_signal_connect(G_OBJECT(window), "delete_event",
227 G_CALLBACK(browse_delete_event), NULL);
228 g_signal_connect(G_OBJECT(window), "key_press_event",
229 G_CALLBACK(browse_key_pressed), NULL);
231 vbox = gtk_vbox_new(FALSE, 8);
232 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(window)->vbox), vbox, TRUE, TRUE, 0);
233 gtk_container_set_border_width( GTK_CONTAINER(vbox), 8 );
235 table = gtk_table_new(2, 2, FALSE);
236 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
237 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
238 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
239 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
243 label = gtk_label_new(_("Server Name :"));
244 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
245 gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
247 label_server = gtk_label_new("");
248 gtk_table_attach(GTK_TABLE(table), label_server, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
249 gtk_misc_set_alignment(GTK_MISC(label_server), 0, 0.5);
253 label = gtk_label_new(_("Distinguished Name (dn) :"));
254 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
255 gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
257 label_addr = gtk_label_new("");
258 gtk_table_attach(GTK_TABLE(table), label_addr, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
259 gtk_misc_set_alignment(GTK_MISC(label_addr), 0, 0.5);
261 /* Address book/folder tree */
262 vlbox = gtk_vbox_new(FALSE, 8);
263 gtk_box_pack_start(GTK_BOX(vbox), vlbox, TRUE, TRUE, 0);
264 gtk_container_set_border_width( GTK_CONTAINER(vlbox), 8 );
266 tree_win = gtk_scrolled_window_new( NULL, NULL );
267 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(tree_win),
268 GTK_POLICY_AUTOMATIC,
269 GTK_POLICY_AUTOMATIC );
270 gtk_box_pack_start( GTK_BOX(vlbox), tree_win, TRUE, TRUE, 0 );
272 list_entry = gtk_clist_new( N_COLS );
273 gtk_container_add( GTK_CONTAINER(tree_win), list_entry );
274 gtk_clist_column_titles_show( GTK_CLIST(list_entry) );
275 gtk_clist_set_column_title(
276 GTK_CLIST(list_entry), COL_NAME, _( "LDAP Name" ) );
277 gtk_clist_set_column_title(
278 GTK_CLIST(list_entry), COL_VALUE, _( "Attribute Value" ) );
279 gtk_clist_set_selection_mode(
280 GTK_CLIST(list_entry), GTK_SELECTION_BROWSE );
281 gtk_clist_set_column_width( GTK_CLIST(list_entry),
282 COL_NAME, COL_WIDTH_NAME );
283 gtk_clist_set_auto_sort( GTK_CLIST(list_entry), TRUE );
286 gtkut_stock_button_set_create(&hbbox, &close_btn, GTK_STOCK_CLOSE,
287 NULL, NULL, NULL, NULL);
288 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
289 gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
291 g_signal_connect(G_OBJECT(close_btn), "clicked",
292 G_CALLBACK(browse_close), NULL);
293 gtk_widget_grab_default(close_btn);
295 gtk_widget_show_all(vbox);
297 browseldap_dlg.window = window;
298 browseldap_dlg.label_server = label_server;
299 browseldap_dlg.label_address = label_addr;
300 browseldap_dlg.list_entry = list_entry;
301 browseldap_dlg.close_btn = close_btn;
303 gtk_widget_show_all( window );
308 * Idler function. This function is called by the main (UI) thread during UI
309 * idle time while an address search is in progress. Items from the display
310 * queue are processed and appended to the address list.
312 * \param data Target data object.
313 * \return <i>TRUE</i> to ensure that idle event do not get ignored.
315 static gboolean browse_idle( gpointer data ) {
320 /* Process all entries in display queue */
321 pthread_mutex_lock( & _browseMutex_ );
322 if( _displayQueue_ ) {
323 node = _displayQueue_;
325 /* Add entry into list */
326 nvp = ( NameValuePair * ) node->data;
327 text[COL_NAME] = nvp->name;
328 text[COL_VALUE] = nvp->value;
329 debug_print("Adding row to list: %s->%s\n",
330 nvp->name?nvp->name:"null",
331 nvp->value?nvp->value:"null");
333 GTK_CLIST(browseldap_dlg.list_entry), text );
336 ldapqry_free_name_value( nvp );
338 node = g_list_next( node );
340 g_list_free( _displayQueue_ );
341 _displayQueue_ = NULL;
343 pthread_mutex_unlock( & _browseMutex_ );
345 if( _searchComplete_ ) {
347 if( _browseIdleID_ != 0 ) {
348 g_source_remove( _browseIdleID_ );
350 gtk_clist_select_row(
351 GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
359 * Main entry point to browse LDAP entries.
360 * \param ds Data source to process.
361 * \param dn Distinguished name to retrieve.
362 * \return <code>TRUE</code>
364 gboolean browseldap_entry( AddressDataSource *ds, const gchar *dn ) {
370 server = ds->rawDataSource;
372 if( ! browseldap_dlg.window ) browse_create();
373 gtk_widget_grab_focus(browseldap_dlg.close_btn);
374 gtk_widget_show(browseldap_dlg.window);
375 manage_window_set_transient(GTK_WINDOW(browseldap_dlg.window));
377 gtk_clist_select_row( GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
378 gtk_widget_show(browseldap_dlg.window);
380 gtk_label_set_text( GTK_LABEL(browseldap_dlg.label_address ), "" );
383 GTK_LABEL(browseldap_dlg.label_address ), dn );
386 GTK_LABEL(browseldap_dlg.label_server ),
387 ldapsvr_get_name( server ) );
389 debug_print("browsing server: %s\n", ldapsvr_get_name(server));
391 _searchComplete_ = FALSE;
392 _queryID_ = ldaplocate_search_setup(
393 server, dn, browse_callback_entry, browse_callback_end );
394 debug_print("query id: %d\n", _queryID_);
395 _browseIdleID_ = g_idle_add( ( GtkFunction ) browse_idle, NULL );
398 debug_print("starting search\n");
399 ldaplocate_search_start( _queryID_ );
403 gtk_widget_hide( browseldap_dlg.window );
406 debug_print("stopping search\n");
407 ldaplocate_search_stop( _queryID_ );
409 if( _browseIdleID_ != 0 ) {
410 g_source_remove( _browseIdleID_ );
413 browse_clear_queue();
414 gtk_clist_clear( GTK_CLIST( browseldap_dlg.list_entry ) );
419 #endif /* USE_LDAP */