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 #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         GtkWidget *statusbar;
  75         gint status_cid;
  76 } browseldap_dlg;
  77
  78 /**
  79  * Message queue.
  80  */
  81 static GList *_displayQueue_ = NULL;
  82
  83 /**
  84  * Mutex to protect callback from multiple threads.
  85  */
  86 static pthread_mutex_t _browseMutex_ = PTHREAD_MUTEX_INITIALIZER;
  87
  88 /**
  89  * Current query ID.
  90  */
  91 static gint _queryID_ = 0;
  92
  93 /**
  94  * Completion idle ID.
  95  */
  96 static guint _browseIdleID_ = 0;
  97
  98 /**
  99  * Search complete indicator.
 100  */
 101 static gboolean _searchComplete_ = FALSE;
 102
 103 /**
 104  * Callback entry point for each LDAP entry processed. The background thread
 105  * (if any) appends the address list to the display queue.
 106  *
 107  * \param qry        LDAP query object.
 108  * \param queryID    Query ID of search request.
 109  * \param listEMail  List of zero of more email objects that met search
 110  *                   criteria.
 111  * \param data       User data.
 112  */
 113 static gint browse_callback_entry(
 114                 LdapQuery *qry, gint queryID, GList *listValues, gpointer data )
 115 {
 116         GList *node;
 117         NameValuePair *nvp;
 118
 119         /* printf( "browse_callback_entry...\n" ); */
 120         pthread_mutex_lock( & _browseMutex_ );
 121         /* Append contents to end of display queue */
 122         node = listValues;
 123         while( node ) {
 124                 nvp = ( NameValuePair * ) node->data;
 125                 /* ldapqry_print_name_value( nvp, stdout ); */
 126                 _displayQueue_ = g_list_append( _displayQueue_, nvp );
 127                 node->data = NULL;
 128                 node = g_list_next( node );
 129         }
 130         pthread_mutex_unlock( & _browseMutex_ );
 131         /* printf( "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         _searchComplete_ = TRUE;
 148         return 0;
 149 }
 150
 151 /**
 152  * Clear the display queue.
 153  */
 154 static void browse_clear_queue( void ) {
 155         /* Clear out display queue */
 156         pthread_mutex_lock( & _browseMutex_ );
 157
 158         ldapqry_free_list_name_value( _displayQueue_ );
 159         g_list_free( _displayQueue_ );
 160         _displayQueue_ = NULL;
 161
 162         pthread_mutex_unlock( & _browseMutex_ );
 163 }
 164
 165 /**
 166  * Clear message in status bar.
 167  * \param msg Message.
 168  */
 169 static void browse_status_show( gchar *msg ) {
 170         if( browseldap_dlg.statusbar != NULL ) {
 171                 gtk_statusbar_pop( GTK_STATUSBAR(browseldap_dlg.statusbar),
 172                         browseldap_dlg.status_cid );
 173                 if( msg ) {
 174                         gtk_statusbar_push(
 175                                 GTK_STATUSBAR(browseldap_dlg.statusbar),
 176                                 browseldap_dlg.status_cid, msg );
 177                 }
 178         }
 179 }
 180
 181 /**
 182  * Close window callback.
 183  * \param widget    Widget.
 184  * \param event     Event.
 185  * \param cancelled Cancelled flag.
 186  */
 187 static gint browse_delete_event(
 188                 GtkWidget *widget, GdkEventAny *event, gboolean *cancelled )
 189 {
 190         gtk_main_quit();
 191         return TRUE;
 192 }
 193
 194 /**
 195  * Respond to key press in window.
 196  * \param widget    Widget.
 197  * \param event     Event.
 198  * \param cancelled Cancelled flag.
 199  */
 200 static void browse_key_pressed(
 201                 GtkWidget *widget, GdkEventKey *event, gboolean *cancelled )
 202 {
 203         if (event && event->keyval == GDK_Escape) {
 204                 gtk_main_quit();
 205         }
 206 }
 207
 208 /**
 209  * Callback to close window.
 210  * \param widget    Widget.
 211  * \param cancelled Cancelled flag.
 212  */
 213 static void browse_close( GtkWidget *widget, gboolean *cancelled ) {
 214         gtk_main_quit();
 215 }
 216
 217 /**
 218  * Create the window to display data.
 219  */
 220 static void browse_create( void ) {
 221         GtkWidget *window;
 222         GtkWidget *vbox;
 223         GtkWidget *table;
 224         GtkWidget *label;
 225         GtkWidget *label_server;
 226         GtkWidget *label_addr;
 227         GtkWidget *list_entry;
 228         GtkWidget *vlbox;
 229         GtkWidget *tree_win;
 230         GtkWidget *hbbox;
 231         GtkWidget *close_btn;
 232         GtkWidget *hsbox;
 233         GtkWidget *statusbar;
 234         gint top;
 235
 236         window = gtk_dialog_new();
 237         gtk_widget_set_size_request( window, BROWSELDAP_WIDTH, BROWSELDAP_HEIGHT );
 238         gtk_container_set_border_width( GTK_CONTAINER(window), 0 );
 239         gtk_window_set_title( GTK_WINDOW(window), _("Browse Directory Entry") );
 240         gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_MOUSE );
 241         gtk_window_set_modal( GTK_WINDOW(window), TRUE );
 242         g_signal_connect(G_OBJECT(window), "delete_event",
 243                          G_CALLBACK(browse_delete_event), NULL);
 244         g_signal_connect(G_OBJECT(window), "key_press_event",
 245                          G_CALLBACK(browse_key_pressed), NULL);
 246
 247         vbox = gtk_vbox_new(FALSE, 8);
 248         gtk_container_add(GTK_CONTAINER(window), vbox);
 249         gtk_container_set_border_width( GTK_CONTAINER(vbox), 8 );
 250
 251         table = gtk_table_new(2, 2, FALSE);
 252         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
 253         gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
 254         gtk_table_set_row_spacings(GTK_TABLE(table), 8);
 255         gtk_table_set_col_spacings(GTK_TABLE(table), 8);
 256
 257         /* First row */
 258         top = 0;
 259         label = gtk_label_new(_("Server Name :"));
 260         gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
 261         gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
 262
 263         label_server = gtk_label_new("");
 264         gtk_table_attach(GTK_TABLE(table), label_server, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
 265         gtk_misc_set_alignment(GTK_MISC(label_server), 0, 0.5);
 266
 267         /* Second row */
 268         top++;
 269         label = gtk_label_new(_("Distinguished Name (dn) :"));
 270         gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
 271         gtk_misc_set_alignment(GTK_MISC(label), 1, 0.5);
 272
 273         label_addr = gtk_label_new("");
 274         gtk_table_attach(GTK_TABLE(table), label_addr, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
 275         gtk_misc_set_alignment(GTK_MISC(label_addr), 0, 0.5);
 276
 277         /* Address book/folder tree */
 278         vlbox = gtk_vbox_new(FALSE, 8);
 279         gtk_box_pack_start(GTK_BOX(vbox), vlbox, TRUE, TRUE, 0);
 280         gtk_container_set_border_width( GTK_CONTAINER(vlbox), 8 );
 281
 282         tree_win = gtk_scrolled_window_new( NULL, NULL );
 283         gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(tree_win),
 284                                         GTK_POLICY_AUTOMATIC,
 285                                         GTK_POLICY_AUTOMATIC );
 286         gtk_box_pack_start( GTK_BOX(vlbox), tree_win, TRUE, TRUE, 0 );
 287
 288         list_entry = gtk_clist_new( N_COLS );
 289         gtk_container_add( GTK_CONTAINER(tree_win), list_entry );
 290         gtk_clist_column_titles_show( GTK_CLIST(list_entry) );
 291         gtk_clist_set_column_title(
 292                 GTK_CLIST(list_entry), COL_NAME, _( "LDAP Name" ) );
 293         gtk_clist_set_column_title(
 294                 GTK_CLIST(list_entry), COL_VALUE, _( "Attribute Value" ) );
 295         gtk_clist_set_selection_mode(
 296                 GTK_CLIST(list_entry), GTK_SELECTION_BROWSE );
 297         gtk_clist_set_column_width( GTK_CLIST(list_entry),
 298                 COL_NAME, COL_WIDTH_NAME );
 299         gtk_clist_set_auto_sort( GTK_CLIST(list_entry), TRUE );
 300
 301         /* Status line */
 302         hsbox = gtk_hbox_new(FALSE, 0);
 303         gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
 304         statusbar = gtk_statusbar_new();
 305         gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
 306
 307         /* Button panel */
 308         gtkut_stock_button_set_create(&hbbox, &close_btn, GTK_STOCK_CLOSE,
 309                                       NULL, NULL, NULL, NULL);
 310         gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
 311         gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
 312
 313         g_signal_connect(G_OBJECT(close_btn), "clicked",
 314                          G_CALLBACK(browse_close), NULL);
 315         gtk_widget_grab_default(close_btn);
 316
 317         gtk_widget_show_all(vbox);
 318
 319         browseldap_dlg.window        = window;
 320         browseldap_dlg.label_server  = label_server;
 321         browseldap_dlg.label_address = label_addr;
 322         browseldap_dlg.list_entry    = list_entry;
 323         browseldap_dlg.close_btn     = close_btn;
 324         browseldap_dlg.statusbar     = statusbar;
 325         browseldap_dlg.status_cid    =
 326                 gtk_statusbar_get_context_id(
 327                         GTK_STATUSBAR(statusbar), "Browse LDAP" );
 328
 329         gtk_widget_show_all( window );
 330
 331 }
 332
 333 /**
 334  * Idler function. This function is called by the main (UI) thread during UI
 335  * idle time while an address search is in progress. Items from the display
 336  * queue are processed and appended to the address list.
 337  *
 338  * \param data Target data object.
 339  * \return <i>TRUE</i> to ensure that idle event do not get ignored.
 340  */
 341 static gboolean browse_idle( gpointer data ) {
 342         GList *node;
 343         NameValuePair *nvp;
 344         gchar *text[N_COLS];
 345
 346         /* Process all entries in display queue */
 347         pthread_mutex_lock( & _browseMutex_ );
 348         if( _displayQueue_ ) {
 349                 node = _displayQueue_;
 350                 while( node ) {
 351                         /* Add entry into list */
 352                         nvp = ( NameValuePair * ) node->data;
 353                         text[COL_NAME]  = nvp->name;
 354                         text[COL_VALUE] = nvp->value;
 355                         gtk_clist_append(
 356                                 GTK_CLIST(browseldap_dlg.list_entry), text );
 357
 358                         /* Free up entry */
 359                         ldapqry_free_name_value( nvp );
 360                         node->data = NULL;
 361                         node = g_list_next( node );
 362                 }
 363                 g_list_free( _displayQueue_ );
 364                 _displayQueue_ = NULL;
 365         }
 366         pthread_mutex_unlock( & _browseMutex_ );
 367
 368         if( _searchComplete_ ) {
 369                 /* Remove idler */
 370                 if( _browseIdleID_ != 0 ) {
 371                         gtk_idle_remove( _browseIdleID_ );
 372                         _browseIdleID_ = 0;
 373                         gtk_clist_select_row(
 374                                 GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 375                 }
 376         }
 377
 378         return TRUE;
 379 }
 380
 381 /**
 382  * Main entry point to browse LDAP entries.
 383  * \param  ds Data source to process.
 384  * \param  dn Distinguished name to retrieve.
 385  * \return <code>TRUE</code>
 386  */
 387 gboolean browseldap_entry( AddressDataSource *ds, const gchar *dn ) {
 388         LdapServer *server;
 389
 390         _queryID_ = 0;
 391         _browseIdleID_ = 0;
 392
 393         server = ds->rawDataSource;
 394
 395         if( ! browseldap_dlg.window ) browse_create();
 396         gtk_widget_grab_focus(browseldap_dlg.close_btn);
 397         gtk_widget_show(browseldap_dlg.window);
 398         manage_window_set_transient(GTK_WINDOW(browseldap_dlg.window));
 399
 400         browse_status_show( "" );
 401         gtk_clist_select_row( GTK_CLIST( browseldap_dlg.list_entry ), 0, 0 );
 402         gtk_widget_show(browseldap_dlg.window);
 403
 404         gtk_label_set_text( GTK_LABEL(browseldap_dlg.label_address ), "" );
 405         if( dn ) {
 406                 gtk_label_set_text(
 407                         GTK_LABEL(browseldap_dlg.label_address ), dn );
 408         }
 409         gtk_label_set_text(
 410                 GTK_LABEL(browseldap_dlg.label_server ),
 411                 ldapsvr_get_name( server ) );
 412
 413         /* Setup search */
 414         _searchComplete_ = FALSE;
 415         _queryID_ = ldaplocate_search_setup(
 416                         server, dn, browse_callback_entry, browse_callback_end );
 417         _browseIdleID_ = gtk_idle_add( ( GtkFunction ) browse_idle, NULL );
 418
 419         /* Start search */
 420         ldaplocate_search_start( _queryID_ );
 421
 422         /* Display dialog */
 423         gtk_main();
 424         gtk_widget_hide( browseldap_dlg.window );
 425
 426         /* Stop query */
 427         ldaplocate_search_stop( _queryID_ );
 428
 429         if( _browseIdleID_ != 0 ) {
 430                 gtk_idle_remove( _browseIdleID_ );
 431                 _browseIdleID_ = 0;
 432         }
 433         browse_clear_queue();
 434         gtk_clist_clear( GTK_CLIST( browseldap_dlg.list_entry ) );
 435
 436         return TRUE;
 437 }
 438
 439 #endif /* USE_LDAP */
 440
 441 /*
 442 * End of Source.
 443 */
 444