/*******************************************************************\ * assistant-csv-account-import.c -- An assistant for importing * * Accounts from a file. * * * * Copyright (C) 2012 Robert Fewell * * * * This program is free software; you can redistribute it and/or * * modify it under the terms of the GNU General Public License as * * published by the Free Software Foundation; either version 2 of * * the License, or (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License* * along with this program; if not, contact: * * * * Free Software Foundation Voice: +1-617-542-5942 * * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 * * Boston, MA 02110-1301, USA gnu@gnu.org * \********************************************************************/ /** @file assistant-csv-account-import.c @brief CSV Import Assistant @author Copyright (c) 2012 Robert Fewell */ #include #include #include #include "dialog-utils.h" #include "gnc-ui.h" #include "gnc-uri-utils.h" #include "gnc-ui-util.h" #include "gnc-component-manager.h" #include "assistant-csv-account-import.h" #include "csv-account-import.h" #define GNC_PREFS_GROUP "dialogs.import.csv" #define ASSISTANT_CSV_IMPORT_CM_CLASS "assistant-csv-account-import" /* This static indicates the debugging module that this .o belongs to. */ static QofLogModule log_module = GNC_MOD_ASSISTANT; /*************************************************************************/ void csv_import_assistant_prepare (GtkAssistant *assistant, GtkWidget *page, gpointer user_data); void csv_import_assistant_finish (GtkAssistant *gtkassistant, gpointer user_data); void csv_import_assistant_cancel (GtkAssistant *gtkassistant, gpointer user_data); void csv_import_assistant_close (GtkAssistant *gtkassistant, gpointer user_data); void csv_import_assistant_start_page_prepare (GtkAssistant *gtkassistant, gpointer user_data); void csv_import_assistant_account_page_prepare (GtkAssistant *gtkassistant, gpointer user_data); void csv_import_assistant_file_page_prepare (GtkAssistant *assistant, gpointer user_data); void csv_import_assistant_finish_page_prepare (GtkAssistant *assistant, gpointer user_data); void csv_import_assistant_summary_page_prepare (GtkAssistant *assistant, gpointer user_data); void csv_import_sep_cb (GtkWidget *radio, gpointer user_data ); void csv_import_hrows_cb (GtkWidget *spin, gpointer user_data ); void csv_import_file_chooser_file_activated_cb (GtkFileChooser *chooser, CsvImportInfo *info); void csv_import_file_chooser_selection_changed_cb (GtkFileChooser *chooser, CsvImportInfo *info); static const gchar *finish_tree_string = N_( "The accounts will be imported from the file '%s' when you click 'Apply'.\n\n" "You can verify your selections by clicking on 'Back' or 'Cancel' to Abort Import.\n"); static const gchar *new_book_finish_tree_string = N_( "The accounts will be imported from the file '%s' when you click 'Apply'.\n\n" "You can verify your selections by clicking on 'Back' or 'Cancel' to Abort Import.\n\n" "If this is your initial import into a new file, you will first see " "a dialog for setting book options, since these can affect how " "imported data is converted to GnuCash transactions.\n" "Note: After import, you may need to use 'View / Filter By / Other' menu option " "and select to show unused Accounts.\n"); /* Escape '_' in string */ static gchar *mnemonic_escape (const gchar *source); static gchar *mnemonic_escape (const gchar *source) { const guchar *p; gchar *dest; gchar *q; g_return_val_if_fail (source != NULL, NULL); p = (guchar *) source; q = dest = g_malloc (strlen (source) * 2 + 1); while (*p) { switch (*p) { case '_': *q++ = '_'; *q++ = '_'; break; default: *q++ = *p; break; } p++; } *q = 0; return dest; } static void create_regex (GString *regex_str, const gchar *sep) { if (!sep) return; g_string_printf (regex_str, "\\G(?[^%s]*)%s" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s?" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s" "(?\"(?:[^\"]|\"\")*\"|[^%s]*)%s" "(?[^%s]*)%s" "(?[^%s]*)%s" "(?[^%s[:cntrl:]]*)(?:\\R*)", sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep, sep); } /*************************************************************************/ /************************************************** * csv_import_assistant_check_filename * * check for a valid filename for GtkFileChooser callbacks **************************************************/ static gboolean csv_import_assistant_check_filename (GtkFileChooser *chooser, CsvImportInfo *info) { gchar *file_name = gtk_file_chooser_get_filename (chooser); /* Test for a valid filename and not a directory */ if (file_name && !g_file_test (file_name, G_FILE_TEST_IS_DIR)) { gchar *filepath = gnc_uri_get_path (file_name); gchar *filedir = g_path_get_dirname (filepath); g_free (info->file_name); info->file_name = g_strdup (file_name); g_free (info->starting_dir); info->starting_dir = g_strdup (filedir); g_free (filedir); g_free (filepath); g_free (file_name); DEBUG("file_name selected is %s", info->file_name); DEBUG("starting directory is %s", info->starting_dir); return TRUE; } g_free (file_name); return FALSE; } /************************************************** * csv_import_file_chooser_file_activated_cb * * call back for GtkFileChooser file-activated signal **************************************************/ void csv_import_file_chooser_file_activated_cb (GtkFileChooser *chooser, CsvImportInfo *info) { GtkAssistant *assistant = GTK_ASSISTANT(info->assistant); gtk_assistant_set_page_complete (assistant, info->file_page, FALSE); /* Test for a valid filename and not a directory */ if (csv_import_assistant_check_filename (chooser, info)) { gtk_assistant_set_page_complete (assistant, info->file_page, TRUE); gtk_assistant_next_page (assistant); } } /************************************************** * csv_import_file_chooser_selection_changed_cb * * call back for file chooser widget **************************************************/ void csv_import_file_chooser_selection_changed_cb (GtkFileChooser *chooser, CsvImportInfo *info) { GtkAssistant *assistant = GTK_ASSISTANT(info->assistant); gtk_assistant_set_page_complete (assistant, info->account_page, FALSE); /* Enable the "Next" button based on a valid filename */ gtk_assistant_set_page_complete (assistant, info->file_page, csv_import_assistant_check_filename (chooser, info)); } /******************************************************* * csv_import_hrows_cb * * call back for the start row / number of header rows *******************************************************/ void csv_import_hrows_cb (GtkWidget *spin, gpointer user_data) { CsvImportInfo *info = user_data; GtkTreeIter iter; gboolean valid; int num_rows; /* Get number of rows for header */ info->header_rows = gtk_spin_button_get_value_as_int (GTK_SPIN_BUTTON(spin)); /* Get number of rows displayed */ num_rows = gtk_tree_model_iter_n_children (GTK_TREE_MODEL(info->store), NULL); /* Modify background color for header rows */ if (info->header_rows == 0) { valid = gtk_tree_model_iter_nth_child (GTK_TREE_MODEL(info->store), &iter, NULL, 0 ); if (valid) gtk_list_store_set (info->store, &iter, ROW_COLOR, NULL, -1); } else { if (info->header_rows - 1 < num_rows) { valid = gtk_tree_model_iter_nth_child (GTK_TREE_MODEL(info->store), &iter, NULL, info->header_rows - 1 ); if (valid) gtk_list_store_set (info->store, &iter, ROW_COLOR, "pink", -1); valid = gtk_tree_model_iter_next (GTK_TREE_MODEL(info->store), &iter); if (valid) gtk_list_store_set (info->store, &iter, ROW_COLOR, NULL, -1); } } } /******************************************************* * csv_import_assistant_enable_account_forward * * enable "Next" button on account_page if store has rows *******************************************************/ static void csv_import_assistant_enable_account_forward (CsvImportInfo *info) { GtkAssistant *assistant = GTK_ASSISTANT(info->assistant); gboolean store_has_rows = TRUE; /* if the store is empty, disable "Next" button */ if (gtk_tree_model_iter_n_children (GTK_TREE_MODEL(info->store), NULL) == 0) store_has_rows = FALSE; gtk_assistant_set_page_complete (assistant, info->account_page, store_has_rows); } /******************************************************* * csv_import_sep_cb * * call back for type of separator required *******************************************************/ void csv_import_sep_cb (GtkWidget *radio, gpointer user_data) { CsvImportInfo *info = user_data; const gchar *name; gchar *temp; gchar *sep = NULL; if (!gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(radio))) { LEAVE("1st callback of pair. Defer to 2nd callback."); return; } name = gtk_buildable_get_name (GTK_BUILDABLE(radio)); if (g_strcmp0 (name, "radio_semi") == 0) sep = ";"; else if (g_strcmp0 (name, "radio_colon") == 0) sep = ":"; else sep = ","; /* Use as default as well */ create_regex (info->regexp, sep); if (g_strcmp0 (name, "radio_custom") == 0) { temp = gnc_input_dialog (GTK_WIDGET (info->assistant), _("Adjust regular expression used for import"), _("This regular expression is used to parse the import file. Modify according to your needs.\n"), info->regexp->str); if (temp) { g_string_assign (info->regexp, temp); g_free (temp); } } /* Generate preview */ gtk_list_store_clear (info->store); gtk_widget_set_sensitive (info->header_row_spin, TRUE); if (csv_import_read_file (GTK_WINDOW (info->assistant), info->file_name, info->regexp->str, info->store, 11) == MATCH_FOUND) gtk_spin_button_set_value (GTK_SPIN_BUTTON(info->header_row_spin), 1); // set header spin to 1 else gtk_spin_button_set_value (GTK_SPIN_BUTTON(info->header_row_spin), 0); //reset header spin to 0 /* if the store has rows, enable "Next" button */ csv_import_assistant_enable_account_forward (info); } /******************************************************* * load_settings * * load the default settings for the assistant *******************************************************/ static void load_settings (CsvImportInfo *info) { info->header_rows = 0; info->error = ""; info->starting_dir = NULL; info->file_name = NULL; info->error = ""; /* The default directory for the user to select files. */ info->starting_dir = gnc_get_default_directory (GNC_PREFS_GROUP); } /* =============================================================== */ /******************************************************* * Assistant page prepare functions *******************************************************/ void csv_import_assistant_start_page_prepare (GtkAssistant *assistant, gpointer user_data) { gint num = gtk_assistant_get_current_page (assistant); GtkWidget *page = gtk_assistant_get_nth_page (assistant, num); /* Enable the Assistant Buttons */ gtk_assistant_set_page_complete (assistant, page, TRUE); } void csv_import_assistant_file_page_prepare (GtkAssistant *assistant, gpointer user_data) { CsvImportInfo *info = user_data; /* Set the default directory */ if (info->starting_dir) gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER(info->file_chooser), info->starting_dir); /* Disable the "Next" Assistant Button */ gtk_assistant_set_page_complete (assistant, info->file_page, FALSE); } void csv_import_assistant_account_page_prepare (GtkAssistant *assistant, gpointer user_data) { CsvImportInfo *info = user_data; csv_import_result res; /* Disable the "Next" Assistant Button */ gtk_assistant_set_page_complete (assistant, info->account_page, FALSE); /* test read one line */ gtk_list_store_clear (info->store); res = csv_import_read_file (GTK_WINDOW (info->assistant), info->file_name, info->regexp->str, info->store, 1 ); if (res == RESULT_OPEN_FAILED) { gnc_error_dialog (GTK_WINDOW (info->assistant), _("The input file can not be opened.")); gtk_assistant_previous_page (assistant); } else if (res == RESULT_OK) gtk_assistant_set_page_complete (assistant, info->account_page, TRUE); else if (res == MATCH_FOUND) gtk_assistant_set_page_complete (assistant, info->account_page, TRUE); // generate preview gtk_list_store_clear (info->store); gtk_widget_set_sensitive (info->header_row_spin, TRUE); if (csv_import_read_file (GTK_WINDOW (info->assistant), info->file_name, info->regexp->str, info->store, 11 ) == MATCH_FOUND) gtk_spin_button_set_value (GTK_SPIN_BUTTON(info->header_row_spin), 1); // set header spin to 1 else gtk_spin_button_set_value (GTK_SPIN_BUTTON(info->header_row_spin), 0); //reset header spin to 0 /* if the store has rows, enable "Next" button */ csv_import_assistant_enable_account_forward (info); } void csv_import_assistant_finish_page_prepare (GtkAssistant *assistant, gpointer user_data) { CsvImportInfo *info = user_data; gchar *text; /* Set Finish page text */ /* Before creating accounts, if this is a new book, tell user they can * specify book options, since they affect how transactions are created */ if (info->new_book) text = g_strdup_printf (gettext (new_book_finish_tree_string), info->file_name); else text = g_strdup_printf (gettext (finish_tree_string), info->file_name); gtk_label_set_text (GTK_LABEL(info->finish_label), text); g_free (text); /* Save the Window size and directory */ gnc_set_default_directory (GNC_PREFS_GROUP, info->starting_dir); /* Enable the Assistant Buttons */ gtk_assistant_set_page_complete (assistant, info->finish_label, TRUE); } void csv_import_assistant_summary_page_prepare (GtkAssistant *assistant, gpointer user_data) { CsvImportInfo *info = user_data; gchar *text, *errtext, *mtext; /* Before creating accounts, if this is a new book, let user specify * book options, since they affect how transactions are created */ if (info->new_book) info->new_book = gnc_new_book_option_display (info->assistant); if (g_strcmp0 (info->error, "") != 0) { GtkTextBuffer *buffer; buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW(info->summary_error_view)); text = g_strdup_printf (gettext ("Import completed but with errors!\n\nThe number of Accounts added was %u and " "%u were updated.\n\nSee below for errors…"), info->num_new, info->num_updates); errtext = g_strdup_printf ("%s", info->error); gtk_text_buffer_set_text (buffer, errtext, -1); g_free (errtext); g_free (info->error); } else text = g_strdup_printf (gettext ("Import completed successfully!\n\nThe number of Accounts added was %u and " "%u were updated.\n"), info->num_new, info->num_updates); mtext = g_strdup_printf ("%s", text); gtk_label_set_markup (GTK_LABEL(info->summary_label), mtext); g_free (text); g_free (mtext); } void csv_import_assistant_prepare (GtkAssistant *assistant, GtkWidget *page, gpointer user_data) { gint currentpage = gtk_assistant_get_current_page (assistant); switch (currentpage) { case 0: /* Current page is Import Start page */ csv_import_assistant_start_page_prepare (assistant, user_data); break; case 1: /* Current page is File select page */ csv_import_assistant_file_page_prepare (assistant, user_data); break; case 2: /* Current page is Account page */ csv_import_assistant_account_page_prepare (assistant, user_data); break; case 3: /* Current page is Finish page */ csv_import_assistant_finish_page_prepare (assistant, user_data); break; case 4: /* Current page is Summary page */ csv_import_assistant_summary_page_prepare (assistant, user_data); break; } } /******************************************************* * Assistant call back functions *******************************************************/ static void csv_import_assistant_destroy_cb (GtkWidget *object, gpointer user_data) { CsvImportInfo *info = user_data; gnc_unregister_gui_component_by_data (ASSISTANT_CSV_IMPORT_CM_CLASS, info); g_free (info); } void csv_import_assistant_cancel (GtkAssistant *assistant, gpointer user_data) { CsvImportInfo *info = user_data; gnc_close_gui_component_by_data (ASSISTANT_CSV_IMPORT_CM_CLASS, info); } void csv_import_assistant_close (GtkAssistant *assistant, gpointer user_data) { CsvImportInfo *info = user_data; gnc_close_gui_component_by_data (ASSISTANT_CSV_IMPORT_CM_CLASS, info); } void csv_import_assistant_finish (GtkAssistant *assistant, gpointer user_data) { CsvImportInfo *info = user_data; gtk_list_store_clear (info->store); csv_import_read_file (GTK_WINDOW (info->assistant), info->file_name, info->regexp->str, info->store, 0 ); csv_account_import (info); } static void csv_import_close_handler (gpointer user_data) { CsvImportInfo *info = user_data; g_free (info->starting_dir); g_free (info->file_name); g_string_free (info->regexp, TRUE); g_object_unref (info->store); gnc_save_window_size (GNC_PREFS_GROUP, GTK_WINDOW(info->assistant)); gtk_widget_destroy (info->assistant); } /******************************************************* * Create the Assistant *******************************************************/ static GtkWidget * csv_import_assistant_create (CsvImportInfo *info) { GtkBuilder *builder; GtkCellRenderer *renderer; GtkTreeViewColumn *column; gchar *mnemonic_desc = NULL; builder = gtk_builder_new(); gnc_builder_add_from_file (builder, "assistant-csv-account-import.glade", "num_hrows_adj"); gnc_builder_add_from_file (builder, "assistant-csv-account-import.glade", "csv_account_import_assistant"); info->assistant = GTK_WIDGET(gtk_builder_get_object (builder, "csv_account_import_assistant")); // Set the name for this assistant so it can be easily manipulated with css gtk_widget_set_name (GTK_WIDGET(info->assistant), "gnc-id-assistant-csv-account-import"); gnc_widget_style_context_add_class (GTK_WIDGET(info->assistant), "gnc-class-imports"); /* Load default settings */ load_settings (info); /* Enable buttons on all page. */ gtk_assistant_set_page_complete (GTK_ASSISTANT(info->assistant), GTK_WIDGET(gtk_builder_get_object(builder, "start_page")), TRUE); gtk_assistant_set_page_complete (GTK_ASSISTANT(info->assistant), GTK_WIDGET(gtk_builder_get_object(builder, "file_page")), FALSE); gtk_assistant_set_page_complete (GTK_ASSISTANT(info->assistant), GTK_WIDGET(gtk_builder_get_object(builder, "import_tree_page")), TRUE); gtk_assistant_set_page_complete (GTK_ASSISTANT(info->assistant), GTK_WIDGET(gtk_builder_get_object(builder, "end_page")), FALSE); gtk_assistant_set_page_complete (GTK_ASSISTANT(info->assistant), GTK_WIDGET(gtk_builder_get_object(builder, "summary_page")), TRUE); /* Start Page */ /* File chooser Page */ info->file_page = GTK_WIDGET(gtk_builder_get_object(builder, "file_page")); info->file_chooser = gtk_file_chooser_widget_new (GTK_FILE_CHOOSER_ACTION_OPEN); g_signal_connect (G_OBJECT(info->file_chooser), "selection-changed", G_CALLBACK(csv_import_file_chooser_selection_changed_cb), info); g_signal_connect (G_OBJECT(info->file_chooser), "file-activated", G_CALLBACK(csv_import_file_chooser_file_activated_cb), info); gtk_box_pack_start (GTK_BOX(info->file_page), info->file_chooser, TRUE, TRUE, 6); gtk_widget_show (info->file_chooser); /* Account Tree Page */ info->account_page = GTK_WIDGET(gtk_builder_get_object(builder, "import_tree_page")); info->header_row_spin = GTK_WIDGET(gtk_builder_get_object (builder, "num_hrows")); info->tree_view = GTK_WIDGET(gtk_builder_get_object (builder, "treeview")); /* Comma Separated file default */ info->regexp = g_string_new (""); create_regex (info->regexp, ","); /* create model and bind to view */ info->store = gtk_list_store_new (N_COLUMNS, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING); gtk_tree_view_set_model (GTK_TREE_VIEW(info->tree_view), GTK_TREE_MODEL(info->store)); #define CREATE_COLUMN(description,column_id) \ renderer = gtk_cell_renderer_text_new (); \ mnemonic_desc = mnemonic_escape (_(description)); \ column = gtk_tree_view_column_new_with_attributes (mnemonic_desc, renderer, "text", column_id, NULL); \ gtk_tree_view_column_add_attribute (column, renderer, "background", ROW_COLOR); \ gtk_tree_view_column_set_resizable (column, TRUE); \ gtk_tree_view_append_column (GTK_TREE_VIEW(info->tree_view), column); \ g_free (mnemonic_desc); CREATE_COLUMN ("Type", TYPE); CREATE_COLUMN ("Account Full Name", FULL_NAME); CREATE_COLUMN ("Account Name", NAME); CREATE_COLUMN ("Account Code", CODE); CREATE_COLUMN ("Description", DESCRIPTION); CREATE_COLUMN ("Account Color", COLOR); CREATE_COLUMN ("Notes", NOTES); CREATE_COLUMN ("Symbol", SYMBOL); CREATE_COLUMN ("Namespace", NAMESPACE); CREATE_COLUMN ("Hidden", HIDDEN); CREATE_COLUMN ("Tax Info", TAX); CREATE_COLUMN ("Placeholder", PLACE_HOLDER); /* Finish Page */ info->finish_label = GTK_WIDGET(gtk_builder_get_object (builder, "end_page")); /* Summary Page */ info->summary_label = GTK_WIDGET(gtk_builder_get_object (builder, "summary_label")); info->summary_error_view = GTK_WIDGET(gtk_builder_get_object (builder, "summary_error_view")); g_signal_connect (G_OBJECT(info->assistant), "destroy", G_CALLBACK(csv_import_assistant_destroy_cb), info); gnc_restore_window_size (GNC_PREFS_GROUP, GTK_WINDOW(info->assistant), gnc_ui_get_main_window(NULL)); gtk_builder_connect_signals (builder, info); g_object_unref (G_OBJECT(builder)); return info->assistant; } /********************************************************************\ * gnc_file_csv_account_import * * opens up a assistant to import accounts. * * * * Args: import_type * * Return: nothing * \********************************************************************/ void gnc_file_csv_account_import(void) { CsvImportInfo *info; info = g_new0 (CsvImportInfo, 1); /* In order to trigger a book options display on the creation of a new book, * we need to detect when we are dealing with a new book. */ info->new_book = gnc_is_new_book(); csv_import_assistant_create (info); gnc_register_gui_component (ASSISTANT_CSV_IMPORT_CM_CLASS, NULL, csv_import_close_handler, info); gtk_widget_show_all (info->assistant); gnc_window_adjust_for_screen (GTK_WINDOW(info->assistant)); }