/* * gnc-plugin-aqbanking.c -- * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation; either version 2 of * the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, contact: * * Free Software Foundation Voice: +1-617-542-5942 * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 * Boston, MA 02110-1301, USA gnu@gnu.org */ /** * @internal * @file gnc-plugin-aqbanking.c * @brief Plugin registration of the AqBanking module * @author Copyright (C) 2002 Christian Stimming * @author Copyright (C) 2003 David Hampton * @author Copyright (C) 2008 Andreas Koehler */ #include #include #include "Account.h" #include "dialog-ab-trans.h" #include "assistant-ab-initial.h" #include "gnc-ab-getbalance.h" #include "gnc-ab-gettrans.h" #include "gnc-ab-transfer.h" #include "gnc-ab-utils.h" #include "gnc-ab-kvp.h" #include "gnc-gwen-gui.h" #include "gnc-file-aqb-import.h" #include "gnc-plugin-aqbanking.h" #include "gnc-plugin-manager.h" #include "gnc-plugin-page-account-tree.h" #include "gnc-plugin-page-register.h" #include "gnc-main-window.h" #include "gnc-prefs.h" #include "gnc-ui-util.h" // for gnc_get_current_book /* This static indicates the debugging module that this .o belongs to. */ static QofLogModule log_module = G_LOG_DOMAIN; static void gnc_plugin_aqbanking_add_to_window(GncPlugin *plugin, GncMainWindow *window, GQuark type); static void gnc_plugin_aqbanking_remove_from_window(GncPlugin *plugin, GncMainWindow *window, GQuark type); /* Object callbacks */ static void gnc_plugin_ab_main_window_page_added(GncMainWindow *window, GncPluginPage *page, gpointer user_data); static void gnc_plugin_ab_main_window_page_changed(GncMainWindow *window, GncPluginPage *page, gpointer user_data); static void gnc_plugin_ab_account_selected(GncPluginPage *plugin_page, Account *account, gpointer user_data); /* Auxiliary functions */ static Account *main_window_to_account(GncMainWindow *window); /* Command callbacks */ static void gnc_plugin_ab_cmd_setup (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_get_balance (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_get_transactions (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_issue_sepatransaction (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_issue_sepainternaltransaction (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_issue_inttransaction (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_issue_sepa_direct_debit (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_view_logwindow (GSimpleAction *simple, GVariant *parameter, gpointer user_data); static void gnc_plugin_ab_cmd_aqb_import (GSimpleAction *simple, GVariant *parameter, gpointer user_data); #define PLUGIN_ACTIONS_NAME "gnc-plugin-aqbanking-actions" #define PLUGIN_UI_FILENAME "gnc-plugin-aqbanking.ui" #define MENU_TOGGLE_ACTION_AB_VIEW_LOGWINDOW "ABViewLogwindowAction" static GActionEntry gnc_plugin_actions [] = { { "OnlineActionsAction", NULL, NULL, NULL, NULL }, { "ABSetupAction", gnc_plugin_ab_cmd_setup, NULL, NULL, NULL }, { "ABGetBalanceAction", gnc_plugin_ab_cmd_get_balance, NULL, NULL, NULL }, { "ABGetTransAction", gnc_plugin_ab_cmd_get_transactions, NULL, NULL, NULL }, { "ABIssueSepaTransAction", gnc_plugin_ab_cmd_issue_sepatransaction, NULL, NULL, NULL }, { "ABIssueSepaIntTransAction", gnc_plugin_ab_cmd_issue_sepainternaltransaction, NULL, NULL, NULL }, { "ABIssueIntTransAction", gnc_plugin_ab_cmd_issue_inttransaction, NULL, NULL, NULL }, { "ABIssueSepaDirectDebitAction", gnc_plugin_ab_cmd_issue_sepa_direct_debit, NULL, NULL, NULL }, { "AQBankingImportAction", gnc_plugin_ab_cmd_aqb_import, NULL, NULL, NULL }, { MENU_TOGGLE_ACTION_AB_VIEW_LOGWINDOW, gnc_plugin_ab_cmd_view_logwindow, NULL, "true", NULL }, }; /** The number of actions provided by this plugin. */ static guint gnc_plugin_n_actions = G_N_ELEMENTS(gnc_plugin_actions); /** The default menu items that need to be add to the menu */ static const gchar *gnc_plugin_load_ui_items [] = { "FilePlaceholder1", "ToolsPlaceholder0", "ActionsPlaceholder1", NULL, }; static const gchar *need_account_actions[] = { "ABGetBalanceAction", "ABGetTransAction", "ABIssueSepaTransAction", #if (AQBANKING_VERSION_INT >= 60400) "ABIssueSepaIntTransAction", #endif "ABIssueIntTransAction", "ABIssueSepaDirectDebitAction", NULL }; #if (AQBANKING_VERSION_INT < 60400) static const gchar *inactive_account_actions[] = { "ABIssueSepaIntTransAction", NULL }; #endif static const gchar *readonly_inactive_actions[] = { "OnlineActionsAction", "ABSetupAction", NULL }; static GncMainWindow *gnc_main_window = NULL; /************************************************************ * Object Implementation * ************************************************************/ struct _GncPluginAqBanking { GncPlugin gnc_plugin; }; G_DEFINE_TYPE(GncPluginAqBanking, gnc_plugin_aqbanking, GNC_TYPE_PLUGIN) GncPlugin * gnc_plugin_aqbanking_new(void) { return GNC_PLUGIN(g_object_new(GNC_TYPE_PLUGIN_AQBANKING, (gchar*) NULL)); } static void gnc_plugin_aqbanking_class_init(GncPluginAqBankingClass *klass) { GncPluginClass *plugin_class = GNC_PLUGIN_CLASS(klass); /* plugin info */ plugin_class->plugin_name = GNC_PLUGIN_AQBANKING_NAME; /* widget addition/removal */ plugin_class->actions_name = PLUGIN_ACTIONS_NAME; plugin_class->actions = gnc_plugin_actions; plugin_class->n_actions = gnc_plugin_n_actions; plugin_class->ui_filename = PLUGIN_UI_FILENAME; plugin_class->ui_updates = gnc_plugin_load_ui_items; plugin_class->add_to_window = gnc_plugin_aqbanking_add_to_window; plugin_class->remove_from_window = gnc_plugin_aqbanking_remove_from_window; } static void gnc_plugin_aqbanking_init(GncPluginAqBanking *plugin) { } /** * Called when this plugin is added to a main window. Connect a few callbacks * here to track page changes. */ static void gnc_plugin_aqbanking_add_to_window(GncPlugin *plugin, GncMainWindow *window, GQuark type) { GAction *action; gnc_main_window = window; g_signal_connect (window, "page_added", G_CALLBACK(gnc_plugin_ab_main_window_page_added), plugin); g_signal_connect (window, "page_changed", G_CALLBACK(gnc_plugin_ab_main_window_page_changed), plugin); action = gnc_main_window_find_action_in_group (window, PLUGIN_ACTIONS_NAME, MENU_TOGGLE_ACTION_AB_VIEW_LOGWINDOW); if (action) { GVariant *state = g_action_get_state (G_ACTION(action)); g_action_change_state (G_ACTION(action), g_variant_new_boolean (FALSE)); g_variant_unref (state); } } static void gnc_plugin_aqbanking_remove_from_window(GncPlugin *plugin, GncMainWindow *window, GQuark type) { g_signal_handlers_disconnect_by_func( window, G_CALLBACK(gnc_plugin_ab_main_window_page_changed), plugin); g_signal_handlers_disconnect_by_func( window, G_CALLBACK(gnc_plugin_ab_main_window_page_added), plugin); } /************************************************************ * Object Callbacks * ************************************************************/ /** * A new page has been added to a main window. Connect a signal to it so that * we can track when accounts are selected. */ static void gnc_plugin_ab_main_window_page_added(GncMainWindow *window, GncPluginPage *page, gpointer user_data) { const gchar *page_name; ENTER("main window %p, page %p", window, page); if (!GNC_IS_PLUGIN_PAGE(page)) { LEAVE("no plugin_page"); return; } page_name = gnc_plugin_page_get_plugin_name(page); if (!page_name) { LEAVE("no page_name of plugin_page"); return; } if (strcmp(page_name, GNC_PLUGIN_PAGE_ACCOUNT_TREE_NAME) == 0) { DEBUG("account tree page, adding signal"); g_signal_connect(page, "account_selected", G_CALLBACK(gnc_plugin_ab_account_selected), NULL); } gnc_plugin_ab_main_window_page_changed(window, page, user_data); LEAVE(" "); } /** Update the actions sensitivity */ static void update_inactive_actions(GncPluginPage *plugin_page) { GncMainWindow *window; GSimpleActionGroup *simple_action_group; // We are readonly - so we have to switch particular actions to inactive. gboolean is_readwrite = !qof_book_is_readonly(gnc_get_current_book()); // We continue only if the current page is a plugin page if (!plugin_page || !GNC_IS_PLUGIN_PAGE(plugin_page)) return; window = GNC_MAIN_WINDOW(plugin_page->window); g_return_if_fail (GNC_IS_MAIN_WINDOW(window)); simple_action_group = gnc_main_window_get_action_group (window, PLUGIN_ACTIONS_NAME); g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP(simple_action_group)); /* Set the action's sensitivity */ gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), readonly_inactive_actions, is_readwrite); } /** * Whenever the current page has changed, update the aqbanking menus based upon * the page that is currently selected. */ static void gnc_plugin_ab_main_window_page_changed (GncMainWindow *window, GncPluginPage *page, gpointer user_data) { Account *account = main_window_to_account (window); /* Make sure not to call this with a NULL GncPluginPage */ if (page) { // Update the menu items according to the selected account gnc_plugin_ab_account_selected (page, account, user_data); // Also update the action sensitivity due to read-only update_inactive_actions (page); } } /** * An account had been (de)selected either in an "account tree" page or by * selecting another register page. Update the aqbanking menus appropriately. */ static void gnc_plugin_ab_account_selected (GncPluginPage *plugin_page, Account *account, gpointer user_data) { GncMainWindow *window; GSimpleActionGroup *simple_action_group; const gchar *bankcode = NULL; const gchar *accountid = NULL; g_return_if_fail(GNC_IS_PLUGIN_PAGE(plugin_page)); window = GNC_MAIN_WINDOW(plugin_page->window); g_return_if_fail(GNC_IS_MAIN_WINDOW(window)); simple_action_group = gnc_main_window_get_action_group (window, PLUGIN_ACTIONS_NAME); g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP(simple_action_group)); if (account) { bankcode = gnc_ab_get_account_bankcode(account); accountid = gnc_ab_get_account_accountid(account); gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), need_account_actions, (account && bankcode && *bankcode && accountid && *accountid)); gnc_main_window_set_vis_of_items_by_action (window, need_account_actions, TRUE); #if (AQBANKING_VERSION_INT < 60400) gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), inactive_account_actions, FALSE); gnc_main_window_set_vis_of_items_by_action (window, inactive_account_actions, FALSE); #endif } else { gnc_plugin_set_actions_enabled (G_ACTION_MAP(simple_action_group), need_account_actions, FALSE); gnc_main_window_set_vis_of_items_by_action (window, need_account_actions, FALSE); } } /************************************************************ * Auxiliary Functions * ************************************************************/ /** * Given a pointer to a main window, try and extract an Account from it. If the * current page is an "account tree" page, get the account corresponding to the * selected account. (What if multiple accounts are selected?) If the current * page is a "register" page, get the head account for the register. (Returns * NULL for a general journal or search register.) * * @param window A pointer to a GncMainWindow object. * @return A pointer to an account, if one can be determined from the current * page. NULL otherwise. */ static Account * main_window_to_account(GncMainWindow *window) { GncPluginPage *page; const gchar *page_name; Account *account = NULL; const gchar *account_name; ENTER("main window %p", window); if (!GNC_IS_MAIN_WINDOW(window)) { LEAVE("no main_window"); return NULL; } page = gnc_main_window_get_current_page(window); if (!GNC_IS_PLUGIN_PAGE(page)) { LEAVE("no plugin_page"); return NULL; } page_name = gnc_plugin_page_get_plugin_name(page); if (!page_name) { LEAVE("no page_name of plugin_page"); return NULL; } if (strcmp(page_name, GNC_PLUGIN_PAGE_REGISTER_NAME) == 0) { DEBUG("register page"); account = gnc_plugin_page_register_get_account( GNC_PLUGIN_PAGE_REGISTER(page)); } else if (strcmp(page_name, GNC_PLUGIN_PAGE_ACCOUNT_TREE_NAME) == 0) { DEBUG("account tree page"); account = gnc_plugin_page_account_tree_get_current_account( GNC_PLUGIN_PAGE_ACCOUNT_TREE(page)); } else { account = NULL; } account_name = account ? xaccAccountGetName(account) : NULL; LEAVE("account %s(%p)", account_name ? account_name : "(null)", account); return account; } void gnc_plugin_aqbanking_set_logwindow_visible (gboolean logwindow_visible) { GAction *action = gnc_main_window_find_action_in_group (gnc_main_window, PLUGIN_ACTIONS_NAME, MENU_TOGGLE_ACTION_AB_VIEW_LOGWINDOW); if (action) { GVariant *state = g_action_get_state (G_ACTION(action)); g_action_change_state (G_ACTION(action), g_variant_new_boolean (logwindow_visible)); g_variant_unref (state); } } /************************************************************ * Command Callbacks * ************************************************************/ static void gnc_plugin_ab_cmd_setup (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; ENTER("action %p, main window data %p", simple, data); gnc_main_window = data->window; gnc_ab_initial_assistant(); LEAVE(" "); } static void gnc_plugin_ab_cmd_get_balance (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; Account *account; ENTER("action %p, main window data %p", simple, data); account = main_window_to_account(data->window); if (account == NULL) { PINFO("No AqBanking account selected"); LEAVE("no account"); return; } gnc_main_window = data->window; gnc_ab_getbalance(GTK_WIDGET(data->window), account); LEAVE(" "); } static void gnc_plugin_ab_cmd_get_transactions (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; Account *account; ENTER("action %p, main window data %p", simple, data); account = main_window_to_account(data->window); if (account == NULL) { PINFO("No AqBanking account selected"); LEAVE("no account"); return; } gnc_main_window = data->window; gnc_ab_gettrans(GTK_WIDGET(data->window), account); LEAVE(" "); } static void gnc_plugin_ab_cmd_issue_sepatransaction (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; Account *account; ENTER("action %p, main window data %p", simple, data); account = main_window_to_account(data->window); if (account == NULL) { PINFO("No AqBanking account selected"); LEAVE("no account"); return; } gnc_main_window = data->window; gnc_ab_maketrans(GTK_WIDGET(data->window), account, SEPA_TRANSFER); LEAVE(" "); } #if (AQBANKING_VERSION_INT >= 60400) static void gnc_plugin_ab_cmd_issue_sepainternaltransaction (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; Account *account; ENTER("action %p, main window data %p", simple, data); account = main_window_to_account(data->window); if (account == NULL) { PINFO("No AqBanking account selected"); LEAVE("no account"); return; } gnc_main_window = data->window; gnc_ab_maketrans(GTK_WIDGET(data->window), account, SEPA_INTERNAL_TRANSFER); LEAVE(" "); } #else static void gnc_plugin_ab_cmd_issue_sepainternaltransaction (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; ENTER("action %p, main window data %p", simple, data); PINFO("Sepa Internal Transfer not supported by your aqbanking version!"); LEAVE("Sepa Internal Transfer not supported!"); } #endif static void gnc_plugin_ab_cmd_issue_inttransaction (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; Account *account; ENTER("action %p, main window data %p", simple, data); account = main_window_to_account(data->window); if (account == NULL) { PINFO("No AqBanking account selected"); LEAVE("no account"); return; } gnc_main_window = data->window; gnc_ab_maketrans(GTK_WIDGET(data->window), account, SINGLE_INTERNAL_TRANSFER); LEAVE(" "); } static void gnc_plugin_ab_cmd_issue_sepa_direct_debit (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; Account *account; ENTER("action %p, main window data %p", simple, data); account = main_window_to_account(data->window); if (account == NULL) { PINFO("No AqBanking account selected"); LEAVE("no account"); return; } gnc_main_window = data->window; gnc_ab_maketrans(GTK_WIDGET(data->window), account, SEPA_DEBITNOTE); LEAVE(" "); } static void gnc_plugin_ab_cmd_view_logwindow (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GVariant *state = g_action_get_state (G_ACTION(simple)); gboolean toggle = g_variant_get_boolean (state); g_variant_unref (state); gboolean new_toggle = !toggle; g_action_change_state (G_ACTION(simple), g_variant_new_boolean (new_toggle)); if (new_toggle) { if (!gnc_GWEN_Gui_show_dialog()) { /* Log window could not be made visible */ g_action_change_state (G_ACTION(simple), g_variant_new_boolean (FALSE)); } } else { gnc_GWEN_Gui_hide_dialog(); } } static void gnc_plugin_ab_cmd_aqb_import (GSimpleAction *simple, GVariant *parameter, gpointer user_data) { GncMainWindowActionData *data = user_data; gnc_main_window = data->window; gnc_file_aqbanking_import_dialog (GTK_WINDOW (gnc_main_window)); } /************************************************************ * Plugin Bootstrapping * ************************************************************/ void gnc_plugin_aqbanking_create_plugin(void) { GncPlugin *plugin = gnc_plugin_aqbanking_new(); gnc_plugin_manager_add_plugin(gnc_plugin_manager_get(), plugin); }