Import_Export

Modules
	AqBanking

Files
file	import-account-matcher.h
	Generic and very flexible account matcher/picker.
file	import-backend.h
	Generic importer backend interface.
file	import-commodity-matcher.h
	A Generic commodity matcher/picker.
file	import-main-matcher.h
	Transaction matcher main window.
file	import-match-picker.h
	The transaction match picker dialog interface.
file	import-pending-matches.h
	Tracking container for pending match status.
file	import-settings.h
	Import preference handling.
file	import-utilities.h
	Utility functions for writing import modules.

Data Structures
struct	AccountOnlineMatch
struct	AccountPickerDialog
struct	GNCImportSelectedMatchInfo
struct	GNCImportTransInfo
struct	GNCImportMatchInfo
struct	GNCImportMainMatcher
struct	RowInfo
struct	match_struct
struct	GNCImportMatchPicker
struct	GNCPendingMatches
struct	GNCImportSettings
struct	split_record
struct	ofx_info

Macros
#define	STATE_SECTION   "dialogs/import/generic_matcher/account_matcher"
#define	GNC_PREFS_GROUP   "dialogs.import.generic.account-picker"
#define	GNCIMPORT_DESC   "desc"
#define	GNCIMPORT_MEMO   "memo"
#define	GNCIMPORT_PAYEE   "payee"
#define	GNC_PREFS_GROUP   "dialogs.import.generic.transaction-list"
#define	IMPORT_MAIN_MATCHER_CM_CLASS   "transaction-matcher-dialog"
#define	CSS_INT_REQUIRED_CLASS   "gnc-class-intervention-required"
#define	CSS_INT_PROB_REQUIRED_CLASS   "gnc-class-intervention-probably-required"
#define	CSS_INT_NOT_REQUIRED_CLASS   "gnc-class-intervention-not-required"
#define	G_MOD_IMPORT_MATCHER   "gnc.import.main-matcher"
#define	GNC_PREFS_GROUP   "dialogs.import.generic.match-picker"
#define	GNC_PREF_DISPLAY_RECONCILED   "display-reconciled"
#define	GNC_PREFS_GROUP_IMPORT   "dialogs.import.generic"
	The preferences used by the importer.
#define	GNC_PREF_ENABLE_SKIP   "enable-skip"
#define	GNC_PREF_ENABLE_UPDATE   "enable-update"
#define	GNC_PREF_USE_BAYES   "use-bayes"
#define	GNC_PREF_ATM_FEE_THRESHOLD   "atm-fee-threshold"
#define	GNC_PREF_AUTO_CLEAR_THRESHOLD   "auto-clear-threshold"
#define	GNC_PREF_AUTO_ADD_THRESHOLD   "auto-add-threshold"
#define	GNC_PREF_MATCH_THRESHOLD   "match-threshold"
#define	GNC_PREF_MATCH_DATE_THRESHOLD   "match-date-threshold"
#define	GNC_PREF_MATCH_DATE_NOT_THRESHOLD   "match-date-not-threshold"
#define	GNC_PREFS_GROUP   "dialogs.log-replay"
#define	STRING_FIELD_SIZE   256
#define	GNC_PREFS_GROUP   "dialogs.import.ofx"
#define	GNC_PREF_AUTO_COMMODITY   "auto-create-commodity"

Typedefs
typedef void(*	GNCTransactionProcessedCB) (GNCImportTransInfo *trans_info, gboolean imported, gpointer user_data)
typedef GHashTable	GNCImportPendingMatches

Enumerations
enum	GNCImportAction {   GNCImport_SKIP, GNCImport_ADD, GNCImport_CLEAR, GNCImport_UPDATE,   GNCImport_LAST_ACTION, GNCImport_INVALID_ACTION }
enum	downloaded_cols {   DOWNLOADED_COL_DATE_TXT = 0, DOWNLOADED_COL_DATE_INT64, DOWNLOADED_COL_ACCOUNT, DOWNLOADED_COL_AMOUNT,   DOWNLOADED_COL_AMOUNT_DOUBLE, DOWNLOADED_COL_DESCRIPTION, DOWNLOADED_COL_DESCRIPTION_ORIGINAL, DOWNLOADED_COL_DESCRIPTION_STYLE,   DOWNLOADED_COL_MEMO, DOWNLOADED_COL_MEMO_ORIGINAL, DOWNLOADED_COL_MEMO_STYLE, DOWNLOADED_COL_NOTES_ORIGINAL,   DOWNLOADED_COL_ACTION_ADD, DOWNLOADED_COL_ACTION_CLEAR, DOWNLOADED_COL_ACTION_UPDATE, DOWNLOADED_COL_ACTION_INFO,   DOWNLOADED_COL_ACTION_PIXBUF, DOWNLOADED_COL_DATA, DOWNLOADED_COL_COLOR, DOWNLOADED_COL_ENABLE,   NUM_DOWNLOADED_COLS, DOWNLOADED_COL_ACCOUNT = 0, DOWNLOADED_COL_DATE, DOWNLOADED_COL_AMOUNT,   DOWNLOADED_COL_DESCRIPTION, DOWNLOADED_COL_MEMO, DOWNLOADED_COL_BALANCED, DOWNLOADED_COL_INFO_PTR,   NUM_DOWNLOADED_COLS }
enum	{ COMPLETION_LIST_ORIGINAL, COMPLETION_LIST_NORMALIZED_FOLDED, NUM_COMPLETION_COLS }
enum	downloaded_cols {   DOWNLOADED_COL_DATE_TXT = 0, DOWNLOADED_COL_DATE_INT64, DOWNLOADED_COL_ACCOUNT, DOWNLOADED_COL_AMOUNT,   DOWNLOADED_COL_AMOUNT_DOUBLE, DOWNLOADED_COL_DESCRIPTION, DOWNLOADED_COL_DESCRIPTION_ORIGINAL, DOWNLOADED_COL_DESCRIPTION_STYLE,   DOWNLOADED_COL_MEMO, DOWNLOADED_COL_MEMO_ORIGINAL, DOWNLOADED_COL_MEMO_STYLE, DOWNLOADED_COL_NOTES_ORIGINAL,   DOWNLOADED_COL_ACTION_ADD, DOWNLOADED_COL_ACTION_CLEAR, DOWNLOADED_COL_ACTION_UPDATE, DOWNLOADED_COL_ACTION_INFO,   DOWNLOADED_COL_ACTION_PIXBUF, DOWNLOADED_COL_DATA, DOWNLOADED_COL_COLOR, DOWNLOADED_COL_ENABLE,   NUM_DOWNLOADED_COLS, DOWNLOADED_COL_ACCOUNT = 0, DOWNLOADED_COL_DATE, DOWNLOADED_COL_AMOUNT,   DOWNLOADED_COL_DESCRIPTION, DOWNLOADED_COL_MEMO, DOWNLOADED_COL_BALANCED, DOWNLOADED_COL_INFO_PTR,   NUM_DOWNLOADED_COLS }
enum	matcher_cols {   MATCHER_COL_CONFIDENCE = 0, MATCHER_COL_CONFIDENCE_PIXBUF, MATCHER_COL_DATE, MATCHER_COL_AMOUNT,   MATCHER_COL_DESCRIPTION, MATCHER_COL_MEMO, MATCHER_COL_RECONCILED, MATCHER_COL_PENDING,   MATCHER_COL_INFO_PTR, NUM_MATCHER_COLS }
enum	GNCImportPendingMatchType { GNCImportPending_NONE, GNCImportPending_AUTO, GNCImportPending_MANUAL }

Functions
Account *	gnc_import_select_account (GtkWidget *parent, const gchar *account_online_id_value, gboolean auto_create, const gchar *account_human_description, const gnc_commodity *new_account_default_commodity, GNCAccountType new_account_default_type, Account *default_selection, gboolean *ok_pressed)
	Must be called with a string containing a unique identifier for the account. More...
gnc_commodity *	gnc_import_select_commodity (const char *cusip, gboolean ask_on_unknown, const char *default_fullname, const char *default_mnemonic)
	Must be called with a string containing a unique identifier for the commodity. More...
void	on_matcher_ok_clicked (GtkButton *button, GNCImportMainMatcher *info)
void	on_matcher_cancel_clicked (GtkButton *button, gpointer user_data)
gboolean	on_matcher_delete_event (GtkWidget *widget, GdkEvent *event, gpointer data)
void	on_matcher_help_clicked (GtkButton *button, gpointer user_data)
	This allows for the transaction help dialog to be started from the assistant button callback. More...
void	on_matcher_help_close_clicked (GtkButton *button, gpointer user_data)
void	gnc_gen_trans_list_delete (GNCImportMainMatcher *info)
	Deletes the given object. More...
gboolean	gnc_gen_trans_list_empty (GNCImportMainMatcher *info)
	Checks whether there are no transactions to match. More...
void	gnc_gen_trans_list_show_all (GNCImportMainMatcher *info)
	Shows widgets. More...
GNCImportMainMatcher *	gnc_gen_trans_list_new (GtkWidget *parent, const gchar *heading, gboolean all_from_same_account, gint match_date_hardlimit, gboolean show_all)
	Create a new generic transaction dialog window and return it. More...
GNCImportMainMatcher *	gnc_gen_trans_assist_new (GtkWidget *parent, GtkWidget *assistant_page, const gchar *heading, gboolean all_from_same_account, gint match_date_hardlimit)
	Add the Transaction matcher to an existing page of an assistant. More...
void	gnc_gen_trans_assist_start (GNCImportMainMatcher *info)
	This starts the import process for transaction from an assistant. More...
void	gnc_gen_trans_list_add_tp_cb (GNCImportMainMatcher *info, GNCTransactionProcessedCB trans_processed_cb, gpointer user_data)
	Add transaction processed callback to the transaction importer. More...
gboolean	gnc_gen_trans_list_run (GNCImportMainMatcher *info)
	Run this dialog and return only after the user pressed Ok, Cancel, or closed the window. More...
void	gnc_gen_trans_list_add_trans (GNCImportMainMatcher *gui, Transaction *trans)
	Add a newly imported Transaction to the Transaction Importer. More...
void	gnc_gen_trans_list_show_reconcile_after_close_button (GNCImportMainMatcher *info, gboolean reconcile_after_close, gboolean active)
	Show and set the reconcile after close check button. More...
GtkWidget *	gnc_gen_trans_list_get_reconcile_after_close_button (GNCImportMainMatcher *info)
	Returns the reconcile after close check button. More...
void	gnc_gen_trans_list_add_trans_with_ref_id (GNCImportMainMatcher *gui, Transaction *trans, guint32 ref_id)
	Add a newly imported Transaction to the Transaction Importer and provide an external reference id for it. More...
GtkWidget *	gnc_gen_trans_list_widget (GNCImportMainMatcher *info)
	Returns the widget of this dialog. More...
GtkWidget *	gnc_gen_trans_list_append_text_widget (GNCImportMainMatcher *info)
	Returns the append_text widget of this dialog. More...
void	gnc_import_match_picker_run_and_close (GtkWidget *parent, GNCImportTransInfo *transaction_info, GNCImportPendingMatches *pending_matches)
	Run a match_picker dialog so that the selected-MatchInfo in the given trans_info is updated accordingly. More...
GNCImportPendingMatches *	gnc_import_PendingMatches_new (void)
void	gnc_import_PendingMatches_delete (GNCImportPendingMatches *map)
void	gnc_import_PendingMatches_add_match (GNCImportPendingMatches *map, GNCImportMatchInfo *match_info, gboolean selected_manually)
void	gnc_import_PendingMatches_remove_match (GNCImportPendingMatches *map, GNCImportMatchInfo *match_info, gboolean selected_manually)
GNCImportPendingMatchType	gnc_import_PendingMatches_get_match_type (GNCImportPendingMatches *map, GNCImportMatchInfo *match_info)
const char *	gnc_import_PendingMatches_get_type_str (GNCImportPendingMatchType type)
GNCImportSettings *	gnc_import_Settings_new (void)
	Allocates a new GNCImportSettings object, and initialize it with the appropriate user prefs.
void	gnc_import_Settings_delete (GNCImportSettings *settings)
	Destructor.
gboolean	gnc_import_trans_has_online_id (Transaction *transaction)
gboolean	gnc_import_split_has_online_id (Split *split)
void	qof_instance_set_guid (gpointer inst, const GncGUID *guid)
	Set the GncGUID of this instance.
void	gnc_file_log_replay (GtkWindow *parent)
	The gnc_file_log_replay() routine will pop up a standard file selection dialogue asking the user to pick a log file to replay. More...
int	ofx_proc_statement_cb (struct OfxStatementData data, void *statement_user_data)
int	ofx_proc_security_cb (const struct OfxSecurityData data, void *security_user_data)
int	ofx_proc_transaction_cb (struct OfxTransactionData data, void *user_data)
int	ofx_proc_account_cb (struct OfxAccountData data, void *account_user_data)
void	gnc_file_ofx_import (GtkWindow *parent)
	The gnc_file_ofx_import() routine will pop up a standard file selection dialogue asking the user to pick a OFX/QFX file. More...
char *	libgncmod_ofx_gnc_module_path (void)
char *	libgncmod_ofx_gnc_module_description (void)
int	libgncmod_ofx_gnc_module_init (int refcount)
int	libgncmod_ofx_gnc_module_end (int refcount)

Variables
gint	GNCPendingMatches::num_manual_matches
gint	GNCPendingMatches::num_auto_matches
int	libgncmod_ofx_gnc_module_system_interface = 0
int	libgncmod_ofx_gnc_module_current = 0
int	libgncmod_ofx_gnc_module_revision = 0
int	libgncmod_ofx_gnc_module_age = 0

Non-GUI Functions
GdkPixbuf *	gen_probability_pixbuf (gint score, GNCImportSettings *settings, GtkWidget *widget)
	This function generates a new pixmap representing a match score. More...
void	split_find_match (GNCImportTransInfo *trans_info, Split *split, gint display_threshold, gint date_threshold, gint date_not_threshold, double fuzzy_amount_difference)
	The transaction matching heuristics are here. More...
gboolean	gnc_import_process_trans_item (GncImportMatchMap *matchmap, GNCImportTransInfo *trans_info)
	/brief – Processes one match according to its selected action. More...
gboolean	gnc_import_exists_online_id (Transaction *trans, GHashTable *acct_id_hash)
	Checks whether the given transaction's online_id already exists in its parent account. More...
void	gnc_import_TransInfo_init_matches (GNCImportTransInfo *trans_info, GNCImportSettings *settings)
	Iterates through all splits of the originating account of trans_info. More...

Getters/Setters for GNCImportTransInfo
GList *	gnc_import_TransInfo_get_match_list (const GNCImportTransInfo *info)
	Returns the stored list of possible matches. More...
void	gnc_import_TransInfo_set_match_list (GNCImportTransInfo *info, GList *match_list)
	Assigns the list of possible matches. More...
Transaction *	gnc_import_TransInfo_get_trans (const GNCImportTransInfo *info)
	Returns the transaction of this TransInfo. More...
gboolean	gnc_import_TransInfo_is_balanced (const GNCImportTransInfo *info)
	Returns if the transaction stored in the TransInfo is currently balanced. More...
Split *	gnc_import_TransInfo_get_fsplit (const GNCImportTransInfo *info)
	Returns the first split of the transaction of this TransInfo. More...
GNCImportMatchInfo *	gnc_import_TransInfo_get_selected_match (const GNCImportTransInfo *info)
	Returns the currently selected match in this TransInfo. More...
void	gnc_import_TransInfo_set_selected_match_info (GNCImportTransInfo *info, GNCImportMatchInfo *match, gboolean selected_manually)
	Sets the currently selected match in this TransInfo. More...
gboolean	gnc_import_TransInfo_get_match_selected_manually (const GNCImportTransInfo *info)
	Returns if the currently selected match was selected by the user. More...
GNCImportAction	gnc_import_TransInfo_get_action (const GNCImportTransInfo *info)
	Returns the currently selected action for this TransInfo. More...
void	gnc_import_TransInfo_set_action (GNCImportTransInfo *info, GNCImportAction action)
	Set the action for this TransInfo. More...
Account *	gnc_import_TransInfo_get_destacc (const GNCImportTransInfo *info)
	Returns the 'other account' of this transaction. More...
void	gnc_import_TransInfo_set_destacc (GNCImportTransInfo *info, Account *acc, gboolean selected_manually)
	Set the 'other account' of this transaction (used for auto-balance if needed). More...
gboolean	gnc_import_TransInfo_get_destacc_selected_manually (const GNCImportTransInfo *info)
	Returns if the currently selected destination account for auto-matching was selected by the user. More...
guint32	gnc_import_TransInfo_get_ref_id (const GNCImportTransInfo *info)
	Returns the reference id for this TransInfo. More...
void	gnc_import_TransInfo_set_ref_id (GNCImportTransInfo *info, guint32 ref_id)
	Set the reference id for this TransInfo. More...
void	gnc_import_TransInfo_set_append_text (GNCImportTransInfo *info, gboolean append_text)
	Set the append_text for this TransInfo. More...
void	gnc_import_TransInfo_delete (GNCImportTransInfo *info)
	Destructor.
GNCImportTransInfo *	gnc_import_TransInfo_new (Transaction *trans, GncImportMatchMap *matchmap)
	Create a new object of GNCImportTransInfo here. More...
gboolean	gnc_import_TransInfo_refresh_destacc (GNCImportTransInfo *transaction_info, GncImportMatchMap *matchmap)
	Try to automatch a given transaction to a destination account.

Getters/Setters for GNCImportMatchInfo
Split *	gnc_import_MatchInfo_get_split (const GNCImportMatchInfo *info)
	Get the split ('this-side split') of this MatchInfo. More...
gint	gnc_import_MatchInfo_get_probability (const GNCImportMatchInfo *info)
	Get the probability (confidence level) of this MatchInfo. More...

Getters/Setters for GNCImportSettings
double	gnc_import_Settings_get_fuzzy_amount (GNCImportSettings *settings)
	Return the allowed amount range for fuzzy amount matching. More...
gboolean	gnc_import_Settings_get_action_skip_enabled (GNCImportSettings *settings)
	Return the selected action is enable state.
gboolean	gnc_import_Settings_get_action_add_enabled (GNCImportSettings *settings)
	Return the selected action is enable state.
gboolean	gnc_import_Settings_get_action_update_enabled (GNCImportSettings *settings)
	Return the selected action is enable state.
gboolean	gnc_import_Settings_get_action_clear_enabled (GNCImportSettings *settings)
	Return the selected action is enable state.
gint	gnc_import_Settings_get_clear_threshold (GNCImportSettings *settings)
	Return the selected threshold.
gint	gnc_import_Settings_get_add_threshold (GNCImportSettings *settings)
	Return the selected threshold.
gint	gnc_import_Settings_get_display_threshold (GNCImportSettings *settings)
	Return the selected threshold.
gint	gnc_import_Settings_get_date_threshold (GNCImportSettings *settings)
gint	gnc_import_Settings_get_date_not_threshold (GNCImportSettings *settings)
void	gnc_import_Settings_set_match_date_hardlimit (GNCImportSettings *s, gint m)
gint	gnc_import_Settings_get_match_date_hardlimit (const GNCImportSettings *settings)
	Returns the hard-limiting number of days that a matching split may differ. More...

Setter-getters
Setter and getter functions for the online_id field for Splits.
gchar *	gnc_import_get_acc_online_id (Account *account)
void	gnc_import_set_acc_online_id (Account *account, const gchar *id)
gchar *	gnc_import_get_trans_online_id (Transaction *transaction)
void	gnc_import_set_trans_online_id (Transaction *transaction, const gchar *id)
gchar *	gnc_import_get_split_online_id (Split *split)
void	gnc_import_set_split_online_id (Split *split, const gchar *id)

Detailed Description

Function Documentation

gen_probability_pixbuf()

GdkPixbuf * gen_probability_pixbuf	(	gint	score,
		GNCImportSettings *	settings,
		GtkWidget *	widget
	)

This function generates a new pixmap representing a match score.

It is a series of vertical bars of different colors. -Below or at the add_threshold the bars are red -Above or at the clear_threshold the bars are green -Between the two threshold the bars are yellow

Parameters

score	The score for which to generate a pixmap.
settings	The user settings from which to get the threshold
widget	The parent widget in which the pixmap will eventually be added. Will be used to generate the colormap.

Definition at line 299 of file import-backend.c.

{
    GdkPixbuf* retval = NULL;
    gint i, j;
    gint score;
    const gint height = 15;
    const gint width_each_bar = 7;
    gchar * green_bar = ("bggggb ");
    gchar * yellow_bar = ("byyyyb ");
    gchar * red_bar = ("brrrrb ");
    gchar * black_bar = ("bbbbbb ");
    const gint width_first_bar = 1;
    gchar * black_first_bar = ("b");
    const gint num_colors = 5;
    gchar * size_str;
    gchar * none_color_str = g_strdup_printf("  c None");
    gchar * green_color_str = g_strdup_printf("g c green");
    gchar * yellow_color_str = g_strdup_printf("y c yellow");
    gchar * red_color_str = g_strdup_printf("r c red");
    gchar * black_color_str = g_strdup_printf("b c black");
    gchar * xpm[2+num_colors+height];
    gint add_threshold, clear_threshold;

    g_assert(settings);
    g_assert(widget);
    if (score_original < 0)
    {
        score = 0;
    }
    else
    {
        score = score_original;
    }
    size_str = g_strdup_printf("%d%s%d%s%d%s", (width_each_bar * score) + width_first_bar/*width*/, " ", height, " ", num_colors, " 1"/*characters per pixel*/);

    /*DEBUG("Begin");*/
    xpm[0] = size_str;
    xpm[1] = none_color_str;
    xpm[2] = green_color_str;
    xpm[3] = yellow_color_str;
    xpm[4] = red_color_str;
    xpm[5] = black_color_str;
    add_threshold = gnc_import_Settings_get_add_threshold(settings);
    clear_threshold = gnc_import_Settings_get_clear_threshold(settings);

    for (i = 0; i < height; i++)
    {
        xpm[num_colors+1+i] = g_new0(char, (width_each_bar * score) + width_first_bar + 1);
        for (j = 0; j <= score; j++)
        {
            if (i == 0 || i == height - 1)
            {
                if (j == 0)
                {
                    strcat(xpm[num_colors+1+i], black_first_bar);
                }
                else
                {
                    strcat(xpm[num_colors+1+i], black_bar);
                }
            }
            else
            {
                if (j == 0)
                {
                    strcat(xpm[num_colors+1+i], black_first_bar);
                }
                else if (j <= add_threshold)
                {
                    strcat(xpm[num_colors+1+i], red_bar);
                }
                else if (j >= clear_threshold)
                {
                    strcat(xpm[num_colors+1+i], green_bar);
                }
                else
                {
                    strcat(xpm[num_colors+1+i], yellow_bar);
                }
            }
        }
    }

    retval =  gdk_pixbuf_new_from_xpm_data((const gchar **)xpm);
    for (i = 0; i <= num_colors + height; i++)
    {
        /*DEBUG("free_loop i=%d%s%s",i,": ",xpm[i]);*/
        g_free(xpm[i]);
    }

    return retval;
}

gnc_file_log_replay()

void gnc_file_log_replay

(

GtkWindow *

parent

)

The gnc_file_log_replay() routine will pop up a standard file selection dialogue asking the user to pick a log file to replay.

If one is selected the .log file is opened and read. Its contents are then silently merged in the current log file.

Definition at line 548 of file gnc-log-replay.c.

{
    char *selected_filename;
    char *default_dir;
    char read_buf[256];
    char *read_retval;
    GtkFileFilter *filter;
    FILE *log_file;
    char * record_start_str = "===== START";
    /* NOTE: This string must match src/engine/TransLog.c (sans newline) */
    char * expected_header_orig = "mod\ttrans_guid\tsplit_guid\ttime_now\t"
                                  "date_entered\tdate_posted\tacc_guid\tacc_name\tnum\tdescription\t"
                                  "notes\tmemo\taction\treconciled\tamount\tvalue\tdate_reconciled";
    static char *expected_header = NULL;

    /* Use g_strdup_printf so we don't get accidental tab -> space conversion */
    if (!expected_header)
        expected_header = g_strdup(expected_header_orig);

    qof_log_set_level(GNC_MOD_IMPORT, QOF_LOG_DEBUG);
    ENTER(" ");

    /* Don't log the log replay. This would only result in redundant logs */
    xaccLogDisable();

    default_dir = gnc_get_default_directory(GNC_PREFS_GROUP);

    filter = gtk_file_filter_new();
    gtk_file_filter_set_name(filter, "*.log");
    gtk_file_filter_add_pattern(filter, "*.[Ll][Oo][Gg]");
    selected_filename = gnc_file_dialog(parent,
                                        _("Select a .log file to replay"),
                                        g_list_prepend(NULL, filter),
                                        default_dir,
                                        GNC_FILE_DIALOG_OPEN);
    g_free(default_dir);

    if (selected_filename != NULL)
    {
        /* Remember the directory as the default. */
        default_dir = g_path_get_dirname(selected_filename);
        gnc_set_default_directory(GNC_PREFS_GROUP, default_dir);
        g_free(default_dir);

        /*strncpy(file,selected_filename, 255);*/
        DEBUG("Filename found: %s", selected_filename);
        if (xaccFileIsCurrentLog(selected_filename))
        {
            g_warning("Cannot open the current log file: %s", selected_filename);
            gnc_error_dialog(NULL,
                             /* Translators: %s is the file name. */
                             _("Cannot open the current log file: %s"),
                             selected_filename);
        }
        else
        {
            DEBUG("Opening selected file");
            log_file = g_fopen(selected_filename, "r");
            if (!log_file || ferror(log_file) != 0)
            {
                int err = errno;
                perror("File open failed");
                /* Translators: First argument is the filename,
                 * second argument is the error.
                 */
                gnc_error_dialog(NULL,
                                 _("Failed to open log file: %s: %s"),
                                 selected_filename,
                                 strerror(err));
            }
            else
            {
                if ((read_retval = fgets(read_buf, sizeof(read_buf), log_file)) == NULL)
                {
                    DEBUG("Read error or EOF");
                    gnc_info_dialog(NULL, "%s",
                                    _("The log file you selected was empty."));
                }
                else
                {
                    if (strncmp(expected_header, read_buf, strlen(expected_header)) != 0)
                    {
                        PERR("File header not recognised:\n%s", read_buf);
                        PERR("Expected:\n%s", expected_header);
                        gnc_error_dialog(NULL, "%s",
                                         _("The log file you selected cannot be read. "
                                           "The file header was not recognized."));
                    }
                    else
                    {
                        do
                        {
                            read_retval = fgets(read_buf, sizeof(read_buf), log_file);
                            /*DEBUG("Chunk read: %s",read_retval);*/
                            if (read_retval && strncmp(record_start_str, read_buf, strlen(record_start_str)) == 0) /* If a record started */
                            {
                                process_trans_record(log_file);
                            }
                        }
                        while (feof(log_file) == 0);
                    }
                }
                fclose(log_file);
            }
        }
        g_free(selected_filename);
    }
    /* Start logging again */
    xaccLogEnable();

    LEAVE("");
}

gnc_file_ofx_import()

void gnc_file_ofx_import

(

GtkWindow *

parent

)

The gnc_file_ofx_import() routine will pop up a standard file selection dialogue asking the user to pick a OFX/QFX file.

If one is selected the OFX file is opened and read. Its contents are merged into the existing session (if any). The current session continues to remain open for editing.

Definition at line 1368 of file gnc-ofx-import.c.

{
    extern int ofx_PARSER_msg;
    extern int ofx_DEBUG_msg;
    extern int ofx_WARNING_msg;
    extern int ofx_ERROR_msg;
    extern int ofx_INFO_msg;
    extern int ofx_STATUS_msg;
    GSList* selected_filenames = NULL;
    char *default_dir;
    GList *filters = NULL;
    GSList* iter = NULL;
    ofx_info* info = NULL;
    GtkFileFilter* filter = gtk_file_filter_new ();


    ofx_PARSER_msg = false;
    ofx_DEBUG_msg = false;
    ofx_WARNING_msg = true;
    ofx_ERROR_msg = true;
    ofx_INFO_msg = true;
    ofx_STATUS_msg = false;

    DEBUG("gnc_file_ofx_import(): Begin...\n");

    default_dir = gnc_get_default_directory(GNC_PREFS_GROUP);
    gtk_file_filter_set_name (filter, _("Open/Quicken Financial Exchange file (*.ofx, *.qfx)"));
    gtk_file_filter_add_pattern (filter, "*.[oqOQ][fF][xX]");
    filters = g_list_prepend( filters, filter );

    selected_filenames = gnc_file_dialog_multi (parent,
                                                _("Select one or multiple OFX/QFX file(s) to process"),
                                                filters,
                                                default_dir,
                                                GNC_FILE_DIALOG_IMPORT);
    g_free(default_dir);

    if (selected_filenames)
    {
        /* Remember the directory as the default. */
        default_dir = g_path_get_dirname(selected_filenames->data);
        gnc_set_default_directory(GNC_PREFS_GROUP, default_dir);
        g_free(default_dir);

        /* Look up the needed preferences */
        auto_create_commodity =
            gnc_prefs_get_bool (GNC_PREFS_GROUP_IMPORT, GNC_PREF_AUTO_COMMODITY);

        DEBUG("Opening selected file(s)");
        // Create the structure that holds the list of files to process and the statement info.
        info = g_new(ofx_info,1);
        info->num_trans_processed = 0;
        info->statement = NULL;
        info->last_investment_account = NULL;
        info->last_import_account = NULL;
        info->last_income_account = NULL;
        info->parent = parent;
        info->run_reconcile = FALSE;
        info->file_list = selected_filenames;
        info->trans_list = NULL;
        info->response = 0;
        // Call the aux import function.
        gnc_file_ofx_import_process_file (info);
    }
}

gnc_gen_trans_assist_new()

GNCImportMainMatcher * gnc_gen_trans_assist_new	(	GtkWidget *	parent,
		GtkWidget *	assistant_page,
		const gchar *	heading,
		gboolean	all_from_same_account,
		gint	match_date_hardlimit
	)

Add the Transaction matcher to an existing page of an assistant.

Must be called with the parent widget, ie. a vbox that the transaction matcher will be packed into. The data structure GNCImportMainMatcher is returned.

Parameters

parent	The parent widget
assistant_page	The parent widget. This is the place the transaction matcher will be packed into.
heading	The heading label in the Importer window. May be NULL.
all_from_same_account	Set this to TRUE if ALL the transaction that will be added with gnc_gen_trans_list_add_trans are from the same source account. This will cause the account column to be hidden.
match_date_hardlimit	The number of days that a matching split may differ from the given transaction before it is discarded immediately. In other words, any split that is more distant from the given transaction than this match_date_hardlimit days will be ignored altogether. For use cases without paper checks (e.g. HBCI), values like 14 (days) might be appropriate, whereas for use cases with paper checks (e.g. OFX, QIF), values like 42 (days) seem more appropriate.

Returns

A pointer to the GNCImportMainMatcher which has been setup.

Definition at line 1749 of file import-main-matcher.c.

{
    GNCImportMainMatcher *info;
    GtkBuilder *builder;
    GtkWidget *box;

    info = g_new0 (GNCImportMainMatcher, 1);
    info->main_widget = GTK_WIDGET(parent);

    /* load the interface */
    builder = gtk_builder_new ();
    gnc_builder_add_from_file (builder, "dialog-import.glade", "transaction_matcher_content");

    /* Pack content into Assistant page widget */
    box = GTK_WIDGET(gtk_builder_get_object (builder, "transaction_matcher_content"));
    g_assert (box != NULL);
    gtk_box_pack_start (GTK_BOX(assistant_page), box, TRUE, TRUE, 6);

    /* setup the common parts */
    gnc_gen_trans_common_setup (info, parent, builder, heading,
                                all_from_same_account, match_date_hardlimit);

    return info;
}

gnc_gen_trans_assist_start()

void gnc_gen_trans_assist_start

(

GNCImportMainMatcher *

info

)

This starts the import process for transaction from an assistant.

assistant button callback.

Parameters

info.

A pointer to the GNCImportMainMatcher structure

Definition at line 1779 of file import-main-matcher.c.

{
    on_matcher_ok_clicked (NULL, info);
}

gnc_gen_trans_list_add_tp_cb()

void gnc_gen_trans_list_add_tp_cb	(	GNCImportMainMatcher *	info,
		GNCTransactionProcessedCB	trans_processed_cb,
		gpointer	user_data
	)

Add transaction processed callback to the transaction importer.

Parameters

info	The Transaction Importer to use.
trans_processed_cb	The callback function.

Definition at line 1789 of file import-main-matcher.c.

{
    info->user_data = user_data;
    info->transaction_processed_cb = trans_processed_cb;
}

gnc_gen_trans_list_add_trans()

void gnc_gen_trans_list_add_trans	(	GNCImportMainMatcher *	gui,
		Transaction *	trans
	)

Add a newly imported Transaction to the Transaction Importer.

The Importer takes over ownership of the passed transaction.

Parameters

gui	The Transaction Importer to use.
trans	The Transaction to add. The must contain at least one split, and this split must have been associated with an account Only the first split will be used for matching. The transaction must NOT be committed. The Importer takes over ownership of the passed transaction.

Definition at line 2193 of file import-main-matcher.c.

{
    Account* acc = NULL;
    Split* split = NULL;
    int i=0;

    split = xaccTransGetSplit (trans, 0);
    acc = xaccSplitGetAccount (split);
    defer_bal_computation (gui, acc);

    gnc_gen_trans_list_add_trans_with_ref_id (gui, trans, 0);
    return;
}/* end gnc_import_add_trans() */

gnc_gen_trans_list_add_trans_with_ref_id()

void gnc_gen_trans_list_add_trans_with_ref_id	(	GNCImportMainMatcher *	gui,
		Transaction *	trans,
		guint32	ref_id
	)

Add a newly imported Transaction to the Transaction Importer and provide an external reference id for it.

The Importer takes over ownership of the passed transaction.

Parameters

gui	The Transaction Importer to use.
trans	The Transaction to add. The must contain at least one split, and this split must have been associated with an account Only the first split will be used for matching. The transaction must NOT be committed. The Importer takes over ownership of the passed transaction.
ref_id	Reference id which links an external object to the transaction.

Definition at line 2223 of file import-main-matcher.c.

{
    GNCImportTransInfo * transaction_info = NULL;
    GtkTreeModel *model;
    GtkTreeIter iter;
    g_assert (gui);
    g_assert (trans);

    if (gnc_import_exists_online_id (trans, gui->acct_id_hash))
        return;
    else
    {
        transaction_info = gnc_import_TransInfo_new (trans, NULL);
        gnc_import_TransInfo_set_ref_id (transaction_info, ref_id);
        // It's much faster to gather the imported transactions into a GSList than directly into the
        // treeview.
        gui->temp_trans_list = g_slist_prepend (gui->temp_trans_list, transaction_info);
    }
    return;
}

gnc_gen_trans_list_append_text_widget()

GtkWidget * gnc_gen_trans_list_append_text_widget

(

GNCImportMainMatcher *

info

)

Returns the append_text widget of this dialog.

Parameters

info	A pointer to the GNCImportMainMatcher structure.

Returns

A GtkWidget pointer to the append_text widget.

Definition at line 2411 of file import-main-matcher.c.

{
    g_assert (info);
    return info->append_text;
}

gnc_gen_trans_list_delete()

void gnc_gen_trans_list_delete

(

GNCImportMainMatcher *

info

)

Deletes the given object.

Definition at line 190 of file import-main-matcher.c.

{
    GtkTreeModel *model;
    GtkTreeIter iter;
    GNCImportTransInfo *trans_info;

    if (info == NULL)
        return;

    model = gtk_tree_view_get_model (info->view);
    if (gtk_tree_model_get_iter_first (model, &iter))
    {
        do
        {
            gtk_tree_model_get (model, &iter,
                                DOWNLOADED_COL_DATA, &trans_info,
                                -1);

            if (info->transaction_processed_cb)
            {
                info->transaction_processed_cb (trans_info, FALSE,
                                                info->user_data);
            }
        }
        while (gtk_tree_model_iter_next (model, &iter));
    }

    if (GTK_IS_DIALOG(info->main_widget))
    {
        gnc_save_window_size (GNC_PREFS_GROUP, GTK_WINDOW(info->main_widget));
        gnc_import_Settings_delete (info->user_settings);
        gnc_unregister_gui_component (info->id);
        gtk_widget_destroy (GTK_WIDGET(info->main_widget));
    }
    else
        gnc_import_Settings_delete (info->user_settings);

    g_slist_free_full (info->temp_trans_list, (GDestroyNotify) gnc_import_TransInfo_delete);
    info->temp_trans_list = NULL;

    // We've deferred balance computations on many accounts. Let's do it now that we're done.
    update_all_balances (info);

    gnc_import_PendingMatches_delete (info->pending_matches);
    g_hash_table_destroy (info->acct_id_hash);
    g_hash_table_destroy (info->desc_hash);
    g_hash_table_destroy (info->notes_hash);
    g_hash_table_destroy (info->memo_hash);

    g_list_free_full (info->new_strings, (GDestroyNotify)g_free);

    g_free (info);
}

gnc_gen_trans_list_empty()

gboolean gnc_gen_trans_list_empty

(

GNCImportMainMatcher *

info

)

Checks whether there are no transactions to match.

Parameters

info	A pointer to the GNCImportMainMatcher structure.

Returns

A boolean indicating whether the transaction list is empty.

Definition at line 245 of file import-main-matcher.c.

{
    GtkTreeModel *model;
    GtkTreeIter iter;
    GNCImportTransInfo *trans_info;
    g_assert (info);
    model = gtk_tree_view_get_model (info->view);
    // Check that both the tree model and the temporary list are empty.
    return !gtk_tree_model_get_iter_first (model, &iter) && !info->temp_trans_list;
}

gnc_gen_trans_list_get_reconcile_after_close_button()

GtkWidget * gnc_gen_trans_list_get_reconcile_after_close_button

(

GNCImportMainMatcher *

info

)

Returns the reconcile after close check button.

Parameters

info	A pointer to the GNCImportMainMatcher structure.

Returns

The check button.

Definition at line 2217 of file import-main-matcher.c.

{
    return info->reconcile_after_close;
}

gnc_gen_trans_list_new()

GNCImportMainMatcher * gnc_gen_trans_list_new	(	GtkWidget *	parent,
		const gchar *	heading,
		gboolean	all_from_same_account,
		gint	match_date_hardlimit,
		gboolean	show_all
	)

Create a new generic transaction dialog window and return it.

Parameters

parent	The parent GtkWidget. May be NULL.
heading	The heading label in the Importer window. May be NULL.
all_from_same_account	Set this to TRUE if ALL the transaction that will be added with gnc_gen_trans_list_add_trans are from the same source account. This will cause the account column to be hidden.
match_date_hardlimit	The number of days that a matching split may differ from the given transaction before it is discarded immediately. In other words, any split that is more distant from the given transaction than this match_date_hardlimit days will be ignored altogether. For use cases without paper checks (e.g. HBCI), values like 14 (days) might be appropriate, whereas for use cases with paper checks (e.g. OFX, QIF), values like 42 (days) seem more appropriate.
show_all	if true, all widgets are shown

Returns

A pointer to the GNCImportMainMatcher which has been setup.

Definition at line 1696 of file import-main-matcher.c.

{
    GNCImportMainMatcher *info;
    GtkBuilder *builder;
    GtkWidget *box, *pbox;

    info = g_new0 (GNCImportMainMatcher, 1);

    /* Initialize the GtkDialog. */
    builder = gtk_builder_new ();
    gnc_builder_add_from_file (builder, "dialog-import.glade", "transaction_matcher_dialog");
    gnc_builder_add_from_file (builder, "dialog-import.glade", "transaction_matcher_content");

    info->main_widget = GTK_WIDGET(gtk_builder_get_object (builder, "transaction_matcher_dialog"));
    g_assert (info->main_widget != NULL);

    /* Pack the content into the dialog vbox */
    pbox = GTK_WIDGET(gtk_builder_get_object (builder, "transaction_matcher_vbox"));
    box = GTK_WIDGET(gtk_builder_get_object (builder, "transaction_matcher_content"));
    gtk_box_pack_start (GTK_BOX(pbox), box, TRUE, TRUE, 0);

    /* setup the common parts */
    gnc_gen_trans_common_setup (info, parent, builder, heading,
                                all_from_same_account, match_date_hardlimit);

    if (parent)
        gtk_window_set_transient_for (GTK_WINDOW(info->main_widget), GTK_WINDOW(parent));

    gnc_restore_window_size (GNC_PREFS_GROUP, GTK_WINDOW(info->main_widget), GTK_WINDOW(parent));

    if (show_all)
        gtk_widget_show_all (GTK_WIDGET(info->main_widget));

    // Register this UI, it needs to be closed when the session is closed.
    info->id = gnc_register_gui_component (IMPORT_MAIN_MATCHER_CM_CLASS,
                                           NULL, /* no refresh handler */
                                           (GNCComponentCloseHandler)gnc_gen_trans_list_delete,
                                           info);
    // This ensure this dialog is closed when the session is closed.
    gnc_gui_component_set_session (info->id, gnc_get_current_session());

    return info;
}

gnc_gen_trans_list_run()

gboolean gnc_gen_trans_list_run

(

GNCImportMainMatcher *

info

)

Run this dialog and return only after the user pressed Ok, Cancel, or closed the window.

This means that all actual importing will have been finished upon returning.

Parameters

info	A pointer to the GNCImportMainMatcher structure.

Returns

The boolean return value of the dialog run.

Definition at line 1798 of file import-main-matcher.c.

{
    gboolean result;

    /* DEBUG("Begin"); */
    result = gtk_dialog_run (GTK_DIALOG (info->main_widget));
    /* DEBUG("Result was %d", result); */

    /* No destroying here since the dialog was already destroyed through
       the ok_clicked handlers. */

    return result;
}

gnc_gen_trans_list_show_all()

void gnc_gen_trans_list_show_all

(

GNCImportMainMatcher *

info

)

Shows widgets.

Parameters

info	A pointer to the GNCImportMainMatcher structure.

Definition at line 504 of file import-main-matcher.c.

{
    GNCImportTransInfo* trans_info;
    Account* account;
    Split* first_split;
    GSList* temp_trans_list;

    g_assert (info);

    // Set initial state of Append checkbox to same as last import for this account.
    // Get the import account from the first split in first transaction.
    temp_trans_list = info->temp_trans_list;
    if (!temp_trans_list)
    {
        gnc_info_dialog (GTK_WINDOW (info->main_widget), _("No new transactions were found in this import."));
        return;
    }
    trans_info = temp_trans_list->data;
    first_split = gnc_import_TransInfo_get_fsplit (trans_info);
    account = xaccSplitGetAccount(first_split);
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON (info->append_text),
                                 xaccAccountGetAppendText(account));

    gnc_gen_trans_list_create_matches (info);
    load_hash_tables (info);
    resolve_conflicts (info);
    gtk_widget_show_all (GTK_WIDGET(info->main_widget));
    gnc_gen_trans_list_show_accounts_column (info);
}

gnc_gen_trans_list_show_reconcile_after_close_button()

void gnc_gen_trans_list_show_reconcile_after_close_button	(	GNCImportMainMatcher *	info,
		gboolean	reconcile_after_close,
		gboolean	active
	)

Show and set the reconcile after close check button.

Parameters

info	A pointer to the GNCImportMainMatcher structure.
reconcile_after_close	A gboolean that shows or hides the button.
active	A gboolean to set or clear the check button.

Definition at line 2208 of file import-main-matcher.c.

{
    gtk_widget_set_visible (info->reconcile_after_close, reconcile_after_close);
    gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (info->reconcile_after_close), active);
}

gnc_gen_trans_list_widget()

GtkWidget * gnc_gen_trans_list_widget

(

GNCImportMainMatcher *

info

)

Returns the widget of this dialog.

Parameters

info	A pointer to the GNCImportMainMatcher structure.

Returns

A GtkWidget pointer to the dialog's widget.

Definition at line 2404 of file import-main-matcher.c.

{
    g_assert (info);
    return info->main_widget;
}

gnc_import_exists_online_id()

gboolean gnc_import_exists_online_id	(	Transaction *	trans,
		GHashTable *	acct_id_hash
	)

Checks whether the given transaction's online_id already exists in its parent account.

The given transaction has to be open for editing. If a matching online_id exists, the transaction is destroyed (!) and TRUE is returned, otherwise FALSE is returned.

Parameters

trans

The transaction for which to check for an existing online_id.

Definition at line 1192 of file import-backend.c.

{
    gboolean online_id_exists = FALSE;
    Account *dest_acct;
    Split *source_split;
    char *source_online_id;

    /* Look for an online_id in the first split */
    source_split = xaccTransGetSplit(trans, 0);
    g_assert(source_split);

    source_online_id = gnc_import_get_split_online_id (source_split);

    // No online id, no point in continuing. We'd crash if we tried.
    if (!source_online_id)
        return FALSE;

    // Create a hash per account of a hash of all split IDs. Then the
    // test below will be fast if we have many transactions to import.
    dest_acct = xaccSplitGetAccount (source_split);
    if (!g_hash_table_contains (acct_id_hash, dest_acct))
    {
        GHashTable* new_hash = g_hash_table_new_full
            (g_str_hash, g_str_equal, g_free, NULL);
        g_hash_table_insert (acct_id_hash, dest_acct, new_hash);
        for (GList *n = xaccAccountGetSplitList (dest_acct) ; n; n=n->next)
        {
            if (gnc_import_split_has_online_id (n->data))
            {
                char *id = gnc_import_get_split_online_id (n->data);
                g_hash_table_insert (new_hash, (void*) id, GINT_TO_POINTER (1));
            }
        }
    }
    online_id_exists = g_hash_table_contains (g_hash_table_lookup (acct_id_hash, dest_acct),
                                              source_online_id);
    
    /* If it does, abort the process for this transaction, since it is
       already in the system. */
    if (online_id_exists == TRUE)
    {
        DEBUG("%s", "Transaction with same online ID exists, destroying current transaction");
        xaccTransDestroy(trans);
        xaccTransCommitEdit(trans);
    }
    g_free (source_online_id);
    return online_id_exists;
}

gnc_import_match_picker_run_and_close()

void gnc_import_match_picker_run_and_close	(	GtkWidget *	parent,
		GNCImportTransInfo *	transaction_info,
		GNCImportPendingMatches *	pending_matches
	)

Run a match_picker dialog so that the selected-MatchInfo in the given trans_info is updated accordingly.

Run a match_picker dialog where the user should pick the best match for 'one' given transaction, so that the selected-MatchInfo in the given trans_info is updated accordingly.

This functions will only return after the user clicked Ok, Cancel, or Window-Close.

This functions will only return after the user clicked Ok, Cancel, or Window-Close.

The dialog uses the same functionality as the one created through gnc_import_add_trans(), except that its two listviews are shown above one another, and the listview of downloaded transactions shows only one transaction, namely, the given trans_info.

This function is used from the gnc-gen-transaction code.

Parameters

parent	The parent widget
transaction_info	The TransInfo for which the user is supposed to pick a matching transaction.
pending_matches	List of transactions

Definition at line 508 of file import-match-picker.c.

{
    GNCImportMatchPicker *matcher;
    gint response;
    GNCImportMatchInfo *old;
    gboolean old_selected_manually;
    g_assert (transaction_info);

    /* Create a new match_picker, even though it's stored in a
       transmatcher struct :-) */
    matcher = g_new0(GNCImportMatchPicker, 1);
    
    matcher->pending_matches = pending_matches;
    
    /* DEBUG("Init match_picker"); */
    init_match_picker_gui(parent, matcher);

    /* Append this single transaction to the view and select it */
    downloaded_transaction_append(matcher, transaction_info);

    old = gnc_import_TransInfo_get_selected_match (transaction_info);
    old_selected_manually = 
        gnc_import_TransInfo_get_match_selected_manually (transaction_info);

    /* Let this dialog run and close. */
    /*DEBUG("Right before run and close");*/
    gtk_window_set_modal(GTK_WINDOW(matcher->transaction_matcher), TRUE);
    response = gtk_dialog_run (GTK_DIALOG (matcher->transaction_matcher));
    
    gnc_save_window_size(GNC_PREFS_GROUP,
                         GTK_WINDOW (matcher->transaction_matcher));
    gtk_widget_destroy (matcher->transaction_matcher);
    /*DEBUG("Right after run and close");*/
    /* DEBUG("Response was %d.", response); */
    if (response == GTK_RESPONSE_OK && matcher->selected_match_info != old)
    {
        /* OK was pressed */
        gnc_import_TransInfo_set_selected_match_info (transaction_info,
                matcher->selected_match_info,
                TRUE);
        
        gnc_import_PendingMatches_remove_match (pending_matches,
                                                old,
                                                old_selected_manually);
        gnc_import_PendingMatches_add_match (pending_matches,
                                             matcher->selected_match_info,
                                             TRUE);
    }
}

gnc_import_MatchInfo_get_probability()

gint gnc_import_MatchInfo_get_probability

(

const GNCImportMatchInfo *

info

)

Get the probability (confidence level) of this MatchInfo.

Parameters

info	Can be NULL, in which case the function returns 0

Definition at line 263 of file import-backend.c.

{
    if (info)
    {
        return info->probability;
    }
    else
    {
        return 0;
    }
}

gnc_import_MatchInfo_get_split()

Split * gnc_import_MatchInfo_get_split

(

const GNCImportMatchInfo *

info

)

Get the split ('this-side split') of this MatchInfo.

Definition at line 256 of file import-backend.c.

{
    g_assert (info);
    return info->split;
}

gnc_import_process_trans_item()

gboolean gnc_import_process_trans_item	(	GncImportMatchMap *	matchmap,
		GNCImportTransInfo *	trans_info
	)

/brief – Processes one match according to its selected action.

This function is intended to be called when the importer dialog is finished.

It should be called once for each imported transaction and processes each ImportTransInfo according to its selected action: For GNCImport_ADD, the transaction is added etc. etc.

Each successful match is also stored in the given ImportMatchMap, or, if that argument is NULL, in the ImportMatchMap of each originating account.

Parameters

matchmap	The ImportMatchMap where each match should be stored. May be NULL, in which case the ImportMatchMap of each account will be used.
trans_info	The ImportTransInfo item to process.

Returns

TRUE if the item has been processed.

Definition at line 932 of file import-backend.c.

{
    Split * other_split;
    gnc_numeric imbalance_value;
    Transaction *trans;

    /* DEBUG("Begin"); */

    g_assert (trans_info);
    /*DEBUG("Iteration %d, action %d, split %s", i,
        trans_info->action,
        xaccTransGetDescription (gnc_import_TransInfo_get_trans
        (trans_info)))*/
    switch (gnc_import_TransInfo_get_action (trans_info))
    {
    case GNCImport_SKIP:
        return FALSE;
    case GNCImport_ADD:
        /* Transaction gets imported. */

        /* Is the transaction not balanced and there is a non-NULL destination account? */
        if (gnc_import_TransInfo_is_balanced(trans_info) == FALSE
                && gnc_import_TransInfo_get_destacc(trans_info) != NULL)
        {
            /* Create the 'other' split. */
            Split *split =
                xaccMallocSplit
                (gnc_account_get_book
                 (gnc_import_TransInfo_get_destacc (trans_info)));
            xaccTransAppendSplit
            (gnc_import_TransInfo_get_trans (trans_info), split);
            xaccAccountInsertSplit
            (gnc_import_TransInfo_get_destacc (trans_info), split);
            /*xaccSplitSetBaseValue
              (split,
               gnc_numeric_neg(xaccTransGetImbalance
                       (gnc_import_TransInfo_get_trans (trans_info))),
               xaccTransGetCurrency
               (gnc_import_TransInfo_get_trans (trans_info)));*/
            {
                /* This is a quick workaround for the bug described in
                         http://lists.gnucash.org/pipermail/gnucash-devel/2003-August/009982.html
                       Assume that importers won't create transactions involving two or more
                       currencies so we can use xaccTransGetImbalanceValue. */
                imbalance_value =
                    gnc_numeric_neg (xaccTransGetImbalanceValue
                                     (gnc_import_TransInfo_get_trans (trans_info)));
                xaccSplitSetValue (split, imbalance_value);
                xaccSplitSetAmount (split, imbalance_value);
            }
            /*xaccSplitSetMemo (split, _("Auto-Balance split"));
              -- disabled due to popular request */
        }

        xaccSplitSetReconcile(gnc_import_TransInfo_get_fsplit (trans_info), CREC);
        /*Set reconcile date to today*/
        xaccSplitSetDateReconciledSecs(gnc_import_TransInfo_get_fsplit (trans_info),
                                       gnc_time (NULL));
        /* Done editing. */
        trans = gnc_import_TransInfo_get_trans (trans_info);
        xaccTransCommitEdit(trans);
        xaccTransRecordPrice(trans, PRICE_SOURCE_SPLIT_IMPORT);
        return TRUE;
    case GNCImport_UPDATE:
    {
        GNCImportMatchInfo *selected_match =
            gnc_import_TransInfo_get_selected_match(trans_info);

        /* If there is no selection, ignore this transaction. */
        if (!selected_match)
        {
            PWARN("No matching translaction to be cleared was chosen. Imported transaction will be ignored.");
            break;
        }

        /* Transaction gets not imported but the matching one gets
           updated and reconciled. */
        if (gnc_import_MatchInfo_get_split(selected_match) == NULL)
        {
            PERR("The split I am trying to update and reconcile is NULL, shouldn't happen!");
        }
        else
        {
            /* Update and reconcile the matching transaction */
            /*DEBUG("BeginEdit selected_match")*/
            xaccTransBeginEdit(selected_match->trans);

            xaccTransSetDatePostedSecsNormalized(selected_match->trans,
                                                 xaccTransGetDate(xaccSplitGetParent(
                                                         gnc_import_TransInfo_get_fsplit(trans_info))));

            xaccSplitSetAmount(selected_match->split,
                               xaccSplitGetAmount(
                                   gnc_import_TransInfo_get_fsplit(trans_info)));
            xaccSplitSetValue(selected_match->split,
                              xaccSplitGetValue(
                                  gnc_import_TransInfo_get_fsplit(trans_info)));

            imbalance_value = xaccTransGetImbalanceValue(
                                  gnc_import_TransInfo_get_trans(trans_info));
            other_split = xaccSplitGetOtherSplit(selected_match->split);
            if (!gnc_numeric_zero_p(imbalance_value) && other_split)
            {
                if (xaccSplitGetReconcile(other_split) == NREC)
                {
                    imbalance_value = gnc_numeric_neg(imbalance_value);
                    xaccSplitSetValue(other_split, imbalance_value);
                    xaccSplitSetAmount(other_split, imbalance_value);
                }
                /* else GC will automatically insert a split to equity
                   to balance the transaction */
            }

            update_desc_and_notes( trans_info);

            if (xaccSplitGetReconcile(selected_match->split) == NREC)
            {
                xaccSplitSetReconcile(selected_match->split, CREC);
            }

            /* Set reconcile date to today */
            xaccSplitSetDateReconciledSecs(selected_match->split, gnc_time (NULL));

            /* Copy the online id to the reconciled transaction, so
               the match will be remembered */
            if (gnc_import_split_has_online_id(trans_info->first_split))
            {
                char *online_id = gnc_import_get_split_online_id
                    (trans_info->first_split);
                gnc_import_set_split_online_id(selected_match->split, online_id);
                g_free (online_id);
            }

            /* Done editing. */
            /*DEBUG("CommitEdit selected_match")*/
            xaccTransCommitEdit(selected_match->trans);

            /* Store the mapping to the other account in the MatchMap. */
            matchmap_store_destination(matchmap, trans_info, TRUE);

            /* Erase the downloaded transaction */
            xaccTransDestroy(trans_info->trans);
            /*DEBUG("CommitEdit trans")*/
            xaccTransCommitEdit(trans_info->trans);
            /* Very important: Make sure the freed transaction is not freed again! */
            trans_info->trans = NULL;
        }
    }
    return TRUE;
    case GNCImport_CLEAR:
    {
        GNCImportMatchInfo *selected_match =
            gnc_import_TransInfo_get_selected_match (trans_info);

        /* If there is no selection, ignore this transaction. */
        if (!selected_match)
        {
            PWARN("No matching translaction to be cleared was chosen. Imported transaction will be ignored.");
            break;
        }

        /* Transaction gets not imported but the matching one gets
           reconciled. */
        if (gnc_import_MatchInfo_get_split (selected_match) == NULL)
        {
            PERR("The split I am trying to reconcile is NULL, shouldn't happen!");
        }
        else
        {
            /* Reconcile the matching transaction */
            /*DEBUG("BeginEdit selected_match")*/
            xaccTransBeginEdit(selected_match->trans);

            if (xaccSplitGetReconcile
                    (selected_match->split) == NREC)
                xaccSplitSetReconcile
                (selected_match->split, CREC);
            /* Set reconcile date to today */
            xaccSplitSetDateReconciledSecs
            (selected_match->split, gnc_time (NULL));

            /* Copy the online id to the reconciled transaction, so
                     the match will be remembered */
            if (gnc_import_split_has_online_id(trans_info->first_split))
            {
                char *online_id = gnc_import_get_split_online_id
                    (trans_info->first_split);
                gnc_import_set_split_online_id (selected_match->split, online_id);
                g_free (online_id);
            }

            /* Done editing. */
            /*DEBUG("CommitEdit selected_match")*/
            xaccTransCommitEdit
            (selected_match->trans);

            /* Store the mapping to the other account in the MatchMap. */
            matchmap_store_destination (matchmap, trans_info, TRUE);

            /* Erase the downloaded transaction */
            xaccTransDestroy(trans_info->trans);
            /*DEBUG("CommitEdit trans")*/
            xaccTransCommitEdit(trans_info->trans);
            /* Very important: Make sure the freed transaction is not freed again! */
            trans_info->trans = NULL;
        }
    }
    return TRUE;
    default:
        DEBUG("Invalid GNCImportAction for this imported transaction.");
        break;
    }
    /*DEBUG("End");*/
    return FALSE;
}

gnc_import_select_account()

Account * gnc_import_select_account	(	GtkWidget *	parent,
		const gchar *	account_online_id_value,
		gboolean	auto_create,
		const gchar *	account_human_description,
		const gnc_commodity *	new_account_default_commodity,
		GNCAccountType	new_account_default_type,
		Account *	default_selection,
		gboolean *	ok_pressed
	)

Must be called with a string containing a unique identifier for the account.

If an account with a matching online_id is found, the function immediately returns with a pointer to that account. Otherwise, the user is prompted to select a GnuCash account or create a new one (in both cases, the unique identifier is written to the account, so the user won't be prompted again). If the user refuses to select or create an account, NULL is returned.

Parameters

parent	The parent widget. Can be NULL.
account_online_id_value	The string containing your unique account_id coming from some string of your module. This is the normal mode of operation. Can be NULL.

If account_online_id_value==NULL, you basically end up with an account selector that allows you to select an account whose GncGUID will be remembered elsewhere. You would fill account_human_description to tell the user what he is looking for. In this mode, the online_id field of the found account will not be touched. To use this mode, auto_create must NOT be set to 0.

Parameters

account_human_description	A human-readable description of the account. Can be NULL. If it is not NULL, it will be shown before the id in the account matching dialog. It will also be used as the default account name if a new account is created.
new_account_default_commodity	Default commodity of the new account. Can be NULL. If not NULL, it will be the account's commodity if a new account is created. Also, if not NULL, the function will also warn the user if the found or created account's commodity doesn't match.
new_account_default_type	Default account type of a new account. Can be NULL. If not ACCT_TYPE_NONE, it will be the account's type if a new account is created. If not ACCT_TYPE_NONE, the function will also warn the user if the found or created account's commodity doesn't match.
auto_create	Only active if no account with the account_online_id_value could be found in gnucash, or if online-id was NULL. In that case, if auto_create is TRUE (nonzero), the user will be asked to create a new account. If auto_create is FALSE (zero), this function will simply return NULL but will neither select nor create any account.
default_selection	If not NULL, that account will be pre-selected by default.
ok_pressed	A pointer to gboolean. If non-NULL, whether or not the picker dialog was closed by the user pressing ok will be stored in the parameter. If no dialog was created by the gnc_import_select_account() call, TRUE is always returned.

Returns

A pointer to the found or created Account, or NULL if no account was found or created.

Definition at line 403 of file import-account-matcher.c.

{
#define ACCOUNT_DESCRIPTION_MAX_SIZE 255
    AccountPickerDialog * picker;
    gint response;
    Account * retval = NULL;
    const gchar *retval_name = NULL;
    GtkBuilder *builder;
    GtkTreeSelection *selection;
    GtkWidget * online_id_label;
    gchar account_description_text[ACCOUNT_DESCRIPTION_MAX_SIZE + 1] = "";
    gboolean ok_pressed_retval = FALSE;

    ENTER("Default commodity received: %s", gnc_commodity_get_fullname( new_account_default_commodity));
    DEBUG("Default account type received: %s", xaccAccountGetTypeStr( new_account_default_type));
    picker = g_new0(AccountPickerDialog, 1);

    picker->account_online_id_value = account_online_id_value;
    picker->account_human_description =  account_human_description;
    picker->new_account_default_commodity = new_account_default_commodity;
    picker->new_account_default_type = new_account_default_type;

    /*DEBUG("Looking for account with online_id: \"%s\"", account_online_id_value);*/
    if (account_online_id_value != NULL)
    {
        AccountOnlineMatch match = {NULL, 0, account_online_id_value};
        retval =
            gnc_account_foreach_descendant_until(gnc_get_current_root_account (),
                                                 test_acct_online_id_match,
                                                 (void*)&match);
        if (!retval && match.count == 1 &&
            new_account_default_type == ACCT_TYPE_NONE)
            retval = match.partial_match;
    }
    if (retval == NULL && auto_create != 0)
    {
        /* load the interface */
        builder = gtk_builder_new();
        gnc_builder_add_from_file (builder, "dialog-import.glade", "account_new_icon");
        gnc_builder_add_from_file (builder, "dialog-import.glade", "account_picker_dialog");
        /* connect the signals in the interface */
        if (builder == NULL)
        {
            PERR("Error opening the glade builder interface");
        }
        picker->dialog = GTK_WIDGET(gtk_builder_get_object (builder, "account_picker_dialog"));
        picker->whbox = GTK_WIDGET(gtk_builder_get_object (builder, "warning_hbox"));
        picker->warning = GTK_WIDGET(gtk_builder_get_object (builder, "warning_label"));
        picker->ok_button = GTK_WIDGET(gtk_builder_get_object (builder, "okbutton"));

        if (parent)
            gtk_window_set_transient_for (GTK_WINDOW (picker->dialog),
                                          GTK_WINDOW (parent));

        gnc_restore_window_size (GNC_PREFS_GROUP,
                                 GTK_WINDOW(picker->dialog), GTK_WINDOW (parent));

        picker->account_tree_sw = GTK_WIDGET(gtk_builder_get_object (builder, "account_tree_sw"));
        online_id_label = GTK_WIDGET(gtk_builder_get_object (builder, "online_id_label"));

        //printf("gnc_import_select_account(): Fin get widget\n");

        if (account_human_description != NULL)
        {
            strncat(account_description_text, account_human_description,
                    ACCOUNT_DESCRIPTION_MAX_SIZE - strlen(account_description_text));
            strncat(account_description_text, "\n",
                    ACCOUNT_DESCRIPTION_MAX_SIZE - strlen(account_description_text));
        }
        if (account_online_id_value != NULL)
        {
            strncat(account_description_text, _("(Full account ID: "),
                    ACCOUNT_DESCRIPTION_MAX_SIZE - strlen(account_description_text));
            strncat(account_description_text, account_online_id_value,
                    ACCOUNT_DESCRIPTION_MAX_SIZE - strlen(account_description_text));
            strncat(account_description_text, ")",
                    ACCOUNT_DESCRIPTION_MAX_SIZE - strlen(account_description_text));
        }
        gtk_label_set_text((GtkLabel*)online_id_label, account_description_text);
        build_acct_tree(picker);
        gtk_window_set_modal(GTK_WINDOW(picker->dialog), TRUE);
        g_signal_connect(picker->account_tree, "row-activated",
                         G_CALLBACK(account_tree_row_activated_cb), picker);
        
        /* Connect key press event so we can expand the tree when the user starts typing, allowing
        * any subaccount to match */
        g_signal_connect (picker->account_tree, "key-press-event", G_CALLBACK (account_tree_key_press_cb), picker->account_tree);

        selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(picker->account_tree));
        g_signal_connect(selection, "changed",
                         G_CALLBACK(account_tree_row_changed_cb), picker);

        gnc_tree_view_account_set_selected_account(picker->account_tree, default_selection);

        do
        {
            response = gtk_dialog_run(GTK_DIALOG(picker->dialog));
            switch (response)
            {
            case GNC_RESPONSE_NEW:
                gnc_import_add_account(NULL, picker);
                response = GTK_RESPONSE_OK;
                /* no break */

            case GTK_RESPONSE_OK:
                retval = gnc_tree_view_account_get_selected_account(picker->account_tree);
                if (retval == NULL)
                {
                    response = GNC_RESPONSE_NEW;
                    break;
                }
                if (retval)
                    retval_name = xaccAccountGetName(retval);
                if (!retval_name)
                    retval_name = "(null)";
                DEBUG("Selected account %p, %s", retval, retval_name);

                /* See if the selected account is a placeholder. */
                if (retval && xaccAccountGetPlaceholder (retval))
                {
                    show_placeholder_warning (picker, retval_name);
                    response = GNC_RESPONSE_NEW;
                    break;
                }
                else if (picker->new_account_default_commodity &&
                            (!gnc_commodity_equal (xaccAccountGetCommodity (retval),
                             picker->new_account_default_commodity))) // check commodity
                {
                    show_commodity_warning (picker, retval_name);
                    response = GNC_RESPONSE_NEW;
                    break;
                }

                if ( account_online_id_value != NULL)
                {
                    gnc_import_set_acc_online_id(retval, account_online_id_value);
                }
                ok_pressed_retval = TRUE;
                break;

            default:
                ok_pressed_retval = FALSE;
                break;
            }
        }
        while (response == GNC_RESPONSE_NEW);

        g_object_unref(G_OBJECT(builder));
        gnc_save_window_size (GNC_PREFS_GROUP, GTK_WINDOW(picker->dialog));
        gtk_widget_destroy(picker->dialog);
    }
    else
    {
        retval_name = retval ? xaccAccountGetName(retval) : NULL;
        ok_pressed_retval = TRUE; /* There was no dialog involved, so the computer "pressed" ok */
    }
    /*FIXME: DEBUG("WRITEME: gnc_import_select_account() Here we should check if account type is compatible, currency matches, etc.\n"); */
    g_free(picker);
    /*DEBUG("Return value: %p%s%s%s",retval,", account name:",xaccAccountGetName(retval),"\n");*/
    if (ok_pressed != NULL)
    {
        *ok_pressed = ok_pressed_retval;
    }
    LEAVE("Selected account %p, %s", retval, retval_name ? retval_name : "(null)");
    return retval;
}

gnc_import_select_commodity()

gnc_commodity * gnc_import_select_commodity	(	const char *	cusip,
		gboolean	ask_on_unknown,
		const char *	default_fullname,
		const char *	default_mnemonic
	)

Must be called with a string containing a unique identifier for the commodity.

If an commodity with a matching cusip is found, the function immediately returns with a pointer to that commodity. Otherwise, the user may be prompted to select a GnuCash commodity or create a new one (in both cases, the cusip is written to the commodity's cusip field, overwriting anything that was there before.

Parameters

cusip	The string containing the code for which you want a matching commodity. A CUISP code or similar UNIQUE code. The stock ticker is NOT appropriate, unless you have no other option. Must be non-NULL.
ask_on_unknown	If the cusip value is unknown and this parameter is false (zero), the function returns NULL. Otherwise the user will be asked to select an existing or create a new commodity.
default_fullname	A human-readable description of the commodity, such as the stock name. Can be NULL. If it is not NULL, it will be shown to the user when selecting a commodity. It will also be used as the default if a new commodity is created.
default_mnemonic	Usually the stock ticker or similar. Can be NULL. If it is not NULL, it will be shown to the user when selecting a commodity. It will also be used as the default if a new commodity is created.

Returns

A pointer to the found or created commodity, or NULL if no commodity was found or created.

Definition at line 53 of file import-commodity-matcher.c.

{
    const gnc_commodity_table * commodity_table = gnc_get_current_commodities ();
    gnc_commodity * retval = NULL;
    gnc_commodity * tmp_commodity = NULL;
    char * tmp_namespace = NULL;
    GList * commodity_list = NULL;
    GList * namespace_list = NULL;
    DEBUG("Default fullname received: %s",
          default_fullname ? default_fullname : "(null)");
    DEBUG("Default mnemonic received: %s",
          default_mnemonic ? default_mnemonic : "(null)");

    g_return_val_if_fail(cusip, NULL);
    DEBUG("Looking for commodity with exchange_code: %s", cusip);

    g_assert(commodity_table);
    namespace_list = gnc_commodity_table_get_namespaces(commodity_table);


    namespace_list = g_list_first(namespace_list);
    while ( namespace_list != NULL && retval == NULL)
    {
        tmp_namespace = namespace_list->data;
        DEBUG("Looking at namespace %s", tmp_namespace);
        commodity_list = gnc_commodity_table_get_commodities(commodity_table,
                                                             tmp_namespace);
        commodity_list  = g_list_first(commodity_list);
        while ( commodity_list != NULL && retval == NULL)
        {
            const char* tmp_cusip = NULL;
            tmp_commodity = commodity_list->data;
            DEBUG("Looking at commodity %s",
                  gnc_commodity_get_fullname(tmp_commodity));
            tmp_cusip = gnc_commodity_get_cusip(tmp_commodity);
            if  (tmp_cusip != NULL && cusip != NULL)
            {
                int len = strlen(cusip) > strlen(tmp_cusip) ? strlen(cusip) :
                    strlen(tmp_cusip);
                if (strncmp(tmp_cusip, cusip, len) == 0)
                {
                    retval = tmp_commodity;
                    DEBUG("Commodity %s%s",
                          gnc_commodity_get_fullname(retval), " matches.");
                }
            }
            commodity_list = g_list_next(commodity_list);
        }
        namespace_list = g_list_next(namespace_list);
    }

    g_list_free(commodity_list);
    g_list_free(namespace_list);

    if (retval == NULL && ask_on_unknown != 0)
    {
        const gchar *message =
            _("Please select a commodity to match the following exchange "
              "specific code. Please note that the exchange code of the "
              "commodity you select will be overwritten.");
        retval = gnc_ui_select_commodity_modal_full(NULL,
                 NULL,
                 DIAG_COMM_ALL,
                 message,
                 cusip,
                 default_fullname,
                 default_mnemonic);

    }
    /* There seems to be a problem here - if the matched commodity does not
       have a cusip defined (gnc_commodity_get_cusip returns NULL) then
       it does not get overwritten - which is not consistent with the
       message - so Im adding it to do this.  Looks like this is all
       that was needed to fix the cash value used as stock units problem
       for pre-defined commodities which didn't have the cusip defined! */
    if (retval != NULL &&
            gnc_commodity_get_cusip(retval) != NULL &&
            cusip != NULL &&
            (strncmp(gnc_commodity_get_cusip(retval), cusip, strlen(cusip)) != 0))
    {
        gnc_commodity_set_cusip(retval, cusip);
    }
    else if (gnc_commodity_get_cusip(retval) == NULL && cusip != NULL)
    {
        gnc_commodity_set_cusip(retval, cusip);
    }
    return retval;
};

gnc_import_Settings_get_fuzzy_amount()

double gnc_import_Settings_get_fuzzy_amount

(

GNCImportSettings *

settings

)

Return the allowed amount range for fuzzy amount matching.

Returns

The allowed amount range for fuzzy amount matching, in the users default commodity.

Definition at line 122 of file import-settings.c.

{
    g_assert (settings);
    return settings->fuzzy_amount;
};

gnc_import_Settings_get_match_date_hardlimit()

gint gnc_import_Settings_get_match_date_hardlimit

(

const GNCImportSettings *

settings

)

Returns the hard-limiting number of days that a matching split may differ.

Definition at line 188 of file import-settings.c.

{
    g_assert(s);
    return s->match_date_hardlimit;
}

gnc_import_Settings_set_match_date_hardlimit()

void gnc_import_Settings_set_match_date_hardlimit	(	GNCImportSettings *	settings,
		gint	match_date_hardlimit
	)

Parameters

match_date_hardlimit

The number of days that a matching split may differ from the given transaction before it is discarded immediately. In other words, any split that is more distant from the given transaction than this match_date_hardlimit days will be ignored altogether. For use cases without paper checks (e.g. HBCI), values like 14 (days) might be appropriate, whereas for use cases with paper checks (e.g. OFX, QIF), values like 42 (days) seem more appropriate.

Definition at line 182 of file import-settings.c.

{
    g_assert(s);
    s->match_date_hardlimit = m;
}

gnc_import_TransInfo_get_action()

GNCImportAction gnc_import_TransInfo_get_action

(

const GNCImportTransInfo *

info

)

Returns the currently selected action for this TransInfo.

Definition at line 184 of file import-backend.c.

{
    g_assert (info);
    return info->action;
}

gnc_import_TransInfo_get_destacc()

Account * gnc_import_TransInfo_get_destacc

(

const GNCImportTransInfo *

info

)

Returns the 'other account' of this transaction.

May return NULL.

Definition at line 203 of file import-backend.c.

{
    g_assert (info);
    return info->dest_acc;
}

gnc_import_TransInfo_get_destacc_selected_manually()

gboolean gnc_import_TransInfo_get_destacc_selected_manually

(

const GNCImportTransInfo *

info

)

Returns if the currently selected destination account for auto-matching was selected by the user.

Definition at line 224 of file import-backend.c.

{
    g_assert (info);
    return info->dest_acc_selected_manually;
}

gnc_import_TransInfo_get_fsplit()

Split * gnc_import_TransInfo_get_fsplit

(

const GNCImportTransInfo *

info

)

Returns the first split of the transaction of this TransInfo.

Definition at line 153 of file import-backend.c.

{
    g_assert (info);
    return info->first_split;
}

gnc_import_TransInfo_get_match_list()

GList * gnc_import_TransInfo_get_match_list

(

const GNCImportTransInfo *

info

)

Returns the stored list of possible matches.

Definition at line 106 of file import-backend.c.

{
    g_assert (info);
    return info->match_list;
}

gnc_import_TransInfo_get_match_selected_manually()

gboolean gnc_import_TransInfo_get_match_selected_manually

(

const GNCImportTransInfo *

info

)

Returns if the currently selected match was selected by the user.

Definition at line 177 of file import-backend.c.

{
    g_assert (info);
    return info->selected_match_info.selected_manually;
}

gnc_import_TransInfo_get_ref_id()

guint32 gnc_import_TransInfo_get_ref_id

(

const GNCImportTransInfo *

info

)

Returns the reference id for this TransInfo.

Definition at line 231 of file import-backend.c.

{
    g_assert (info);
    return info->ref_id;
}

gnc_import_TransInfo_get_selected_match()

GNCImportMatchInfo * gnc_import_TransInfo_get_selected_match

(

const GNCImportTransInfo *

info

)

Returns the currently selected match in this TransInfo.

Definition at line 160 of file import-backend.c.

{
    g_assert (info);
    return info->selected_match_info.selected_match;
}

gnc_import_TransInfo_get_trans()

Transaction * gnc_import_TransInfo_get_trans

(

const GNCImportTransInfo *

info

)

Returns the transaction of this TransInfo.

Definition at line 129 of file import-backend.c.

{
    g_assert (info);
    return info->trans;
}

gnc_import_TransInfo_init_matches()

void gnc_import_TransInfo_init_matches	(	GNCImportTransInfo *	trans_info,
		GNCImportSettings *	settings
	)

Iterates through all splits of the originating account of trans_info.

Sorts the resulting list and sets the selected_match and action fields in the trans_info.

Sorts the resulting list and sets the selected_match and action fields in the trans_info.

Parameters

trans_info	The TransInfo for which the matches should be found, sorted, and selected.
settings	The structure that holds all the user preferences.

Definition at line 1283 of file import-backend.c.

{
    GNCImportMatchInfo * best_match = NULL;
    g_assert (trans_info);

    if (trans_info->match_list != NULL)
    {
        trans_info->match_list = g_list_sort(trans_info->match_list,
                                             compare_probability);
        best_match = g_list_nth_data(trans_info->match_list, 0);
        gnc_import_TransInfo_set_selected_match_info (trans_info,
                best_match,
                FALSE);
        if (best_match != NULL &&
                best_match->probability >= gnc_import_Settings_get_clear_threshold(settings))
        {
            trans_info->action = GNCImport_CLEAR;
        }
        else if (best_match == NULL ||
                 best_match->probability <= gnc_import_Settings_get_add_threshold(settings))
        {
            trans_info->action = GNCImport_ADD;
        }
        else if (gnc_import_Settings_get_action_skip_enabled(settings))
        {
            trans_info->action = GNCImport_SKIP;
        }
        else if (gnc_import_Settings_get_action_update_enabled(settings))
        {
            trans_info->action = GNCImport_UPDATE;
        }
        else
        {
            trans_info->action = GNCImport_ADD;
        }
    }
    else
    {
        trans_info->action = GNCImport_ADD;
    }
    if (best_match &&
            trans_info->action == GNCImport_CLEAR &&
            gnc_import_Settings_get_action_update_enabled(settings))
    {
        if (best_match->update_proposed)
        {
            trans_info->action = GNCImport_UPDATE;
        }
    }

    trans_info->previous_action = trans_info->action;
}

gnc_import_TransInfo_is_balanced()

gboolean gnc_import_TransInfo_is_balanced

(

const GNCImportTransInfo *

info

)

Returns if the transaction stored in the TransInfo is currently balanced.

Definition at line 136 of file import-backend.c.

{
    g_assert (info);
    /* Assume that the importer won't create a transaction that involves two or more
       currencies and no non-currency commodity.  In that case can use the simpler
       value imbalance check. */
    if (gnc_numeric_zero_p(xaccTransGetImbalanceValue(gnc_import_TransInfo_get_trans(info))))
    {
        return TRUE;
    }
    else
    {
        return FALSE;
    }
}

gnc_import_TransInfo_new()

GNCImportTransInfo * gnc_import_TransInfo_new	(	Transaction *	trans,
		GncImportMatchMap *	matchmap
	)

Create a new object of GNCImportTransInfo here.

Allocates a new TransInfo object, with the Transaction 'trans' already stored in there.

Also, this already checks the ImportMatchMap for automated destination account matching. The given MatchMap may be NULL, in which case the ImportMatchMap of the originating account will be used.

Parameters

trans	The transaction that this TransInfo should work with.
matchmap	MatchMap used for automated destination account choosing. This may be NULL, in which case the MatchMap of the originating account will be used.

Definition at line 1247 of file import-backend.c.

{
    GNCImportTransInfo *transaction_info;
    Split *split;
    g_assert (trans);

    transaction_info = g_new0(GNCImportTransInfo, 1);

    transaction_info->trans = trans;
    /* Only use first split, the source split */
    split = xaccTransGetSplit(trans, 0);
    g_assert(split);
    transaction_info->first_split = split;

    /* Try to find a previously selected destination account
       string match for the ADD action */
    gnc_import_TransInfo_set_destacc (transaction_info,
                                      matchmap_find_destination (matchmap, transaction_info),
                                      FALSE);
    return transaction_info;
}

gnc_import_TransInfo_set_action()

void gnc_import_TransInfo_set_action	(	GNCImportTransInfo *	info,
		GNCImportAction	action
	)

Set the action for this TransInfo.

Also sets the previous action.

Definition at line 191 of file import-backend.c.

{
    g_assert (info);
    if (action != info->action)
    {
        info->previous_action = info->action;
        info->action = action;
    }
}

gnc_import_TransInfo_set_append_text()

void gnc_import_TransInfo_set_append_text	(	GNCImportTransInfo *	info,
		gboolean	append_text
	)

Set the append_text for this TransInfo.

Definition at line 247 of file import-backend.c.

{
    g_assert (info);
    info->append_text = append_text;
}

gnc_import_TransInfo_set_destacc()

void gnc_import_TransInfo_set_destacc	(	GNCImportTransInfo *	info,
		Account *	acc,
		gboolean	selected_manually
	)

Set the 'other account' of this transaction (used for auto-balance if needed).

May be set to NULL.

Parameters

selected_manually

TRUE or FALSE; Was this account set as a result of a selection by the user or by an algorithm?

Definition at line 208 of file import-backend.c.

{
    g_assert (info);
    info->dest_acc = acc;
    info->dest_acc_selected_manually = selected_manually;

    /* Store the mapping to the other account in the MatchMap. */
    if (selected_manually)
    {
        matchmap_store_destination (NULL, info, FALSE);
    }
}

gnc_import_TransInfo_set_match_list()

void gnc_import_TransInfo_set_match_list	(	GNCImportTransInfo *	info,
		GList *	match_list
	)

Assigns the list of possible matches.

Definition at line 113 of file import-backend.c.

{
    g_assert (info);
    info->match_list = match_list;
    if (match_list)
    {
        info->selected_match_info.selected_match = match_list->data;
    }
    else
    {
        info->selected_match_info.selected_match = NULL;
        gnc_import_TransInfo_set_action (info, GNCImport_ADD);
    }
}

gnc_import_TransInfo_set_ref_id()

void gnc_import_TransInfo_set_ref_id	(	GNCImportTransInfo *	info,
		guint32	ref_id
	)

Set the reference id for this TransInfo.

Definition at line 238 of file import-backend.c.

{
    g_assert (info);
    info->ref_id = ref_id;
}

gnc_import_TransInfo_set_selected_match_info()

void gnc_import_TransInfo_set_selected_match_info	(	GNCImportTransInfo *	info,
		GNCImportMatchInfo *	match,
		gboolean	selected_manually
	)

Sets the currently selected match in this TransInfo.

Parameters

selected_manually

TRUE or FALSE; Was this match set as a result of a selection by the user or by an algorithm?

Definition at line 167 of file import-backend.c.

{
    g_assert (info);
    info->selected_match_info.selected_match = match;
    info->selected_match_info.selected_manually = selected_manually;
}

on_matcher_help_clicked()

void on_matcher_help_clicked	(	GtkButton *	button,
		gpointer	user_data
	)

This allows for the transaction help dialog to be started from the assistant button callback.

Parameters

button.	The button widget clicked on in the call back.
user_data.	A pointer to a structure.

Definition at line 625 of file import-main-matcher.c.

{
    GNCImportMainMatcher *info = user_data;
    GtkBuilder *builder;
    GtkWidget *help_dialog, *box;
    gchar *int_required_class, *int_prob_required_class, *int_not_required_class;
    gchar *class_extension = NULL;

    builder = gtk_builder_new ();
    gnc_builder_add_from_file (builder, "dialog-import.glade", "textbuffer2");
    gnc_builder_add_from_file (builder, "dialog-import.glade", "textbuffer3");
    gnc_builder_add_from_file (builder, "dialog-import.glade", "textbuffer4");
    gnc_builder_add_from_file (builder, "dialog-import.glade", "textbuffer5");
    gnc_builder_add_from_file (builder, "dialog-import.glade", "textbuffer1");
    gnc_builder_add_from_file (builder, "dialog-import.glade", "matcher_help_dialog");

    if (info->dark_theme == TRUE)
        class_extension = "-dark";

    int_required_class = g_strconcat (CSS_INT_REQUIRED_CLASS, class_extension, NULL);
    int_prob_required_class = g_strconcat (CSS_INT_PROB_REQUIRED_CLASS, class_extension, NULL);
    int_not_required_class = g_strconcat (CSS_INT_NOT_REQUIRED_CLASS, class_extension, NULL);

    box = GTK_WIDGET(gtk_builder_get_object (builder, "intervention_required_box"));
    gnc_widget_style_context_add_class (GTK_WIDGET(box), int_required_class);

    box = GTK_WIDGET(gtk_builder_get_object (builder, "intervention_probably_required_box"));
    gnc_widget_style_context_add_class (GTK_WIDGET(box), int_prob_required_class);

    box = GTK_WIDGET(gtk_builder_get_object (builder, "intervention_not_required_box"));
    gnc_widget_style_context_add_class (GTK_WIDGET(box), int_not_required_class);

    help_dialog = GTK_WIDGET(gtk_builder_get_object (builder, "matcher_help_dialog"));
    gtk_window_set_transient_for (GTK_WINDOW(help_dialog), GTK_WINDOW(info->main_widget));

    /* Connect the signals */
    gtk_builder_connect_signals_full (builder, gnc_builder_connect_full_func, help_dialog);

    g_object_unref (G_OBJECT(builder));

    g_free (int_required_class);
    g_free (int_prob_required_class);
    g_free (int_not_required_class);

    gtk_widget_show (help_dialog);
}

split_find_match()

void split_find_match	(	GNCImportTransInfo *	trans_info,
		Split *	split,
		gint	display_threshold,
		gint	date_threshold,
		gint	date_not_threshold,
		double	fuzzy_amount_difference
	)

The transaction matching heuristics are here.

Evaluates the match between trans_info and split using the provided parameters.

Parameters

trans_info	The TransInfo for the imported transaction
split	The register split that should be evaluated for a match.
display_threshold	Minimum match score to include split in the list of matches.
date_threshold	Maximum number of days a match considered likely.
date_not_threshold	Minimum number of days a match is considered unlikely.
fuzzy_amount_difference	Maximum amount difference to consider the match good.

Definition at line 627 of file import-backend.c.

{
    /* DEBUG("Begin"); */

    /*Ignore the split if the transaction is open for edit, meaning it
      was just downloaded. */
    if (xaccTransIsOpen(xaccSplitGetParent(split)) == FALSE)
    {
        GNCImportMatchInfo * match_info;
        gint prob = 0;
        gboolean update_proposed;
        double downloaded_split_amount, match_split_amount;
        time64 match_time, download_time;
        int datediff_day;
        Transaction *new_trans = gnc_import_TransInfo_get_trans (trans_info);
        Split *new_trans_fsplit = gnc_import_TransInfo_get_fsplit (trans_info);

        /* Matching heuristics */

        /* Amount heuristics */
        downloaded_split_amount =
            gnc_numeric_to_double (xaccSplitGetAmount(new_trans_fsplit));
        /*DEBUG(" downloaded_split_amount=%f", downloaded_split_amount);*/
        match_split_amount = gnc_numeric_to_double(xaccSplitGetAmount(split));
        /*DEBUG(" match_split_amount=%f", match_split_amount);*/
        if (fabs(downloaded_split_amount - match_split_amount) < 1e-6)
            /* bug#347791: Double type shouldn't be compared for exact
               equality, so we're using fabs() instead. */
            /*if (gnc_numeric_equal(xaccSplitGetAmount
              (new_trans_fsplit),
              xaccSplitGetAmount(split)))
              -- gnc_numeric_equal is an expensive function call */
        {
            prob = prob + 3;
            /*DEBUG("heuristics:  probability + 3 (amount)");*/
        }
        else if (fabs (downloaded_split_amount - match_split_amount) <=
                 fuzzy_amount_difference)
        {
            /* ATM fees are sometimes added directly in the transaction.
               So you withdraw 100$ and get charged 101,25$ in the same
               transaction */
            prob = prob + 2;
            /*DEBUG("heuristics:  probability + 2 (amount)");*/
        }
        else
        {
            /* If a transaction's amount doesn't match within the
               threshold, it's very unlikely to be the same transaction
               so we give it an extra -5 penalty */
            prob = prob - 5;
            /* DEBUG("heuristics:  probability - 1 (amount)"); */
        }

        /* Date heuristics */
        match_time = xaccTransGetDate (xaccSplitGetParent (split));
        download_time = xaccTransGetDate (new_trans);
        datediff_day = llabs(match_time - download_time) / 86400;
        /* Sorry, there are not really functions around at all that
             provide for less hacky calculation of days of date
             differences. Whatever. On the other hand, the difference
             calculation itself will work regardless of month/year
             turnarounds. */
        /*DEBUG("diff day %d", datediff_day);*/
        if (datediff_day == 0)
        {
            prob = prob + 3;
            /*DEBUG("heuristics:  probability + 3 (date)");*/
        }
        else if (datediff_day <= date_threshold)
        {
            prob = prob + 2;
            /*DEBUG("heuristics:  probability + 2 (date)");*/
        }
        else if (datediff_day > date_not_threshold)
        {
            /* Extra penalty if that split lies awfully far away from
               the given one. */
            prob = prob - 5;
            /*DEBUG("heuristics:  probability - 5 (date)"); */
            /* Changed 2005-02-21: Revert the hard-limiting behaviour
               back to the previous large penalty. (Changed 2004-11-27:
               The penalty is so high that we can forget about this
               split anyway and skip the rest of the tests.) */
        }

        /* Check if date and amount are identical */
        update_proposed = (prob < 6);

        /* Check number heuristics */
        {
            const char *new_trans_str = gnc_get_num_action(new_trans, new_trans_fsplit);
            if (new_trans_str && strlen(new_trans_str) != 0)
            {
                long new_trans_number, split_number;
                const gchar *split_str;
                char *endptr;
                gboolean conversion_ok = TRUE;

                /* To distinguish success/failure after strtol call */
                errno = 0;
                new_trans_number = strtol(new_trans_str, &endptr, 10);
                /* Possible addressed problems: over/underflow, only non
                         numbers on string and string empty */
                if (errno || endptr == new_trans_str)
                    conversion_ok = FALSE;

                split_str = gnc_get_num_action (xaccSplitGetParent (split), split);
                errno = 0;
                split_number = strtol(split_str, &endptr, 10);
                if (errno || endptr == split_str)
                    conversion_ok = FALSE;

                if ( (conversion_ok && (split_number == new_trans_number)) ||
                        (g_strcmp0(new_trans_str, split_str) == 0) )
                {
                    /* An exact match of the Check number gives a +4 */
                    prob += 4;
                    /*DEBUG("heuristics:  probability + 4 (Check number)");*/
                }
                else if (strlen(new_trans_str) > 0 && strlen(split_str) > 0)
                {
                    /* If both number are not empty yet do not match, add a
                             little extra penalty */
                    prob -= 2;
                }
            }
        }

        /* Memo heuristics */
        {
            const char *memo = xaccSplitGetMemo(new_trans_fsplit);
            if (memo && strlen(memo) != 0)
            {
                if (safe_strcasecmp(memo, xaccSplitGetMemo(split)) == 0)
                {
                    /* An exact match of memo gives a +2 */
                    prob = prob + 2;
                    /* DEBUG("heuristics:  probability + 2 (memo)"); */
                }
                else if ((strncasecmp(memo, xaccSplitGetMemo(split),
                                      strlen(xaccSplitGetMemo(split)) / 2)
                          == 0))
                {
                    /* Very primitive fuzzy match worth +1.  This matches the
                             first 50% of the strings to skip annoying transaction
                             number some banks seem to include in the memo but someone
                             should write something more sophisticated */
                    prob = prob + 1;
                    /*DEBUG("heuristics:  probability + 1 (memo)"); */
                }
            }
        }

        /* Description heuristics */
        {
            const char *descr = xaccTransGetDescription(new_trans);
            if (descr && strlen(descr) != 0)
            {
                if (safe_strcasecmp(descr,
                                    xaccTransGetDescription(xaccSplitGetParent(split)))
                        == 0)
                {
                    /*An exact match of Description gives a +2 */
                    prob = prob + 2;
                    /*DEBUG("heuristics:  probability + 2 (description)");*/
                }
                else if ((strncasecmp(descr,
                                      xaccTransGetDescription (xaccSplitGetParent(split)),
                                      strlen(xaccTransGetDescription (new_trans)) / 2)
                          == 0))
                {
                    /* Very primitive fuzzy match worth +1.  This matches the
                             first 50% of the strings to skip annoying transaction
                             number some banks seem to include in the memo but someone
                             should write something more sophisticated */
                    prob = prob + 1;
                    /*DEBUG("heuristics:  probability + 1 (description)");  */
                }
            }
        }

        /* Is the probability high enough? Otherwise do nothing and return. */
        if (prob < display_threshold)
        {
            return;
        }

        /* The probability is high enough, so allocate an object
             here. Allocating it only when it's actually being used is
             probably quite some performance gain. */
        match_info = g_new0(GNCImportMatchInfo, 1);

        match_info->probability = prob;
        match_info->update_proposed = update_proposed;
        match_info->split = split;
        match_info->trans = xaccSplitGetParent(split);


        /* Append that to the list. Do not use g_list_append because
               it is slow. The list is sorted afterwards anyway. */
        trans_info->match_list =
            g_list_prepend(trans_info->match_list,
                           match_info);
    }
}/* end split_find_match */