Vytváření modulů pro KMyMoney

6. 12. 2010 | Petr Bravenec | Programování | Návody | 2524×

V dalším díle seriálu se podíváme na to, jak si můžete naprogramovat jednoduchý modul do KMyMoney.

Obsah

• Co budeme vyrábět
• Co bude náš modul dělat
• Struktura modulu
  • Výkonná část modulu
  • Nastavení modulu
• Výkonná část modulu
  • Umístění akce v menu
• Nastavení modulu
• Překlady do různých jazyků
• Překlad a linkování
• Ověření funkce
• Odkazy na dokumentaci
• Zdrojové tvary
• Zveřejnění modulu

Co budeme vyrábět

V tomto článku se pokusím vysvětlit, jak vytvořit jednoduchý modul pro domácí účetníctví KMyMoney. U čtenářů předpokládám znalost programování v C++, výhodou je znalost Qt (na AbcLinuxu vycházel/vychází seriál o knihovně Qt) a případná znalost programování pro platformu KDE. V článku nebudu zacházet do přílišných detailů, protože předpokládám, že případní zájemci o tvorbu modulů v KMyMoney nebudou naprostí programátorští zelenáči.

Co bude náš modul dělat

Ukázkový modul by neměl být příliš složitý. Vytvoříme tedy jednoduchý modul, který bude umět otevřít dokument spojený s příslušnou transakcí v peněžním deníku – například fakturu. Transakci budeme identifikovat podle čísla dokladu (při vydávání faktur určuje číslo faktury účtující, u přijatých faktur jsme odkázáni na vydavatele faktury).

Máme-li faktury uložené v pdf, můžeme do nastavení napsat například:

okular /home/uzivatel/Dokumenty/Faktury/Faktura-%1.pdf

Parametr %1 se nahradí číslem dokladu z transakce v KMyMoney a výsledné jméno souboru se pak použije jako parametr pro aplikaci okular.

Abychom dosáhli požadované funkčnosti, potřebujeme ve skutečnosti vyrobit dva provázané moduly – jeden modul se bude starat o nastavení (cesta k uloženým dokumentům), druhý modul se bude starat o fungování – spuštění požadované akce. Nastavení najdeme v menu Nastavení - Nastavení KMyMoney - Moduly, akci samotnou pak v kontextovém menu transakce a v menu Transakce. Akci samotnou bude možné spustit pouze v případě, že vybraná transakce má vyplněné číslo dokladu, jinak nebude akce povolená.

Struktura modulu

Nejsem žádný velký programátor, natožpak pro KDE. Naštěstí pro vytvoření takto jednoduchého modulu není nutné nic složitého studovat, stačí se podívat do jiných modulů a prostě opsat, co už je hotové. Další informace proto mohou být poněkud nepřesné, důležité však je, že to funguje.

Jednotlivé části modulu jsou různě pojmenované. Výkonný modul používá prefix kmm_, nastavovací modul pak kcm_kmm_ - podle těchto předpon můžete identifikovat v adresáři /usr/lib/kde moduly pro KMyMoney. Náš modul bude tvořen dvěma soubory: kmm_openattachedfile.so a kcm_kmm_openattachedfile.so.

Každý modul má vlastní adresář ve stromu zdrojových tvarů v kmymoney/kmymoney/plugins. V adresáři najdeme několik souborů (názvy beru z už hotového modulu):

• CMakeLists.txt

Výkonná část modulu

• kmm_openattachedfile.desktop - popis služby.
• kmm_openattachedfile.rc - umístění akce v menu
• openattachedfile.cpp - zdrojový tvar vlastního modulu
• openattachedfile.h - hlavičkový soubor modulu

Nastavení modulu

• kcm_kmm_openattachedfile.desktop - popis služby pro nastavení
• kcm_kmm_openattachedfile.ui - nastavovací formulář
• kcm_openattachedfile.cpp - zdrojový tvar nastavení modulu
• kcm_openattachedfile.h - hlavičkový soubor nastavení modulu
• pluginsettings.kcfg - xml soubor pro tvorbu rc souboru (uložení nastavení)
• pluginsettings.kcfgc - předpis pro přeložení pluginsettings.kcfg

Výkonná část modulu

Vlastní objekt modulu je deklarován v hlavičkovém souboru openattachedfile.h. Měl by být potomkem třídy KMyMoneyPlugin::Plugin. Protože se jedná o klasický QObject, musíte v hlavičkovém souboru uvést i makro Q_OBJECT. Modul tak může obsahovat různé sloty, které můžete napojit na signály generované v KMyMoney.

V souboru openattachedfile.cpp najdete vlastní zdrojový tvar akce. Po nezbytných hlavičkách a includech následuje povinné "byl jednou jeden král", kterým se zaregistruje modul v KDE (KGenericFactory, K_EXPORT_COMPONENT_FACTORY atd). Při opisování dbejte pečlivě na to, abyste přepsali všechna místa vlastními řetězci a názvy. Úvod pohádky pokračuje i v konstruktoru.

http://api.kde.org/4.x-api/kdelibs-apidocs/kdecore/html/classKGenericFactory.html
http://kmymoney2.sourceforge.net/kmymoney2-api/html/classKMyMoneyPlugin_1_1Plugin.html

 
typedef KGenericFactory openattachedfileFactory;
 
K_EXPORT_COMPONENT_FACTORY(kmm_openattachedfile, openattachedfileFactory("kmm_openattachedfile"))
 
/**
 * Konstruktor pluginu
 * Přidává akci do menu (podrobnosti jsou v kmm_openattachedfile.rc)
 * Propojuje vytvořenou akci v menu se slotem v pluginu
 */
KMMOpenAttachedFilePlugin::KMMOpenAttachedFilePlugin(QObject *parent, const QStringList&)
    : KMyMoneyPlugin::Plugin(parent, "Open Attached File" /* Musí být shodné s  X-KDE-PluginInfo-Name */) {
 
  setComponentData(openattachedfileFactory::componentData());
  setXMLFile("kmm_openattachedfile.rc");

V konstruktoru dále vytvoříme akci a napojíme ji na náš slot. Dále propojíme sloty slotPlug a slotUnPlug. Při zasunutí modulu se propojují další sloty se signály generovanými aplikací KMyMoney. Netuším, jestli se dají tyto sloty a signály propojit i v konstruktoru – zde jsem se nechal plně inspirovat předlohou, ze které jsem opisoval (modul printcheck). Předpokládám ale, že modul je možné propojit se signály KMyMoney až po zasunutí proto, že při vytvoření (volání konstruktoru) není ještě vytvořené prostředí KMyMoney a funkce viewInterface() by vrátila neužitečnou hodnotu. Chcete-li experimentovat, můžete.

 
  m_action = actionCollection()->addAction("openattachedfile", this, SLOT(slotOpenAttachedFile()));
  m_action->setText(i18n("Open Attached File"));
  m_action->setEnabled(false);
 
  connect(KMyMoneyPlugin::PluginLoader::instance(), SIGNAL(plug(KPluginInfo*)), 
            this, SLOT(slotPlug(KPluginInfo*)));
  connect(KMyMoneyPlugin::PluginLoader::instance(), SIGNAL(unplug(KPluginInfo*)), 
            this, SLOT(slotUnplug(KPluginInfo*)));

Další sloty už se týkají vlastní funkce modulu. Vybrané transakce se zapamatují v našem modulu (změna výběru je signalizovaná do slotu slotTransactionsSelected) a při vyvolání akce se s vybranými transakcemi provede požadovaná činnost.

V seznamu vybraných transakcí se pracuje s objektem MyMoneyTransaction (ten je v seznamu transakcí trochu schovaný). Popis tohoto objektu můžete najít zde:

http://kmymoney2.sourceforge.net/kmymoney2-api/html/classMyMoneyTransaction.html

V našem modulu se z objektu využívá pouze volání *it.split().number(), které vrací číslo dokladu. Podle tohoto čísla se otevírá příslušný dokument.

 
/**
 * Slot volaný při změně výběru transakcí.
 * Pokud vybrané transakce obsahují číslo dokumentu, povolí se akce spojená s transakcí, jinak
 * je akce v menu neaktivní.
 */
void KMMOpenAttachedFilePlugin::slotTransactionsSelected(const KMyMoneyRegister::SelectedTransactions& transactions) {
  bool actionEnabled = false;
  m_transactions = transactions;
  KMyMoneyRegister::SelectedTransactions::const_iterator it;
  for (it = transactions.constBegin(); it != transactions.constEnd(); it++) {
    if ( (*it).split().number() != "" ) {
      actionEnabled = true;
      break;
      }
    }
  m_action->setEnabled(actionEnabled);
}

U vybraných transakcí se startuje externí aplikace podle uloženého nastavení. K tomu se dostaneme voláním funkce PluginSettings::path(). Využívá se zde automatického ukládání nastavení v KDE modulech do rc souborů. Po zaregistrování v souboru pluginsettings.kcfg je možné k hodnotám v nastavovacím formuláři přistupovat tímto jednoduchým voláním (path je jméno formulářového políčka). U widgetů z KDE je tato vlastnost bezproblémová, kolem widgetů z KMyMoney je někdy potřeba vytvořit jednoduchý wrapper, který tuto funkčnost doplní.

 
/**
 * Tento slot je volaný při vyvolání akce z kontextového menu transakce.
 * Pro každou vybranou transakci se zadaným číslem dokladu
 * zavolá funkci pro otevření příslušného dokumentu.
 */
void KMMOpenAttachedFilePlugin::slotOpenAttachedFile() {
  qDebug() << "KMMOpenAttachedFilePlugin::slotOpenAttachedFile()";
  KMyMoneyRegister::SelectedTransactions::const_iterator it;
  for (it = m_transactions.constBegin(); it != m_transactions.constEnd(); ++it) {
    if ( (*it).split().number() == "" ) {
      continue;
      }
    openFile((*it).split().number());
    }
}
 
 
/**
 * Funkce pro otevření dokumentu v zadaném programu.
 * Program se startuje nezávisle na KMyMoney. Po ukončení
 * programu se volá slotProcessFinished, aby se po nastartovaném
 * a ukončeném programu uklidilo.
 */
void KMMOpenAttachedFilePlugin::openFile(const QString& number) {
  QStringList params = PluginSettings::path().split(' ');
  if (params.isEmpty()) return;
  KProcess *process = new KProcess();
  process->setProgram(params.takeFirst());
 
  for (int i=0; i

Při programování modulů pro KMyMoney využijete často i další dva objekty (zde nepoužité) – MyMoneyFile a MyMoneyTransactionFilter. Objekt MyMoneyFile vám zprostředkuje přístup do všech vašich dat uložených v KMyMoney, pomocí objektu MyMoneyTransactionFilter pak můžete vybrat pouze transakce, které vás zajímají.

http://kmymoney2.sourceforge.net/kmymoney2-api/html/classMyMoneyTransactionFilter.html
http://kmymoney2.sourceforge.net/kmymoney2-api/html/classMyMoneyFile.html

Umístění akce v menu

Akci lze doplnit do prakticky libovolného menu v aplikaci KMyMoney. Umístění je určeno souborem kmm_openattachedfile.rc. Jde o jednoduchý xml soubor. Chcete-li se zorientovat ve struktuře menu aplikace KMyMoney, podívejte se do souboru kmymoneyui.rc (o dva adresáře výše, jste-li v  adresáři s modulem).

Nastavení modulu

Díky automatickému ukládání hodnot může být modul pro nastavení velmi jednoduchý. Prakticky nám stačí jen naklikat nastavovací formulář (vytvářejte widget, nikoli okno nebo dialog) a ve vlastním objektu jej pouze vytvořit (setupUi()) a připojit k objektu pluginu. Hezký popis tvorby nastavovací části pluginu najdete v dokumentaci KDE:

http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKCModule.html

Při klikání formuláře aplikací Designer z Qt vybírejte pouze widgety určené pro KDE. Jména polí uvádějte prefixem kcfg_ - naše pole pro nastavení aplikace se tak jmenuje kcfg_path. Když uvedete takové pole v souboru pluginsettings.kcfg, bude se hodnota ukládat automaticky a ve výkonné části modulu se k ní dostanete jednoduše voláním PluginSettings::path().

Překlady do různých jazyků

Chcete-li, aby byl modul začlenitelný do hlavního stromu aplikace KMyMoney, všechny řetězce, které se zobrazují uživateli, pište anglicky a uzavírejte je do volání funkce i18n(). Asi takto: i18n("This is an English string").

Překlad a linkování

Aby se váš nový modul překládal spolu s aplikací KMyMoney, musíte upravit soubor CMakeLists.txt v nadřízeném adresáři. Prakticky stačí doplnit řádek

 
ADD_SUBDIRECTORY( openattachedfile )

V tomto souboru se popisuje, co a jak se má při překladu a linkování dělat. Soubor CMakeLists.txt musí být i v adresáři openattachedfile, kde jsou uloženy naše zdrojové kódy. Jeho obsah už je složitější, ale nejjednodušším řešením je opět opisování odjinud. Já jsem opsal a upravil údaje v souboru připojeném k modulu printcheck.

Náš ukázkový modul je jednoduchý, vystačí si s minimem knihoven z KMyMoney. Sáhnete-li po některých dialozích či widgetech z KMyMoney (datum, výběr účtu), může být potřeba přilinkovat i některé další (bohužel statické) knihovny.

Ověření funkce

Jakmile je modul přeložený a nainstalovaný, měli byste nalézt jeho nastavení v menu Nastavení - Nastavení KMyMoney - Moduly. Mimo to můžete vyzkoušet modul pro nastavení i bez startu KMyMoney, použijte program kcmshell4: kcmshell4 kcm_kmm_openattachedfile.

Vlastní výkonnou část najdete v kontextovém menu transakce – v peněžním deníku klikněte levým tlačítkem na zvolenou transakci. Na konci menu byste měli vidět naši akci "Open attached file".

Odkazy na dokumentaci

Množství odkazů jsem uvedl již v textu, zde najdete alespoň krátké shrnutí:

Popis knihovny Qt
Popis API prostředí KDE
Popis API aplikace KMyMoney

Zdrojové tvary

I když je modul poměrně jednoduchý, zdrojových souborů je docela dost. Kompletní zdrojové tvary jsou proto ke stažení extra:

openattachedfile.tgz

Zveřejnění modulu

Máte-li modul přeložený a odladěný na vlastní kopii KMyMoney, můžete se pokusit o jeho začlenění do KMyMoney. Mně se to dosud nepodařilo, nejsem dostatečně vytvalý a vtěrný. Nebo mi nechodí pošta (to by byla ostuda). Zamýšlel jsem tento článek završit vítězným virtuálním poplácáním po vlastním rameni, ale plugin openattachedfile v hlavním stromu dosud není. Článek mám rozepsaný už nějakou dobu a dospěl jsem k názoru, že bude lepší jej zveřejnit i bez vítězného konce. Případné oznámení o úspěšném začlenění modulu a použitý postup tak najdete nejspíš v mém blogu zde na AbcLinuxu.

       

Komentáře

[Josef Kufner]

Btw, řešil jste někdo propojení s KMymoney s nějakým měřičem času? A třeba přímý převod času na peníze na nějakém (virtuálním) účtu odkud by se při zaplacení převedly na účet reprezentující reálné peníze...

[minix]

jiz delsi dobu (vlastne celou dobu aktivniho internetu) pozoruji Vase aktivity ohledne vsech moznych ucetnictvi. Kdyz si tak sectu ty hodiny, ktere jste patrne s celou tou problematikou stravil (vcetne tech nespocetnych clanku), tak mi vychazi, ze uz byste musel mit davno svuj vlastni softvarovy ucetni balik, ktery by se nemusel pred temi vsemi Pohodami a Winstromy stydet.

Mohl bych se zeptat, proc jste se do toho nikdy nepustil? Pak byste napr. nemusel u tech vsech cizich systemu, ktere jste kdy testoval a/nebo provozoval psat nejake takove moduly, ktere jsou napr.popsany v tomto clanku.