AqBanking

Files
file	assistant-ab-initial.h
	AqBanking setup functionality.
file	dialog-ab-select-imexporter.h
	Dialog to select AQBanking importer/exporter and format profile.
file	dialog-ab-trans.h
	Dialog for AqBanking transaction data.
file	gnc-ab-getbalance.h
	AqBanking getbalance functions.
file	gnc-ab-getbalance.h
	AqBanking getbalance functions.
file	gnc-ab-kvp.h
	AqBanking KVP handling.
file	gnc-ab-transfer.h
	Dialog for AqBanking transaction data.
file	gnc-ab-utils.h
	AqBanking utility functions.
file	gnc-flicker-gui.h
	GUI callbacks for Flicker and ChipTAN(optisch)
file	gnc-gwen-gui.h
	GUI callbacks for AqBanking.
file	gnc-plugin-aqbanking.h
	Plugin registration of the AqBanking module.

Data Structures
struct	AB_Node_Pair
struct	GncFlickerGui

Macros
#define	GNC_RESPONSE_NOW   GTK_RESPONSE_YES
#define	GNC_RESPONSE_LATER   GTK_RESPONSE_NO
#define	AQBANKING_VERSION_INT   (10000 * AQBANKING_VERSION_MAJOR + 100 * AQBANKING_VERSION_MINOR + AQBANKING_VERSION_PATCHLEVEL)
	A define that combines the aqbanking version number into one single integer number. More...
#define	GWENHYWFAR_VERSION_INT   (10000 * GWENHYWFAR_VERSION_MAJOR + 100 * GWENHYWFAR_VERSION_MINOR + GWENHYWFAR_VERSION_PATCHLEVEL)
	A define that combines the gwenhywfar version number into one single integer number. More...
#define	GNC_AB_ACCOUNT_SPEC   AB_ACCOUNT_SPEC
#define	GNC_AB_ACCOUNT_SPEC_LIST   AB_ACCOUNT_SPEC_LIST
#define	GNC_AB_JOB   AB_TRANSACTION
#define	GNC_AB_JOB_LIST2   AB_TRANSACTION_LIST2
#define	GNC_AB_JOB_LIST2_ITERATOR   AB_TRANSACTION_LIST2_ITERATOR
#define	GNC_AB_JOB_STATUS   AB_TRANSACTION_STATUS
#define	GNC_GWEN_DATE   GWEN_DATE
#define	GNC_PREFS_GROUP_AQBANKING   "dialogs.import.hbci"
#define	GNC_PREF_FORMAT_SWIFT940   "format-swift-mt940"
#define	GNC_PREF_FORMAT_SWIFT942   "format-swift-mt942"
#define	GNC_PREF_FORMAT_DTAUS   "format-dtaus"
#define	GNC_PREF_USE_TRANSACTION_TXT   "use-ns-transaction-text"
#define	GNC_PREF_VERBOSE_DEBUG   "verbose-debug"
#define	AWAIT_BALANCES   1 << 1
#define	FOUND_BALANCES   1 << 2
#define	IGNORE_BALANCES   1 << 3
#define	AWAIT_TRANSACTIONS   1 << 4
#define	FOUND_TRANSACTIONS   1 << 5
#define	IGNORE_TRANSACTIONS   1 << 6
#define	GNC_TYPE_PLUGIN_AQBANKING   (gnc_plugin_aqbanking_get_type())
#define	GNC_PLUGIN_AQBANKING_NAME   "gnc-plugin-aqbanking"

Typedefs
typedef struct _GncABSelectImExDlg	GncABSelectImExDlg
typedef enum _GncABTransType	GncABTransType
typedef typedefG_BEGIN_DECLS struct _GncGWENGui	GncGWENGui

Enumerations
enum	_GncABTransType {   SINGLE_TRANSFER = 0, SINGLE_DEBITNOTE, SINGLE_INTERNAL_TRANSFER, SEPA_TRANSFER,   SEPA_DEBITNOTE }

Functions
GncABTransTempl *	gnc_ab_trans_templ_new (void)
	Create a template with unset contents. More...
GncABTransTempl *	gnc_ab_trans_templ_new_full (const gchar *name, const gchar *recp_name, const gchar *recp_account, const gchar *recp_bankcode, gnc_numeric amount, const gchar *purpose, const gchar *purpose_cont)
	Create a template with given contents. More...
GList *	gnc_ab_trans_templ_list_new_from_book (QofBook *b)
	Obtain the list of QofTemplates saved in a Book. More...
void	gnc_ab_set_book_template_list (QofBook *b, GList *template_list)
	Set the GList of kvp_frames of template transactions in the Book b to template_list. More...
void	gnc_ab_trans_templ_free (GncABTransTempl *t)
	Free the memory used by a template. More...
void	gnc_ab_trans_templ_list_free (GList *l)
	Free the memory used by a list of templates, including the list itself. More...
const gchar *	gnc_ab_trans_templ_get_name (const GncABTransTempl *t)
const gchar *	gnc_ab_trans_templ_get_recp_name (const GncABTransTempl *t)
const gchar *	gnc_ab_trans_templ_get_recp_account (const GncABTransTempl *t)
const gchar *	gnc_ab_trans_templ_get_recp_bankcode (const GncABTransTempl *t)
gnc_numeric	gnc_ab_trans_templ_get_amount (const GncABTransTempl *t)
const gchar *	gnc_ab_trans_templ_get_purpose (const GncABTransTempl *t)
const gchar *	gnc_ab_trans_templ_get_purpose_cont (const GncABTransTempl *t)
void	gnc_ab_trans_templ_set_name (GncABTransTempl *t, const gchar *name)
	Set the name of a template. More...
void	gnc_ab_trans_templ_set_recp_name (GncABTransTempl *t, const gchar *recp_name)
	Replace the Account Number of the recipient stored in a template. More...
void	gnc_ab_trans_templ_set_recp_account (GncABTransTempl *t, const gchar *recp_account)
	Replace the Account Number of the recipient stored in a template. More...
void	gnc_ab_trans_templ_set_recp_bankcode (GncABTransTempl *t, const gchar *recp_bankcode)
	Replace the Bank Code of the recipient stored in a template. More...
void	gnc_ab_trans_templ_set_amount (GncABTransTempl *t, gnc_numeric amount)
	Replace the amount stored in a template. More...
void	gnc_ab_trans_templ_set_purpose (GncABTransTempl *t, const gchar *purpose)
	Replace the first purpose line stored in a template. More...
void	gnc_ab_trans_templ_set_purpose_cont (GncABTransTempl *t, const gchar *purpose_cont)
	Replace the second purpose line stored in a template. More...
G_BEGIN_DECLS void	gnc_ab_initial_assistant (void)
	Create and show an assistant for the aqbanking setup.
G_BEGIN_DECLS gboolean	gnc_ab_enter_daterange (GtkWidget *parent, const char *heading, time64 *from_date, gboolean *last_retv_date, gboolean *first_possible_date, time64 *to_date, gboolean *to_now)
	Show a dialog to pick a time frame using a sensible set of default options. More...
G_BEGIN_DECLS GncABSelectImExDlg *	gnc_ab_select_imex_dlg_new (GtkWidget *parent, AB_BANKING *abi)
	Create an AQBanking importer/exporter selection dialog. More...
void	gnc_ab_select_imex_dlg_destroy (GncABSelectImExDlg *imexd)
	Destroy an AQBanking importer/exporter selection dialog. More...
int	gnc_ab_select_imex_dlg_run (GncABSelectImExDlg *imexd)
	Run an AQBanking importer/exporter selection dialog. More...
char *	gnc_ab_select_imex_dlg_get_imexporter_name (GncABSelectImExDlg *imexd)
	Get the selected importer/exporter name. More...
void	gnc_ab_select_imex_dlg_set_imexporter_name (GncABSelectImExDlg *imexd, const char *name)
	Get the selected importer/exporter name. More...
char *	gnc_ab_select_imex_dlg_get_profile_name (GncABSelectImExDlg *imexd)
	Get the selected file format profile name. More...
void	gnc_ab_select_imex_dlg_set_profile_name (GncABSelectImExDlg *imexd, const char *name)
	Get the selected file format profile name. More...
gboolean	gnc_ab_trans_isSEPA (GncABTransType t)
	Returns true if the given GncABTransType is an European (SEPA) transaction (transfer or debit note), otherwise false.
GncABTransDialog *	gnc_ab_trans_dialog_new (GtkWidget *parent, GNC_AB_ACCOUNT_SPEC *ab_acc, gint commodity_scu, GncABTransType trans_type, GList *templates)
	Create a new AqBanking transfer dialog. More...
gint	gnc_ab_trans_dialog_run_until_ok (GncABTransDialog *td)
	Run the Aqbanking transfer dialog until correct values where entered or the user cancelled the dialog. More...
void	gnc_ab_trans_dialog_free (GncABTransDialog *td)
	Free a Aqbanking transfer dialog. More...
GtkWidget *	gnc_ab_trans_dialog_get_parent (const GncABTransDialog *td)
	Retrieve the widget used as parent. More...
const AB_TRANSACTION *	gnc_ab_trans_dialog_get_ab_trans (const GncABTransDialog *td)
	Receive the Aqbanking Transaction filled by the dialog. More...
GNC_AB_JOB *	gnc_ab_trans_dialog_get_job (const GncABTransDialog *td)
	Receive the Aqbanking job filled by the dialog. More...
GNC_AB_JOB *	gnc_ab_get_trans_job (GNC_AB_ACCOUNT_SPEC *ab_acc, const AB_TRANSACTION *ab_trans, GncABTransType trans_type)
	Return the AqBanking job associated with the transaction. More...
G_BEGIN_DECLS void	gnc_ab_getbalance (GtkWidget *parent, Account *gnc_acc)
	Execute a GetBalance job, show the resulting balance and offer to reconcile the GnuCash account. More...
G_BEGIN_DECLS void	gnc_ab_gettrans (GtkWidget *parent, Account *gnc_acc)
	Execute a GetTransactions job. More...
G_BEGIN_DECLS void	gnc_ab_maketrans (GtkWidget *parent, Account *gnc_acc, GncABTransType trans_type)
	Create SEPA transfers. More...
void	gnc_GWEN_Init (void)
	Initialize the gwenhywfar library by calling GWEN_Init() and setting up gwenhywfar logging.
void	gnc_GWEN_Fini (void)
	Finalize the gwenhywfar library.
AB_BANKING *	gnc_AB_BANKING_new (void)
	If there is a cached AB_BANKING object, return it initialized. More...
void	gnc_AB_BANKING_delete (AB_BANKING *api)
	Delete the AB_BANKING api. More...
gint	gnc_AB_BANKING_fini (AB_BANKING *api)
	Finish the AB_BANKING api. More...
GNC_AB_ACCOUNT_SPEC *	gnc_ab_get_ab_account (const AB_BANKING *api, Account *gnc_acc)
	Get the corresponding AqBanking account to the GnuCash account gnc_acc. More...
gchar *	gnc_AB_VALUE_to_readable_string (const AB_VALUE *value)
	Print the value of value with two decimal places and value's currency appended, or 0.0 otherwise. More...
gchar *	gnc_AB_JOB_to_readable_string (const GNC_AB_JOB *job)
	Return the job as string. More...
gchar *	gnc_AB_JOB_ID_to_string (gulong job_id)
	Return the job_id as string. More...
gchar *	gnc_ab_get_remote_name (const AB_TRANSACTION *ab_trans)
	Retrieve the merged "remote name" fields from a transaction. More...
gchar *	gnc_ab_get_purpose (const AB_TRANSACTION *ab_trans, gboolean is_ofx)
	Retrieve the merged purpose fields from a transaction. More...
gchar *	gnc_ab_description_to_gnc (const AB_TRANSACTION *ab_trans, gboolean is_ofx)
	Create the appropriate description field for a GnuCash Transaction by the information given in the AB_TRANSACTION ab_trans. More...
gchar *	gnc_ab_memo_to_gnc (const AB_TRANSACTION *ab_trans)
	Create the appropriate memo field for a GnuCash Split by the information given in the AB_TRANSACTION ab_trans. More...
Transaction *	gnc_ab_trans_to_gnc (const AB_TRANSACTION *ab_trans, Account *gnc_acc)
	Create an unbalanced and dirty GnuCash transaction with a split to gnc_acc from the information available in the AqBanking transaction ab_trans. More...
GncABImExContextImport *	gnc_ab_import_context (AB_IMEXPORTER_CONTEXT *context, guint awaiting, gboolean execute_txns, AB_BANKING *api, GtkWidget *parent)
	Import balances and transactions found in a AB_IMEXPORTER_CONTEXT into GnuCash. More...
guint	gnc_ab_ieci_get_found (GncABImExContextImport *ieci)
	Extract awaiting from data. More...
GNC_AB_JOB_LIST2 *	gnc_ab_ieci_get_job_list (GncABImExContextImport *ieci)
	Extract the job list from data. More...
gboolean	gnc_ab_ieci_run_matcher (GncABImExContextImport *ieci)
	Run the generic transaction matcher dialog. More...
GWEN_DB_NODE *	gnc_ab_get_permanent_certs (void)
	get the GWEN_DB_NODE from AqBanking configuration files More...
gchar *	gnc_ab_create_online_id (const gchar *bankcode, const gchar *accountnumber)
	Creates an online ID from bank code and account number. More...
GList *	gnc_ab_imexporter_list (AB_BANKING *abi)
	Retrieve the available AQBanking importers. More...
GList *	gnc_ab_imexporter_profile_list (AB_BANKING *abi, const char *importer_name)
	Retrieve the available format templates for an AQBanking importer. More...
G_BEGIN_DECLS void	gnc_file_aqbanking_import_dialog (GtkWindow *parent)
	Import files via AQBanking's Import Dialog. More...
void	ini_flicker_gui (const char *pChallenge, GncFlickerGui *gui)
	Initialize the dialog and drawing area. More...
void	gnc_GWEN_Gui_log_init (void)
	Hook our logging into the gwenhywfar logging framework by creating a minimalistic GWEN_GUI with only a callback for Gwen_Gui_LogHook(). More...
GncGWENGui *	gnc_GWEN_Gui_get (GtkWidget *parent)
	When called for the first time, create a unique GncGWENGui object featuring a GWEN_GUI with all necessary callbacks, which can serve as a user interface for AqBanking jobs. More...
void	gnc_GWEN_Gui_release (GncGWENGui *gui)
	Currently a no-op. More...
void	gnc_GWEN_Gui_shutdown (void)
	Free all memory related to both the full-blown and minimalistic GUI objects.
void	gnc_GWEN_Gui_set_close_flag (gboolean close_when_finished)
	Set "Close when finished" flag. More...
gboolean	gnc_GWEN_Gui_get_close_flag (void)
	Get "Close when finished" flag. More...
gboolean	gnc_GWEN_Gui_show_dialog (void)
	Unhides Online Banking Connection Window (Make log visible) More...
void	gnc_GWEN_Gui_hide_dialog (void)
	Hides Online Banking Connection Window (Close log window) More...
GncPlugin *	gnc_plugin_aqbanking_new (void)
void	gnc_plugin_aqbanking_create_plugin (void)
	Create a new GncPluginAqBanking object and register it.
void	gnc_plugin_aqbanking_set_logwindow_visible (gboolean logwindow_visible)
	Set MENU_TOGGLE_ACTION_AB_VIEW_LOGWINDOW.

Variables
GtkWidget *	GncFlickerGui::dialog
GtkWidget *	GncFlickerGui::input_entry
GtkWidget *	GncFlickerGui::flicker_challenge
GtkWidget *	GncFlickerGui::flicker_marker
GtkWidget *	GncFlickerGui::flicker_hbox
GtkAdjustment *	GncFlickerGui::adj_barwidth
GtkAdjustment *	GncFlickerGui::adj_delay
GtkSpinButton *	GncFlickerGui::spin_barwidth
GtkSpinButton *	GncFlickerGui::spin_delay

Account
const gchar *	gnc_ab_get_account_accountid (const Account *a)
	Return accountid string in the Account a. More...
void	gnc_ab_set_account_accountid (Account *a, const gchar *id)
	Set the accountid string in the Account a to id. More...
const gchar *	gnc_ab_get_account_bankcode (const Account *a)
	Return the bankcode string in the Account a. More...
void	gnc_ab_set_account_bankcode (Account *a, const gchar *code)
	Set the bankcode string in the Account a to code. More...
guint32	gnc_ab_get_account_uid (const Account *a)
	Return the unique id for the AB_BANKING account in the Account a. More...
void	gnc_ab_set_account_uid (Account *a, guint32 uid)
	Set the unique id for the AB_BANKING account in the Account a to uid. More...
time64	gnc_ab_get_account_trans_retrieval (const Account *a)
	Return the time of last online transaction retrieval for Account a. More...
void	gnc_ab_set_account_trans_retrieval (Account *a, time64 time)
	Set the time of last online transaction retrieval for Account a. More...

Detailed Description

Macro Definition Documentation

AQBANKING_VERSION_INT

#define AQBANKING_VERSION_INT   (10000 * AQBANKING_VERSION_MAJOR + 100 * AQBANKING_VERSION_MINOR + AQBANKING_VERSION_PATCHLEVEL)

A define that combines the aqbanking version number into one single integer number.

Assumption: Both MINOR and PATCHLEVEL numbers are in the interval [0..99].

Definition at line 48 of file gnc-ab-utils.h.

GWENHYWFAR_VERSION_INT

#define GWENHYWFAR_VERSION_INT   (10000 * GWENHYWFAR_VERSION_MAJOR + 100 * GWENHYWFAR_VERSION_MINOR + GWENHYWFAR_VERSION_PATCHLEVEL)

A define that combines the gwenhywfar version number into one single integer number.

Assumption: Both MINOR and PATCHLEVEL numbers are in the interval [0..99].

Definition at line 53 of file gnc-ab-utils.h.

Function Documentation

gnc_AB_BANKING_delete()

void gnc_AB_BANKING_delete

(

AB_BANKING *

api

)

Delete the AB_BANKING api.

If this is also the one that was cached by gnc_AB_BANKING_new(), then all references are deleted, too.

Parameters

api	AB_BANKING or NULL for the cached AB_BANKING object

Definition at line 207 of file gnc-ab-utils.c.

{
    if (!api)
        api = gnc_AB_BANKING;

    if (api)
    {
        if (api == gnc_AB_BANKING)
        {
            gnc_AB_BANKING = NULL;
            gnc_AB_BANKING_fini (api);
        }

        AB_Banking_free (api);
    }
}

gnc_AB_BANKING_fini()

gint gnc_AB_BANKING_fini

(

AB_BANKING *

api

)

Finish the AB_BANKING api.

If this is also the one that was cached by gnc_AB_BANKING_new(), then finish only if the decremented reference count reaches zero. After this call, you may only call gnc_AB_BANKING_new() to get the api again in a properly initialized state.

Parameters

api	AB_BANKING object

Returns

Zero on success

Definition at line 226 of file gnc-ab-utils.c.

{
    if (api == gnc_AB_BANKING)
    {
        if (--gnc_AB_BANKING_refcount == 0)
        {
            if (gnc_gwengui_extended_by_ABBanking)
                AB_Gui_Unextend (gnc_gwengui_extended_by_ABBanking);
            gnc_gwengui_extended_by_ABBanking = NULL;
            return AB_Banking_Fini (api);
        }
    }
    else
    {
        if (gnc_gwengui_extended_by_ABBanking)
            AB_Gui_Unextend (gnc_gwengui_extended_by_ABBanking);
        gnc_gwengui_extended_by_ABBanking = NULL;
        return AB_Banking_Fini (api);
    }
    return 0;
}

gnc_AB_BANKING_new()

AB_BANKING* gnc_AB_BANKING_new

(

void

)

If there is a cached AB_BANKING object, return it initialized.

Otherwise, create a new AB_BANKING, let it load its environment from its default configuration and cache it.

Returns

The AB_BANKING object

Definition at line 163 of file gnc-ab-utils.c.

{
    AB_BANKING *api;

    if (gnc_AB_BANKING)
    {
        /* API cached. */
        api = gnc_AB_BANKING;

        /* Init the API again. */
        if (gnc_AB_BANKING_refcount == 0)
            g_return_val_if_fail (AB_Banking_Init (api) == 0, NULL);

    }
    else
    {
        api = AB_Banking_new (PROJECT_NAME, NULL, 0);
        g_return_val_if_fail (api, NULL);

        /* These two values must be set because newest bank regulation requires
        the bank servers to require it. The string itself results from our
        registration with the German bank association at
        https://www.hbci-zka.de/register/prod_register.htm (where the
        registration was requested and is managed by cstim). The function call was
        introduced in aqbanking-5.99.25 and aqbanking-5.7.9. */
        AB_Banking_RuntimeConfig_SetCharValue (api, "fintsRegistrationKey", "412748A1836CDD07181CE1910");
        AB_Banking_RuntimeConfig_SetCharValue (api, "fintsApplicationVersionString", PROJECT_VERSION);

        /* Init the API */
        g_return_val_if_fail (AB_Banking_Init (api) == 0, NULL);
        gnc_gwengui_extended_by_ABBanking = GWEN_Gui_GetGui ();
        AB_Gui_Extend (gnc_gwengui_extended_by_ABBanking, api);

        /* Cache it */
        gnc_AB_BANKING = api;
        gnc_AB_BANKING_refcount = 0;
    }

    gnc_AB_BANKING_refcount++;

    return api;
}

gnc_ab_create_online_id()

gchar* gnc_ab_create_online_id	(	const gchar *	bankcode,
		const gchar *	accountnumber
	)

Creates an online ID from bank code and account number.

The returned string must be g_free'd by the caller.

Parameters

bankcode	Bank code
accountnumber	Account number

Returns

an online ID

Definition at line 295 of file gnc-ab-utils.c.

{
    gchar *online_id;

    /* The accountnumber may have leading zeros, depending on where them
     * accountnumber is came from, e.g. the accountnumber of accountinfo
     * has no leading zeros while the (local)accountnumber of a transaction
     * has leading zeros.
     * So remove all leading '0', to get a consistent online_id.
     */
    while (accountnumber && *accountnumber == '0')
        accountnumber++;

    online_id = g_strconcat (bankcode ? bankcode : "",
                             accountnumber ? accountnumber : "",
                             (gchar*)NULL);

    return online_id;
}

gnc_ab_description_to_gnc()

gchar* gnc_ab_description_to_gnc	(	const AB_TRANSACTION *	ab_trans,
		gboolean	is_ofx
	)

Create the appropriate description field for a GnuCash Transaction by the information given in the AB_TRANSACTION ab_trans.

The returned string must be g_free'd by the caller.

Parameters

ab_trans

AqBanking transaction

Returns

A newly allocated string, may be ""

Definition at line 425 of file gnc-ab-utils.c.

{
    GList *acc = NULL;
    gchar *retval;

    acc = g_list_prepend (acc, gnc_ab_get_remote_name (ab_trans));
    acc = g_list_prepend (acc, gnc_ab_get_purpose (ab_trans, is_ofx));
    acc = g_list_prepend (acc, ab_ultimate_creditor_debtor_to_gnc (ab_trans, is_ofx));
    retval = gnc_g_list_stringjoin_nodups (acc, "; ");

    g_list_free_full (acc, g_free);
    return retval ? retval : g_strdup (_("Unspecified"));
}

gnc_ab_enter_daterange()

G_BEGIN_DECLS gboolean gnc_ab_enter_daterange	(	GtkWidget *	parent,
		const char *	heading,
		time64 *	from_date,
		gboolean *	last_retv_date,
		gboolean *	first_possible_date,
		time64 *	to_date,
		gboolean *	to_now
	)

Show a dialog to pick a time frame using a sensible set of default options.

Parameters

parent	Widget to use as parent, may be NULL
heading	Descriptive text showed at the top, may be NULL
from_date	Location to read from the initial and write to the final value of the from date entry
last_retv_date	Location to read from whether the caller knows the last retrieval date and write to whether the corresponding button has been chosen
first_possible_date	Location to write to whether the earliest possible date button has been chosen
to_date	Location to read from the initial and write to the final value of the to date entry
to_now	Location to write to whether the to now button has been chosen

Definition at line 52 of file dialog-ab-daterange.c.

{
    GtkBuilder *builder;
    GtkWidget *dialog;
    GtkWidget *heading_label;
    GtkWidget *first_button;
    GtkWidget *last_retrieval_button;
    GtkWidget *now_button;
    DaterangeInfo info;
    gint result;

    ENTER("");

    builder = gtk_builder_new();
    gnc_builder_add_from_file (builder, "dialog-ab.glade", "aqbanking_date_range_dialog");

    dialog = GTK_WIDGET(gtk_builder_get_object (builder, "aqbanking_date_range_dialog"));

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

    if (parent)
        gtk_window_set_transient_for(GTK_WINDOW(dialog), GTK_WINDOW(parent));

    heading_label  = GTK_WIDGET(gtk_builder_get_object (builder, "date_heading_label"));
    first_button  = GTK_WIDGET(gtk_builder_get_object (builder, "first_button"));
    last_retrieval_button  = GTK_WIDGET(gtk_builder_get_object (builder, "last_retrieval_button"));
    info.enter_from_button  = GTK_WIDGET(gtk_builder_get_object (builder, "enter_from_button"));
    now_button  = GTK_WIDGET(gtk_builder_get_object (builder, "now_button"));
    info.enter_to_button  = GTK_WIDGET(gtk_builder_get_object (builder, "enter_to_button"));

    info.from_dateedit = gnc_date_edit_new (*from_date, FALSE, FALSE);
    gtk_container_add(GTK_CONTAINER(gtk_builder_get_object (builder, "enter_from_box")),
                      info.from_dateedit);
    gtk_widget_show(info.from_dateedit);

    info.to_dateedit = gnc_date_edit_new (*to_date, FALSE, FALSE);
    gtk_container_add(GTK_CONTAINER(gtk_builder_get_object (builder, "enter_to_box")),
                      info.to_dateedit);
    gtk_widget_show(info.to_dateedit);

    if (*last_retv_date)
    {
        gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(last_retrieval_button),
                                     TRUE);
    }
    else
    {
        gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(first_button), TRUE);
        gtk_widget_set_sensitive(last_retrieval_button, FALSE);
    }

    gtk_widget_set_sensitive(info.from_dateedit, FALSE);
    gtk_widget_set_sensitive(info.to_dateedit, FALSE);

    gtk_dialog_set_default_response(GTK_DIALOG(dialog), GTK_RESPONSE_OK);

    if (heading)
        gtk_label_set_text(GTK_LABEL(heading_label), heading);

    gtk_widget_show(dialog);

    result = gtk_dialog_run(GTK_DIALOG(dialog));
    gtk_widget_hide(dialog);

    if (result == GTK_RESPONSE_OK)
    {
        *from_date = gnc_date_edit_get_date(GNC_DATE_EDIT(info.from_dateedit));
        *last_retv_date = gtk_toggle_button_get_active(
                              GTK_TOGGLE_BUTTON(last_retrieval_button));
        *first_possible_date = gtk_toggle_button_get_active(
                                   GTK_TOGGLE_BUTTON(first_button));
        *to_date = gnc_date_edit_get_date (GNC_DATE_EDIT(info.to_dateedit));
        *to_now = gtk_toggle_button_get_active(
                      GTK_TOGGLE_BUTTON(now_button));
    }

    g_object_unref(G_OBJECT(builder));

    gtk_widget_destroy(dialog);

    LEAVE("");
    return result == GTK_RESPONSE_OK;
}

gnc_ab_get_ab_account()

GNC_AB_ACCOUNT_SPEC* gnc_ab_get_ab_account	(	const AB_BANKING *	api,
		Account *	gnc_acc
	)

Get the corresponding AqBanking account to the GnuCash account gnc_acc.

Of course this only works after the GnuCash account has been set up for AqBanking use, i.e. the account's hbci data have been set up and populated.

Parameters

api	The AB_BANKING to get the GNC_AB_ACCOUNT_SPEC from
gnc_acc	The GnuCash account to query for GNC_AB_ACCOUNT_SPEC reference data

Returns

The GNC_AB_ACCOUNT_SPEC found or NULL otherwise

Definition at line 249 of file gnc-ab-utils.c.

{
    GNC_AB_ACCOUNT_SPEC *ab_account = NULL;
    const gchar *bankcode = NULL;
    const gchar *accountid = NULL;
    guint32 account_uid = 0;

    bankcode = gnc_ab_get_account_bankcode (gnc_acc);
    accountid = gnc_ab_get_account_accountid (gnc_acc);
    account_uid = gnc_ab_get_account_uid (gnc_acc);

    if (account_uid > 0)
    {
        gint rv;

        rv = AB_Banking_GetAccountSpecByUniqueId (api, account_uid, &ab_account);

        if ( (rv<0 || !ab_account) && bankcode && *bankcode &&
             accountid && *accountid)
        {
/* Finding the account by code and number is suspended in AQBANKING 6 pending
 * implementation of a replacement for AB_Banking_GetAccountByCodeAndNumber.
 */
            PINFO("gnc_ab_get_ab_account: No AB_ACCOUNT found for UID %d, "
                      "trying bank code\n", account_uid);
            return NULL;
        }
        return ab_account;
    }

    return NULL;
}

gnc_ab_get_account_accountid()

const gchar* gnc_ab_get_account_accountid

(

const Account *

a

)

Return accountid string in the Account a.

Parameters

a

Account

Returns

Account ID

Definition at line 39 of file gnc-ab-kvp.c.

{
    gchar *id = NULL;
    qof_instance_get (QOF_INSTANCE (a),
              "ab-account-id", &id,
              NULL);
    return id;
}

gnc_ab_get_account_bankcode()

const gchar* gnc_ab_get_account_bankcode

(

const Account *

a

)

Return the bankcode string in the Account a.

Parameters

a

Account

Returns

Bank code

Definition at line 59 of file gnc-ab-kvp.c.

{
    gchar *code = NULL;
    qof_instance_get (QOF_INSTANCE (a),
              "ab-bank-code", &code,
              NULL);
    return code;
}

gnc_ab_get_account_trans_retrieval()

time64 gnc_ab_get_account_trans_retrieval

(

const Account *

a

)

Return the time of last online transaction retrieval for Account a.

Parameters

a

Account

Returns

Retrieval time

Definition at line 99 of file gnc-ab-kvp.c.

{
    Time64 *t = NULL;
    qof_instance_get (QOF_INSTANCE (a),
              "ab-trans-retrieval", &t,
              NULL);
    return t ? t->t : 0;
}

gnc_ab_get_account_uid()

guint32 gnc_ab_get_account_uid

(

const Account *

a

)

Return the unique id for the AB_BANKING account in the Account a.

Parameters

a

Account

Returns

Unique ID

Definition at line 79 of file gnc-ab-kvp.c.

{
    guint64 uid = 0LL;
    qof_instance_get (QOF_INSTANCE (a),
              "ab-account-uid", &uid,
              NULL);
    return (guint32)uid;
}

gnc_ab_get_permanent_certs()

GWEN_DB_NODE* gnc_ab_get_permanent_certs

(

void

)

get the GWEN_DB_NODE from AqBanking configuration files

Returns

a GWEN_DB containing all permanently accepted SSL certificates (hashed).

Definition at line 1167 of file gnc-ab-utils.c.

{
    int rv;
    GWEN_DB_NODE *perm_certs = NULL;
    AB_BANKING *banking = gnc_AB_BANKING_new ();

    g_return_val_if_fail (banking, NULL);
    rv = AB_Banking_LoadSharedConfig (banking, "certs", &perm_certs);
    gnc_AB_BANKING_fini (banking);
    g_return_val_if_fail (rv >= 0, NULL);
    return perm_certs;
}

gnc_ab_get_purpose()

gchar* gnc_ab_get_purpose	(	const AB_TRANSACTION *	ab_trans,
		gboolean	is_ofx
	)

Retrieve the merged purpose fields from a transaction.

The returned string must be g_free'd by the caller. If there was no purpose, an empty (but allocated) string is returned.

Parameters

ab_trans

AqBanking transaction

Returns

A newly allocated string, may be ""

Definition at line 370 of file gnc-ab-utils.c.

{
    GWEN_STRINGLIST *ab_purpose;
    const char *ab_transactionText = NULL;
    gchar *gnc_description = NULL;

    g_return_val_if_fail (ab_trans, g_strdup (""));

    if (!is_ofx && gnc_prefs_get_bool (GNC_PREFS_GROUP_AQBANKING, GNC_PREF_USE_TRANSACTION_TXT))
    {
        /* According to AqBanking, some of the non-swift lines have a special
         * meaning. Some banks place valuable text into the transaction text,
         * hence we put this text in front of the purpose. */
        ab_transactionText = AB_Transaction_GetTransactionText (ab_trans);
        if (ab_transactionText && *ab_transactionText)
            gnc_description = g_utf8_normalize (ab_transactionText, -1, G_NORMALIZE_NFC);
    }

    ab_purpose = AB_Transaction_GetPurposeAsStringList (ab_trans);
    if (ab_purpose)
        GWEN_StringList_ForEach (ab_purpose, join_ab_strings_cb,
                                 &gnc_description);

    GWEN_StringList_free (ab_purpose);

    return gnc_description;
}

gnc_ab_get_remote_name()

gchar* gnc_ab_get_remote_name

(

const AB_TRANSACTION *

ab_trans

)

Retrieve the merged "remote name" fields from a transaction.

The returned string must be g_free'd by the caller. If there was no "remote name" field, NULL (!) is returned.

Parameters

ab_trans

AqBanking transaction

Returns

A newly allocated string or NULL otherwise

Definition at line 350 of file gnc-ab-utils.c.

{
    const char* ab_remote_name;
    gchar *gnc_other_name = NULL;

    g_return_val_if_fail (ab_trans, NULL);

    ab_remote_name = AB_Transaction_GetRemoteName (ab_trans);
    if (ab_remote_name)
        gnc_other_name = g_strdup(ab_remote_name);
    if (!gnc_other_name || !*gnc_other_name)
    {
        g_free (gnc_other_name);
        gnc_other_name = NULL;
    }

    return gnc_other_name;
}

gnc_ab_get_trans_job()

GNC_AB_JOB* gnc_ab_get_trans_job	(	GNC_AB_ACCOUNT_SPEC *	ab_acc,
		const AB_TRANSACTION *	ab_trans,
		GncABTransType	trans_type
	)

Return the AqBanking job associated with the transaction.

Parameters

td	Transaction dialog

Returns

An AQBanking job

Definition at line 866 of file dialog-ab-trans.c.

{
    GNC_AB_JOB *job;

    g_return_val_if_fail(ab_acc && ab_trans, NULL);

    job = gnc_ab_trans_dialog_get_available_empty_job(ab_acc, trans_type);
    if (job)
    {
        AB_TRANSACTION *new_job;

        /* merge transactions */
        new_job=AB_Transaction_dup(ab_trans);
        AB_Transaction_SetCommand(new_job, AB_Transaction_GetCommand(job));
        AB_Transaction_SetUniqueAccountId(new_job,
                                          AB_Transaction_GetUniqueAccountId(job));

        AB_Transaction_free(job);
        return new_job;
    }
    return NULL;

}

gnc_ab_getbalance()

G_BEGIN_DECLS void gnc_ab_getbalance	(	GtkWidget *	parent,
		Account *	gnc_acc
	)

Execute a GetBalance job, show the resulting balance and offer to reconcile the GnuCash account.

Parameters

parent	Widget to use as parent, may be NULL
gnc_acc	GnuCash account to fetch balance for

Definition at line 47 of file gnc-ab-getbalance.c.

{
    AB_BANKING *api;
    GNC_AB_ACCOUNT_SPEC *ab_acc;
    GNC_AB_JOB *job = NULL;
    GNC_AB_JOB_LIST2 *job_list = NULL;
    GncGWENGui *gui = NULL;
    AB_IMEXPORTER_CONTEXT *context = NULL;
    GncABImExContextImport *ieci = NULL;
    GNC_AB_JOB_STATUS job_status;

    g_return_if_fail(parent && gnc_acc);

    /* Get the API */
    api = gnc_AB_BANKING_new();
    if (!api)
    {
        g_warning("gnc_ab_gettrans: Couldn't get AqBanking API");
        return;
    }

    /* Get the AqBanking Account */
    ab_acc = gnc_ab_get_ab_account(api, gnc_acc);
    if (!ab_acc)
    {
        g_warning("gnc_ab_getbalance: No AqBanking account found");
        gnc_error_dialog (GTK_WINDOW (parent), _("No valid online banking account assigned."));
        goto cleanup;
    }

    /* Get a GetBalance job and enqueue it */
    if (!AB_AccountSpec_GetTransactionLimitsForCommand(ab_acc, AB_Transaction_CommandGetBalance))
    {
        g_warning("gnc_ab_getbalance: JobGetBalance not available for this "
                  "account");
        gnc_error_dialog (GTK_WINDOW (parent), _("Online action \"Get Balance\" not available for this account."));
        goto cleanup;
    }
    job = AB_Transaction_new();
    AB_Transaction_SetCommand(job, AB_Transaction_CommandGetBalance);
    AB_Transaction_SetUniqueAccountId(job, AB_AccountSpec_GetUniqueId(ab_acc));

    job_list = AB_Transaction_List2_new();
    AB_Transaction_List2_PushBack(job_list, job);
    /* Get a GUI object */
    gui = gnc_GWEN_Gui_get(parent);
    if (!gui)
    {
        g_warning("gnc_ab_getbalance: Couldn't initialize Gwenhywfar GUI");
        goto cleanup;
    }

    /* Create a context to store the results */
    context = AB_ImExporterContext_new();

    /* Execute the job */
    AB_Banking_SendCommands(api, job_list, context);
    /* Ignore the return value of AB_Banking_ExecuteJobs(), as the job's
     * status always describes better whether the job was actually
     * transferred to and accepted by the bank.  See also
     * https://lists.gnucash.org/pipermail/gnucash-de/2008-September/006389.html
     */
    job_status = AB_Transaction_GetStatus(job);
    if (job_status != AB_Transaction_StatusEnqueued
            && job_status != AB_Transaction_StatusPending
            && job_status != AB_Transaction_StatusAccepted)
    {
        g_warning("gnc_ab_getbalance: Error on executing job: %d", job_status);
        gnc_error_dialog (GTK_WINDOW (parent),
                          _("Error on executing job.\n\nStatus: %s"),
                          AB_Transaction_Status_toString(job_status));
        goto cleanup;
    }

    /* Import the results */
    ieci = gnc_ab_import_context(context, AWAIT_BALANCES, FALSE, NULL, parent);

cleanup:
    if (ieci)
        g_free(ieci);
    if (context)
        AB_ImExporterContext_free(context);
    if (gui)
        gnc_GWEN_Gui_release(gui);
     if (job_list)
         AB_Transaction_List2_free(job_list);
     if (job)
         AB_Transaction_free(job);
    gnc_AB_BANKING_fini(api);
}

gnc_ab_gettrans()

G_BEGIN_DECLS void gnc_ab_gettrans	(	GtkWidget *	parent,
		Account *	gnc_acc
	)

Execute a GetTransactions job.

Parameters

parent	Widget to use as parent, may be NULL
gnc_acc	GnuCash account to fetch transactions for

Definition at line 97 of file gnc-ab-gettrans.c.

{
    AB_BANKING *api;
    GNC_AB_ACCOUNT_SPEC *ab_acc;
    GWEN_TIME *from_date = NULL, *to_date = NULL;
    time64 until;
    GNC_AB_JOB *job = NULL;
    GNC_AB_JOB_LIST2 *job_list = NULL;
    GncGWENGui *gui = NULL;
    AB_IMEXPORTER_CONTEXT *context = NULL;
    GncABImExContextImport *ieci = NULL;
    GNC_AB_JOB_STATUS job_status;

    g_return_if_fail(parent && gnc_acc);

    /* Get the API */
    api = gnc_AB_BANKING_new();
    if (!api)
    {
        g_warning("gnc_ab_gettrans: Couldn't get AqBanking API");
        return;
    }
    /* Get the AqBanking Account */
    ab_acc = gnc_ab_get_ab_account(api, gnc_acc);
    if (!ab_acc)
    {
        g_warning("gnc_ab_gettrans: No AqBanking account found");
        gnc_error_dialog (GTK_WINDOW (parent), _("No valid online banking account assigned."));
        goto cleanup;
    }

    /* Get the start and end dates for the GetTransactions job.  */
    if (!gettrans_dates(parent, gnc_acc, &from_date, &to_date))
    {
        DEBUG("gnc_ab_gettrans: gettrans_dates aborted");
        goto cleanup;
    }
    /* Use this as a local storage for the until_time below. */
    until = GWEN_Time_toTime_t(to_date);

    /* Get a GetTransactions job and enqueue it */
    if (!AB_AccountSpec_GetTransactionLimitsForCommand(ab_acc, AB_Transaction_CommandGetTransactions))
    {
        g_warning("gnc_ab_gettrans: JobGetTransactions not available for this "
                  "account");
        gnc_error_dialog (GTK_WINDOW (parent), _("Online action \"Get Transactions\" not available for this account."));
        goto cleanup;
    }
    job = AB_Transaction_new();
    AB_Transaction_SetCommand(job, AB_Transaction_CommandGetTransactions);
    AB_Transaction_SetUniqueAccountId(job, AB_AccountSpec_GetUniqueId(ab_acc));

    if (from_date) /* TODO: this should be simplified */
    {
        GWEN_DATE *dt;

        dt=GWEN_Date_fromLocalTime(GWEN_Time_toTime_t(from_date));
        AB_Transaction_SetFirstDate(job, dt);
        GWEN_Date_free(dt);
    }

    if (to_date)
    {
        GWEN_DATE *dt;

        dt=GWEN_Date_fromLocalTime(GWEN_Time_toTime_t(to_date));
        AB_Transaction_SetLastDate(job, dt);
        GWEN_Date_free(dt);
    }

    job_list = AB_Transaction_List2_new();
    AB_Transaction_List2_PushBack(job_list, job);
    /* Get a GUI object */
    gui = gnc_GWEN_Gui_get(parent);
    if (!gui)
    {
        g_warning("gnc_ab_gettrans: Couldn't initialize Gwenhywfar GUI");
        goto cleanup;
    }

    /* Create a context to store the results */
    context = AB_ImExporterContext_new();

    /* Execute the job */
    AB_Banking_SendCommands(api, job_list, context);

    /* Ignore the return value of AB_Banking_ExecuteJobs(), as the job's
     * status always describes better whether the job was actually
     * transferred to and accepted by the bank.  See also
     * https://lists.gnucash.org/pipermail/gnucash-de/2008-September/006389.html
     */
    job_status = AB_Transaction_GetStatus(job);
    if (job_status != AB_Transaction_StatusAccepted
            && job_status != AB_Transaction_StatusPending)
    {
        g_warning("gnc_ab_gettrans: Error on executing job");
        gnc_error_dialog (GTK_WINDOW (parent),
                          _("Error on executing job.\n\nStatus: %s (%d)"),
                          AB_Transaction_Status_toString(job_status),
                          job_status);
        goto cleanup;
    }

    /* Import the results */
    ieci = gnc_ab_import_context(context, AWAIT_TRANSACTIONS, FALSE, NULL,
                                 parent);
    if (!(gnc_ab_ieci_get_found(ieci) & FOUND_TRANSACTIONS))
    {
        /* No transaction found */
        GtkWidget *dialog = gtk_message_dialog_new(
                                GTK_WINDOW(parent),
                                GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
                                GTK_MESSAGE_INFO,
                                GTK_BUTTONS_OK,
                                "%s",
                                _("The Online Banking import returned no transactions "
                                  "for the selected time period."));
        gtk_dialog_run(GTK_DIALOG(dialog));
        gtk_widget_destroy(dialog);
    }

    /* Store the date of this retrieval */
    gnc_ab_set_account_trans_retrieval(gnc_acc, until);

cleanup:
    if (ieci)
        g_free(ieci);
    if (context)
        AB_ImExporterContext_free(context);
    if (gui)
        gnc_GWEN_Gui_release(gui);
    if (job_list)
        AB_Transaction_List2_free(job_list);
    if (job)
        AB_Transaction_free(job);
    if (to_date)
        GWEN_Time_free(to_date);
    if (from_date)
        GWEN_Time_free(from_date);
    gnc_AB_BANKING_fini(api);
}

gnc_ab_ieci_get_found()

guint gnc_ab_ieci_get_found

(

GncABImExContextImport *

ieci

)

Extract awaiting from data.

Parameters

ieci	The return value of gnc_ab_import_context()

Returns

The initial awaiting bitmask plus IGNORE_* for unexpected and then ignored items, and FOUND_* for non-empty items

Definition at line 1143 of file gnc-ab-utils.c.

{
    g_return_val_if_fail (ieci, 0);

    return ieci->awaiting;
}

gnc_ab_ieci_get_job_list()

GNC_AB_JOB_LIST2* gnc_ab_ieci_get_job_list

(

GncABImExContextImport *

ieci

)

Extract the job list from data.

Parameters

ieci	The return value of gnc_ab_import_context()

Returns

The list of jobs, freeable with AB_Job_List2_FreeAll()

Definition at line 1151 of file gnc-ab-utils.c.

{
    g_return_val_if_fail (ieci, NULL);

    return ieci->job_list;
}

gnc_ab_ieci_run_matcher()

gboolean gnc_ab_ieci_run_matcher

(

GncABImExContextImport *

ieci

)

Run the generic transaction matcher dialog.

Parameters

ieci	The return value of gnc_ab_import_context()

Returns

The return value of gnc_gen_trans_list_run().

Definition at line 1159 of file gnc-ab-utils.c.

{
    g_return_val_if_fail (ieci, FALSE);

    return gnc_gen_trans_list_run (ieci->generic_importer);
}

gnc_ab_imexporter_list()

GList* gnc_ab_imexporter_list

(

AB_BANKING *

abi

)

Retrieve the available AQBanking importers.

Parameters

abi	The AQBanking instance.

Returns

a GList<AB_Node_Pair> containing importer names and descriptions.

Definition at line 1230 of file gnc-ab-utils.c.

{
    GList* desc_list = NULL;
    GWEN_PLUGIN_DESCRIPTION_LIST2 *il =
        AB_Banking_GetImExporterDescrs (api);
    GWEN_PLUGIN_DESCRIPTION_LIST2_ITERATOR *ilit;
    g_return_val_if_fail (il, NULL);
    ilit = GWEN_PluginDescription_List2_First(il);

    for (GWEN_PLUGIN_DESCRIPTION *pd =
            GWEN_PluginDescription_List2Iterator_Data(ilit);
         pd;
         pd = GWEN_PluginDescription_List2Iterator_Next(ilit))
    {
        AB_Node_Pair *node = NULL;

        node = g_slice_new (AB_Node_Pair);
        node->name = g_strdup(GWEN_PluginDescription_GetName(pd));
        node->descr = g_strdup(GWEN_PluginDescription_GetShortDescr(pd));
        desc_list = g_list_prepend (desc_list, node);
    }
    GWEN_PluginDescription_List2_free(il);
    return g_list_sort (desc_list, (GCompareFunc)ab_node_pair_compare);
}

gnc_ab_imexporter_profile_list()

GList* gnc_ab_imexporter_profile_list	(	AB_BANKING *	abi,
		const char *	importer_name
	)

Retrieve the available format templates for an AQBanking importer.

Parameters

api	the AQBanking instance.
importer_name	The importer's name.

Returns

a GList<AB_Node_Pair> containing format template names and descriptions.

Definition at line 1256 of file gnc-ab-utils.c.

{
    GList* prof_list = NULL;
    GWEN_DB_NODE* db = AB_Banking_GetImExporterProfiles(api, importer_name);
    g_return_val_if_fail (db, NULL);

    for (GWEN_DB_NODE *profile = GWEN_DB_GetFirstGroup(db); profile;
         profile = GWEN_DB_GetNextGroup(profile))
    {
         AB_Node_Pair *node = g_slice_new(AB_Node_Pair);
        if (!profile) continue;
        node->name = g_strdup(GWEN_DB_GetCharValue(profile, "name", 0, NULL));
        node->descr = g_strdup(GWEN_DB_GetCharValue(profile, "shortDescr", 0, NULL));
        prof_list = g_list_prepend (prof_list, node);
    }
    return g_list_sort (prof_list, (GCompareFunc)ab_node_pair_compare);
}

gnc_ab_import_context()

GncABImExContextImport* gnc_ab_import_context	(	AB_IMEXPORTER_CONTEXT *	context,
		guint	awaiting,
		gboolean	execute_txns,
		AB_BANKING *	api,
		GtkWidget *	parent
	)

Import balances and transactions found in a AB_IMEXPORTER_CONTEXT into GnuCash.

By using awaiting the caller can specify what the user will expect to receive. By using execute_txns, transactions in context can be used to generate corresponding AqBanking jobs, e.g. after a file import.

Parameters

context	AB_IMEXPORTER_CONTEXT to import
awaiting	Information the caller expects to receive or wants to ignore, bitmask of AWAIT_* or IGNORE_* values
execute_txns	If awaiting contains AWAIT_TRANSACTIONS, whether to create an aqbanking job for each of the transactions found
api	If execute_txns is TRUE, the AB_BANKING to get GNC_AB_ACCOUNT_SPECs from
parent	Widget to set new dialogs transient for, may be NULL

Returns

A new GncABImExContextImport object which must be freed with g_free(), or NULL otherwise. If execute_txns is TRUE, additionally gnc_ab_ieci_get_job_list() must be called and the result freed with AB_Job_List2_FreeAll()

Definition at line 1072 of file gnc-ab-utils.c.

{
    GncABImExContextImport *data = g_new (GncABImExContextImport, 1);
    AB_IMEXPORTER_ACCOUNTINFO_LIST *ab_ail;
    g_return_val_if_fail (context, NULL);
    /* Do not await and ignore at the same time */
    g_return_val_if_fail (!(awaiting & AWAIT_BALANCES)
                          || !(awaiting & IGNORE_BALANCES),
                          NULL);
    g_return_val_if_fail (!(awaiting & AWAIT_TRANSACTIONS)
                          || !(awaiting & IGNORE_TRANSACTIONS),
                          NULL);
    /* execute_txns must be FALSE if txns are not awaited */
    g_return_val_if_fail (awaiting & AWAIT_TRANSACTIONS || !execute_txns, NULL);
    /* An api is needed for the jobs */
    g_return_val_if_fail (!execute_txns || api, NULL);

    data->awaiting = awaiting;
    data->txn_found = FALSE;
    data->execute_txns = execute_txns;
    data->api = api;
    data->parent = parent;
    data->job_list = AB_Transaction_List2_new ();
    data->tmp_job_list = NULL;
    data->generic_importer = NULL;

    g_datalist_init (&data->tmp_job_list);

    /* Import transactions */
    ab_ail = AB_ImExporterContext_GetAccountInfoList (context);
    if (ab_ail && AB_ImExporterAccountInfo_List_GetCount (ab_ail))
    {
        if (!(awaiting & IGNORE_TRANSACTIONS))
            AB_ImExporterAccountInfo_List_ForEach (ab_ail, 
                                                   txn_accountinfo_cb,
                                                   data);

        /* populate and display the matching window */
        if (data->generic_importer)
            gnc_gen_trans_list_show_all (data->generic_importer);

        /* Check balances */
        if (!(awaiting & IGNORE_BALANCES))
            AB_ImExporterAccountInfo_List_ForEach (ab_ail,
                                                   bal_accountinfo_cb,
                                                   data);
    }

    /* Check bank-messages */
    {
        AB_MESSAGE * bankmsg = AB_ImExporterContext_GetFirstMessage (context);
        while (bankmsg)
        {
            const char* subject = AB_Message_GetSubject (bankmsg);
            const char* text = AB_Message_GetText (bankmsg);
            gnc_info_dialog (GTK_WINDOW(data->parent), "%s\n%s %s\n%s",
                             _("The bank has sent a message in its response."),
                             _("Subject:"),
                             subject,
                             text);

            bankmsg = AB_Message_List_Next (bankmsg);
        }
    }

    return data;
}

gnc_AB_JOB_ID_to_string()

gchar* gnc_AB_JOB_ID_to_string

(

gulong

job_id

)

Return the job_id as string.

Parameters

job_id

Returns

A newly allocated string

Definition at line 794 of file gnc-ab-utils.c.

{
    return g_strdup_printf ("job_%lu", job_id);
}

gnc_AB_JOB_to_readable_string()

gchar* gnc_AB_JOB_to_readable_string

(

const GNC_AB_JOB *

job

)

Return the job as string.

Parameters

value

GNC_AB_JOB or NULL

Returns

A newly allocated string

Definition at line 782 of file gnc-ab-utils.c.

{
    if (job)
    {
        return gnc_AB_JOB_ID_to_string (AB_Transaction_GetUniqueId (job));
    }
    else
    {
        return gnc_AB_JOB_ID_to_string (0);
    }
}

gnc_ab_maketrans()

G_BEGIN_DECLS void gnc_ab_maketrans	(	GtkWidget *	parent,
		Account *	gnc_acc,
		GncABTransType	trans_type
	)

Create SEPA transfers.

Parameters

parent	Widget to use as parent, may be NULL
gnc_acc	GnuCash account to fetch balance for
trans_type	Type of transaction

Definition at line 80 of file gnc-ab-transfer.c.

{
    AB_BANKING *api;
    GNC_AB_ACCOUNT_SPEC *ab_acc;
    GList *templates = NULL;
    GncABTransDialog *td = NULL;
    gboolean successful = FALSE;
    gboolean aborted = FALSE;

    g_return_if_fail(parent && gnc_acc);

    /* Get the API */
    api = gnc_AB_BANKING_new();
    if (!api)
    {
        g_warning("gnc_ab_maketrans: Couldn't get AqBanking API");
        return;
    }
    /* Get the AqBanking Account */
    ab_acc = gnc_ab_get_ab_account(api, gnc_acc);
    if (!ab_acc)
    {
        g_warning("gnc_ab_gettrans: No AqBanking account found");
        gnc_error_dialog (GTK_WINDOW (parent), _("No valid online banking account assigned."));
        goto cleanup;
    }

#if (AQBANKING_VERSION_INT >= 60400)
    if (trans_type == SEPA_INTERNAL_TRANSFER)
    {
        /* Generate list of template transactions from the reference accounts*/
        templates = gnc_ab_trans_templ_list_new_from_ref_accounts (ab_acc);
        if (templates == NULL)
        {
            g_warning ("gnc_ab_gettrans: No reference accounts found");
            gnc_error_dialog (GTK_WINDOW (parent), _("No reference accounts found."));
            goto cleanup;
        }
    }
    else
#endif
    {
    /* Get list of template transactions */
        templates = gnc_ab_trans_templ_list_new_from_book(
             gnc_account_get_book(gnc_acc));
    }

    /* Create new ABTransDialog */
    td = gnc_ab_trans_dialog_new(parent, ab_acc,
                                 xaccAccountGetCommoditySCU(gnc_acc),
                                 trans_type, templates);
    templates = NULL;

    /* Repeat until AqBanking action was successful or user pressed cancel */
    do
    {
        GncGWENGui *gui = NULL;
        gint result;
        const AB_TRANSACTION *ab_trans;
        GNC_AB_JOB *job = NULL;
        GNC_AB_JOB_LIST2 *job_list = NULL;
        XferDialog *xfer_dialog = NULL;
        gnc_numeric amount;
        gchar *description;
        gchar *memo;
        Transaction *gnc_trans = NULL;
        AB_IMEXPORTER_CONTEXT *context = NULL;
        GNC_AB_JOB_STATUS job_status;
        GncABImExContextImport *ieci = NULL;


        /* Let the user enter the values */
        result = gnc_ab_trans_dialog_run_until_ok(td);

#if (AQBANKING_VERSION_INT >= 60400)
        gboolean changed;
        templates = gnc_ab_trans_dialog_get_templ(td, &changed);
        if (trans_type != SEPA_INTERNAL_TRANSFER && changed)
        {
           /* Save the templates */
            save_templates(parent, gnc_acc, templates,
                           (result == GNC_RESPONSE_NOW));
        }
        g_list_free(templates);
        templates = NULL;
#endif

        if (result != GNC_RESPONSE_NOW && result != GNC_RESPONSE_LATER)
        {
            aborted = TRUE;
            goto repeat;
        }

        /* Get a job and enqueue it */
        ab_trans = gnc_ab_trans_dialog_get_ab_trans(td);
        job = gnc_ab_trans_dialog_get_job(td);
        if (!job || AB_AccountSpec_GetTransactionLimitsForCommand(ab_acc, AB_Transaction_GetCommand(job))==NULL)
        {
            if (!gnc_verify_dialog (
                        GTK_WINDOW (parent), FALSE, "%s",
                        _("The backend found an error during the preparation "
                          "of the job. It is not possible to execute this job.\n"
                          "\n"
                          "Most probable the bank does not support your chosen "
                          "job or your Online Banking account does not have the permission "
                          "to execute this job. More error messages might be "
                          "visible on your console log.\n"
                          "\n"
                          "Do you want to enter the job again?")))
                aborted = TRUE;
            goto repeat;
        }
        job_list = AB_Transaction_List2_new();
        AB_Transaction_List2_PushBack(job_list, job);
        /* Setup a Transfer Dialog for the GnuCash transaction */
        xfer_dialog = gnc_xfer_dialog(gnc_ab_trans_dialog_get_parent(td),
                                      gnc_acc);
        switch (trans_type)
        {
        case SINGLE_DEBITNOTE:
            gnc_xfer_dialog_set_title(
                xfer_dialog, _("Online Banking Direct Debit Note"));
            gnc_xfer_dialog_lock_to_account_tree(xfer_dialog);
            break;
        case SINGLE_INTERNAL_TRANSFER:
            gnc_xfer_dialog_set_title(
                xfer_dialog, _("Online Banking Bank-Internal Transfer"));
            gnc_xfer_dialog_lock_from_account_tree(xfer_dialog);
            break;
        case SEPA_TRANSFER:
            gnc_xfer_dialog_set_title(
                xfer_dialog, _("Online Banking European (SEPA) Transfer"));
            gnc_xfer_dialog_lock_from_account_tree(xfer_dialog);
            break;
#if (AQBANKING_VERSION_INT >= 60400)
        case SEPA_INTERNAL_TRANSFER:
            gnc_xfer_dialog_set_title (
                xfer_dialog, _("Online Banking European (SEPA) Internal Transfer"));
            gnc_xfer_dialog_lock_from_account_tree (xfer_dialog);
            break;
#endif
        case SEPA_DEBITNOTE:
            gnc_xfer_dialog_set_title(
                xfer_dialog, _("Online Banking European (SEPA) Debit Note"));
            gnc_xfer_dialog_lock_to_account_tree(xfer_dialog);
            break;
        case SINGLE_TRANSFER:
        default:
            gnc_xfer_dialog_set_title(
                xfer_dialog, _("Online Banking Transaction"));
            gnc_xfer_dialog_lock_from_account_tree(xfer_dialog);
        }
        gnc_xfer_dialog_set_to_show_button_active(xfer_dialog, TRUE);

        amount = double_to_gnc_numeric(
                     AB_Value_GetValueAsDouble(AB_Transaction_GetValue(ab_trans)),
                     xaccAccountGetCommoditySCU(gnc_acc),
                     GNC_HOW_RND_ROUND_HALF_UP);
        gnc_xfer_dialog_set_amount(xfer_dialog, amount);
        gnc_xfer_dialog_set_amount_sensitive(xfer_dialog, FALSE);
        gnc_xfer_dialog_set_date_sensitive(xfer_dialog, FALSE);

        /* OFX doesn't do transfers. */
        description = gnc_ab_description_to_gnc(ab_trans, FALSE);
        gnc_xfer_dialog_set_description(xfer_dialog, description);
        g_free(description);

        memo = gnc_ab_memo_to_gnc(ab_trans);
        gnc_xfer_dialog_set_memo(xfer_dialog, memo);
        g_free(memo);

        gnc_xfer_dialog_set_txn_cb(xfer_dialog, txn_created_cb, &gnc_trans);

        /* And run it */
        successful = gnc_xfer_dialog_run_until_done(xfer_dialog);

        /* On cancel, go back to the AB transaction dialog */
        if (!successful || !gnc_trans)
        {
            successful = FALSE;
            goto repeat;
        }

        if (result == GNC_RESPONSE_NOW)
        {
            /* Create a context to store possible results */
            context = AB_ImExporterContext_new();

            gui = gnc_GWEN_Gui_get(parent);
            if (!gui)
            {
                g_warning("gnc_ab_maketrans: Couldn't initialize Gwenhywfar GUI");
                aborted = TRUE;
                goto repeat;
            }

            /* Finally, execute the job */
            AB_Banking_SendCommands(api, job_list, context);
            /* Ignore the return value of AB_Banking_ExecuteJobs(), as the job's
             * status always describes better whether the job was actually
             * transferred to and accepted by the bank.  See also
             * https://lists.gnucash.org/pipermail/gnucash-de/2008-September/006389.html
             */
            job_status = AB_Transaction_GetStatus(job);
            if (job_status != AB_Transaction_StatusAccepted
                && job_status != AB_Transaction_StatusPending)
            {
                successful = FALSE;
                if (!gnc_verify_dialog (
                            GTK_WINDOW (parent), FALSE, "%s",
                            _("An error occurred while executing the job. Please check "
                              "the log window for the exact error message.\n"
                              "\n"
                              "Do you want to enter the job again?")))
                {
                    aborted = TRUE;
                }
            }
            else
            {
                successful = TRUE;
            }

            if (successful)
            {
                /* Import the results, awaiting nothing */
                ieci = gnc_ab_import_context(context, 0, FALSE, NULL, parent);
            }
        }
        /* Simply ignore any other case */

repeat:
        /* Clean up */
        if (gnc_trans && !successful)
        {
            xaccTransBeginEdit(gnc_trans);
            xaccTransDestroy(gnc_trans);
            xaccTransCommitEdit(gnc_trans);
            gnc_trans = NULL;
        }
        if (ieci)
            g_free(ieci);
        if (context)
            AB_ImExporterContext_free(context);
        if (job_list)
        {
            AB_Transaction_List2_free(job_list);
            job_list = NULL;
        }
        if (job)
        {
            AB_Transaction_free(job);
            job = NULL;
        }
        if (gui)
        {
            gnc_GWEN_Gui_release(gui);
            gui = NULL;
        }

    }
    while (!successful && !aborted);

cleanup:
    if (td)
        gnc_ab_trans_dialog_free(td);
    gnc_AB_BANKING_fini(api);
}

gnc_ab_memo_to_gnc()

gchar* gnc_ab_memo_to_gnc

(

const AB_TRANSACTION *

ab_trans

)

Create the appropriate memo field for a GnuCash Split by the information given in the AB_TRANSACTION ab_trans.

The returned string must be g_free'd by the caller.

Parameters

ab_trans

AqBanking transaction

Returns

A newly allocated string, may be ""

Definition at line 440 of file gnc-ab-utils.c.

{
    const gchar *ab_remote_accountnumber =
        AB_Transaction_GetRemoteAccountNumber (ab_trans);
    const gchar *ab_remote_bankcode =
        AB_Transaction_GetRemoteBankCode (ab_trans);

    gchar *ab_other_accountid;
    gchar *ab_other_bankcode;

    gboolean have_accountid;
    gboolean have_bankcode;

    gchar *retval;

    // For SEPA transactions, we need to ask for something different here
    if (!ab_remote_accountnumber)
        ab_remote_accountnumber = AB_Transaction_GetRemoteIban (ab_trans);
    if (!ab_remote_bankcode)
        ab_remote_bankcode = AB_Transaction_GetRemoteBic (ab_trans);

    ab_other_accountid = g_strdup (ab_remote_accountnumber ? ab_remote_accountnumber : "");
    ab_other_bankcode = g_strdup (ab_remote_bankcode ? ab_remote_bankcode : "");

    /* Ensure string is in utf8 */
    gnc_utf8_strip_invalid (ab_other_accountid);
    gnc_utf8_strip_invalid (ab_other_bankcode);

    /* and -then- trim it */
    g_strstrip (ab_other_accountid);
    g_strstrip (ab_other_bankcode);


    have_accountid = ab_other_accountid && *ab_other_accountid;
    have_bankcode = ab_other_bankcode && *ab_other_bankcode;

    if ( have_accountid || have_bankcode )
    {
        retval = g_strdup_printf ("%s %s %s %s",
                                  have_accountid ? _("Account") : "",
                                  have_accountid ? ab_other_accountid : "",
                                  have_bankcode  ? _("Bank") : "",
                                  have_bankcode  ? ab_other_bankcode : ""
                                 );
        g_strstrip (retval);
    }
    else
    {
        retval = g_strdup ("");
    }

    g_free (ab_other_accountid);
    g_free (ab_other_bankcode);

    return retval;
}

gnc_ab_select_imex_dlg_destroy()

void gnc_ab_select_imex_dlg_destroy

(

GncABSelectImExDlg *

imexd

)

Destroy an AQBanking importer/exporter selection dialog.

Parameters

imexd

the dialog.

Definition at line 136 of file dialog-ab-select-imexporter.c.

{

    if (imexd->imexporter_list)
        gtk_list_store_clear (imexd->imexporter_list);

    if (imexd->profile_list)
        gtk_list_store_clear (imexd->profile_list);

    if (imexd->dialog)
        gtk_widget_destroy (imexd->dialog);

    g_free (imexd);
}

gnc_ab_select_imex_dlg_get_imexporter_name()

char* gnc_ab_select_imex_dlg_get_imexporter_name

(

GncABSelectImExDlg *

imexd

)

Get the selected importer/exporter name.

Parameters

imexd

the dialog with the selection

Returns

the selected importer/exporter name, free with g_free.

Definition at line 266 of file dialog-ab-select-imexporter.c.

{
    return tree_view_get_name (GTK_TREE_VIEW (imexd->select_imexporter));
}

gnc_ab_select_imex_dlg_get_profile_name()

char* gnc_ab_select_imex_dlg_get_profile_name

(

GncABSelectImExDlg *

imexd

)

Get the selected file format profile name.

Parameters

imexd

the dialog with the selection

Returns

the selected format profile name, free with g_free.

Definition at line 272 of file dialog-ab-select-imexporter.c.

{
    return tree_view_get_name (GTK_TREE_VIEW (imexd->select_profile));
}

gnc_ab_select_imex_dlg_new()

G_BEGIN_DECLS GncABSelectImExDlg* gnc_ab_select_imex_dlg_new	(	GtkWidget *	parent,
		AB_BANKING *	abi
	)

Create an AQBanking importer/exporter selection dialog.

Parameters

parent	A widget to center the dialog over.
abi	The AQBanking instance to query.

Returns

a GncABSelectImExDlg.

Definition at line 80 of file dialog-ab-select-imexporter.c.

{
    GncABSelectImExDlg* imexd;
    GtkBuilder* builder;
    GList* imexporters;
    GtkTreeSelection *imex_select = NULL, *prof_select = NULL;

    g_return_val_if_fail (abi, NULL);
    imexporters = gnc_ab_imexporter_list (abi);
    g_return_val_if_fail (imexporters, NULL);
    imexd = g_new0(GncABSelectImExDlg, 1);
    imexd->parent = parent;
    imexd->abi = abi;

    g_signal_connect (parent, "destroy",
                      G_CALLBACK (gtk_widget_destroyed), &imexd->parent);
    builder = gtk_builder_new();
    gnc_builder_add_from_file (builder, "dialog-ab.glade", "imexporter-list");
    gnc_builder_add_from_file (builder, "dialog-ab.glade", "profile-list");
    gnc_builder_add_from_file (builder, "dialog-ab.glade",
                               "aqbanking-select-imexporter-dialog");
    imexd->dialog =
        GTK_WIDGET (gtk_builder_get_object (builder,
                                            "aqbanking-select-imexporter-dialog"));
    g_signal_connect (imexd->dialog, "destroy",
                      G_CALLBACK (gtk_widget_destroyed), &imexd->dialog);
    imexd->imexporter_list =
        GTK_LIST_STORE (gtk_builder_get_object (builder, "imexporter-list"));
    imexd->profile_list =
        GTK_LIST_STORE (gtk_builder_get_object (builder, "profile-list"));
    imexd->select_imexporter =
        GTK_WIDGET (gtk_builder_get_object (builder, "imexporter-sel"));
    imexd->select_profile =
        GTK_WIDGET (gtk_builder_get_object (builder, "profile-sel"));
    imexd->ok_button =
        GTK_WIDGET (gtk_builder_get_object (builder, "imex-okbutton"));

    imex_select = GTK_TREE_SELECTION (gtk_builder_get_object (builder, "imex-selection"));
    prof_select = GTK_TREE_SELECTION (gtk_builder_get_object (builder, "prof-selection"));
    populate_list_store (imexd->imexporter_list,
                         imexporters);

    g_signal_connect (imex_select, "changed", G_CALLBACK(imexporter_changed),
                      imexd);
    g_signal_connect (prof_select, "changed", G_CALLBACK(profile_changed),
                      imexd);
    g_list_free (imexporters);
    g_object_unref (G_OBJECT (builder));

    gtk_window_set_transient_for (GTK_WINDOW (imexd->dialog),
                                  GTK_WINDOW (imexd->parent));

    return imexd;
}

gnc_ab_select_imex_dlg_run()

int gnc_ab_select_imex_dlg_run

(

GncABSelectImExDlg *

imexd

)

Run an AQBanking importer/exporter selection dialog.

Parameters

imexd

the dialog.

Returns

A GTK_RESPONSE status.

Definition at line 214 of file dialog-ab-select-imexporter.c.

{

    int response = gtk_dialog_run (GTK_DIALOG (imexd->dialog));
    return response == GTK_RESPONSE_OK ? TRUE : FALSE;
}

gnc_ab_select_imex_dlg_set_imexporter_name()

void gnc_ab_select_imex_dlg_set_imexporter_name	(	GncABSelectImExDlg *	imexd,
		const char *	name
	)

Get the selected importer/exporter name.

Parameters

imexd

the dialog with the selection name the importer/exporter name to select.

Definition at line 278 of file dialog-ab-select-imexporter.c.

{
    if (name)
        tree_view_set_name (GTK_TREE_VIEW (imexd->select_imexporter), name);
}

gnc_ab_select_imex_dlg_set_profile_name()

void gnc_ab_select_imex_dlg_set_profile_name	(	GncABSelectImExDlg *	imexd,
		const char *	name
	)

Get the selected file format profile name.

Parameters

imexd	the dialog with the selection
name	the profile to select.

Definition at line 285 of file dialog-ab-select-imexporter.c.

{
    if (name)
        tree_view_set_name (GTK_TREE_VIEW (imexd->select_profile), name);
}

gnc_ab_set_account_accountid()

void gnc_ab_set_account_accountid	(	Account *	a,
		const gchar *	id
	)

Set the accountid string in the Account a to id.

A copy of the string will be stored. The Account will be marked as "dirty".

Parameters

a	Account
id	Account ID

Definition at line 49 of file gnc-ab-kvp.c.

{
    xaccAccountBeginEdit(a);
    qof_instance_set (QOF_INSTANCE (a),
              "ab-account-id", id,
              NULL);
    xaccAccountCommitEdit(a);
}

gnc_ab_set_account_bankcode()

void gnc_ab_set_account_bankcode	(	Account *	a,
		const gchar *	code
	)

Set the bankcode string in the Account a to code.

A copy of the string will be stored. The Account will be marked as "dirty".

Parameters

a	Account
code	Bank code

Definition at line 69 of file gnc-ab-kvp.c.

{
    xaccAccountBeginEdit(a);
    qof_instance_set (QOF_INSTANCE (a),
              "ab-bank-code", code,
              NULL);
    xaccAccountCommitEdit(a);
}

gnc_ab_set_account_trans_retrieval()

void gnc_ab_set_account_trans_retrieval	(	Account *	a,
		time64	time
	)

Set the time of last online transaction retrieval for Account a.

The account will be marked as "dirty".

Parameters

a	Account
time	Retrieval time

Definition at line 109 of file gnc-ab-kvp.c.

{
    Time64 t = {time};
    xaccAccountBeginEdit(a);
    qof_instance_set (QOF_INSTANCE (a),
              "ab-trans-retrieval", &t,
              NULL);
    xaccAccountCommitEdit(a);
}

gnc_ab_set_account_uid()

void gnc_ab_set_account_uid	(	Account *	a,
		guint32	uid
	)

Set the unique id for the AB_BANKING account in the Account a to uid.

The Account will be marked as "dirty".

Parameters

a	Account
uid	Unique ID

Definition at line 89 of file gnc-ab-kvp.c.

{
    xaccAccountBeginEdit(a);
    qof_instance_set (QOF_INSTANCE (a),
              "ab-account-uid", (guint64)uid,
              NULL);
    xaccAccountCommitEdit(a);
}

gnc_ab_set_book_template_list()

void gnc_ab_set_book_template_list	(	QofBook *	b,
		GList *	template_list
	)

Set the GList of kvp_frames of template transactions in the Book b to template_list.

No copy of the GList will be stored, the callee becomes the owner and the caller must not free it. The book will be marked "dirty".

Parameters

b	Book
template_list	Template list

Definition at line 180 of file gnc-aqbanking-templates.cpp.

{
    GList *kvp_list = NULL;
    for (auto node = template_list; node != NULL; node = g_list_next (node))
    {
        auto templ = static_cast<_GncABTransTempl*>(node->data);
        auto value = new KvpValue(templ->make_kvp_frame());
        kvp_list = g_list_prepend (kvp_list, value);
    }
    kvp_list = g_list_reverse (kvp_list);
    auto value = new KvpValue(g_list_copy_deep(kvp_list, copy_list_value,
                                               nullptr));
    qof_book_begin_edit(b);
    KvpFrame *toplevel = qof_instance_get_slots (QOF_INSTANCE (b));
    delete toplevel->set_path({"hbci", "template-list"}, value);
    qof_instance_set_dirty_flag (QOF_INSTANCE (b), TRUE);
    qof_book_commit_edit(b);
}

gnc_ab_trans_dialog_free()

void gnc_ab_trans_dialog_free

(

GncABTransDialog *

td

)

Free a Aqbanking transfer dialog.

Parameters

td	Transaction dialog

Definition at line 749 of file dialog-ab-trans.c.

{
    if (!td) return;
    if (td->ab_trans)
        AB_Transaction_free(td->ab_trans);
    if (td->dialog)
        gtk_widget_destroy(td->dialog);

#if (AQBANKING_VERSION_INT >= 60400)
    if (td->template_list_store)
    {
        gtk_tree_model_foreach(GTK_TREE_MODEL(td->template_list_store),
                               gnc_ab_trans_dialog_clear_templ_helper, NULL);
        g_object_unref(td->template_list_store);
    }
#endif
    g_free(td);
}

gnc_ab_trans_dialog_get_ab_trans()

const AB_TRANSACTION* gnc_ab_trans_dialog_get_ab_trans

(

const GncABTransDialog *

td

)

Receive the Aqbanking Transaction filled by the dialog.

Parameters

td	Transaction dialog

Returns

An Aqbanking transaction

Definition at line 814 of file dialog-ab-trans.c.

{
    g_return_val_if_fail(td, NULL);
    return td->ab_trans;
}

gnc_ab_trans_dialog_get_job()

GNC_AB_JOB* gnc_ab_trans_dialog_get_job

(

const GncABTransDialog *

td

)

Receive the Aqbanking job filled by the dialog.

Parameters

td	Transaction dialog

Returns

An Aqbanking job

Definition at line 859 of file dialog-ab-trans.c.

{
    g_return_val_if_fail(td, NULL);
    return gnc_ab_get_trans_job(td->ab_acc, td->ab_trans, td->trans_type);
}

gnc_ab_trans_dialog_get_parent()

GtkWidget* gnc_ab_trans_dialog_get_parent

(

const GncABTransDialog *

td

)

Retrieve the widget used as parent.

Parameters

td	Transaction dialog

Returns

The parent

Definition at line 807 of file dialog-ab-trans.c.

{
    g_return_val_if_fail(td, NULL);
    return td->parent;
}

gnc_ab_trans_dialog_new()

GncABTransDialog* gnc_ab_trans_dialog_new	(	GtkWidget *	parent,
		GNC_AB_ACCOUNT_SPEC *	ab_acc,
		gint	commodity_scu,
		GncABTransType	trans_type,
		GList *	templates
	)

Create a new AqBanking transfer dialog.

Parameters

parent	Widget to use as parent, may be NULL
ab_acc	Aqbanking account
commodity_scu	commodity used for the amount
trans_type	Type of transaction
templates	A GList of template transactions which will become fully managed by the dialog, so do not free it and retrieve snapshots via gnc_ab_trans_dialog_get_templ()

Returns

A new GncABTransDialog, free with gnc_ab_trans_dialog_free()

Definition at line 242 of file dialog-ab-trans.c.

{
    GncABTransDialog *td;
    GtkBuilder  *builder;
    const gchar *ab_ownername;
    const gchar *ab_accountnumber;
    const gchar *ab_bankname;
    const gchar *ab_bankcode;
    G_GNUC_UNUSED GtkWidget *trans_vbox;
    GtkWidget *heading_label;
    GtkWidget *recp_name_heading;
    GtkWidget *recp_account_heading;
    GtkWidget *recp_bankcode_heading;
    GtkWidget *amount_hbox, *amount_label;
    GtkWidget *orig_name_heading;
    GtkWidget *orig_account_heading;
    GtkWidget *orig_account_label;
    G_GNUC_UNUSED GtkWidget *orig_bankname_heading;
    GtkWidget *orig_bankname_label;
    GtkWidget *orig_bankcode_heading;
    GtkWidget *orig_bankcode_label;
    GtkCellRenderer *renderer;
    GtkTreeViewColumn *column;
#if (AQBANKING_VERSION_INT >= 60400)
    GtkExpander *template_expander;
    GtkWidget *template_label;
    GtkWidget *add_templ_button;
    GtkWidget *del_templ_button;
#endif

    g_return_val_if_fail(ab_acc, NULL);

    ab_ownername = AB_AccountSpec_GetOwnerName(ab_acc);
    if (!ab_ownername)
        ab_ownername = "";
    ab_accountnumber = AB_AccountSpec_GetAccountNumber(ab_acc);
    ab_bankcode = AB_AccountSpec_GetBankCode(ab_acc);
    ab_bankname = _("(unknown)");

    td = g_new0(GncABTransDialog, 1);
    td->parent = parent;
    td->ab_acc = ab_acc;
    td->trans_type = trans_type;

    builder = gtk_builder_new();
    gnc_builder_add_from_file (builder, "dialog-ab.glade", "aqbanking_transaction_dialog");
    td->dialog = GTK_WIDGET(gtk_builder_get_object (builder, "aqbanking_transaction_dialog"));

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

    /* Extract widgets */
    trans_vbox = GTK_WIDGET(gtk_builder_get_object (builder, "trans_vbox"));
    heading_label = GTK_WIDGET(gtk_builder_get_object (builder, "heading_label"));
    recp_name_heading = GTK_WIDGET(gtk_builder_get_object (builder, "recp_name_heading"));
    td->recp_name_entry = GTK_WIDGET(gtk_builder_get_object (builder, "recp_name_entry"));
    recp_account_heading = GTK_WIDGET(gtk_builder_get_object (builder, "recp_account_heading"));
    td->recp_account_entry = GTK_WIDGET(gtk_builder_get_object (builder, "recp_account_entry"));
    recp_bankcode_heading = GTK_WIDGET(gtk_builder_get_object (builder, "recp_bankcode_heading"));
    td->recp_bankcode_entry = GTK_WIDGET(gtk_builder_get_object (builder, "recp_bankcode_entry"));
    td->recp_bankname_label = GTK_WIDGET(gtk_builder_get_object (builder, "recp_bankname_label"));
    amount_hbox = GTK_WIDGET(gtk_builder_get_object (builder, "amount_hbox"));
    amount_label = GTK_WIDGET(gtk_builder_get_object (builder, "amount_label"));
    td->purpose_entry = GTK_WIDGET(gtk_builder_get_object (builder, "purpose_entry"));
    td->purpose_cont_entry = GTK_WIDGET(gtk_builder_get_object (builder, "purpose_cont_entry"));
    td->purpose_cont2_entry = GTK_WIDGET(gtk_builder_get_object (builder, "purpose_cont2_entry"));
    td->purpose_cont3_entry = GTK_WIDGET(gtk_builder_get_object (builder, "purpose_cont3_entry"));
    td->exec_button = GTK_WIDGET(gtk_builder_get_object(builder, "exec_now_button"));
    orig_name_heading = GTK_WIDGET(gtk_builder_get_object (builder, "orig_name_heading"));
    td->orig_name_entry = GTK_WIDGET(gtk_builder_get_object (builder, "orig_name_label"));
    orig_account_heading = GTK_WIDGET(gtk_builder_get_object (builder, "orig_account_heading"));
    orig_account_label = GTK_WIDGET(gtk_builder_get_object (builder, "orig_account_label"));
    orig_bankname_heading = GTK_WIDGET(gtk_builder_get_object (builder, "orig_bankname_heading"));
    orig_bankname_label = GTK_WIDGET(gtk_builder_get_object (builder, "orig_bankname_label"));
    orig_bankcode_heading = GTK_WIDGET(gtk_builder_get_object (builder, "orig_bankcode_heading"));
    orig_bankcode_label = GTK_WIDGET(gtk_builder_get_object (builder, "orig_bankcode_label"));
    td->template_gtktreeview =
        GTK_TREE_VIEW(gtk_builder_get_object (builder, "template_list"));
#if (AQBANKING_VERSION_INT >= 60400)
    template_expander = GTK_EXPANDER(gtk_builder_get_object (builder, "expander1"));
    template_label = GTK_WIDGET(gtk_builder_get_object (builder, "label1"));
    add_templ_button= GTK_WIDGET(gtk_builder_get_object(builder, "add_templ_button"));
    del_templ_button= GTK_WIDGET(gtk_builder_get_object(builder, "del_templ_button"));
#endif

    /* Amount edit */
    td->amount_edit = gnc_amount_edit_new();
    gtk_box_pack_start(GTK_BOX(amount_hbox), td->amount_edit, TRUE, TRUE, 0);
    gnc_amount_edit_make_mnemonic_target(GNC_AMOUNT_EDIT(td->amount_edit), amount_label);
    gnc_amount_edit_set_evaluate_on_enter(GNC_AMOUNT_EDIT(td->amount_edit),
                                          TRUE);
    gnc_amount_edit_set_fraction(GNC_AMOUNT_EDIT(td->amount_edit),
                                 commodity_scu);

    /* Use "focus-out" signal because "amount-changed" is only sent when ENTER is pressed */
    g_signal_connect_swapped (gnc_amount_edit_gtk_entry(GNC_AMOUNT_EDIT(td->amount_edit)), "focus-out-event",
                              G_CALLBACK(gnc_ab_trans_dialog_verify_values), td);

    /* Check for what kind of transaction this should be, and change the
     * labels accordingly */
    switch (trans_type)
    {
    case SINGLE_TRANSFER:
    case SINGLE_INTERNAL_TRANSFER:
        /* all labels are already set */
        break;
    case SEPA_TRANSFER:
        gtk_label_set_text(GTK_LABEL (heading_label),
                           /* Translators: Strings from this file are
                              needed only in countries that have one of
                              aqbanking's Online Banking techniques
                              available. This is 'OFX DirectConnect'
                              (U.S. and others), 'HBCI' (Germany),
                              or 'YellowNet' (Switzerland). If none of
                              these techniques are available in your
                              country, you may safely ignore strings
                              from the import-export/hbci
                              subdirectory. */
                           _("Enter a SEPA Online Transfer"));
        gtk_label_set_text(GTK_LABEL(recp_account_heading),
                           _("Recipient IBAN (International Account Number)"));
        gtk_label_set_text(GTK_LABEL(recp_bankcode_heading),
                           _("Recipient BIC (Bank Code)"));

        gtk_label_set_text(GTK_LABEL(orig_account_heading),
                           _("Originator IBAN (International Account Number)"));
        gtk_label_set_text(GTK_LABEL(orig_bankcode_heading),
                           _("Originator BIC (Bank Code)"));
        break;

#if (AQBANKING_VERSION_INT >= 60400)
    case SEPA_INTERNAL_TRANSFER:
        gtk_label_set_text(GTK_LABEL (heading_label),
                           _("Enter a SEPA Internal Transfer"));
        gtk_label_set_text(GTK_LABEL(recp_account_heading),
                           _("Recipient IBAN (International Account Number)"));
        gtk_label_set_text(GTK_LABEL(recp_bankcode_heading),
                           _("Recipient BIC (Bank Code)"));

        gtk_label_set_text(GTK_LABEL(orig_account_heading),
                           _("Originator IBAN (International Account Number)"));
        gtk_label_set_text(GTK_LABEL(orig_bankcode_heading),
                           _("Originator BIC (Bank Code)"));
    /* Disable target account entry for SEPA internal transfers, but only let choose from templates */
        gtk_widget_set_sensitive(td->recp_name_entry, FALSE);
        gtk_widget_set_sensitive(td->recp_account_entry, FALSE);
        gtk_widget_set_sensitive(td->recp_bankcode_entry, FALSE);
        gtk_widget_set_sensitive(add_templ_button, FALSE);
        gtk_widget_set_visible(add_templ_button, FALSE);
        gtk_widget_set_can_focus(add_templ_button, FALSE);
        gtk_widget_set_sensitive(del_templ_button, FALSE);
        gtk_widget_set_visible(del_templ_button, FALSE);
        gtk_widget_set_can_focus(del_templ_button, FALSE);
        gtk_label_set_text(GTK_LABEL(template_label),
                           _("Target Accounts"));
        gtk_expander_set_expanded(template_expander, TRUE);
        break;
#endif

    case SINGLE_DEBITNOTE:
        /* this case is no longer in use; don't introduce extra strings */
        break;

    case SEPA_DEBITNOTE:
        gtk_label_set_text(GTK_LABEL (heading_label),
                           _("Enter a SEPA Online Direct Debit Note"));

        gtk_label_set_text(GTK_LABEL(recp_name_heading),
                           _("Debited Account Owner"));
        gtk_label_set_text(GTK_LABEL(recp_account_heading),
                           _("Debited IBAN (International Account Number)"));
        gtk_label_set_text(GTK_LABEL(recp_bankcode_heading),
                           _("Debited BIC (Bank Code)"));

        gtk_label_set_text(GTK_LABEL(orig_name_heading),
                           _("Credited Account Owner"));
        gtk_label_set_text(GTK_LABEL(orig_account_heading),
                           _("Credited IBAN (International Account Number)"));
        gtk_label_set_text(GTK_LABEL(orig_bankcode_heading),
                           _("Credited BIC (Bank Code)"));
        break;

    default:
        g_critical("gnc_ab_trans_dialog_new: Oops, unknown GncABTransType %d",
                   trans_type);
        break;
    }

    /* Additionally change the labels for the European (SEPA) transactions */
    if (gnc_ab_trans_isSEPA(trans_type))
    {
        // Also, SEPA might have much longer IBAN (up to 34 chars) and BIC (11)
        gtk_entry_set_max_length(GTK_ENTRY(td->recp_bankcode_entry), 11);
        gtk_entry_set_max_length(GTK_ENTRY(td->recp_account_entry), 34);
    }

    gtk_entry_set_text(GTK_ENTRY(td->orig_name_entry), ab_ownername);
    gtk_label_set_text(GTK_LABEL(orig_bankname_label), ab_bankname);
    if (gnc_ab_trans_isSEPA(trans_type))
    {
        gtk_widget_set_sensitive(GTK_WIDGET(td->orig_name_entry), TRUE);
        ab_accountnumber = AB_AccountSpec_GetIban(ab_acc);
        ab_bankcode = AB_AccountSpec_GetBic(ab_acc);
        gtk_label_set_text(GTK_LABEL(orig_account_label), ab_accountnumber);
        gtk_label_set_text (GTK_LABEL (orig_bankcode_label), ab_bankcode);
    }
    else
    {
        gtk_widget_set_sensitive(GTK_WIDGET(td->orig_name_entry), FALSE);
        gtk_label_set_text(GTK_LABEL(orig_account_label), ab_accountnumber);
        gtk_label_set_text (GTK_LABEL (orig_bankcode_label), ab_bankcode);
    }

#if (AQBANKING_VERSION_INT >= 60400)
    /* Fill list for choosing a transaction template */
    td->template_list_store = gtk_list_store_new(TEMPLATE_NUM_COLUMNS,
                              G_TYPE_STRING, G_TYPE_POINTER);
    g_list_foreach(templates, gnc_ab_trans_dialog_fill_templ_helper, td->template_list_store);
    gtk_tree_view_set_model(td->template_gtktreeview,
                            GTK_TREE_MODEL(td->template_list_store));
    td->templ_changed = FALSE;
    /* Keep a reference to the store */
#endif
    /* Show this list */
    renderer = gtk_cell_renderer_text_new();
    column = gtk_tree_view_column_new_with_attributes(
                 "Template Name", renderer, "text", TEMPLATE_NAME, NULL);
    gtk_tree_view_append_column(td->template_gtktreeview, column);

    /* Connect the Signals */
    gtk_builder_connect_signals_full(builder, gnc_builder_connect_full_func, td);

    g_object_unref(G_OBJECT(builder));

    /* Disabled OK button until suitable values are filled */
    gnc_ab_trans_dialog_verify_values(td);

    return td;
}

gnc_ab_trans_dialog_run_until_ok()

gint gnc_ab_trans_dialog_run_until_ok

(

GncABTransDialog *

td

)

Run the Aqbanking transfer dialog until correct values where entered or the user cancelled the dialog.

Parameters

td	Transaction dialog
ab_acc	AqBanking account

Returns

GTK_RESPONSE_CANCEL or GTK_RESPONSE_DESTROY_EVENT if the user cancelled the dialog and GNC_RESPONSE_NOW otherwise.

Definition at line 662 of file dialog-ab-trans.c.

{
    gint result;
    GNC_AB_JOB *job;
    const AB_TRANSACTION_LIMITS *joblimits;
    guint8 max_purpose_lines;

    /* Check whether the account supports this job */
    job = gnc_ab_trans_dialog_get_available_empty_job(td->ab_acc, td->trans_type);
    if (!job)
    {
        g_warning("gnc_ab_trans_dialog_run_until_ok: Oops, job not available");
        return GTK_RESPONSE_CANCEL;
    }

    /* Activate as many purpose entries as available for the job */
    joblimits = AB_AccountSpec_GetTransactionLimitsForCommand(td->ab_acc, AB_Transaction_GetCommand(job));
    max_purpose_lines = joblimits ?
                        AB_TransactionLimits_GetMaxLinesPurpose(joblimits) : 2;
    gtk_widget_set_sensitive(td->purpose_cont_entry, max_purpose_lines > 1);
    gtk_widget_set_sensitive(td->purpose_cont2_entry, max_purpose_lines > 2);
    gtk_widget_set_sensitive(td->purpose_cont3_entry, max_purpose_lines > 3);
    if (joblimits)
    {
        gtk_entry_set_max_length(GTK_ENTRY(td->purpose_entry),
                                 AB_TransactionLimits_GetMaxLenPurpose(joblimits));
        gtk_entry_set_max_length(GTK_ENTRY(td->purpose_cont_entry),
                                 AB_TransactionLimits_GetMaxLenPurpose(joblimits));
        gtk_entry_set_max_length(GTK_ENTRY(td->purpose_cont2_entry),
                                 AB_TransactionLimits_GetMaxLenPurpose(joblimits));
        gtk_entry_set_max_length(GTK_ENTRY(td->purpose_cont3_entry),
                                 AB_TransactionLimits_GetMaxLenPurpose(joblimits));
        gtk_entry_set_max_length(GTK_ENTRY(td->recp_name_entry),
                                 AB_TransactionLimits_GetMaxLenRemoteName(joblimits));
    }

    /* Show the dialog */
    gtk_widget_show(td->dialog);

    /* Now run the dialog until it gets closed by a button press */
    result = gtk_dialog_run (GTK_DIALOG (td->dialog));

    /* Was cancel pressed or dialog closed?
     *  GNC_RESPONSE_NOW == execute now
     *  GNC_RESPONSE_LATER == scheduled for later execution (unimplemented)
     *  GTK_RESPONSE_CANCEL == cancel
     *  GTK_RESPONSE_DELETE_EVENT == window destroyed */
    if (result != GNC_RESPONSE_NOW && result != GNC_RESPONSE_LATER)
    {
        gtk_widget_destroy(td->dialog);
        td->dialog = NULL;
        return result;
    }

    /* Get the transaction details - have been checked beforehand */
    td->ab_trans = gnc_ab_trans_dialog_fill_values(td);

    /* FIXME: If this is a direct debit, set the textkey/ "Textschluessel"/
     * transactionCode according to some GUI selection here!! */
    /*if (td->trans_type == SINGLE_DEBITNOTE)
    AB_TRANSACTION_setTextKey (td->hbci_trans, 05); */


    /* Hide the dialog */
    if (td->dialog)
        gtk_widget_hide(td->dialog);

    return result;
}

gnc_ab_trans_templ_free()

void gnc_ab_trans_templ_free

(

GncABTransTempl *

t

)

Free the memory used by a template.

Parameters

t	GncABTransTempl to be freed

Definition at line 161 of file gnc-aqbanking-templates.cpp.

{
    delete t;
}

gnc_ab_trans_templ_get_amount()

gnc_numeric gnc_ab_trans_templ_get_amount

(

const GncABTransTempl *

t

)

Parameters

t

Template

Returns

Amount

Definition at line 228 of file gnc-aqbanking-templates.cpp.

{
    g_return_val_if_fail(t, gnc_numeric_zero());
    return t->amount();
}

gnc_ab_trans_templ_get_name()

const gchar* gnc_ab_trans_templ_get_name

(

const GncABTransTempl *

t

)

Parameters

t

Template

Returns

Name of the template, an internal string

Definition at line 200 of file gnc-aqbanking-templates.cpp.

{
    g_return_val_if_fail(t, NULL);
    return t->name();
}

gnc_ab_trans_templ_get_purpose()

const gchar* gnc_ab_trans_templ_get_purpose

(

const GncABTransTempl *

t

)

Parameters

t

Template

Returns

First purpose line, an internal string

Definition at line 235 of file gnc-aqbanking-templates.cpp.

{
    g_return_val_if_fail(t, NULL);
    return t->purpose();
}

gnc_ab_trans_templ_get_purpose_cont()

const gchar* gnc_ab_trans_templ_get_purpose_cont

(

const GncABTransTempl *

t

)

Parameters

t

Template

Returns

Second purpose line, an internal string

Definition at line 242 of file gnc-aqbanking-templates.cpp.

{
    g_return_val_if_fail(t, NULL);
    return t->purpose_continuation();
}

gnc_ab_trans_templ_get_recp_account()

const gchar* gnc_ab_trans_templ_get_recp_account

(

const GncABTransTempl *

t

)

Parameters

t

Template

Returns

Account Number of the recipient, an internal string

Definition at line 214 of file gnc-aqbanking-templates.cpp.

{
    g_return_val_if_fail(t, NULL);
    return t->recipient_account();
}

gnc_ab_trans_templ_get_recp_bankcode()

const gchar* gnc_ab_trans_templ_get_recp_bankcode

(

const GncABTransTempl *

t

)

Parameters

t

Template

Returns

Bank Code of the recipient, an internal string

Definition at line 221 of file gnc-aqbanking-templates.cpp.

{
    g_return_val_if_fail(t, NULL);
    return t->recipient_bankcode();
}

gnc_ab_trans_templ_get_recp_name()

const gchar* gnc_ab_trans_templ_get_recp_name

(

const GncABTransTempl *

t

)

Parameters

t

Template

Returns

Name of the recipient, an internal string

Definition at line 207 of file gnc-aqbanking-templates.cpp.

{
    g_return_val_if_fail(t, NULL);
    return t->recipient_name();
}

gnc_ab_trans_templ_list_free()

void gnc_ab_trans_templ_list_free

(

GList *

l

)

Free the memory used by a list of templates, including the list itself.

Parameters

l	GList of GncABTransTempl

Definition at line 167 of file gnc-aqbanking-templates.cpp.

{
    for(GList *node = l; node != NULL; node = g_list_next(node))
        delete static_cast<_GncABTransTempl*>(node->data);
}

gnc_ab_trans_templ_list_new_from_book()

GList* gnc_ab_trans_templ_list_new_from_book

(

QofBook *

b

)

Obtain the list of QofTemplates saved in a Book.

Parameters

b	QofBook containing the templates.

Returns

A GList of newly allocated GncABTransTempls

Definition at line 133 of file gnc-aqbanking-templates.cpp.

{
    GList *retval = NULL;
    auto toplevel = qof_instance_get_slots (QOF_INSTANCE (b));
    auto slot = toplevel->get_slot({"hbci", "template-list"});
    if (slot == nullptr)
        return retval;
    auto list = slot->get<GList*>();
    for (auto node = list; node != NULL; node = g_list_next (node))
    {
        KvpFrame *frame = static_cast<KvpValue*>(node->data)->get<KvpFrame*>();
        auto c_func = [frame](const char* key)
            { auto slot = frame->get_slot({key});
              return slot == nullptr ? std::string("") : std::string(slot->get<const char*>());};
        auto n_func = [frame](const char* key)
            { auto slot = frame->get_slot({key});
              return slot == nullptr ? gnc_numeric_zero() : slot->get<gnc_numeric>();};
        auto templ = new _GncABTransTempl (c_func(TT_NAME), c_func(TT_RNAME),
                                           c_func(TT_RACC), c_func(TT_RBCODE),
                                           n_func(TT_AMOUNT), c_func(TT_PURPOS),
                                           c_func(TT_PURPOSCT));
        retval = g_list_prepend (retval, templ);
    }
    retval = g_list_reverse (retval);
    return retval;
}

gnc_ab_trans_templ_new()

GncABTransTempl* gnc_ab_trans_templ_new

(

void

)

Create a template with unset contents.

Returns

A newly allocated GncABTransTempl

Definition at line 117 of file gnc-aqbanking-templates.cpp.

{
    return new _GncABTransTempl;
}

gnc_ab_trans_templ_new_full()

GncABTransTempl* gnc_ab_trans_templ_new_full	(	const gchar *	name,
		const gchar *	recp_name,
		const gchar *	recp_account,
		const gchar *	recp_bankcode,
		gnc_numeric	amount,
		const gchar *	purpose,
		const gchar *	purpose_cont
	)

Create a template with given contents.

Parameters

name	Name of the template
recp_name	Name of the recipient
recp_account	Account Number of the recipient
recp_bankcode	Bank Code of the recipient
amount	Amount
purpose	First purpose line
purpose_cont	Second purpose line

Returns

A newly allocated GncABTransTempl

Definition at line 123 of file gnc-aqbanking-templates.cpp.

{
    return new _GncABTransTempl(name, recp_name, recp_account, recp_bankcode,
                                amount, purpose, purpose_cont);
}

gnc_ab_trans_templ_set_amount()

void gnc_ab_trans_templ_set_amount	(	GncABTransTempl *	t,
		gnc_numeric	amount
	)

Replace the amount stored in a template.

Parameters

t	Template
amount	Amount

Definition at line 279 of file gnc-aqbanking-templates.cpp.

{
    g_return_if_fail(t);
    t->set_amount(amount);
}

gnc_ab_trans_templ_set_name()

void gnc_ab_trans_templ_set_name	(	GncABTransTempl *	t,
		const gchar *	name
	)

Set the name of a template.

Parameters

t	Template
name	Name

Definition at line 249 of file gnc-aqbanking-templates.cpp.

{
    g_return_if_fail(t);
    t->set_name(name);
}

gnc_ab_trans_templ_set_purpose()

void gnc_ab_trans_templ_set_purpose	(	GncABTransTempl *	t,
		const gchar *	purpose
	)

Replace the first purpose line stored in a template.

Parameters

t	Template
purpose	First purpose line

Definition at line 286 of file gnc-aqbanking-templates.cpp.

{
    g_return_if_fail(t);
    t->set_purpose(purpose);
}

gnc_ab_trans_templ_set_purpose_cont()

void gnc_ab_trans_templ_set_purpose_cont	(	GncABTransTempl *	t,
		const gchar *	purpose_cont
	)

Replace the second purpose line stored in a template.

Parameters

t	Template
purpose_cont	Second purpose line

Definition at line 293 of file gnc-aqbanking-templates.cpp.

{
    g_return_if_fail(t);
    t->set_purpose_continuation (purpose_cont);
}

gnc_ab_trans_templ_set_recp_account()

void gnc_ab_trans_templ_set_recp_account	(	GncABTransTempl *	t,
		const gchar *	recp_account
	)

Replace the Account Number of the recipient stored in a template.

Parameters

t	Template
recp_account	Account Number of the recipient

Definition at line 263 of file gnc-aqbanking-templates.cpp.

{
    g_return_if_fail(t);
    t->set_recipient_account(recp_account);
}

gnc_ab_trans_templ_set_recp_bankcode()

void gnc_ab_trans_templ_set_recp_bankcode	(	GncABTransTempl *	t,
		const gchar *	recp_bankcode
	)

Replace the Bank Code of the recipient stored in a template.

Parameters

t	Template
recp_bankcode	Bank Code of the recipient

Definition at line 271 of file gnc-aqbanking-templates.cpp.

{
    g_return_if_fail(t);
    t->set_recipient_bankcode(recp_bankcode);
}

gnc_ab_trans_templ_set_recp_name()

void gnc_ab_trans_templ_set_recp_name	(	GncABTransTempl *	t,
		const gchar *	recp_name
	)

Replace the Account Number of the recipient stored in a template.

Parameters

t	Template
recp_name	Account Number of the recipient

Definition at line 256 of file gnc-aqbanking-templates.cpp.

{
    g_return_if_fail(t);
    t->set_recipient_name(recp_name);
}

gnc_ab_trans_to_gnc()

Transaction* gnc_ab_trans_to_gnc	(	const AB_TRANSACTION *	ab_trans,
		Account *	gnc_acc
	)

Create an unbalanced and dirty GnuCash transaction with a split to gnc_acc from the information available in the AqBanking transaction ab_trans.

Parameters

ab_trans	AqBanking transaction
gnc_acc	Account of to use for the split

Returns

A dirty GnuCash transaction or NULL otherwise

Definition at line 498 of file gnc-ab-utils.c.

{
    QofBook *book;
    Transaction *gnc_trans;
    const gchar *fitid;
    const GNC_GWEN_DATE *value_date, *post_date;
    time64 post_time;
    const char *custref;
    gchar *description;
    Split *split;
    gchar *memo;

    g_return_val_if_fail (ab_trans && gnc_acc, NULL);

    /* Create new GnuCash transaction for the given AqBanking one */
    book = gnc_account_get_book (gnc_acc);
    gnc_trans = xaccMallocTransaction (book);
    xaccTransBeginEdit (gnc_trans);

    /* Date / Time */
    /* SWIFT import formats (in particular MT940) provide for two
     * dates, the entry date and the value date (valuta is value in
     * German). The value date is the effective date for financial
     * calculation purposes and is mandatory, the entry date is the
     * date that the financial institution posted the
     * transaction. Unfortunately if the transaction field doesn't
     * provide an entry date AQBanking substitutes the date from the
     * last balance instead of using the value date or NULL, making
     * the field unreliable.
     */
    value_date = AB_Transaction_GetValutaDate (ab_trans);
    if (value_date)
         post_time = gnc_gwen_date_to_time64 (value_date);
    else if ((post_date = AB_Transaction_GetDate (ab_trans))) // always true
         post_time = gnc_gwen_date_to_time64 (post_date);
    else
    {
        g_warning ("transaction_cb: Import had no transaction date");
        post_time = gnc_time (NULL);
    }
    xaccTransSetDatePostedSecsNormalized (gnc_trans, post_time);

    xaccTransSetDateEnteredSecs (gnc_trans, gnc_time (NULL));

    /* Currency.  We take simply the default currency of the gnucash account */
    xaccTransSetCurrency (gnc_trans, xaccAccountGetCommodity (gnc_acc));

    /* Trans-Num or Split-Action set with gnc_set_num_action below per book
     * option */

    fitid = AB_Transaction_GetFiId (ab_trans);

    /* Description */
    description = gnc_ab_description_to_gnc (ab_trans, (fitid && *fitid));
    xaccTransSetDescription (gnc_trans, description);
    g_free (description);

    /* Notes. */
    /* xaccTransSetNotes(gnc_trans, g_notes); */
    /* But Nobody ever uses the Notes field? */

    /* Add one split */
    split = xaccMallocSplit (book);
    xaccSplitSetParent (split, gnc_trans);
    xaccSplitSetAccount (split, gnc_acc);

    /* Set the transaction number or split action field based on book option.
     * We use the "customer reference", if there is one. */
    custref = AB_Transaction_GetCustomerReference (ab_trans);
    if (custref && *custref && g_ascii_strncasecmp (custref, "NONREF", 6) != 0)
        gnc_set_num_action (gnc_trans, split, custref, NULL);

    /* Set OFX unique transaction ID */
    if (fitid && *fitid)
        gnc_import_set_split_online_id (split, fitid);

    /* FIXME: Extract function */
    {
        /* Amount into the split */
        const AB_VALUE *ab_value = AB_Transaction_GetValue (ab_trans);
        double d_value = ab_value ? AB_Value_GetValueAsDouble (ab_value) : 0.0;
        AB_TRANSACTION_TYPE ab_type = AB_Transaction_GetType (ab_trans);
        gnc_numeric gnc_amount;

        /*printf("Transaction with value %f has type %d\n", d_value, ab_type);*/
        /* If the value is positive, but the transaction type says the
           money is transferred away from our account (Transfer instead of
           DebitNote), we switch the value to negative. */
        if (d_value > 0.0 && ab_type == AB_Transaction_TypeTransfer)
            d_value = -d_value;

        gnc_amount = double_to_gnc_numeric (
                         d_value,
                         xaccAccountGetCommoditySCU (gnc_acc),
                         GNC_HOW_RND_ROUND_HALF_UP);
        if (!ab_value)
            g_warning ("transaction_cb: Oops, value was NULL.  Using 0");
        xaccSplitSetBaseValue (split, gnc_amount, xaccAccountGetCommodity (gnc_acc));
    }

    /* Memo in the Split. */
    memo = gnc_ab_memo_to_gnc (ab_trans);
    xaccSplitSetMemo (split, memo);
    g_free (memo);

    return gnc_trans;
}

gnc_AB_VALUE_to_readable_string()

gchar* gnc_AB_VALUE_to_readable_string

(

const AB_VALUE *

value

)

Print the value of value with two decimal places and value's currency appended, or 0.0 otherwise.

Parameters

value

AB_VALUE or NULL

Returns

A newly allocated string

Definition at line 283 of file gnc-ab-utils.c.

{
    if (value)
        return g_strdup_printf ("%.2f %s",
                                AB_Value_GetValueAsDouble (value),
                                AB_Value_GetCurrency (value));
    else
        return g_strdup_printf ("%.2f", 0.0);
}

gnc_file_aqbanking_import_dialog()

G_BEGIN_DECLS void gnc_file_aqbanking_import_dialog

(

GtkWindow *

parent

)

Import files via AQBanking's Import Dialog.

This permits importing any file format that Aqbanking supports.

Parameters

parent

A GtkWindow for setting the import dialog transient for.

Definition at line 133 of file gnc-file-aqb-import.c.

{
     AB_BANKING* api = gnc_AB_BANKING_new ();
     GncABSelectImExDlg* imexd =
         gnc_ab_select_imex_dlg_new (GTK_WIDGET (parent), api);
     char *imexporter = NULL, *profile = NULL;
     AB_IMEXPORTER_CONTEXT* ctx = NULL;

     if (!imexd)
     {

         PERR ("Failed to create select imex dialog.");
         gnc_AB_BANKING_fini(api);
         return;
     }
     load_imexporter_and_profile(&imexporter, &profile);
     gnc_ab_select_imex_dlg_set_imexporter_name(imexd, imexporter);
     gnc_ab_select_imex_dlg_set_profile_name(imexd, profile);

     if (!gnc_ab_select_imex_dlg_run (imexd))
     {
         gnc_ab_select_imex_dlg_destroy (imexd);
         return;
     }

     imexporter = gnc_ab_select_imex_dlg_get_imexporter_name (imexd);
     profile = gnc_ab_select_imex_dlg_get_profile_name (imexd);

     if (imexporter && profile)
     {
         ctx = named_import_get_context (parent, api, imexporter, profile);
         gnc_ab_select_imex_dlg_destroy (imexd);

         if (ctx)
         {
             GncABImExContextImport* ieci = NULL;
             ieci = gnc_ab_import_context (ctx, AWAIT_TRANSACTIONS, FALSE, api, GTK_WIDGET(parent));
             g_free(ieci);
             AB_ImExporterContext_free(ctx);
         }

         save_imexporter_and_profile(imexporter, profile);
         g_free (imexporter);
         g_free (profile);
     }

     gnc_AB_BANKING_fini(api);
}

gnc_GWEN_Gui_get()

GncGWENGui* gnc_GWEN_Gui_get

(

GtkWidget *

parent

)

When called for the first time, create a unique GncGWENGui object featuring a GWEN_GUI with all necessary callbacks, which can serve as a user interface for AqBanking jobs.

On later calls, return the object only when it is not active and save to use. Typically, you only need to call gnc_GWEN_Gui_release() once your job has finished.

Parameters

parent

Widget to set new dialogs transient for, may be NULL

Returns

The unique GncGWENGui object or NULL otherwise

Definition at line 245 of file gnc-gwen-gui.c.

{
    GncGWENGui *gui;

    ENTER("parent=%p", parent);

    if (full_gui)
    {
        if (full_gui->state == INIT || full_gui->state == RUNNING)
        {
            LEAVE("full_gui in use, state=%d", full_gui->state);
            return NULL;
        }

        gui = full_gui;
        gui->parent = parent;
        reset_dialog(gui);
        register_callbacks(gui);

        LEAVE("gui=%p", gui);
        return gui;
    }

    gui = g_new0(GncGWENGui, 1);
    gui->parent = parent;
    setup_dialog(gui);
    register_callbacks(gui);

    full_gui = gui;

    LEAVE("new gui=%p", gui);
    return gui;
}

gnc_GWEN_Gui_get_close_flag()

gboolean gnc_GWEN_Gui_get_close_flag

(

void

)

Get "Close when finished" flag.

Returns

gboolean close_when_finished

Definition at line 344 of file gnc-gwen-gui.c.

{
    return gnc_prefs_get_bool (GNC_PREFS_GROUP_AQBANKING, GNC_PREF_CLOSE_ON_FINISH);
}

gnc_GWEN_Gui_hide_dialog()

void gnc_GWEN_Gui_hide_dialog

(

void

)

Hides Online Banking Connection Window (Close log window)

Definition at line 381 of file gnc-gwen-gui.c.

{
    GncGWENGui *gui = full_gui;

    if (gui)
    {
        hide_dialog(gui);
    }
}

gnc_GWEN_Gui_log_init()

void gnc_GWEN_Gui_log_init

(

void

)

Hook our logging into the gwenhywfar logging framework by creating a minimalistic GWEN_GUI with only a callback for Gwen_Gui_LogHook().

This function can be called more than once, it will unref and replace the currently set GWEN_GUI though.

Definition at line 229 of file gnc-gwen-gui.c.

{
    if (!log_gwen_gui)
    {
        log_gwen_gui = Gtk3_Gui_new();

        /* Always use our own logging */
        GWEN_Gui_SetLogHookFn(log_gwen_gui, loghook_cb);

        /* Keep a reference so that the GWEN_GUI survives a GUI switch */
        GWEN_Gui_Attach(log_gwen_gui);
    }
    GWEN_Gui_SetGui(log_gwen_gui);
}

gnc_GWEN_Gui_release()

void gnc_GWEN_Gui_release

(

GncGWENGui *

gui

)

Currently a no-op.

The GncGWENGui will not be freed and it is considered finished once the first tracked progress has ended.

Parameters

gui	The GncGwenGUI returned by gnc_GWEN_Gui_get()

Definition at line 280 of file gnc-gwen-gui.c.

{
    g_return_if_fail(gui && gui == full_gui);

    /* Currently a no-op */
    ENTER("gui=%p", gui);
    LEAVE(" ");
}

gnc_GWEN_Gui_set_close_flag()

void gnc_GWEN_Gui_set_close_flag

(

gboolean

close_when_finished

)

Set "Close when finished" flag.

Parameters

gboolean

close_when_finished

Definition at line 325 of file gnc-gwen-gui.c.

{
    gnc_prefs_set_bool(
        GNC_PREFS_GROUP_AQBANKING, GNC_PREF_CLOSE_ON_FINISH,
        close_when_finished);

    if (full_gui)
    {
        if (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(full_gui->close_checkbutton))
                != close_when_finished)
        {
            gtk_toggle_button_set_active(
                GTK_TOGGLE_BUTTON(full_gui->close_checkbutton),
                close_when_finished);
        }
    }
}

gnc_GWEN_Gui_show_dialog()

gboolean gnc_GWEN_Gui_show_dialog

(

void

)

Unhides Online Banking Connection Window (Make log visible)

Returns

gboolean window is visible

Definition at line 350 of file gnc-gwen-gui.c.

{
    GncGWENGui *gui = full_gui;

    if (!gui)
    {
        gnc_GWEN_Gui_get(NULL);
        gui = full_gui;
    }

    if (gui)
    {
        if (gui->state == HIDDEN)
        {
            gui->state = FINISHED;
        }
        gtk_toggle_button_set_active(
            GTK_TOGGLE_BUTTON(gui->close_checkbutton),
            gnc_prefs_get_bool (GNC_PREFS_GROUP_AQBANKING, GNC_PREF_CLOSE_ON_FINISH));

        gtk_widget_set_sensitive(gui->close_button, TRUE);

        show_dialog(gui, FALSE);

        return TRUE;
    }

    return FALSE;
}

gnc_plugin_aqbanking_new()

GncPlugin* gnc_plugin_aqbanking_new

(

void

)

Returns

A new GncPluginAqBanking object

Definition at line 150 of file gnc-plugin-aqbanking.c.

{
    return GNC_PLUGIN(g_object_new(GNC_TYPE_PLUGIN_AQBANKING, (gchar*) NULL));
}

ini_flicker_gui()

void ini_flicker_gui	(	const char *	pChallenge,
		GncFlickerGui *	gui
	)

Initialize the dialog and drawing area.

Parameters

pChallenge	The answer from the bank which is shown as a flickering picture
gui	The structure of the Dialog-Widgets

Definition at line 391 of file gnc-flicker-gui.c.

{
    /* Establish reference to the dialog widgets created in gnc_gwen_gui */
    flickergui = gui;

    /* Load window size and initial setting values */
    do_flicker_load_state (GTK_WIDGET (flickergui->dialog));

    /* Initialize application */
    flickerdraw.barheight = BAR_HEIGHT;
    flickerdraw.margin = MARGIN;
    flickerdraw.y_barpos = 20;        /* First painting position */
    flickerdraw.halfbyteid = 0;
    flickerdraw.clock = 1;

    flickerdraw.challenge = pChallenge;

    g_signal_connect (GTK_WINDOW (flickergui->dialog), "destroy",
                      G_CALLBACK (on_dialog_destroy), NULL);

    g_signal_connect (GTK_WIDGET (flickergui->flicker_challenge), "map",
                      G_CALLBACK (on_flicker_challenge_map), NULL);
    g_signal_connect (GTK_WIDGET (flickergui->flicker_challenge), "draw",
                      G_CALLBACK (on_flicker_challenge_draw), NULL);
    g_signal_connect (GTK_WIDGET (flickergui->flicker_challenge), "destroy",
                      G_CALLBACK (on_flicker_challenge_destroy), NULL);

    g_signal_connect (GTK_WIDGET (flickergui->flicker_marker), "map",
                      G_CALLBACK (on_flicker_marker_map), NULL);
    g_signal_connect (GTK_WIDGET (flickergui->flicker_marker), "draw",
                      G_CALLBACK (on_flicker_marker_draw), NULL);

    flickergui->adj_barwidth = gtk_adjustment_new (0.0, 10.0, 80.0, 1.0, 10.0, 0.0);
    gtk_spin_button_set_adjustment (flickergui->spin_barwidth, flickergui->adj_barwidth);
    gtk_spin_button_set_value (GTK_SPIN_BUTTON (flickergui->spin_barwidth),
                               flickerdraw.barwidth);
    g_signal_connect (GTK_WIDGET (flickergui->spin_barwidth), "value-changed",
                      G_CALLBACK (on_spin_barwidth_value_changed),
                                 flickergui->flicker_marker);
    gtk_widget_set_focus_on_click (GTK_WIDGET (flickergui->spin_barwidth), FALSE);

    flickergui->adj_delay = gtk_adjustment_new (0.0, 10.0, 100.0, 10.0, 10.0, 0.0);
    gtk_spin_button_set_adjustment (flickergui->spin_delay, flickergui->adj_delay);
    gtk_spin_button_set_value (GTK_SPIN_BUTTON (flickergui->spin_delay),
                               flickerdraw.delay);
    g_signal_connect (GTK_WIDGET (flickergui->spin_delay), "value-changed",
                      G_CALLBACK (on_spin_delay_value_changed),
                      flickergui->flicker_challenge);
    gtk_widget_set_focus_on_click (GTK_WIDGET (flickergui->spin_delay), FALSE);

    gtk_widget_grab_focus (GTK_WIDGET (flickergui->input_entry));
}