src/browseldap.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2003 Match Grun
   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 2 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, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Browse LDAP entry.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27
  28 #include "defs.h"
  29
  30 #include <glib.h>
  31 #include <gdk/gdkkeysyms.h>
  32 #include <gtk/gtkwindow.h>
  33 #include <gtk/gtksignal.h>
  34 #include <gtk/gtkhbox.h>
  35 #include <gtk/gtklabel.h>
  36 #include <gtk/gtkentry.h>
  37 #include <gtk/gtkhbbox.h>
  38 #include <gtk/gtkbutton.h>
  39
  40 #include <pthread.h>
  41 #include "intl.h"
  42 #include "gtkutils.h"
  43 #include "stock_pixmap.h"
  44 #include "prefs_common.h"
  45 #include "browseldap.h"
  46 #include "addritem.h"
  47 #include "addrindex.h"
  48 #include "manage_window.h"
  49
  50 #include "ldapquery.h"
  51 #include "ldapserver.h"
  52 #include "ldaplocate.h"
  53
  54 typedef enum {
  55         COL_NAME  = 0,
  56         COL_VALUE = 1
  57 } LDAPEntryColumnPos;
  58
  59 #define BROWSELDAP_WIDTH    450
  60 #define BROWSELDAP_HEIGHT   420
  61
  62 #define N_COLS              2
  63 #define COL_WIDTH_NAME      140
  64 #define COL_WIDTH_VALUE     140
  65
  66 static struct _LDAPEntry_dlg {
  67         GtkWidget *window;
  68         GtkWidget *label_server;
  69         GtkWidget *label_address;
  70         GtkWidget *list_entry;
  71         GtkWidget *close_btn;
  72         GtkWidget *statusbar;
  73         gint status_cid;
  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                 /* ldapqry_print_name_value( nvp, stdout ); */
 124                 _displayQueue_ = g_list_append( _displayQueue_, nvp );
 125                 node->data = NULL;
 126                 node = g_list_next( node );
 127         }
 128         pthread_mutex_unlock( & _browseMutex_ );
 129         /* printf( "browse_callback_entry...done\n" ); */
 130
 131         return 0;
 132 }
 133
 134 /**
 135  * Callback entry point for end of LDAP locate search.
 136  *
 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.
 141  */
 142 static gint browse_callback_end(
 143                 LdapQuery *qry, gint queryID, gint status, gpointer data )
 144 {
 145         _searchComplete_ = TRUE;
 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  * Clear message in status bar.
 164  * \param msg Message.
 165  */
 166 static void browse_status_show( gchar *msg ) {
 167         if( browseldap_dlg.statusbar != NULL ) {
 168                 gtk_statusbar_pop( GTK_STATUSBAR(browseldap_dlg.statusbar),
 169                         browseldap_dlg.status_cid );
 170                 if( msg ) {
 171                         gtk_statusbar_push(
 172                                 GTK_STATUSBAR(browseldap_dlg.statusbar),
 173                                 browseldap_dlg.status_cid, msg );
 174                 }
 175         }
 176 }
 177
 178 /**
 179  * Close window callback.
 180  * \param widget    Widget.
 181  * \param event     Event.
 182  * \param cancelled Cancelled flag.
 183  */
 184 static gint browse_delete_event(
 185                 GtkWidget *widget, GdkEventAny *event, gboolean *cancelled )
 186 {
 187         gtk_main_quit();
 188         return TRUE;
 189 }
 190
 191 /**
 192  * Respond to key press in window.
 193  * \param widget    Widget.
 194  * \param event     Event.
 195  * \param cancelled Cancelled flag.
 196  */
 197 static void browse_key_pressed(
 198                 GtkWidget *widget, GdkEventKey *event, gboolean *cancelled )
 199 {
 200         if (event && event->keyval == GDK_Escape) {
 201                 gtk_main_quit();
 202         }
 203 }
 204
 205 /**
 206  * Callback to close window.
 207  * \param widget    Widget.
 208  * \param cancelled Cancelled flag.
 209  */
 210 static void browse_close( GtkWidget *widget, gboolean *cancelled ) {
 211         gtk_main_quit();
 212 }
 213
 214 /**
 215  * Create the window to display data.
 216  */
 217 static void browse_create( void ) {
 218         GtkWidget *window;
 219         GtkWidget *vbox;
 220         GtkWidget *table;
 221         GtkWidget *label;
 222         GtkWidget *label_server;
 223         GtkWidget *label_addr;
 224         GtkWidget *list_entry;
 225         GtkWidget *vlbox;
 226         GtkWidget *tree_win;
 227         GtkWidget *hbbox;
 228         GtkWidget *close_btn;
 229         GtkWidget *hsbox;
 230         GtkWidget *statusbar;
 231         gint top;
 232
 233         window = gtk_window_new(GTK_WINDOW_DIALOG);
 234         gtk_widget_set_usize( window, BROWSELDAP_WIDTH, BROWSELDAP_HEIGHT );
 235         gtk_container_set_border_width( GTK_CONTAINER(window), 0 );
 236         gtk_window_set_title( GTK_WINDOW(window), _("Browse Directory Entry") );
 237         gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_MOUSE );
 238         gtk_window_set_modal( GTK_WINDOW(window), TRUE );
 239         gtk_signal_connect( GTK_OBJECT(window), "delete_event",
 240                             GTK_SIGNAL_FUNC(browse_delete_event), NULL );
 241         gtk_signal_connect( GTK_OBJECT(window), "key_press_event",
 242                             GTK_SIGNAL_FUNC(browse_key_pressed), NULL );
 243
 244         vbox = gtk_vbox_new(FALSE, 8);
 245         gtk_container_add(GTK_CONTAINER(window), vbox);
 246         gtk_container_set_border_width( GTK_CONTAINER(vbox), 8 );
 247
 248         table = gtk_table_new(2, 2, FALSE);
 249         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
 250         gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
 251         gtk_table_set_row_spacings(GTK_TABLE(table), 8);
 252         gtk_table_set_col_spacings(GTK_TABLE(table), 8);
 253
 254         /* First row */
 255         top = 0;
 256         label = gtk_label_new(_("Server Name :"));
 257         gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
 258         gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
 259
 260         label_server = gtk_label_new("");
 261         gtk_table_attach(GTK_TABLE(table), label_server, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
 262         gtk_misc_set_alignment(GTK_MISC(label_server), 0, 0.5);
 263
 264         /* Second row */
 265         top++;
 266         label = gtk_label_new(_("Distinguished Name (dn) :"));
 267         gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
 268         gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
 269
 270         label_addr = gtk_label_new("");
 271         gtk_table_attach(GTK_TABLE(table), label_addr, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
 272         gtk_misc_set_alignment(GTK_MISC(label_addr), 0, 0.5);
 273
 274         /* Address book/folder tree */
 275         vlbox = gtk_vbox_new(FALSE, 8);
 276         gtk_box_pack_start(GTK_BOX(vbox), vlbox, TRUE, TRUE, 0);
 277         gtk_container_set_border_width( GTK_CONTAINER(vlbox), 8 );
 278
 279         tree_win = gtk_scrolled_window_new( NULL, NULL );
 280         gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(tree_win),
 281                                         GTK_POLICY_AUTOMATIC,
 282                                         GTK_POLICY_ALWAYS );
 283         gtk_box_pack_start( GTK_BOX(vlbox), tree_win, TRUE, TRUE, 0 );
 284
 285         list_entry = gtk_clist_new( N_COLS );
 286         gtk_container_add( GTK_CONTAINER(tree_win), list_entry );
 287         gtk_clist_column_titles_show( GTK_CLIST(list_entry) );
 288         gtk_clist_set_column_title(
 289                 GTK_CLIST(list_entry), COL_NAME, _( "LDAP Name" ) );
 290         gtk_clist_set_column_title(
 291                 GTK_CLIST(list_entry), COL_VALUE, _( "Attribute Value" ) );
 292         gtk_clist_set_selection_mode(
 293                 GTK_CLIST(list_entry), GTK_SELECTION_BROWSE );
 294         gtk_clist_set_column_width( GTK_CLIST(list_entry),
 295                 COL_NAME, COL_WIDTH_NAME );
 296         gtk_clist_set_auto_sort( GTK_CLIST(list_entry), TRUE );
 297
 298         /* Status line */
 299         hsbox = gtk_hbox_new(FALSE, 0);
 300         gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
 301         statusbar = gtk_statusbar_new();
 302         gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
 303
 304         /* Button panel */
 305         gtkut_button_set_create(&hbbox, &close_btn, _( "Close" ),
 306                                 NULL, NULL, NULL, NULL);
 307         gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
 308         gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
 309
 310         gtk_signal_connect(GTK_OBJECT(close_btn), "clicked",
 311                            GTK_SIGNAL_FUNC(browse_close), NULL);
 312         gtk_widget_grab_default(close_btn);
 313
 314         gtk_widget_show_all(vbox);
 315
 316         browseldap_dlg.window        = window;
 317         browseldap_dlg.label_server  = label_server;
 318         browseldap_dlg.label_address = label_addr;
 319         browseldap_dlg.list_entry    = list_entry;
 320         browseldap_dlg.close_btn     = close_btn;
 321         browseldap_dlg.statusbar     = statusbar;
 322         browseldap_dlg.status_cid    =
 323                 gtk_statusbar_get_context_id(
 324                         GTK_STATUSBAR(statusbar), "Browse LDAP" );
 325
 326         gtk_widget_show_all( window );
 327
 328 }
 329
 330 /**
 331  * Idler function. This function is called by the main (UI) thread during UI
 332  * idle time while an address search is in progress. Items from the display
 333  * queue are processed and appended to the address list.
 334  *
 335  * \param data Target data object.
 336  * \return <i>TRUE</i> to ensure that idle event do not get ignored.
 337  */
 338 static gboolean browse_idle( gpointer data ) {
 339         GList *node;
 340         NameValuePair *nvp;
 341         gchar *text[N_COLS];
 342
 343         /* Process all entries in display queue */
 344         pthread_mutex_lock( & _browseMutex_ );
 345         if( _displayQueue_ ) {
 346                 node = _displayQueue_;
 347                 while( node ) {
 348                         /* Add entry into list */
 349                         nvp = ( NameValuePair * ) node->data;
 350                         text[COL_NAME]  = nvp->name;
 351                         text[COL_VALUE] = nvp->value;
 352                         gtk_clist_append(
 353                                 GTK_CLIST(browseldap_dlg.list_entry), text );
 354
 355                         /* Free up entry */
 356                         ldapqry_free_name_value( nvp );
 357                         node->data = NULL;
 358                         node = g_list_next( node );
 359                 }
 360                 g_list_free( _displayQueue_ );
 361                 _displayQueue_ = NULL;
 362         }
 363         pthread_mutex_unlock( & _browseMutex_ );
 364
 365         if( _searchComplete_ ) {
 366                 /* Remove idler */
 367                 if( _browseIdleID_ != 0 ) {
 368                         gtk_idle_remove( _browseIdleID_ );
 369                         _browseIdleID_ = 0;
 370                         gtk_clist_select_row(
 371                                 GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 372                 }
 373         }
 374
 375         return TRUE;
 376 }
 377
 378 /**
 379  * Main entry point to browse LDAP entries.
 380  * \param  ds Data source to process.
 381  * \param  dn Distinguished name to retrieve.
 382  * \return <code>TRUE</code>
 383  */
 384 gboolean browseldap_entry( AddressDataSource *ds, const gchar *dn ) {
 385         LdapServer *server;
 386
 387         _queryID_ = 0;
 388         _browseIdleID_ = 0;
 389
 390         server = ds->rawDataSource;
 391
 392         if( ! browseldap_dlg.window ) browse_create();
 393         gtk_widget_grab_focus(browseldap_dlg.close_btn);
 394         gtk_widget_show(browseldap_dlg.window);
 395         manage_window_set_transient(GTK_WINDOW(browseldap_dlg.window));
 396
 397         browse_status_show( "" );
 398         gtk_clist_select_row( GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 399         gtk_widget_show(browseldap_dlg.window);
 400
 401         gtk_label_set_text( GTK_LABEL(browseldap_dlg.label_address ), "" );
 402         if( dn ) {
 403                 gtk_label_set_text(
 404                         GTK_LABEL(browseldap_dlg.label_address ), dn );
 405         }
 406         gtk_label_set_text(
 407                 GTK_LABEL(browseldap_dlg.label_server ),
 408                 ldapsvr_get_name( server ) );
 409
 410         /* Setup search */
 411         _searchComplete_ = FALSE;
 412         _queryID_ = ldaplocate_search_setup(
 413                         server, dn, browse_callback_entry, browse_callback_end );
 414         _browseIdleID_ = gtk_idle_add( ( GtkFunction ) browse_idle, NULL );
 415
 416         /* Start search */
 417         ldaplocate_search_start( _queryID_ );
 418
 419         /* Display dialog */
 420         gtk_main();
 421         gtk_widget_hide( browseldap_dlg.window );
 422
 423         /* Stop query */
 424         ldaplocate_search_stop( _queryID_ );
 425
 426         if( _browseIdleID_ != 0 ) {
 427                 gtk_idle_remove( _browseIdleID_ );
 428                 _browseIdleID_ = 0;
 429         }
 430         browse_clear_queue();
 431         gtk_clist_clear( GTK_CLIST( browseldap_dlg.list_entry ) );
 432
 433         return TRUE;
 434 }
 435
 436 /*
 437 * End of Source.
 438 */
 439