assistant-csv-account-import.c File Reference

CSV Import Assistant. More...

#include <config.h>
#include <gtk/gtk.h>
#include <glib/gi18n.h>
#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"

Go to the source code of this file.

Macros
#define	GNC_PREFS_GROUP   "dialogs.import.csv"
#define	ASSISTANT_CSV_IMPORT_CM_CLASS   "assistant-csv-account-import"
#define	CREATE_COLUMN(description, column_id)

Functions
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)
void	gnc_file_csv_account_import (void)
	The gnc_file_csv_account_import() will let the user import accounts from a delimited file.

Detailed Description

CSV Import Assistant.

Author

Copyright (c) 2012 Robert Fewell

Definition in file assistant-csv-account-import.c.

Macro Definition Documentation

ASSISTANT_CSV_IMPORT_CM_CLASS

#define ASSISTANT_CSV_IMPORT_CM_CLASS   "assistant-csv-account-import"

Definition at line 44 of file assistant-csv-account-import.c.

CREATE_COLUMN

#define CREATE_COLUMN	(		description,
			column_id
	)

Value:

  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);

GNC_PREFS_GROUP

#define GNC_PREFS_GROUP   "dialogs.import.csv"

Definition at line 43 of file assistant-csv-account-import.c.

Function Documentation

csv_import_assistant_account_page_prepare()

void csv_import_assistant_account_page_prepare	(	GtkAssistant *	gtkassistant,
		gpointer	user_data
	)

Definition at line 378 of file assistant-csv-account-import.c.

{
    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);
}

csv_import_assistant_cancel()

void csv_import_assistant_cancel	(	GtkAssistant *	gtkassistant,
		gpointer	user_data
	)

Definition at line 521 of file assistant-csv-account-import.c.

{
    CsvImportInfo *info = user_data;
    gnc_close_gui_component_by_data (ASSISTANT_CSV_IMPORT_CM_CLASS, info);
}

csv_import_assistant_close()

void csv_import_assistant_close	(	GtkAssistant *	gtkassistant,
		gpointer	user_data
	)

Definition at line 528 of file assistant-csv-account-import.c.

{
    CsvImportInfo *info = user_data;
    gnc_close_gui_component_by_data (ASSISTANT_CSV_IMPORT_CM_CLASS, info);
}

csv_import_assistant_file_page_prepare()

void csv_import_assistant_file_page_prepare	(	GtkAssistant *	assistant,
		gpointer	user_data
	)

Definition at line 363 of file assistant-csv-account-import.c.

{
    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);
}

csv_import_assistant_finish()

void csv_import_assistant_finish	(	GtkAssistant *	gtkassistant,
		gpointer	user_data
	)

Definition at line 535 of file assistant-csv-account-import.c.

{
    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);
}

csv_import_assistant_finish_page_prepare()

void csv_import_assistant_finish_page_prepare	(	GtkAssistant *	assistant,
		gpointer	user_data
	)

Definition at line 416 of file assistant-csv-account-import.c.

{
    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);
}

csv_import_assistant_prepare()

void csv_import_assistant_prepare	(	GtkAssistant *	assistant,
		GtkWidget *	page,
		gpointer	user_data
	)

Definition at line 478 of file assistant-csv-account-import.c.

{
    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;
    }
}

csv_import_assistant_start_page_prepare()

void csv_import_assistant_start_page_prepare	(	GtkAssistant *	gtkassistant,
		gpointer	user_data
	)

Definition at line 351 of file assistant-csv-account-import.c.

{
    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);
}

csv_import_assistant_summary_page_prepare()

void csv_import_assistant_summary_page_prepare	(	GtkAssistant *	assistant,
		gpointer	user_data
	)

Definition at line 442 of file assistant-csv-account-import.c.

{
    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 ("<span size=\"medium\"><b>%s</b></span>", text);
    gtk_label_set_markup (GTK_LABEL(info->summary_label), mtext);
 
    g_free (text);
    g_free (mtext);
}

csv_import_file_chooser_file_activated_cb()

void csv_import_file_chooser_file_activated_cb	(	GtkFileChooser *	chooser,
		CsvImportInfo *	info
	)

Definition at line 179 of file assistant-csv-account-import.c.

{
    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()

void csv_import_file_chooser_selection_changed_cb	(	GtkFileChooser *	chooser,
		CsvImportInfo *	info
	)

Definition at line 200 of file assistant-csv-account-import.c.

{
    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()

void csv_import_hrows_cb	(	GtkWidget *	spin,
		gpointer	user_data
	)

Definition at line 217 of file assistant-csv-account-import.c.

{
    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_sep_cb()

void csv_import_sep_cb	(	GtkWidget *	radio,
		gpointer	user_data
	)

Definition at line 276 of file assistant-csv-account-import.c.

{
    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);
}

gnc_file_csv_account_import()

void gnc_file_csv_account_import

(

void

)

The gnc_file_csv_account_import() will let the user import accounts from a delimited file.

Definition at line 672 of file assistant-csv-account-import.c.

{
    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));
}