src/browseldap.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2003-2007 Match Grun and the Claws Mail team
   4  *
   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.
   9  *
  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.
  14  *
  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/>.
  17  *
  18  */
  19
  20 /*
  21  * Browse LDAP entry.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27
  28 #ifdef USE_LDAP
  29
  30 #include "defs.h"
  31
  32 #include <glib.h>
  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>
  42
  43 #include <pthread.h>
  44 #include "gtkutils.h"
  45 #include "stock_pixmap.h"
  46 #include "prefs_common.h"
  47 #include "browseldap.h"
  48 #include "addritem.h"
  49 #include "addrindex.h"
  50 #include "manage_window.h"
  51
  52 #include "ldapquery.h"
  53 #include "ldapserver.h"
  54 #include "ldaplocate.h"
  55
  56 typedef enum {
  57         COL_NAME  = 0,
  58         COL_VALUE = 1
  59 } LDAPEntryColumnPos;
  60
  61 #define BROWSELDAP_WIDTH    450
  62 #define BROWSELDAP_HEIGHT   420
  63
  64 #define N_COLS              2
  65 #define COL_WIDTH_NAME      140
  66 #define COL_WIDTH_VALUE     140
  67
  68 static struct _LDAPEntry_dlg {
  69         GtkWidget *window;
  70         GtkWidget *label_server;
  71         GtkWidget *label_address;
  72         GtkWidget *list_entry;
  73         GtkWidget *close_btn;
  74 } browseldap_dlg;
  75
  76 /**
  77  * Message queue.
  78  */
  79 static GList *_displayQueue_ = NULL;
  80
  81 /**
  82  * Mutex to protect callback from multiple threads.
  83  */
  84 static pthread_mutex_t _browseMutex_ = PTHREAD_MUTEX_INITIALIZER;
  85
  86 /**
  87  * Current query ID.
  88  */
  89 static gint _queryID_ = 0;
  90
  91 /**
  92  * Completion idle ID.
  93  */
  94 static guint _browseIdleID_ = 0;
  95
  96 /**
  97  * Search complete indicator.
  98  */
  99 static gboolean _searchComplete_ = FALSE;
 100
 101 /**
 102  * Callback entry point for each LDAP entry processed. The background thread
 103  * (if any) appends the address list to the display queue.
 104  *
 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
 108  *                   criteria.
 109  * \param data       User data.
 110  */
 111 static gint browse_callback_entry(
 112                 LdapQuery *qry, gint queryID, GList *listValues, gpointer data )
 113 {
 114         GList *node;
 115         NameValuePair *nvp;
 116
 117         /* printf( "browse_callback_entry...\n" ); */
 118         pthread_mutex_lock( & _browseMutex_ );
 119         /* Append contents to end of display queue */
 120         node = listValues;
 121         while( node ) {
 122                 nvp = ( NameValuePair * ) node->data;
 123                 _displayQueue_ = g_list_append( _displayQueue_, nvp );
 124                 node->data = NULL;
 125                 node = g_list_next( node );
 126         }
 127         pthread_mutex_unlock( & _browseMutex_ );
 128         /* printf( "browse_callback_entry...done\n" ); */
 129
 130         return 0;
 131 }
 132
 133 /**
 134  * Callback entry point for end of LDAP locate search.
 135  *
 136  * \param qry     LDAP query object.
 137  * \param queryID Query ID of search request.
 138  * \param status  Status/error code.
 139  * \param data    User data.
 140  */
 141 static gint browse_callback_end(
 142                 LdapQuery *qry, gint queryID, gint status, gpointer data )
 143 {
 144         _searchComplete_ = TRUE;
 145         return 0;
 146 }
 147
 148 /**
 149  * Clear the display queue.
 150  */
 151 static void browse_clear_queue( void ) {
 152         /* Clear out display queue */
 153         pthread_mutex_lock( & _browseMutex_ );
 154
 155         ldapqry_free_list_name_value( _displayQueue_ );
 156         g_list_free( _displayQueue_ );
 157         _displayQueue_ = NULL;
 158
 159         pthread_mutex_unlock( & _browseMutex_ );
 160 }
 161
 162 /**
 163  * Close window callback.
 164  * \param widget    Widget.
 165  * \param event     Event.
 166  * \param cancelled Cancelled flag.
 167  */
 168 static gint browse_delete_event(
 169                 GtkWidget *widget, GdkEventAny *event, gboolean *cancelled )
 170 {
 171         gtk_main_quit();
 172         return TRUE;
 173 }
 174
 175 /**
 176  * Respond to key press in window.
 177  * \param widget    Widget.
 178  * \param event     Event.
 179  * \param cancelled Cancelled flag.
 180  */
 181 static void browse_key_pressed(
 182                 GtkWidget *widget, GdkEventKey *event, gboolean *cancelled )
 183 {
 184         if (event && event->keyval == GDK_Escape) {
 185                 gtk_main_quit();
 186         }
 187 }
 188
 189 /**
 190  * Callback to close window.
 191  * \param widget    Widget.
 192  * \param cancelled Cancelled flag.
 193  */
 194 static void browse_close( GtkWidget *widget, gboolean *cancelled ) {
 195         gtk_main_quit();
 196 }
 197
 198 /**
 199  * Create the window to display data.
 200  */
 201 static void browse_create( void ) {
 202         GtkWidget *window;
 203         GtkWidget *vbox;
 204         GtkWidget *table;
 205         GtkWidget *label;
 206         GtkWidget *label_server;
 207         GtkWidget *label_addr;
 208         GtkWidget *list_entry;
 209         GtkWidget *vlbox;
 210         GtkWidget *tree_win;
 211         GtkWidget *hbbox;
 212         GtkWidget *close_btn;
 213         gint top;
 214
 215         window = gtk_dialog_new();
 216         gtk_widget_set_size_request( window, BROWSELDAP_WIDTH, BROWSELDAP_HEIGHT );
 217         gtk_container_set_border_width( GTK_CONTAINER(window), 0 );
 218         gtk_window_set_title( GTK_WINDOW(window), _("Browse Directory Entry") );
 219         gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_MOUSE );
 220         gtk_window_set_modal( GTK_WINDOW(window), TRUE );
 221         g_signal_connect(G_OBJECT(window), "delete_event",
 222                          G_CALLBACK(browse_delete_event), NULL);
 223         g_signal_connect(G_OBJECT(window), "key_press_event",
 224                          G_CALLBACK(browse_key_pressed), NULL);
 225
 226         vbox = gtk_vbox_new(FALSE, 8);
 227         gtk_box_pack_start(GTK_BOX(GTK_DIALOG(window)->vbox), vbox, TRUE, TRUE, 0);
 228         gtk_container_set_border_width( GTK_CONTAINER(vbox), 8 );
 229
 230         table = gtk_table_new(2, 2, FALSE);
 231         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
 232         gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
 233         gtk_table_set_row_spacings(GTK_TABLE(table), 8);
 234         gtk_table_set_col_spacings(GTK_TABLE(table), 8);
 235
 236         /* First row */
 237         top = 0;
 238         label = gtk_label_new(_("Server Name :"));
 239         gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
 240         gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
 241
 242         label_server = gtk_label_new("");
 243         gtk_table_attach(GTK_TABLE(table), label_server, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
 244         gtk_misc_set_alignment(GTK_MISC(label_server), 0, 0.5);
 245
 246         /* Second row */
 247         top++;
 248         label = gtk_label_new(_("Distinguished Name (dn) :"));
 249         gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
 250         gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
 251
 252         label_addr = gtk_label_new("");
 253         gtk_table_attach(GTK_TABLE(table), label_addr, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
 254         gtk_misc_set_alignment(GTK_MISC(label_addr), 0, 0.5);
 255
 256         /* Address book/folder tree */
 257         vlbox = gtk_vbox_new(FALSE, 8);
 258         gtk_box_pack_start(GTK_BOX(vbox), vlbox, TRUE, TRUE, 0);
 259         gtk_container_set_border_width( GTK_CONTAINER(vlbox), 8 );
 260
 261         tree_win = gtk_scrolled_window_new( NULL, NULL );
 262         gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(tree_win),
 263                                         GTK_POLICY_AUTOMATIC,
 264                                         GTK_POLICY_AUTOMATIC );
 265         gtk_box_pack_start( GTK_BOX(vlbox), tree_win, TRUE, TRUE, 0 );
 266
 267         list_entry = gtk_clist_new( N_COLS );
 268         gtk_container_add( GTK_CONTAINER(tree_win), list_entry );
 269         gtk_clist_column_titles_show( GTK_CLIST(list_entry) );
 270         gtk_clist_set_column_title(
 271                 GTK_CLIST(list_entry), COL_NAME, _( "LDAP Name" ) );
 272         gtk_clist_set_column_title(
 273                 GTK_CLIST(list_entry), COL_VALUE, _( "Attribute Value" ) );
 274         gtk_clist_set_selection_mode(
 275                 GTK_CLIST(list_entry), GTK_SELECTION_BROWSE );
 276         gtk_clist_set_column_width( GTK_CLIST(list_entry),
 277                 COL_NAME, COL_WIDTH_NAME );
 278         gtk_clist_set_auto_sort( GTK_CLIST(list_entry), TRUE );
 279
 280         /* Button panel */
 281         gtkut_stock_button_set_create(&hbbox, &close_btn, GTK_STOCK_CLOSE,
 282                                       NULL, NULL, NULL, NULL);
 283         gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
 284         gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
 285
 286         g_signal_connect(G_OBJECT(close_btn), "clicked",
 287                          G_CALLBACK(browse_close), NULL);
 288         gtk_widget_grab_default(close_btn);
 289
 290         gtk_widget_show_all(vbox);
 291
 292         browseldap_dlg.window        = window;
 293         browseldap_dlg.label_server  = label_server;
 294         browseldap_dlg.label_address = label_addr;
 295         browseldap_dlg.list_entry    = list_entry;
 296         browseldap_dlg.close_btn     = close_btn;
 297
 298         gtk_widget_show_all( window );
 299
 300 }
 301
 302 /**
 303  * Idler function. This function is called by the main (UI) thread during UI
 304  * idle time while an address search is in progress. Items from the display
 305  * queue are processed and appended to the address list.
 306  *
 307  * \param data Target data object.
 308  * \return <i>TRUE</i> to ensure that idle event do not get ignored.
 309  */
 310 static gboolean browse_idle( gpointer data ) {
 311         GList *node;
 312         NameValuePair *nvp;
 313         gchar *text[N_COLS];
 314
 315         /* Process all entries in display queue */
 316         pthread_mutex_lock( & _browseMutex_ );
 317         if( _displayQueue_ ) {
 318                 node = _displayQueue_;
 319                 while( node ) {
 320                         /* Add entry into list */
 321                         nvp = ( NameValuePair * ) node->data;
 322                         text[COL_NAME]  = nvp->name;
 323                         text[COL_VALUE] = nvp->value;
 324                         gtk_clist_append(
 325                                 GTK_CLIST(browseldap_dlg.list_entry), text );
 326
 327                         /* Free up entry */
 328                         ldapqry_free_name_value( nvp );
 329                         node->data = NULL;
 330                         node = g_list_next( node );
 331                 }
 332                 g_list_free( _displayQueue_ );
 333                 _displayQueue_ = NULL;
 334         }
 335         pthread_mutex_unlock( & _browseMutex_ );
 336
 337         if( _searchComplete_ ) {
 338                 /* Remove idler */
 339                 if( _browseIdleID_ != 0 ) {
 340                         g_source_remove( _browseIdleID_ );
 341                         _browseIdleID_ = 0;
 342                         gtk_clist_select_row(
 343                                 GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 344                 }
 345         }
 346
 347         return TRUE;
 348 }
 349
 350 /**
 351  * Main entry point to browse LDAP entries.
 352  * \param  ds Data source to process.
 353  * \param  dn Distinguished name to retrieve.
 354  * \return <code>TRUE</code>
 355  */
 356 gboolean browseldap_entry( AddressDataSource *ds, const gchar *dn ) {
 357         LdapServer *server;
 358
 359         _queryID_ = 0;
 360         _browseIdleID_ = 0;
 361
 362         server = ds->rawDataSource;
 363
 364         if( ! browseldap_dlg.window ) browse_create();
 365         gtk_widget_grab_focus(browseldap_dlg.close_btn);
 366         gtk_widget_show(browseldap_dlg.window);
 367         manage_window_set_transient(GTK_WINDOW(browseldap_dlg.window));
 368
 369         gtk_clist_select_row( GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 370         gtk_widget_show(browseldap_dlg.window);
 371
 372         gtk_label_set_text( GTK_LABEL(browseldap_dlg.label_address ), "" );
 373         if( dn ) {
 374                 gtk_label_set_text(
 375                         GTK_LABEL(browseldap_dlg.label_address ), dn );
 376         }
 377         gtk_label_set_text(
 378                 GTK_LABEL(browseldap_dlg.label_server ),
 379                 ldapsvr_get_name( server ) );
 380
 381         /* Setup search */
 382         _searchComplete_ = FALSE;
 383         _queryID_ = ldaplocate_search_setup(
 384                         server, dn, browse_callback_entry, browse_callback_end );
 385         _browseIdleID_ = g_idle_add( ( GtkFunction ) browse_idle, NULL );
 386
 387         /* Start search */
 388         ldaplocate_search_start( _queryID_ );
 389
 390         /* Display dialog */
 391         gtk_main();
 392         gtk_widget_hide( browseldap_dlg.window );
 393
 394         /* Stop query */
 395         ldaplocate_search_stop( _queryID_ );
 396
 397         if( _browseIdleID_ != 0 ) {
 398                 g_source_remove( _browseIdleID_ );
 399                 _browseIdleID_ = 0;
 400         }
 401         browse_clear_queue();
 402         gtk_clist_clear( GTK_CLIST( browseldap_dlg.list_entry ) );
 403
 404         return TRUE;
 405 }
 406
 407 #endif /* USE_LDAP */
 408
 409 /*
 410 * End of Source.
 411 */
 412