src/importldif.c

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001-2022 the Claws Mail team and 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 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  * Import LDIF address book data.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #include "claws-features.h"
  26 #endif
  27
  28 #include "defs.h"
  29
  30 #include <glib.h>
  31 #include <glib/gi18n.h>
  32 #include <gdk/gdkkeysyms.h>
  33 #include <gtk/gtk.h>
  34
  35 #include "addrbook.h"
  36 #include "addressbook.h"
  37 #include "addressitem.h"
  38 #include "gtkutils.h"
  39 #include "stock_pixmap.h"
  40 #include "prefs_common.h"
  41 #include "manage_window.h"
  42 #include "mgutils.h"
  43 #include "ldif.h"
  44 #include "utils.h"
  45 #include "filesel.h"
  46
  47 #define IMPORTLDIF_GUESS_NAME      "LDIF Import"
  48
  49 #define PAGE_FILE_INFO             0
  50 #define PAGE_ATTRIBUTES            1
  51 #define PAGE_FINISH                2
  52
  53 #define IMPORTLDIF_WIDTH           390
  54 #define IMPORTLDIF_HEIGHT          300
  55
  56 #define FIELDS_COL_WIDTH_RESERVED  10
  57 #define FIELDS_COL_WIDTH_SELECT    10
  58 #define FIELDS_COL_WIDTH_FIELD     140
  59 #define FIELDS_COL_WIDTH_ATTRIB    140
  60
  61 typedef enum {
  62         FIELD_COL_RESERVED,
  63         FIELD_COL_SELECT,
  64         FIELD_COL_FIELD,
  65         FIELD_COL_ATTRIB,
  66         FIELD_COL_PTR,
  67         FIELDS_N_COLS
  68 } ImpLdif_FieldColPos;
  69
  70 /**
  71  * LDIF dialog definition.
  72  */
  73 static struct _ImpLdif_Dlg {
  74         GtkWidget *window;
  75         GtkWidget *notebook;
  76         GtkWidget *entryFile;
  77         GtkWidget *entryName;
  78         GtkWidget *view_fields;
  79         GtkWidget *entryField;
  80         GtkWidget *entryAttrib;
  81         GtkWidget *checkSelect;
  82         GtkWidget *btnModify;
  83         GtkWidget *labelBook;
  84         GtkWidget *labelFile;
  85         GtkWidget *labelRecords;
  86         GtkWidget *btnPrev;
  87         GtkWidget *btnNext;
  88         GtkWidget *btnProceed;
  89         GtkWidget *btnCancel;
  90         GtkWidget *statusbar;
  91         gint      status_cid;
  92         gint      rowCount;
  93         gchar     *nameBook;
  94         gchar     *fileName;
  95         gboolean  cancelled;
  96 } impldif_dlg;
  97
  98 static struct _AddressFileSelection _imp_ldif_file_selector_;
  99 static AddressBookFile *_importedBook_;
 100 static AddressIndex *_imp_addressIndex_;
 101 static LdifFile *_ldifFile_ = NULL;
 102
 103 static GdkPixbuf *markxpm;
 104
 105 /**
 106  * Structure of error message table.
 107  */
 108 typedef struct _ErrMsgTableEntry ErrMsgTableEntry;
 109 struct _ErrMsgTableEntry {
 110         gint    code;
 111         gchar   *description;
 112 };
 113
 114 static gchar *_errMsgUnknown_ = N_( "Unknown" );
 115
 116 /**
 117  * Lookup table of error messages for general errors. Note that a NULL
 118  * description signifies the end of the table.
 119  */
 120 static ErrMsgTableEntry _lutErrorsLDIF_[] = {
 121         { MGU_SUCCESS,          N_("Success") },
 122         { MGU_BAD_ARGS,         N_("Bad arguments") },
 123         { MGU_NO_FILE,          N_("File not specified") },
 124         { MGU_OPEN_FILE,        N_("Error opening file") },
 125         { MGU_ERROR_READ,       N_("Error reading file") },
 126         { MGU_EOF,              N_("End of file encountered") },
 127         { MGU_OO_MEMORY,        N_("Error allocating memory") },
 128         { MGU_BAD_FORMAT,       N_("Bad file format") },
 129         { MGU_ERROR_WRITE,      N_("Error writing to file") },
 130         { MGU_OPEN_DIRECTORY,   N_("Error opening directory") },
 131         { MGU_NO_PATH,          N_("No path specified") },
 132         { 0,                    NULL }
 133 };
 134
 135 /**
 136  * Lookup message for specified error code.
 137  * \param lut  Lookup table.
 138  * \param code Code to lookup.
 139  * \return Description associated to code.
 140  */
 141 static gchar *imp_ldif_err2string( ErrMsgTableEntry lut[], gint code ) {
 142         gchar *desc = NULL;
 143         ErrMsgTableEntry entry;
 144         gint i;
 145
 146         for( i = 0; ; i++ ) {
 147                 entry = lut[ i ];
 148                 if( entry.description == NULL ) break;
 149                 if( entry.code == code ) {
 150                         desc = entry.description;
 151                         break;
 152                 }
 153         }
 154         if( ! desc ) {
 155                 desc = _errMsgUnknown_;
 156         }
 157         return desc;
 158 }
 159
 160 /**
 161  * Display message in status field.
 162  * \param msg Message to display.
 163  */
 164 static void imp_ldif_status_show( gchar *msg ) {
 165         if( impldif_dlg.statusbar != NULL ) {
 166                 gtk_statusbar_pop( GTK_STATUSBAR(impldif_dlg.statusbar),
 167                         impldif_dlg.status_cid );
 168                 if( msg ) {
 169                         gtk_statusbar_push(
 170                                 GTK_STATUSBAR(impldif_dlg.statusbar),
 171                                 impldif_dlg.status_cid, msg );
 172                 }
 173         }
 174 }
 175
 176 /**
 177  * Select and display status message appropriate for the page being displayed.
 178  */
 179 static void imp_ldif_message( void ) {
 180         gchar *sMsg = NULL;
 181         gint pageNum;
 182
 183         pageNum = gtk_notebook_get_current_page( GTK_NOTEBOOK(impldif_dlg.notebook) );
 184         if( pageNum == PAGE_FILE_INFO ) {
 185                 sMsg = _( "Please specify address book name and file to import." );
 186         }
 187         else if( pageNum == PAGE_ATTRIBUTES ) {
 188                 sMsg = _( "Select and rename LDIF field names to import." );
 189         }
 190         else if( pageNum == PAGE_FINISH ) {
 191                 sMsg = _( "File imported." );
 192         }
 193         imp_ldif_status_show( sMsg );
 194 }
 195
 196 /**
 197  * Update the line (represented by the GtkTreeIter) with data
 198  * from the Ldif_FieldRec.
 199  */
 200 static void _populate_iter(GtkListStore *store, GtkTreeIter *iter,
 201                 Ldif_FieldRec *rec)
 202 {
 203         gtk_list_store_set(store, iter,
 204                         FIELD_COL_FIELD, rec->tagName,
 205                         FIELD_COL_ATTRIB, rec->userName,
 206                         FIELD_COL_PTR, rec,
 207                         -1);
 208         gtk_list_store_set(store, iter,
 209                         FIELD_COL_SELECT, rec->selected ? markxpm : NULL, -1);
 210         gtk_list_store_set(store, iter,
 211                         FIELD_COL_RESERVED, rec->reserved ? markxpm : NULL, -1);
 212 }
 213
 214 /**
 215  * Load list with LDIF fields read from file.
 216  * \param ldf LDIF control data.
 217  */
 218 static void imp_ldif_load_fields( LdifFile *ldf ) {
 219         GtkWidget *view = impldif_dlg.view_fields;
 220         GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
 221         GtkTreeIter iter;
 222         GList *node, *list;
 223
 224         impldif_dlg.rowCount = 0;
 225
 226         if( ! ldf->accessFlag ) return;
 227
 228         gtk_list_store_clear(GTK_LIST_STORE(model));
 229
 230         list = ldif_get_fieldlist( ldf );
 231         node = list;
 232         while( node ) {
 233                 Ldif_FieldRec *rec = node->data;
 234
 235                 gtk_list_store_append(GTK_LIST_STORE(model), &iter);
 236                 _populate_iter(GTK_LIST_STORE(model), &iter, rec);
 237                 impldif_dlg.rowCount++;
 238                 node = g_list_next( node );
 239         }
 240         g_list_free( list );
 241         list = NULL;
 242         ldif_set_accessed( ldf, FALSE );
 243 }
 244
 245 /**
 246  * Test whether we can move off fields page.
 247  * \return <i>TRUE</i> if OK to move off page.
 248  */
 249 static gboolean imp_ldif_field_move() {
 250         gboolean retVal = FALSE;
 251         gchar *newFile;
 252         AddressBookFile *abf = NULL;
 253
 254         if( _importedBook_ ) {
 255                 addrbook_free_book( _importedBook_ );
 256         }
 257
 258         abf = addrbook_create_book();
 259         addrbook_set_path( abf, _imp_addressIndex_->filePath );
 260         addrbook_set_name( abf, impldif_dlg.nameBook );
 261         newFile = addrbook_guess_next_file( abf );
 262         addrbook_set_file( abf, newFile );
 263         g_free( newFile );
 264
 265         /* Import data into file */
 266         if( ldif_import_data( _ldifFile_, abf->addressCache ) == MGU_SUCCESS ) {
 267                 addrbook_save_data( abf );
 268                 _importedBook_ = abf;
 269                 retVal = TRUE;
 270         }
 271         else {
 272                 addrbook_free_book( abf );
 273         }
 274
 275         return retVal;
 276 }
 277
 278 static void _update_selected_row()
 279 {
 280         GtkTreeModel *model;
 281         GtkTreeIter iter;
 282         Ldif_FieldRec *rec;
 283
 284         rec = gtkut_tree_view_get_selected_pointer(
 285                         GTK_TREE_VIEW(impldif_dlg.view_fields), FIELD_COL_PTR,
 286                         &model, NULL, &iter);
 287         if (rec == NULL)
 288                 return;
 289
 290         ldif_field_set_name(rec, gtk_entry_get_text(
 291                                 GTK_ENTRY(impldif_dlg.entryAttrib)));
 292         ldif_field_set_selected(rec, gtk_toggle_button_get_active(
 293                                 GTK_TOGGLE_BUTTON(impldif_dlg.checkSelect)));
 294
 295         _populate_iter(GTK_LIST_STORE(model), &iter, rec);
 296 }
 297
 298 static void imp_ldif_modify_pressed(GtkButton *widget, gpointer user_data)
 299 {
 300         _update_selected_row();
 301 }
 302
 303 static void imp_ldif_entryattrib_activate(GtkEntry *entry, gpointer user_data)
 304 {
 305         _update_selected_row();
 306 }
 307
 308 /**
 309  * Test whether we can move off file page.
 310  * \return <i>TRUE</i> if OK to move off page.
 311  */
 312 static gboolean imp_ldif_file_move() {
 313         gboolean retVal = FALSE;
 314         gchar *sName;
 315         gchar *sFile;
 316         gchar *sMsg = NULL;
 317         gboolean errFlag = FALSE;
 318
 319         sFile = gtk_editable_get_chars( GTK_EDITABLE(impldif_dlg.entryFile), 0, -1 );
 320         g_strstrip( sFile );
 321
 322         sName = gtk_editable_get_chars( GTK_EDITABLE(impldif_dlg.entryName), 0, -1 );
 323         g_strstrip( sName );
 324
 325         g_free( impldif_dlg.nameBook );
 326         g_free( impldif_dlg.fileName );
 327         impldif_dlg.nameBook = sName;
 328         impldif_dlg.fileName = sFile;
 329
 330         gtk_entry_set_text( GTK_ENTRY(impldif_dlg.entryFile), sFile );
 331         gtk_entry_set_text( GTK_ENTRY(impldif_dlg.entryName), sName );
 332
 333         if( *sFile == '\0' ) {
 334                 sMsg = _( "Please select a file." );
 335                 gtk_widget_grab_focus(impldif_dlg.entryFile);
 336                 errFlag = TRUE;
 337         }
 338
 339         if( ! errFlag && *sName == '\0' ) {
 340                 sMsg = _( "Address book name must be supplied." );
 341                 gtk_widget_grab_focus(impldif_dlg.entryName);
 342                 errFlag = TRUE;
 343         }
 344
 345         if( ! errFlag ) {
 346                 /* Read attribute list */
 347                 ldif_set_file( _ldifFile_, sFile );
 348                 if( ldif_read_tags( _ldifFile_ ) == MGU_SUCCESS ) {
 349                         /* Load fields */
 350                         /* ldif_print_file( _ldifFile_, stdout ); */
 351                         imp_ldif_load_fields( _ldifFile_ );
 352                         retVal = TRUE;
 353                 }
 354                 else {
 355                         sMsg = imp_ldif_err2string( _lutErrorsLDIF_, _ldifFile_->retVal );
 356                 }
 357         }
 358         imp_ldif_status_show( sMsg );
 359
 360         return retVal;
 361 }
 362
 363 /**
 364  * Display finish page.
 365  */
 366 static void imp_ldif_finish_show() {
 367         gchar *sMsg;
 368         gchar *name;
 369
 370         name = gtk_editable_get_chars( GTK_EDITABLE(impldif_dlg.entryName), 0, -1 );
 371         gtk_label_set_text( GTK_LABEL(impldif_dlg.labelBook), name );
 372         g_free( name );
 373         gtk_label_set_text( GTK_LABEL(impldif_dlg.labelFile), _ldifFile_->path );
 374         gtk_label_set_text( GTK_LABEL(impldif_dlg.labelRecords), itos( _ldifFile_->importCount ) );
 375         gtk_widget_set_sensitive( impldif_dlg.btnPrev, FALSE );
 376         gtk_widget_hide( impldif_dlg.btnNext );
 377         gtk_widget_show( impldif_dlg.btnProceed );
 378         gtk_widget_set_sensitive( impldif_dlg.btnProceed, FALSE );
 379         if( _ldifFile_->retVal == MGU_SUCCESS ) {
 380                 sMsg = _( "LDIF file imported successfully." );
 381         }
 382         else {
 383                 sMsg = imp_ldif_err2string( _lutErrorsLDIF_, _ldifFile_->retVal );
 384         }
 385         imp_ldif_status_show( sMsg );
 386         gtk_widget_grab_focus(impldif_dlg.btnCancel);
 387 }
 388
 389 /**
 390  * Callback function to select previous page.
 391  * \param widget Widget (button).
 392  */
 393 static void imp_ldif_prev( GtkWidget *widget ) {
 394         gint pageNum;
 395
 396         pageNum = gtk_notebook_get_current_page( GTK_NOTEBOOK(impldif_dlg.notebook) );
 397         if( pageNum == PAGE_ATTRIBUTES ) {
 398                 /* Goto file page stuff */
 399                 gtk_notebook_set_current_page(
 400                         GTK_NOTEBOOK(impldif_dlg.notebook), PAGE_FILE_INFO );
 401                 gtk_widget_set_sensitive( impldif_dlg.btnPrev, FALSE );
 402                 gtk_widget_hide( impldif_dlg.btnProceed );
 403                 gtk_widget_show( impldif_dlg.btnNext );
 404         }
 405         imp_ldif_message();
 406 }
 407
 408 /**
 409  * Callback function to select next page.
 410  * \param widget Widget (button).
 411  */
 412 static void imp_ldif_next( GtkWidget *widget ) {
 413         gint pageNum;
 414
 415         pageNum = gtk_notebook_get_current_page( GTK_NOTEBOOK(impldif_dlg.notebook) );
 416         if( pageNum == PAGE_FILE_INFO ) {
 417                 /* Goto attributes stuff */
 418                 if( imp_ldif_file_move() ) {
 419                         gtk_notebook_set_current_page(
 420                                 GTK_NOTEBOOK(impldif_dlg.notebook), PAGE_ATTRIBUTES );
 421                         imp_ldif_message();
 422                         gtk_widget_set_sensitive( impldif_dlg.btnPrev, TRUE );
 423                         gtk_widget_hide( impldif_dlg.btnNext );
 424                         gtk_widget_show( impldif_dlg.btnProceed );
 425                         gtk_widget_set_sensitive( impldif_dlg.btnProceed, TRUE );
 426                 }
 427                 else {
 428                         gtk_widget_set_sensitive( impldif_dlg.btnPrev, FALSE );
 429                         _ldifFile_->dirtyFlag = TRUE;
 430                 }
 431         }
 432         else if( pageNum == PAGE_ATTRIBUTES ) {
 433                 /* Goto finish stuff */
 434                 if( imp_ldif_field_move() ) {
 435                         gtk_notebook_set_current_page(
 436                                 GTK_NOTEBOOK(impldif_dlg.notebook), PAGE_FINISH );
 437                         gtk_button_set_label(GTK_BUTTON(impldif_dlg.btnCancel),
 438                                              _("_Close"));
 439                         gtk_button_set_image(GTK_BUTTON(impldif_dlg.btnCancel),
 440                                 gtk_image_new_from_icon_name("window-close", GTK_ICON_SIZE_BUTTON));
 441                         imp_ldif_finish_show();
 442                 }
 443         }
 444 }
 445
 446 /**
 447  * Callback function to cancel and close dialog.
 448  * \param widget Widget (button).
 449  * \param data   User data.
 450  */
 451 static void imp_ldif_cancel( GtkWidget *widget, gpointer data ) {
 452         gint pageNum;
 453
 454         pageNum = gtk_notebook_get_current_page( GTK_NOTEBOOK(impldif_dlg.notebook) );
 455         if( pageNum != PAGE_FINISH ) {
 456                 impldif_dlg.cancelled = TRUE;
 457         }
 458         gtk_main_quit();
 459 }
 460
 461
 462 /**
 463  * Create LDIF file selection dialog.
 464  * \param afs Address file selection data.
 465  */
 466 static void imp_ldif_file_select_create( AddressFileSelection *afs ) {
 467         gchar *file = filesel_select_file_open(_("Select LDIF File"), NULL);
 468
 469         if (file == NULL)
 470                 afs->cancelled = TRUE;
 471         else {
 472                 afs->cancelled = FALSE;
 473                 gtk_entry_set_text( GTK_ENTRY(impldif_dlg.entryFile), file );
 474                 g_free(file);
 475         }
 476 }
 477
 478 /**
 479  * Callback function to display LDIF file selection dialog.
 480  */
 481 static void imp_ldif_file_select( void ) {
 482         imp_ldif_file_select_create( & _imp_ldif_file_selector_ );
 483 }
 484
 485 /**
 486  * Callback function to handle dialog close event.
 487  * \param widget Widget (dialog).
 488  * \param event  Event object.
 489  * \param data   User data.
 490  */
 491 static gint imp_ldif_delete_event( GtkWidget *widget, GdkEventAny *event, gpointer data ) {
 492         imp_ldif_cancel( widget, data );
 493         return TRUE;
 494 }
 495
 496 /**
 497  * Callback function to respond to dialog key press events.
 498  * \param widget Widget.
 499  * \param event  Event object.
 500  * \param data   User data.
 501  */
 502 static gboolean imp_ldif_key_pressed( GtkWidget *widget, GdkEventKey *event, gpointer data ) {
 503         if (event && event->keyval == GDK_KEY_Escape) {
 504                 imp_ldif_cancel( widget, data );
 505         }
 506         return FALSE;
 507 }
 508
 509 /**
 510  * Format notebook "file" page.
 511  * \param pageNum Page (tab) number.
 512  * \param pageLbl Page (tab) label.
 513  */
 514 static void imp_ldif_page_file( gint pageNum, gchar *pageLbl ) {
 515         GtkWidget *vbox;
 516         GtkWidget *table;
 517         GtkWidget *label;
 518         GtkWidget *entryFile;
 519         GtkWidget *entryName;
 520         GtkWidget *btnFile;
 521
 522         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8);
 523         gtk_container_add( GTK_CONTAINER( impldif_dlg.notebook ), vbox );
 524         gtk_container_set_border_width( GTK_CONTAINER (vbox), BORDER_WIDTH );
 525
 526         label = gtk_label_new( pageLbl );
 527         gtk_widget_show( label );
 528         gtk_notebook_set_tab_label(
 529                 GTK_NOTEBOOK( impldif_dlg.notebook ),
 530                 gtk_notebook_get_nth_page(
 531                         GTK_NOTEBOOK( impldif_dlg.notebook ), pageNum ),
 532                 label );
 533
 534         table = gtk_grid_new();
 535         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
 536         gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
 537         gtk_grid_set_row_spacing(GTK_GRID(table), 8);
 538         gtk_grid_set_column_spacing(GTK_GRID(table), 8);
 539
 540         /* First row */
 541         label = gtk_label_new(_("Address Book"));
 542         gtk_label_set_xalign(GTK_LABEL(label), 0.0);
 543         gtk_grid_attach(GTK_GRID(table), label, 0, 0, 1, 1);
 544
 545         entryName = gtk_entry_new();
 546         gtk_grid_attach(GTK_GRID(table), entryName, 1, 0, 1, 1);
 547         gtk_widget_set_hexpand(entryName, TRUE);
 548         gtk_widget_set_halign(entryName, GTK_ALIGN_FILL);
 549
 550         CLAWS_SET_TIP(entryName, _(
 551                 "Specify the name for the address book that will " \
 552                 "be created from the LDIF file data." ));
 553
 554         /* Second row */
 555         label = gtk_label_new(_("File Name"));
 556         gtk_label_set_xalign(GTK_LABEL(label), 0.0);
 557         gtk_grid_attach(GTK_GRID(table), label, 0, 1, 1, 1);
 558
 559         entryFile = gtk_entry_new();
 560         gtk_grid_attach(GTK_GRID(table), entryFile, 1, 1, 1, 1);
 561         gtk_widget_set_hexpand(entryFile, TRUE);
 562         gtk_widget_set_halign(entryFile, GTK_ALIGN_FILL);
 563
 564         CLAWS_SET_TIP(entryFile,
 565                 _( "The full file specification of the LDIF file to import." ));
 566
 567         btnFile = gtkut_get_browse_file_btn(_("B_rowse"));
 568         gtk_grid_attach(GTK_GRID(table), btnFile, 2, 1, 1, 1);
 569
 570         CLAWS_SET_TIP(btnFile,
 571                 _( "Select the LDIF file to import." ));
 572
 573         gtk_widget_show_all(vbox);
 574
 575         /* Button handler */
 576         g_signal_connect(G_OBJECT(btnFile), "clicked",
 577                          G_CALLBACK(imp_ldif_file_select), NULL);
 578
 579         impldif_dlg.entryFile = entryFile;
 580         impldif_dlg.entryName = entryName;
 581
 582 }
 583
 584 static void imp_ldif_field_list_cursor_changed(GtkTreeView *view,
 585                 gpointer user_data)
 586 {
 587         Ldif_FieldRec *rec;
 588
 589         gtk_entry_set_text( GTK_ENTRY(impldif_dlg.entryAttrib), "" );
 590
 591         rec = gtkut_tree_view_get_selected_pointer(view, FIELD_COL_PTR,
 592                         NULL, NULL, NULL);
 593
 594         if( rec != NULL) {
 595                 /* Update widget contents */
 596                 gtk_label_set_text(
 597                         GTK_LABEL(impldif_dlg.entryField), rec->tagName );
 598                 if( rec->userName )
 599                         gtk_entry_set_text(
 600                                 GTK_ENTRY(impldif_dlg.entryAttrib), rec->userName );
 601                 gtk_toggle_button_set_active(
 602                         GTK_TOGGLE_BUTTON(impldif_dlg.checkSelect),
 603                         rec->selected );
 604
 605                 /* Disable widgets for reserved fields */
 606                 gtk_widget_set_sensitive(
 607                         impldif_dlg.entryAttrib, ! rec->reserved );
 608                 gtk_widget_set_sensitive(
 609                         impldif_dlg.checkSelect, ! rec->reserved );
 610                 gtk_widget_set_sensitive(
 611                         impldif_dlg.btnModify,   ! rec->reserved );
 612         }
 613         gtk_widget_grab_focus(impldif_dlg.entryAttrib);
 614 }
 615
 616 static void imp_ldif_field_list_row_activated(GtkTreeView *view,
 617                 GtkTreePath *path, GtkTreeViewColumn *col,
 618                 gpointer user_data)
 619 {
 620         GtkTreeModel *model = gtk_tree_view_get_model(view);
 621         GtkTreeIter iter;
 622         gboolean ok;
 623         Ldif_FieldRec *rec;
 624
 625         ok = gtk_tree_model_get_iter(model, &iter, path);
 626         if (!ok) {
 627                 return; /* Huh? */
 628         }
 629
 630         gtk_tree_model_get(model, &iter, FIELD_COL_PTR, &rec, -1);
 631         cm_return_if_fail(rec != NULL);
 632
 633         /* Flip the "selected" state for the record, and update the
 634          * "selected" column in the list view, as well as the
 635          * "selected" checkbox. */
 636         ldif_field_toggle(rec);
 637         gtk_list_store_set(GTK_LIST_STORE(model), &iter,
 638                         FIELD_COL_SELECT, rec->selected ? markxpm : NULL, -1);
 639         gtk_toggle_button_set_active(
 640                 GTK_TOGGLE_BUTTON(impldif_dlg.checkSelect),
 641                 rec->selected );
 642 }
 643
 644 /**
 645  * Format notebook fields page.
 646  * \param pageNum Page (tab) number.
 647  * \param pageLbl Page (tab) label.
 648  */
 649 static void imp_ldif_page_fields( gint pageNum, gchar *pageLbl ) {
 650         GtkWidget *vbox;
 651         GtkWidget *vboxt;
 652         GtkWidget *vboxb;
 653         GtkWidget *table;
 654         GtkWidget *label;
 655         GtkWidget *scrollwin;
 656         GtkWidget *view_fields;
 657         GtkWidget *entryField;
 658         GtkWidget *entryAttrib;
 659         GtkWidget *checkSelect;
 660         GtkWidget *btnModify;
 661         GtkWidget *eventBox;
 662         GtkListStore *store;
 663         GtkCellRenderer *rdr;
 664         GtkTreeViewColumn *col;
 665         GtkTreeSelection *sel;
 666
 667         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8);
 668         gtk_container_add( GTK_CONTAINER( impldif_dlg.notebook ), vbox );
 669         gtk_container_set_border_width( GTK_CONTAINER (vbox), 4 );
 670
 671         label = gtk_label_new( pageLbl );
 672         gtk_widget_show( label );
 673         gtk_notebook_set_tab_label(
 674                 GTK_NOTEBOOK( impldif_dlg.notebook ),
 675                 gtk_notebook_get_nth_page(GTK_NOTEBOOK( impldif_dlg.notebook ), pageNum ),
 676                 label );
 677
 678         /* Upper area - Field list */
 679         vboxt = gtk_box_new(GTK_ORIENTATION_VERTICAL, 4 );
 680         gtk_container_add( GTK_CONTAINER( vbox ), vboxt );
 681
 682         scrollwin = gtk_scrolled_window_new( NULL, NULL );
 683         gtk_container_add( GTK_CONTAINER(vboxt), scrollwin );
 684         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrollwin),
 685                                        GTK_POLICY_AUTOMATIC,
 686                                        GTK_POLICY_AUTOMATIC);
 687
 688         store = gtk_list_store_new(FIELDS_N_COLS,
 689                         GDK_TYPE_PIXBUF, GDK_TYPE_PIXBUF,
 690                         G_TYPE_STRING, G_TYPE_STRING,
 691                         G_TYPE_POINTER,
 692                         -1);
 693
 694         view_fields = gtk_tree_view_new_with_model(GTK_TREE_MODEL(store));
 695         g_object_unref(store);
 696         gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(view_fields), TRUE);
 697         gtk_tree_view_set_reorderable(GTK_TREE_VIEW(view_fields), FALSE);
 698         sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(view_fields));
 699         gtk_tree_selection_set_mode(sel, GTK_SELECTION_BROWSE);
 700
 701         rdr = gtk_cell_renderer_pixbuf_new();
 702         col = gtk_tree_view_column_new_with_attributes(_("R"), rdr,
 703                         "pixbuf", FIELD_COL_RESERVED, NULL);
 704         gtk_tree_view_column_set_min_width(col, FIELD_COL_RESERVED);
 705         gtk_tree_view_append_column(GTK_TREE_VIEW(view_fields), col);
 706
 707         col = gtk_tree_view_column_new_with_attributes(_("S"), rdr,
 708                         "pixbuf", FIELD_COL_SELECT, NULL);
 709         gtk_tree_view_column_set_min_width(col, FIELD_COL_SELECT);
 710         gtk_tree_view_append_column(GTK_TREE_VIEW(view_fields), col);
 711
 712         rdr = gtk_cell_renderer_text_new();
 713         col = gtk_tree_view_column_new_with_attributes(_("LDIF Field Name"), rdr,
 714                         "markup", FIELD_COL_FIELD, NULL);
 715         gtk_tree_view_column_set_min_width(col, FIELD_COL_FIELD);
 716         gtk_tree_view_append_column(GTK_TREE_VIEW(view_fields), col);
 717
 718         col = gtk_tree_view_column_new_with_attributes(_("Attribute Name"), rdr,
 719                         "markup", FIELD_COL_ATTRIB, NULL);
 720         gtk_tree_view_column_set_min_width(col, FIELD_COL_ATTRIB);
 721         gtk_tree_view_append_column(GTK_TREE_VIEW(view_fields), col);
 722
 723         gtk_container_add( GTK_CONTAINER(scrollwin), view_fields );
 724
 725         /* Lower area - Edit area */
 726         vboxb = gtk_box_new(GTK_ORIENTATION_VERTICAL, 4 );
 727         gtk_box_pack_end(GTK_BOX(vbox), vboxb, FALSE, FALSE, 2);
 728
 729         /* Data entry area */
 730         table = gtk_grid_new();
 731         gtk_box_pack_start(GTK_BOX(vboxb), table, FALSE, FALSE, 0);
 732         gtk_grid_set_row_spacing(GTK_GRID(table), 4);
 733         gtk_grid_set_column_spacing(GTK_GRID(table), 4);
 734
 735         /* First row */
 736         label = gtk_label_new(_("LDIF Field"));
 737         gtk_label_set_xalign(GTK_LABEL(label), 0.0);
 738         gtk_grid_attach(GTK_GRID(table), label, 0, 0, 1, 1);
 739
 740         entryField = gtk_label_new( "" );
 741         gtk_label_set_xalign(GTK_LABEL(entryField), 0.0);
 742         gtk_grid_attach(GTK_GRID(table), entryField, 1, 0, 1, 1);
 743         gtk_widget_set_hexpand(entryField, TRUE);
 744         gtk_widget_set_halign(entryField, GTK_ALIGN_FILL);
 745
 746         /* Second row */
 747         label = gtk_label_new(_("Attribute"));
 748         /*
 749          * Use an event box to attach some help in the form of a tooltip.
 750          * Tried this for the clist but it looked bad.
 751          */
 752         eventBox = gtk_event_box_new();
 753         gtk_container_add( GTK_CONTAINER(eventBox), label );
 754         gtk_label_set_xalign(GTK_LABEL(label), 0.0);
 755         gtk_grid_attach(GTK_GRID(table), eventBox, 0, 1, 1, 1);
 756
 757         CLAWS_SET_TIP(eventBox, _(
 758                 "Choose the LDIF field that will be renamed or selected " \
 759                 "for import in the list above. Reserved fields (marked " \
 760                 "with a tick in the \"R\" column), are automatically " \
 761                 "imported and cannot be renamed. A single click in the " \
 762                 "Select (\"S\") column will select the field for import " \
 763                 "with a tick. A single click anywhere in the row will " \
 764                 "select that field for rename in the input area below " \
 765                 "the list. A double click anywhere in the row will also " \
 766                 "select the field for import."));
 767
 768         entryAttrib = gtk_entry_new();
 769         gtk_grid_attach(GTK_GRID(table), entryAttrib, 1, 1, 1, 1);
 770         gtk_widget_set_hexpand(entryAttrib, TRUE);
 771         gtk_widget_set_halign(entryAttrib, GTK_ALIGN_FILL);
 772
 773         CLAWS_SET_TIP(entryAttrib,
 774                 _( "The LDIF field can be renamed to the User Attribute name." ));
 775
 776         /* Next row */
 777         checkSelect = gtk_check_button_new_with_label( _( "Select for Import" ) );
 778         gtk_grid_attach(GTK_GRID(table), checkSelect, 1, 2, 1, 1);
 779
 780         CLAWS_SET_TIP(checkSelect,
 781                 _( "Select the LDIF field for import into the address book." ));
 782
 783         btnModify = gtk_button_new_with_label( _(" Modify "));
 784         gtk_grid_attach(GTK_GRID(table), btnModify, 2, 2, 1, 1);
 785
 786         CLAWS_SET_TIP(btnModify,
 787                 _( "This button will update the list above with the data supplied." ));
 788
 789         gtk_widget_show_all(vbox);
 790
 791         /* Event handlers */
 792         g_signal_connect(G_OBJECT(view_fields), "cursor-changed",
 793                         G_CALLBACK(imp_ldif_field_list_cursor_changed), NULL);
 794         g_signal_connect(G_OBJECT(view_fields), "row-activated",
 795                         G_CALLBACK(imp_ldif_field_list_row_activated), NULL);
 796         g_signal_connect(G_OBJECT(btnModify), "clicked",
 797                         G_CALLBACK(imp_ldif_modify_pressed), NULL );
 798         g_signal_connect(G_OBJECT(entryAttrib), "activate",
 799                         G_CALLBACK(imp_ldif_entryattrib_activate), NULL);
 800
 801         impldif_dlg.view_fields = view_fields;
 802         impldif_dlg.entryField  = entryField;
 803         impldif_dlg.entryAttrib = entryAttrib;
 804         impldif_dlg.checkSelect = checkSelect;
 805         impldif_dlg.btnModify   = btnModify;
 806 }
 807
 808 /**
 809  * Format notebook finish page.
 810  * \param pageNum Page (tab) number.
 811  * \param pageLbl Page (tab) label.
 812  */
 813 static void imp_ldif_page_finish( gint pageNum, gchar *pageLbl ) {
 814         GtkWidget *vbox;
 815         GtkWidget *table;
 816         GtkWidget *label;
 817         GtkWidget *labelBook;
 818         GtkWidget *labelFile;
 819         GtkWidget *labelRecs;
 820
 821         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8);
 822         gtk_container_add( GTK_CONTAINER( impldif_dlg.notebook ), vbox );
 823         gtk_container_set_border_width( GTK_CONTAINER (vbox), BORDER_WIDTH );
 824
 825         label = gtk_label_new( pageLbl );
 826         gtk_widget_show( label );
 827         gtk_notebook_set_tab_label(
 828                 GTK_NOTEBOOK( impldif_dlg.notebook ),
 829                 gtk_notebook_get_nth_page( GTK_NOTEBOOK( impldif_dlg.notebook ), pageNum ),
 830                 label );
 831
 832         table = gtk_grid_new();
 833         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
 834         gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
 835         gtk_grid_set_row_spacing(GTK_GRID(table), 8);
 836         gtk_grid_set_column_spacing(GTK_GRID(table), 8);
 837
 838         /* First row */
 839         label = gtk_label_new( _( "Address Book:" ) );
 840         gtk_label_set_xalign(GTK_LABEL(label), 1.0);
 841         gtk_grid_attach(GTK_GRID(table), label, 0, 0, 1, 1);
 842
 843         labelBook = gtk_label_new("");
 844         gtk_label_set_xalign(GTK_LABEL(labelBook), 0.0);
 845         gtk_grid_attach(GTK_GRID(table), labelBook, 1, 0, 1, 1);
 846
 847         /* Second row */
 848         label = gtk_label_new( _( "File Name:" ) );
 849         gtk_label_set_xalign(GTK_LABEL(label), 1.0);
 850         gtk_grid_attach(GTK_GRID(table), label, 0, 1, 1, 1);
 851
 852         labelFile = gtk_label_new("");
 853         gtk_label_set_xalign(GTK_LABEL(labelFile), 0.0);
 854         gtk_grid_attach(GTK_GRID(table), labelFile, 1, 1, 1, 1);
 855
 856         /* Third row */
 857         label = gtk_label_new( _("Records Imported:") );
 858         gtk_label_set_xalign(GTK_LABEL(label), 1.0);
 859         gtk_grid_attach(GTK_GRID(table), label, 0, 2, 1, 1);
 860
 861         labelRecs = gtk_label_new("");
 862         gtk_label_set_xalign(GTK_LABEL(labelRecs), 0.0);
 863         gtk_grid_attach(GTK_GRID(table), labelRecs, 1, 2, 1, 1);
 864
 865         impldif_dlg.labelBook    = labelBook;
 866         impldif_dlg.labelFile    = labelFile;
 867         impldif_dlg.labelRecords = labelRecs;
 868 }
 869
 870 /**
 871  * Create main dialog decorations (excluding notebook pages).
 872  */
 873 static void imp_ldif_dialog_create() {
 874         GtkWidget *window;
 875         GtkWidget *vbox;
 876         GtkWidget *vnbox;
 877         GtkWidget *notebook;
 878         GtkWidget *hbbox;
 879         GtkWidget *btnPrev;
 880         GtkWidget *btnNext;
 881         GtkWidget *btnProceed;
 882         GtkWidget *btnCancel;
 883         GtkWidget *hsbox;
 884         GtkWidget *statusbar;
 885
 886         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "importldif");
 887         gtk_widget_set_size_request(window, IMPORTLDIF_WIDTH, IMPORTLDIF_HEIGHT );
 888         gtk_container_set_border_width( GTK_CONTAINER(window), 0 );
 889         gtk_window_set_title( GTK_WINDOW(window), _("Import LDIF file into Address Book") );
 890         gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
 891         gtk_window_set_type_hint(GTK_WINDOW(window), GDK_WINDOW_TYPE_HINT_DIALOG);
 892         g_signal_connect(G_OBJECT(window), "delete_event",
 893                          G_CALLBACK(imp_ldif_delete_event),
 894                          NULL );
 895         g_signal_connect(G_OBJECT(window), "key_press_event",
 896                          G_CALLBACK(imp_ldif_key_pressed),
 897                          NULL );
 898
 899         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 4);
 900         gtk_widget_show(vbox);
 901         gtk_container_add(GTK_CONTAINER(window), vbox);
 902
 903         vnbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 4);
 904         gtk_container_set_border_width(GTK_CONTAINER(vnbox), 4);
 905         gtk_widget_show(vnbox);
 906         gtk_box_pack_start(GTK_BOX(vbox), vnbox, TRUE, TRUE, 0);
 907
 908         /* Notebook */
 909         notebook = gtk_notebook_new();
 910         gtk_notebook_set_show_tabs( GTK_NOTEBOOK(notebook), FALSE );
 911         gtk_widget_show(notebook);
 912         gtk_box_pack_start(GTK_BOX(vnbox), notebook, TRUE, TRUE, 0);
 913         gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
 914
 915         /* Status line */
 916         hsbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
 917         gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH);
 918         statusbar = gtk_statusbar_new();
 919         gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH);
 920
 921         /* Button panel */
 922         gtkut_stock_button_set_create(&hbbox,
 923                                         &btnPrev, "go-previous", _("_Previous"),
 924                                         &btnNext, "go-next", _("_Next"),
 925                                         &btnCancel, NULL, _("_Cancel"));
 926
 927         btnProceed = gtk_button_new_with_mnemonic(_("Proceed"));
 928         gtk_widget_set_can_default(btnProceed, TRUE);
 929         gtk_box_pack_start(GTK_BOX(hbbox), btnProceed, TRUE, TRUE, 0);
 930         gtk_widget_hide(btnProceed);
 931
 932         gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
 933         gtk_container_set_border_width(GTK_CONTAINER(hbbox), 2);
 934         gtk_widget_grab_default(btnNext);
 935
 936         /* Button handlers */
 937         g_signal_connect(G_OBJECT(btnPrev), "clicked",
 938                          G_CALLBACK(imp_ldif_prev), NULL);
 939         g_signal_connect(G_OBJECT(btnNext), "clicked",
 940                          G_CALLBACK(imp_ldif_next), NULL);
 941         g_signal_connect(G_OBJECT(btnProceed), "clicked",
 942                          G_CALLBACK(imp_ldif_next), NULL);
 943         g_signal_connect(G_OBJECT(btnCancel), "clicked",
 944                          G_CALLBACK(imp_ldif_cancel), NULL);
 945
 946         gtk_widget_show_all(vbox);
 947
 948         impldif_dlg.window     = window;
 949         impldif_dlg.notebook   = notebook;
 950         impldif_dlg.btnPrev    = btnPrev;
 951         impldif_dlg.btnNext    = btnNext;
 952         impldif_dlg.btnProceed = btnProceed;
 953         impldif_dlg.btnCancel  = btnCancel;
 954         impldif_dlg.statusbar  = statusbar;
 955         impldif_dlg.status_cid = gtk_statusbar_get_context_id(
 956                         GTK_STATUSBAR(statusbar), "Import LDIF Dialog" );
 957
 958 }
 959
 960 /**
 961  * Create import LDIF dialog.
 962  */
 963 static void imp_ldif_create() {
 964         imp_ldif_dialog_create();
 965         imp_ldif_page_file( PAGE_FILE_INFO, _( "File Info" ) );
 966         imp_ldif_page_fields( PAGE_ATTRIBUTES, _( "Attributes" ) );
 967         imp_ldif_page_finish( PAGE_FINISH, _( "Finish" ) );
 968         gtk_widget_show_all( impldif_dlg.window );
 969 }
 970
 971 /**
 972  * Import LDIF file.
 973  * \param  addrIndex Address index.
 974  * \return Address book file of imported data, or <i>NULL</i> if import
 975  *         was cancelled.
 976  */
 977 AddressBookFile *addressbook_imp_ldif( AddressIndex *addrIndex ) {
 978         GtkWidget *view;
 979         GtkTreeModel *model;
 980
 981         _importedBook_ = NULL;
 982         _imp_addressIndex_ = addrIndex;
 983
 984         if( ! impldif_dlg.window )
 985                 imp_ldif_create();
 986
 987         view = impldif_dlg.view_fields;
 988         model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
 989
 990         gtk_button_set_label(GTK_BUTTON(impldif_dlg.btnCancel),
 991                              _("_Cancel"));
 992         gtk_widget_hide(impldif_dlg.btnProceed);
 993         gtk_widget_show(impldif_dlg.btnNext);
 994
 995         impldif_dlg.cancelled = FALSE;
 996         gtk_widget_show(impldif_dlg.window);
 997         manage_window_set_transient(GTK_WINDOW(impldif_dlg.window));
 998         gtk_widget_grab_default(impldif_dlg.btnNext);
 999         gtk_window_set_modal(GTK_WINDOW(impldif_dlg.window), TRUE);
1000
1001         gtk_entry_set_text( GTK_ENTRY(impldif_dlg.entryName), IMPORTLDIF_GUESS_NAME );
1002         gtk_entry_set_text( GTK_ENTRY(impldif_dlg.entryFile), "" );
1003         gtk_label_set_text( GTK_LABEL(impldif_dlg.entryField), "" );
1004         gtk_entry_set_text( GTK_ENTRY(impldif_dlg.entryAttrib), "" );
1005         gtk_list_store_clear( GTK_LIST_STORE(model) );
1006         gtk_notebook_set_current_page( GTK_NOTEBOOK(impldif_dlg.notebook), PAGE_FILE_INFO );
1007         gtk_widget_set_sensitive( impldif_dlg.btnPrev, FALSE );
1008         gtk_widget_set_sensitive( impldif_dlg.btnNext, TRUE );
1009         stock_pixbuf_gdk(STOCK_PIXMAP_MARK, &markxpm );
1010         imp_ldif_message();
1011         gtk_widget_grab_focus(impldif_dlg.entryFile);
1012
1013         impldif_dlg.rowCount = 0;
1014         g_free( impldif_dlg.nameBook );
1015         g_free( impldif_dlg.fileName );
1016         impldif_dlg.nameBook = NULL;
1017         impldif_dlg.fileName = NULL;
1018
1019         _ldifFile_ = ldif_create();
1020         gtk_main();
1021         gtk_widget_hide(impldif_dlg.window);
1022         gtk_window_set_modal(GTK_WINDOW(impldif_dlg.window), FALSE);
1023         ldif_free( _ldifFile_ );
1024         _ldifFile_ = NULL;
1025         _imp_addressIndex_ = NULL;
1026
1027         g_free( impldif_dlg.nameBook );
1028         g_free( impldif_dlg.fileName );
1029         impldif_dlg.nameBook = NULL;
1030         impldif_dlg.fileName = NULL;
1031
1032         if( impldif_dlg.cancelled == TRUE ) return NULL;
1033         return _importedBook_;
1034 }
1035
1036 /*
1037  * ============================================================================
1038  * End of Source.
1039  * ============================================================================
1040  */
1041