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         debug_print("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                 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 );
 127                 node->data = NULL;
 128                 node = g_list_next( node );
 129         }
 130         pthread_mutex_unlock( & _browseMutex_ );
 131         /* g_print( "browse_callback_entry...done\n" ); */
 132
 133         return 0;
 134 }
 135
 136 /**
 137  * Callback entry point for end of LDAP locate search.
 138  *
 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.
 143  */
 144 static gint browse_callback_end(
 145                 LdapQuery *qry, gint queryID, gint status, gpointer data )
 146 {
 147         debug_print("search completed\n");
 148         _searchComplete_ = TRUE;
 149         return 0;
 150 }
 151
 152 /**
 153  * Clear the display queue.
 154  */
 155 static void browse_clear_queue( void ) {
 156         /* Clear out display queue */
 157         pthread_mutex_lock( & _browseMutex_ );
 158
 159         ldapqry_free_list_name_value( _displayQueue_ );
 160         g_list_free( _displayQueue_ );
 161         _displayQueue_ = NULL;
 162
 163         pthread_mutex_unlock( & _browseMutex_ );
 164 }
 165
 166 /**
 167  * Close window callback.
 168  * \param widget    Widget.
 169  * \param event     Event.
 170  * \param cancelled Cancelled flag.
 171  */
 172 static gint browse_delete_event(
 173                 GtkWidget *widget, GdkEventAny *event, gboolean *cancelled )
 174 {
 175         gtk_main_quit();
 176         return TRUE;
 177 }
 178
 179 /**
 180  * Respond to key press in window.
 181  * \param widget    Widget.
 182  * \param event     Event.
 183  * \param cancelled Cancelled flag.
 184  */
 185 static void browse_key_pressed(
 186                 GtkWidget *widget, GdkEventKey *event, gboolean *cancelled )
 187 {
 188         if (event && event->keyval == GDK_Escape) {
 189                 gtk_main_quit();
 190         }
 191 }
 192
 193 /**
 194  * Callback to close window.
 195  * \param widget    Widget.
 196  * \param cancelled Cancelled flag.
 197  */
 198 static void browse_close( GtkWidget *widget, gboolean *cancelled ) {
 199         gtk_main_quit();
 200 }
 201
 202 /**
 203  * Create the window to display data.
 204  */
 205 static void browse_create( void ) {
 206         GtkWidget *window;
 207         GtkWidget *vbox;
 208         GtkWidget *table;
 209         GtkWidget *label;
 210         GtkWidget *label_server;
 211         GtkWidget *label_addr;
 212         GtkWidget *list_entry;
 213         GtkWidget *vlbox;
 214         GtkWidget *tree_win;
 215         GtkWidget *hbbox;
 216         GtkWidget *close_btn;
 217         gint top;
 218
 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);
 230
 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 );
 234
 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);
 240
 241         /* First row */
 242         top = 0;
 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);
 246
 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);
 250
 251         /* Second row */
 252         top++;
 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);
 256
 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);
 260
 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 );
 265
 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 );
 271
 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 );
 284
 285         /* Button panel */
 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 );
 290
 291         g_signal_connect(G_OBJECT(close_btn), "clicked",
 292                          G_CALLBACK(browse_close), NULL);
 293         gtk_widget_grab_default(close_btn);
 294
 295         gtk_widget_show_all(vbox);
 296
 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;
 302
 303         gtk_widget_show_all( window );
 304
 305 }
 306
 307 /**
 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.
 311  *
 312  * \param data Target data object.
 313  * \return <i>TRUE</i> to ensure that idle event do not get ignored.
 314  */
 315 static gboolean browse_idle( gpointer data ) {
 316         GList *node;
 317         NameValuePair *nvp;
 318         gchar *text[N_COLS];
 319
 320         /* Process all entries in display queue */
 321         pthread_mutex_lock( & _browseMutex_ );
 322         if( _displayQueue_ ) {
 323                 node = _displayQueue_;
 324                 while( node ) {
 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");
 332                         gtk_clist_append(
 333                                 GTK_CLIST(browseldap_dlg.list_entry), text );
 334
 335                         /* Free up entry */
 336                         ldapqry_free_name_value( nvp );
 337                         node->data = NULL;
 338                         node = g_list_next( node );
 339                 }
 340                 g_list_free( _displayQueue_ );
 341                 _displayQueue_ = NULL;
 342         }
 343         pthread_mutex_unlock( & _browseMutex_ );
 344
 345         if( _searchComplete_ ) {
 346                 /* Remove idler */
 347                 if( _browseIdleID_ != 0 ) {
 348                         g_source_remove( _browseIdleID_ );
 349                         _browseIdleID_ = 0;
 350                         gtk_clist_select_row(
 351                                 GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 352                 }
 353         }
 354
 355         return TRUE;
 356 }
 357
 358 /**
 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>
 363  */
 364 gboolean browseldap_entry( AddressDataSource *ds, const gchar *dn ) {
 365         LdapServer *server;
 366
 367         _queryID_ = 0;
 368         _browseIdleID_ = 0;
 369
 370         server = ds->rawDataSource;
 371
 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));
 376
 377         gtk_clist_select_row( GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 378         gtk_widget_show(browseldap_dlg.window);
 379
 380         gtk_label_set_text( GTK_LABEL(browseldap_dlg.label_address ), "" );
 381         if( dn ) {
 382                 gtk_label_set_text(
 383                         GTK_LABEL(browseldap_dlg.label_address ), dn );
 384         }
 385         gtk_label_set_text(
 386                 GTK_LABEL(browseldap_dlg.label_server ),
 387                 ldapsvr_get_name( server ) );
 388
 389         debug_print("browsing server: %s\n", ldapsvr_get_name(server));
 390         /* Setup search */
 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 );
 396
 397         /* Start search */
 398         debug_print("starting search\n");
 399         ldaplocate_search_start( _queryID_ );
 400
 401         /* Display dialog */
 402         gtk_main();
 403         gtk_widget_hide( browseldap_dlg.window );
 404
 405         /* Stop query */
 406         debug_print("stopping search\n");
 407         ldaplocate_search_stop( _queryID_ );
 408
 409         if( _browseIdleID_ != 0 ) {
 410                 g_source_remove( _browseIdleID_ );
 411                 _browseIdleID_ = 0;
 412         }
 413         browse_clear_queue();
 414         gtk_clist_clear( GTK_CLIST( browseldap_dlg.list_entry ) );
 415
 416         return TRUE;
 417 }
 418
 419 #endif /* USE_LDAP */
 420
 421 /*
 422 * End of Source.
 423 */
 424