Some enhancements to gc2latex

bin/gc2latex

@@ -1,3 +1,6 @@
+#!/opt/local/bin/perl
+# use the following line as default, the above line had to be
+# changed for Mac OSX perl installed with MacPorts/CPAN
 #!/usr/bin/perl
 
 # gc2latex by Stefan Tomanek <[email protected]>
@@ -7,6 +10,7 @@ use Gnucash::Business::InvoiceEntry;
 use Gnucash::Business::Customer;
 use IO::File;
 use Date::Format;
+use IO::Zlib;
 
 use strict;
 
@@ -19,16 +23,27 @@ sub main($$$) {
     }
 
     my $parser = new XML::Parser (ErrorContext => 2, Style => "Tree");
-    my $xmlobj = new XML::SimpleObject( $parser->parsefile($gnucash) ) || die "Unable to open Gnucash file";
-
+
+    my $zhandle = new IO::Zlib;
+    $zhandle->open($gnucash, "rb") || die "Unable to zopen Gnucash file\n";
+
+    my $xmlobj = new XML::SimpleObject( $parser->parse($zhandle) ) || die "Unable to open Gnucash file";
+
     my $invoice = new Invoice( $xmlobj, $id);
 
     replace($template, $invoice);
 }
 
+sub translateNewlines($) {
+    my ($value) = @_;
+    $value =~ s/\n/\\\\/g;
+    return $value;
+}
+
 # LaTeX encode: use LaTeX::Encode if available
-sub l_enc {
+sub l_enc ($) {
     my ($data) = @_;
+    return "" unless $data;
     my $result = $data;
     eval {
         # try to load LaTeX::Encode and encode the supplied data
@@ -37,58 +52,95 @@ sub l_enc {
         require LaTeX::Encode;
         $result = LaTeX::Encode::latex_encode( $data, {iquotes=>1} );
     };
+    $result = translateNewlines( $result );
     return $result;
 }
 
-sub createLaTeXTable($) {
-    my ($invoice) = @_;
-
-    my $cur = $invoice->getCurrency();
-
-    my $text = '\begin{longtable}{l|p{150pt}|l|l|r|r}'."\n";
-    $text .= 'Datum&Beschreibung&Einheit&Anzahl&St�ckpreis&Betrag\\\\'."\n";
-    $text .= '\hline\hline'."\n";
-    foreach my $e (@{ $invoice->getEntries() }) {
-        $text .= time2str("%e.%L.%Y", $e->getDate())."&";
-        $text .= l_enc( $e->getDescription() )."&";
-        $text .= l_enc( $e->getAction() )."&";
-        $text .= $e->getQuantity()."&";
-        $text .= sprintf("%0.2f", $e->getNetPrice())." $cur&";
-        $text .= sprintf("%0.2f", $e->getNetSum())." ".$cur.'\\\\'."\n";
-        $text .= '\hline'."\n";
-    }
-    $text .= '\hline'."\n";
-    $text .= '\multicolumn{5}{r|}{Summe} &'.sprintf("%0.2f", $invoice->getNetSum()).' '.$cur.'\\\\'."\n";
-    ## FIXME
-    ##	* Retrieve the right percentage from gnucash file
-    ##	* Support multiple taxes
-    $text .= '\multicolumn{5}{r|}{zuz�glich 19\% Umsatzsteuer} &'.sprintf("%0.2f", $invoice->getTaxes()).' '.$cur.'\\\\'."\n";
-    $text .= '\hline\hline'."\n";
-    $text .= '\multicolumn{5}{r|}{Gesamtsumme} &'.sprintf("%0.2f", $invoice->getNetSum()+$invoice->getTaxes()).' '.$cur.'\\\\'."\n";
-    $text .= '\end{longtable}'."\n";
-    return $text;
+sub createLaTexMacros() {
+
+  my $text= '%\usepackage{etoolbox}'."\n";
+
+  $text .= '\newcommand\gclsetline[3]{%'    ."\n";
+  $text .= '  \csdef{gcl#1#2}{#3}}%'        ."\n";
+
+  $text .= '\newcommand\gclgetline[2]{%'    ."\n";
+  $text .= '  \csuse{gcl#1#2}}'             ."\n";
+
+  return $text;
+}
+
+sub createLaTexParams($) {
+  my ($invoice) = @_;
+
+  my $text = '';
+
+  my $i=0;
+  foreach my $e (@{ $invoice->getEntries() }) {
+    $text .= "\\gclsetline{Date}{$i}{"          . time2str("%e.%L.%Y", $e->getDate())               . "}\n" ;
+    $text .= "\\gclsetline{Description}{$i}{"   . l_enc( $e->getDescription() )                     . "}\n" ;
+    $text .= "\\gclsetline{Action}{$i}{"        . l_enc( $e->getAction() )                          . "}\n" ;
+    $text .= "\\gclsetline{Quantity}{$i}{"      . $e->getQuantity()                                 . "}\n" ; 
+    $text .= "\\gclsetline{UnitPrice}{$i}{"     . sprintf("%0.2f", $e->getPrice())                  . "}\n" ;
+    $text .= "\\gclsetline{DiscType}{$i}{"      . l_enc($e->getDiscountType())                      . "}\n" ;
+    $text .= "\\gclsetline{DiscHow}{$i}{"       . l_enc($e->getDiscountHow())                       . "}\n" ;
+    $text .= "\\gclsetline{Disc}{$i}{"          . sprintf("%0.2f", round($e->getDiscount()))        . "}\n" ;
+    $text .= "\\gclsetline{isTaxable}{$i}{"     . l_enc($e->isTaxable())                            . "}\n" ;
+    $text .= "\\gclsetline{TaxTable}{$i}{"      . l_enc($e->getTaxTable())                          . "}\n" ;
+    $text .= "\\gclsetline{isTaxIncluded}{$i}{" . l_enc($e->isTaxIncluded())                        . "}\n" ;
+    $text .= "\\gclsetline{Subtotal}{$i}{"      . sprintf("%0.2f", round($e->getAmount('SubTotal'))). "}\n" ;
+    $text .= "\\gclsetline{Tax}{$i}{"           . sprintf("%0.2f", round($e->getAmount('Tax')))     . "}\n" ;
+    $text .= "\\gclsetline{Total}{$i}{"         . sprintf("%0.2f", round($e->getAmount('Total')))   . "}\n" ;
+    $text .= "\n";
+    $i=$i+1;
+  }
+  $text .= '\csdef{gclinvoicelines}{' . $i . "}\n";
+  return $text;
 }
 
 sub replace($$) {
     my ($template, $invoice) = @_;
-
-    my $file = new IO::File "< $template" || die "Unable to open template";
 
+    my $id = $invoice->getID();
+    my $postingdate = l_enc( time2str("%e.%L.%Y", $invoice->getPostingDate()) );
+    my $address = l_enc( $invoice->getCustomer()->getAddress() );
+    my $notes = l_enc($invoice->getNotes());
+    my $terms = l_enc($invoice->getTerms());
+    my $creditNoteType = $invoice->getCreditNoteType();
+    my $currency = $invoice->getCurrency();
+    my $total = sprintf("%0.2f", $invoice->getNetSum()+$invoice->getTaxes());
+    my $subtotal = sprintf("%0.2f", $invoice->getNetSum());
+    my $taxes = sprintf("%0.2f", $invoice->getTaxes());
+
+    # invoice items (mutliple lines)
+    my $parameters = createLaTexParams($invoice);
+    my $macros = createLaTexMacros();
+
+    my $file = new IO::File "< $template" || die "Unable to open template";
     while ( my $l = $file->getline() ) {
-        my $id = $invoice->getID();
-        my $date = l_enc( time2str("%e.%L.%Y", $invoice->getPostingDate()) );
-        my $address = l_enc( $invoice->getCustomer()->getAddress() );
-        $address =~ s/\n/\\\\/g;
-        my $table = createLaTeXTable($invoice);
 
-        $l =~ s/__GNUCASH-INVOICE-ID__/$id/;
-        $l =~ s/__GNUCASH-POSTING-DATE__/$date/;
-        $l =~ s/__GNUCASH-CUSTOMER__/$address/;
-        $l =~ s/__GNUCASH-TABLE__/$table/;
+        $l =~ s/__GNUCASH-INVOICE-ID__/$id/g;
+        $l =~ s/__GNUCASH-POSTING-DATE__/$postingdate/g;
+        $l =~ s/__GNUCASH-CUSTOMER__/$address/g;
+        $l =~ s/__GNUCASH-INVOICE-NOTES__/$notes/g;
+	$l =~ s/__GNUCASH-BILLING-TERMS__/$terms/g;
+        $l =~ s/__GNUCASH-CURRENCY__/$currency/g;
+        $l =~ s/__GNUCASH-TOTAL__/$total/g;
+        $l =~ s/__GNUCASH-SUBTOTAL__/$subtotal/g;
+        $l =~ s/__GNUCASH-TAXES__/$taxes/g;
+        $l =~ s/__GNUCASH-CREDIT-NOTE-TYPE__/$creditNoteType/g;
+
+        # invoice items (multiple lines)
+        $l =~ s/__GNUCASH-MACROS__/$macros/;
+        $l =~ s/__GNUCASH-PARAMETERS__/$parameters/;
 
         print $l;
     }
     $file->close();
 }
 
+sub round($) {
+    my ($value) = @_;
+    return int($value * 100 + 0.5) / 100;
+}
+
 main($ARGV[0], $ARGV[1], $ARGV[2]);

examples/template.tex

@@ -1,53 +1,104 @@
 % Template for gc2latex
 % by Stefan Tomanek <[email protected]>
 % http://stefans.datenbruch.de/gnucash/gc2latex.shtml
+%
+% adapted to use parameters and not directly generated
+% latex input from gc2latex by Benedikt Trefzer <[email protected]>
+%
+% enhanced for appropriate titles (invoice vs. credit-note), works
+% since GnuCash 2.6 by Susanne Wunsch <[email protected]>
 
 \documentclass[DIN, pagenumber=false, parskip=half,% 
                fromalign=left, fromphone=true,%  
                fromemail=true, fromurl=false, %
                fromlogo=true, fromrule=false]{scrlttr2}
 
-\usepackage[latin1]{inputenc}
-\usepackage{german}
-\RequirePackage{graphicx}
+\usepackage[ngerman]{babel}
+\usepackage{etoolbox}
+\usepackage{ifthen}
+\usepackage{tabularx}
+\usepackage{booktabs}
 
 \setkomavar{fromname}{Max Mustermann}
-\setkomavar{fromaddress}{Musterstra�e 34\\12345 Musterstadt}
+\setkomavar{fromaddress}{Musterstr. 34\\12345 Musterstadt}
 \setkomavar{fromphone}{01234/123456}
 \setkomavar{fromemail}{[email protected]}
 \setkomavar{fromurl}{}
 \setkomavar{signature}{Max Mustermann}
-\setkomavar{fromlogo}{\includegraphics*[width=6cm]{musterfirma.eps}}
 \setkomavar{frombank}{Musterbank\\BLZ: 12345678\\Kontonummer: 0123456}
-\setkomavar{subject}{Rechnung Nr. __GNUCASH-INVOICE-ID__}
+
+% Werte: DIN, DINmtext, SN, SNleft, KOMAold.
+\LoadLetterOption{DIN}  
+
+__GNUCASH-MACROS__
+
+__GNUCASH-PARAMETERS__
+
+\setkomavar{yourref}{}
+\setkomavar{yourmail}{}
+\setkomavar{myref}{}
+\setkomavar{customer}{}
+
+\setkomavar{invoice}{__GNUCASH-INVOICE-ID__}
 \setkomavar{date}{__GNUCASH-POSTING-DATE__}
 
-\begin{document}
+% Change the titles for your language needs
+\csdef{gclcreditnotetype1}{Gutschrift} % credit-note
+\csdef{gclcreditnotetype0}{Rechnung} % invoice/bill
+\setkomavar{title}{\csuse{__GNUCASH-CREDIT-NOTE-TYPE__}}
+
+\newcommand{\amp}{&}
+
+\newcommand{\printQuantity}[1]{
+  \gclgetline{Quantity}{#1}%
+  \ifthenelse{\equal{\gclgetline{Action}{#1}}{Hours}}{h}{}
+  \ifthenelse{\equal{\gclgetline{Action}{#1}}{Material}}{Stk.}{}
+}
 
-\firstfoot{ {\hrulefill\\}%
-  \fontsize{9}{10.5}\selectfont%
-  \parbox[t]{0.4\textwidth}{%
-    Musterfirma\\
-    \usekomavar{fromname}\\
-    \usekomavar{fromaddress}}%
-  \hfill%
-  \parbox[t]{0.3\textwidth}{\usekomavar{fromname}\\\usekomavar{frombank}}%
-  \hfill% 
-  \parbox[t]{0.3\textwidth}{%
-    Steuernummer: 111/22222/3333\\
-    Finanzamt Musterstadt-S�d\par } 
+\newcommand{\printDiscount}[1]{
+  \gclgetline{Disc}{#1}%
+  \ifthenelse{\equal{\gclgetline{DiscType}{#1}}{PERCENT}}{\%}{}
+  \ifthenelse{\equal{\gclgetline{DiscType}{#1}}{VALUE}}{__GNUCASH-CURRENCY__}{}
 }
+
+
 
+\newcommand{\printline}[5]{
+#1\amp#2\amp#3\amp#4\amp#5\\
+}
+
+
+\newcounter{i}
+\newcommand{\printtab}[1]{%
+  \setcounter{i}{0}
+  \whiledo {\value{i} < #1}{
+    \printline{\printQuantity{\arabic{i}}}
+              {\gclgetline{Description}{\arabic{i}}}
+              {\hfill\gclgetline{UnitPrice}{\arabic{i}}}
+              {\printDiscount{\arabic{i}}}
+              {\hfill\gclgetline{Subtotal}{\arabic{i}}}
+    \stepcounter{i}
+  }
+}
+
+
+\begin{document}
 \begin{letter}{__GNUCASH-CUSTOMER__}
+\opening{}
 
-\opening{Sehr geehrte Damen und Herren,}
-hiermit erlaube ich ich mir zu berechnen:
+\fontsize{10pt}{1em}\selectfont
+\begin{tabularx}{\linewidth}{lXlll}
+  Menge & Text & Preis (__GNUCASH-CURRENCY__) & Rabatt & Total (__GNUCASH-CURRENCY__) \\\toprule
+  \printtab{\csuse{gclinvoicelines}}\\[-2ex]
+  \midrule
+  &Taxes&\hfill__GNUCASH-SUBTOTAL__&&\hfill__GNUCASH-TAXES__\\
+  &\multicolumn{3}{l}{Total}&\hfill__GNUCASH-TOTAL__\\
+  \bottomrule
+\end{tabularx}
 
-__GNUCASH-TABLE__
+__GNUCASH-BILLING-TERMS__
 
-\closing{Mit freundlichem Gru�}
+\closing{}
 
 \end{letter}
-
 \end{document}
-

lib/Gnucash/Business/BillTerm.pm

@@ -0,0 +1,35 @@
+package BillTerm;
+
+use XML::SimpleObject;
+
+use strict;
+
+## By Susanne Wunsch <[email protected]>
+## Adapted from Stefan Tomanek <[email protected]>
+
+sub new($$$) {
+    my ($proto, $gc, $guid) = @_;
+
+    my $self = {};
+    $self->{guid} = $guid;	
+    fillInfos($self, $gc);
+
+    bless($self);
+    return $self;
+}
+
+sub fillInfos($) {
+    my ($self, $xml) = @_;
+
+    my $gc = $xml->child("gnc-v2")->child("gnc:book");
+
+    my @terms = $gc->children("gnc:GncBillTerm");
+    return if ($terms[0] eq "");
+    foreach my $tm (@terms) {
+        next unless ($self->{guid} eq $tm->child("billterm:guid")->value());
+        $self->{info}{description} = $tm->child("billterm:desc")->value();
+        last;
+    }
+}
+
+1;