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", nvp->name, nvp->value);
124 _displayQueue_ = g_list_append( _displayQueue_, nvp );
126 node = g_list_next( node );
128 pthread_mutex_unlock( & _browseMutex_ );
129 /* g_print( "browse_callback_entry...done\n" ); */
135 * Callback entry point for end of LDAP locate search.
137 * \param qry LDAP query object.
138 * \param queryID Query ID of search request.
139 * \param status Status/error code.
140 * \param data User data.
142 static gint browse_callback_end(
143 LdapQuery *qry, gint queryID, gint status, gpointer data )
145 debug_print("search completed\n");
146 _searchComplete_ = TRUE;
151 * Clear the display queue.
153 static void browse_clear_queue( void ) {
154 /* Clear out display queue */
155 pthread_mutex_lock( & _browseMutex_ );
157 ldapqry_free_list_name_value( _displayQueue_ );
158 g_list_free( _displayQueue_ );
159 _displayQueue_ = NULL;
161 pthread_mutex_unlock( & _browseMutex_ );
165 * Close window callback.
166 * \param widget Widget.
167 * \param event Event.
168 * \param cancelled Cancelled flag.
170 static gint browse_delete_event(
171 GtkWidget *widget, GdkEventAny *event, gboolean *cancelled )
178 * Respond to key press in window.
179 * \param widget Widget.
180 * \param event Event.
181 * \param cancelled Cancelled flag.
183 static void browse_key_pressed(
184 GtkWidget *widget, GdkEventKey *event, gboolean *cancelled )
186 if (event && event->keyval == GDK_Escape) {
192 * Callback to close window.
193 * \param widget Widget.
194 * \param cancelled Cancelled flag.
196 static void browse_close( GtkWidget *widget, gboolean *cancelled ) {
201 * Create the window to display data.
203 static void browse_create( void ) {
208 GtkWidget *label_server;
209 GtkWidget *label_addr;
210 GtkWidget *list_entry;
214 GtkWidget *close_btn;
217 debug_print("creating browse widget\n");
218 window = gtk_dialog_new();
219 gtk_widget_set_size_request( window, BROWSELDAP_WIDTH, BROWSELDAP_HEIGHT );
220 gtk_container_set_border_width( GTK_CONTAINER(window), 0 );
221 gtk_window_set_title( GTK_WINDOW(window), _("Browse Directory Entry") );
222 gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_MOUSE );
223 gtk_window_set_modal( GTK_WINDOW(window), TRUE );
224 g_signal_connect(G_OBJECT(window), "delete_event",
225 G_CALLBACK(browse_delete_event), NULL);
226 g_signal_connect(G_OBJECT(window), "key_press_event",
227 G_CALLBACK(browse_key_pressed), NULL);
229 vbox = gtk_vbox_new(FALSE, 8);
230 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(window)->vbox), vbox, TRUE, TRUE, 0);
231 gtk_container_set_border_width( GTK_CONTAINER(vbox), 8 );
233 table = gtk_table_new(2, 2, FALSE);
234 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
235 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
236 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
237 gtk_table_set_col_spacings(GTK_TABLE(table), 8);
241 label = gtk_label_new(_("Server Name :"));
242 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
243 gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
245 label_server = gtk_label_new("");
246 gtk_table_attach(GTK_TABLE(table), label_server, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
247 gtk_misc_set_alignment(GTK_MISC(label_server), 0, 0.5);
251 label = gtk_label_new(_("Distinguished Name (dn) :"));
252 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
253 gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
255 label_addr = gtk_label_new("");
256 gtk_table_attach(GTK_TABLE(table), label_addr, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
257 gtk_misc_set_alignment(GTK_MISC(label_addr), 0, 0.5);
259 /* Address book/folder tree */
260 vlbox = gtk_vbox_new(FALSE, 8);
261 gtk_box_pack_start(GTK_BOX(vbox), vlbox, TRUE, TRUE, 0);
262 gtk_container_set_border_width( GTK_CONTAINER(vlbox), 8 );
264 tree_win = gtk_scrolled_window_new( NULL, NULL );
265 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(tree_win),
266 GTK_POLICY_AUTOMATIC,
267 GTK_POLICY_AUTOMATIC );
268 gtk_box_pack_start( GTK_BOX(vlbox), tree_win, TRUE, TRUE, 0 );
270 list_entry = gtk_clist_new( N_COLS );
271 gtk_container_add( GTK_CONTAINER(tree_win), list_entry );
272 gtk_clist_column_titles_show( GTK_CLIST(list_entry) );
273 gtk_clist_set_column_title(
274 GTK_CLIST(list_entry), COL_NAME, _( "LDAP Name" ) );
275 gtk_clist_set_column_title(
276 GTK_CLIST(list_entry), COL_VALUE, _( "Attribute Value" ) );
277 gtk_clist_set_selection_mode(
278 GTK_CLIST(list_entry), GTK_SELECTION_BROWSE );
279 gtk_clist_set_column_width( GTK_CLIST(list_entry),
280 COL_NAME, COL_WIDTH_NAME );
281 gtk_clist_set_auto_sort( GTK_CLIST(list_entry), TRUE );
284 gtkut_stock_button_set_create(&hbbox, &close_btn, GTK_STOCK_CLOSE,
285 NULL, NULL, NULL, NULL);
286 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
287 gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
289 g_signal_connect(G_OBJECT(close_btn), "clicked",
290 G_CALLBACK(browse_close), NULL);
291 gtk_widget_grab_default(close_btn);
293 gtk_widget_show_all(vbox);
295 browseldap_dlg.window = window;
296 browseldap_dlg.label_server = label_server;
297 browseldap_dlg.label_address = label_addr;
298 browseldap_dlg.list_entry = list_entry;
299 browseldap_dlg.close_btn = close_btn;
301 gtk_widget_show_all( window );
306 * Idler function. This function is called by the main (UI) thread during UI
307 * idle time while an address search is in progress. Items from the display
308 * queue are processed and appended to the address list.
310 * \param data Target data object.
311 * \return <i>TRUE</i> to ensure that idle event do not get ignored.
313 static gboolean browse_idle( gpointer data ) {
318 /* Process all entries in display queue */
319 pthread_mutex_lock( & _browseMutex_ );
320 if( _displayQueue_ ) {
321 node = _displayQueue_;
323 /* Add entry into list */
324 nvp = ( NameValuePair * ) node->data;
325 text[COL_NAME] = nvp->name;
326 text[COL_VALUE] = nvp->value;
327 debug_print("Adding row to list: %s->%s\n", nvp->name, nvp->value);
329 GTK_CLIST(browseldap_dlg.list_entry), text );
332 ldapqry_free_name_value( nvp );
334 node = g_list_next( node );
336 g_list_free( _displayQueue_ );
337 _displayQueue_ = NULL;
339 pthread_mutex_unlock( & _browseMutex_ );
341 if( _searchComplete_ ) {
343 if( _browseIdleID_ != 0 ) {
344 g_source_remove( _browseIdleID_ );
346 gtk_clist_select_row(
347 GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
355 * Main entry point to browse LDAP entries.
356 * \param ds Data source to process.
357 * \param dn Distinguished name to retrieve.
358 * \return <code>TRUE</code>
360 gboolean browseldap_entry( AddressDataSource *ds, const gchar *dn ) {
366 server = ds->rawDataSource;
368 if( ! browseldap_dlg.window ) browse_create();
369 gtk_widget_grab_focus(browseldap_dlg.close_btn);
370 gtk_widget_show(browseldap_dlg.window);
371 manage_window_set_transient(GTK_WINDOW(browseldap_dlg.window));
373 gtk_clist_select_row( GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
374 gtk_widget_show(browseldap_dlg.window);
376 gtk_label_set_text( GTK_LABEL(browseldap_dlg.label_address ), "" );
379 GTK_LABEL(browseldap_dlg.label_address ), dn );
382 GTK_LABEL(browseldap_dlg.label_server ),
383 ldapsvr_get_name( server ) );
385 debug_print("browsing server: %s\n", ldapsvr_get_name(server));
387 _searchComplete_ = FALSE;
388 _queryID_ = ldaplocate_search_setup(
389 server, dn, browse_callback_entry, browse_callback_end );
390 debug_print("query id: %d\n", _queryID_);
391 _browseIdleID_ = g_idle_add( ( GtkFunction ) browse_idle, NULL );
394 debug_print("starting search\n");
395 ldaplocate_search_start( _queryID_ );
399 gtk_widget_hide( browseldap_dlg.window );
402 debug_print("stopping search\n");
403 ldaplocate_search_stop( _queryID_ );
405 if( _browseIdleID_ != 0 ) {
406 g_source_remove( _browseIdleID_ );
409 browse_clear_queue();
410 gtk_clist_clear( GTK_CLIST( browseldap_dlg.list_entry ) );
415 #endif /* USE_LDAP */