3 #example script to print a basketgroup
4 #written 07/11/08 by john.soros@biblibre.com and paul.poulain@biblibre.com
6 # Copyright 2008-2009 BibLibre SARL
8 # This file is part of Koha.
10 # Koha is free software; you can redistribute it and/or modify it
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #you can use any PDF::API2 module, all you need to do is return the stringifyed pdf object from the printpdf sub.
24 package pdfformat::layout3pages;
25 use vars qw(@ISA @EXPORT);
27 use List::MoreUtils qw/uniq/;
32 use Koha::Number::Price;
38 our (@ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
40 @EXPORT = qw(printpdf);
44 #be careful, all the sizes (height, width, etc...) are in mm, not PostScript points (the default measurment of PDF::API2).
45 #The constants exported transform that into PostScript points (/mm for milimeter, /in for inch, pt is postscript point, and as so is there only to show what is happening.
46 use constant mm => 25.4 / 72;
47 use constant in => 1 / 72;
52 my ($height, $width) = (297, 210);
56 my ($pdf, $basketgroup, $baskets, $orders) = @_;
58 my $cur_format = C4::Context->preference("CurrencyFormat");
60 $pdf->mediabox($height/mm, $width/mm);
62 for my $basket (@$baskets){
63 my $page = $pdf->page();
64 my $billing_library = Koha::Libraries->find( $basket->{billingplace} );
65 my $delivery_library = Koha::Libraries->find( $basket->{deliveryplace} );
67 # print basket header (box)
69 $box->rectxy(($width - 10)/mm, ($height - 5)/mm, 10/mm, ($height - 25)/mm);
74 my $text = $page->text;
75 # add basketgroup number
76 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm );
77 $text->translate(20/mm, ($height-15)/mm);
78 $text->text("Order no. ".$basketgroup->{'id'}.". Basket no. ".$basket->{basketno}.". ".$basket->{booksellernote});
79 $text->translate(20/mm, ($height-20)/mm);
80 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 4/mm );
81 $text->text( ( $billing_library ? "Billing at " . $billing_library->branchname : "" )
82 . ( $billing_library and $delivery_library ? " and " : "" )
83 . ( $delivery_library ? "delivery at " . $delivery_library->branchname : "" )
86 my $pdftable = new PDF::Table();
89 my @keys = ('Document', 'Qty', 'RRP tax exc.', 'RRP tax inc.', 'Discount', 'Discount price', 'GST rate', 'Total tax exc.', 'Total tax inc.');
90 for my $bkey (@keys) {
91 push(@$arrbasket, $bkey);
93 push(@$abaskets, $arrbasket);
96 foreach my $line (@{$orders->{$basket->{basketno}}}) {
99 if ( C4::Context->preference("marcflavour") eq 'UNIMARC' ) {
100 $titleinfo = $line->{title} . " / " . $line->{author} .
101 ( $line->{isbn} ? " ISBN: " . $line->{isbn} : '' ) .
102 ( $line->{en} ? " EN: " . $line->{en} : '' ) .
103 ( $line->{itemtype} ? ", " . $line->{itemtype} : '' ) .
104 ( $line->{edition} ? ", " . $line->{edition} : '' ) .
105 ( $line->{publishercode} ? ' published by '. $line->{publishercode} : '') .
106 ( $line->{publicationyear} ? ', '. $line->{publicationyear} : '');
108 else { # MARC21, NORMARC
109 $titleinfo = $line->{title} . " " . $line->{author} .
110 ( $line->{isbn} ? " ISBN: " . $line->{isbn} : '' ) .
111 ( $line->{en} ? " EN: " . $line->{en} : '' ) .
112 ( $line->{itemtype} ? " " . $line->{itemtype} : '' ) .
113 ( $line->{edition} ? ", " . $line->{edition} : '' ) .
114 ( $line->{publishercode} ? ' published by '. $line->{publishercode} : '') .
115 ( $line->{copyrightdate} ? ' '. $line->{copyrightdate} : '');
118 $titleinfo. ($line->{order_vendornote} ? "\n----------------\nNote for vendor : " . $line->{order_vendornote} : '' ),
120 Koha::Number::Price->new( $line->{rrp_tax_excluded} )->format,
121 Koha::Number::Price->new( $line->{rrp_tax_included} )->format,
122 Koha::Number::Price->new( $line->{discount} )->format . '%',
123 Koha::Number::Price->new( $line->{rrp_tax_excluded} - $line->{ecost_tax_excluded})->format,
124 Koha::Number::Price->new( $line->{tax_rate} * 100 )->format . '%',
125 Koha::Number::Price->new( $line->{total_tax_excluded} )->format,
126 Koha::Number::Price->new( $line->{total_tax_included} )->format,
128 push(@$abaskets, $arrbasket);
131 $pdftable->table($pdf, $page, $abaskets,
133 w => ($width - 20)/mm,
140 background_color_odd => "lightgray",
141 font => $pdf->corefont("Times", -encoding => "utf8"),
144 font => $pdf->corefont("Times", -encoding => "utf8"),
151 min_w => 85/mm, # Minimum column width.
154 justify => 'right', # One of left|right ,
157 justify => 'right', # One of left|right ,
160 justify => 'right', # One of left|right ,
163 justify => 'right', # One of left|right ,
166 justify => 'right', # One of left|right ,
169 justify => 'right', # One of left|right ,
172 justify => 'right', # One of left|right ,
175 justify => 'right', # One of left|right ,
180 $pdf->mediabox($width/mm, $height/mm);
184 my ($pdf, $basketgroup, $hbaskets, $bookseller, $GSTrate, $orders) = @_;
187 my $libraryname = C4::Context->preference("LibraryName");
189 my $cur_format = C4::Context->preference("CurrencyFormat");
191 $pdf->mediabox($width/mm, $height/mm);
192 my $page = $pdf->openpage(2);
194 my $text = $page->text;
196 # add basketgroup number
197 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm );
198 $text->translate(($width-40)/mm, ($height-53)/mm);
199 $text->text("".$basketgroup->{'id'});
200 # print the libraryname in the header
201 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm );
202 $text->translate(30/mm, ($height-28.5)/mm);
203 $text->text($libraryname);
204 my $pdftable = new PDF::Table();
207 # header of the table
208 my @keys = ('Lot', 'Basket (No.)','Total RRP tax exc.', 'Total RRP tax inc.', 'GST rate', 'GST', 'Total discount', 'Total tax exc.', 'Total tax inc.');
209 for my $bkey (@keys) {
210 push(@$arrbasket, $bkey);
212 my ($grandtotal_rrp_tax_included, $grandtotal_rrp_tax_excluded, $grandtotal_tax_included, $grandtotal_tax_excluded, $grandtotaltax_value, $grandtotaldiscount);
213 # calculate each basket total
214 push(@$abaskets, $arrbasket);
215 for my $basket (@$hbaskets) {
218 my ($total_rrp_tax_excluded, $total_rrp_tax_included, $total_tax_excluded, $total_tax_included, $totaltax_value, $totaldiscount);
219 my $ords = $orders->{$basket->{basketno}};
220 my $ordlength = @$ords;
221 foreach my $ord (@$ords) {
222 $total_tax_excluded += $ord->{total_tax_excluded};
223 $total_tax_included += $ord->{total_tax_included};
224 $totaltax_value += $ord->{tax_value};
225 $totaldiscount += ($ord->{rrp_tax_excluded} - $ord->{ecost_tax_excluded} ) * $ord->{quantity};
226 $total_rrp_tax_excluded += $ord->{rrp_tax_excluded} * $ord->{quantity};
227 $total_rrp_tax_included += $ord->{rrp_tax_included} * $ord->{quantity};
228 push @gst, $ord->{tax_rate};
230 @gst = uniq map { $_ * 100 } @gst;
231 $grandtotal_rrp_tax_excluded += $total_rrp_tax_excluded;
232 $grandtotal_rrp_tax_included += $total_rrp_tax_included;
233 $grandtotal_tax_included += $total_tax_included;
234 $grandtotal_tax_excluded += $total_tax_excluded;
235 $grandtotaltax_value += $totaltax_value;
236 $grandtotaldiscount += $totaldiscount;
238 map { Koha::Number::Price->new($_)->format . '%' } @gst;
240 $basket->{contractname},
241 $basket->{basketname} . ' (No. ' . $basket->{basketno} . ')',
242 Koha::Number::Price->new( $total_rrp_tax_excluded )->format,
243 Koha::Number::Price->new( $total_rrp_tax_included )->format,
245 Koha::Number::Price->new( $totaltax_value )->format,
246 Koha::Number::Price->new( $totaldiscount )->format,
247 Koha::Number::Price->new( $total_tax_excluded )->format,
248 Koha::Number::Price->new( $total_tax_included )->format,
250 push(@$abaskets, $arrbasket);
257 Koha::Number::Price->new( $grandtotal_rrp_tax_excluded )->format,
258 Koha::Number::Price->new( $grandtotal_rrp_tax_included )->format,
260 Koha::Number::Price->new( $grandtotaltax_value )->format,
261 Koha::Number::Price->new( $grandtotaldiscount )->format,
262 Koha::Number::Price->new( $grandtotal_tax_excluded )->format,
263 Koha::Number::Price->new( $grandtotal_tax_included )->format;
264 push @$abaskets,$arrbasket;
265 # height is width and width is height in this function, as the pdf is in landscape mode for the Tables.
267 $pdftable->table($pdf, $page, $abaskets,
269 w => ($width - 10)/mm,
274 font => $pdf->corefont("Times", -encoding => "utf8"),
278 background_color_odd => "lightgray",
305 $pdf->mediabox($height/mm, $width/mm);
309 my ($pdf, $basketgroup, $bookseller) = @_;
312 my $libraryname = C4::Context->preference("LibraryName");
313 my $billing_library = Koha::Libraries->find( $basketgroup->{billingplace} );
314 my $delivery_library = Koha::Libraries->find( $basketgroup->{deliveryplace} );
315 my $freedeliveryplace = $basketgroup->{freedeliveryplace};
319 # open 1st page (with the header)
320 my $page = $pdf->openpage(1);
323 my $text = $page->text;
325 # print the libraryname in the header
326 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm );
327 $text->translate(30/mm, ($height-28.5)/mm);
328 $text->text($libraryname);
330 # print order info, on the default PDF
331 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 8/mm );
332 $text->translate(100/mm, ($height-5-48)/mm);
333 $text->text($basketgroup->{'id'});
336 my $today = output_pref({ dt => dt_from_string, dateonly => 1 });
337 $text->translate(130/mm, ($height-5-48)/mm);
340 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 4/mm );
342 # print billing infos
343 $text->translate(100/mm, ($height-86)/mm);
344 $text->text($libraryname);
345 $text->translate(100/mm, ($height-97)/mm);
346 $text->text($billing_library->branchname);
347 $text->translate(100/mm, ($height-108.5)/mm);
348 $text->text($billing_library->branchphone);
349 $text->translate(100/mm, ($height-115.5)/mm);
350 $text->text($billing_library->branchfax);
351 $text->translate(100/mm, ($height-122.5)/mm);
352 $text->text($billing_library->branchaddress1);
353 $text->translate(100/mm, ($height-127.5)/mm);
354 $text->text($billing_library->branchaddress2);
355 $text->translate(100/mm, ($height-132.5)/mm);
356 $text->text($billing_library->branchaddress3);
357 $text->translate(100/mm, ($height-137.5)/mm);
358 $text->text(join(' ', $billing_library->branchzip, $billing_library->branchcity, $billing_library->branchcountry));
359 $text->translate(100/mm, ($height-147.5)/mm);
360 $text->text($billing_library->branchemail);
363 $text->translate(100/mm, ($height-145.5)/mm);
364 $text->text($subject);
366 # print bookseller infos
367 $text->translate(100/mm, ($height-180)/mm);
368 $text->text($bookseller->name);
369 $text->translate(100/mm, ($height-185)/mm);
370 $text->text($bookseller->postal);
371 $text->translate(100/mm, ($height-190)/mm);
372 $text->text($bookseller->address1);
373 $text->translate(100/mm, ($height-195)/mm);
374 $text->text($bookseller->address2);
375 $text->translate(100/mm, ($height-200)/mm);
376 $text->text($bookseller->address3);
377 $text->translate(100/mm, ($height-205)/mm);
378 $text->text($bookseller->accountnumber);
380 # print delivery infos
381 $text->font( $pdf->corefont("Times-Bold", -encoding => "utf8"), 4/mm );
382 $text->translate(50/mm, ($height-237)/mm);
383 if ($freedeliveryplace) {
385 my @fdp = split('\n', $freedeliveryplace);
388 $text->translate( 50 / mm, ( $height - $start ) / mm );
392 $text->text($delivery_library->branchaddress1);
393 $text->translate(50/mm, ($height-242)/mm);
394 $text->text($delivery_library->branchaddress2);
395 $text->translate(50/mm, ($height-247)/mm);
396 $text->text($delivery_library->branchaddress3);
397 $text->translate(50/mm, ($height-252)/mm);
398 $text->text(join(' ', $delivery_library->branchzip, $delivery_library->branchcity, $delivery_library->branchcountry));
400 $text->translate(50/mm, ($height-262)/mm);
401 $text->text($basketgroup->{deliverycomment});
406 for (my $i=1;$i <= $pdf->pages;$i++) {
407 my $page = $pdf->openpage($i);
408 my $text = $page->text;
409 $text->font( $pdf->corefont("Times", -encoding => "utf8"), 3/mm );
410 $text->translate(10/mm, 10/mm);
411 $text->text("Page $i / ".$pdf->pages);
416 my ($basketgroup, $bookseller, $baskets, $orders, $GST) = @_;
417 # open the default PDF that will be used for base (1st page already filled)
418 my $pdf_template = C4::Context->config('intrahtdocs') . '/' . C4::Context->preference('template') . '/pdf/layout3pages.pdf';
419 my $pdf = PDF::API2->open($pdf_template);
420 $pdf->pageLabel( 0, {
422 } ); # start with roman numbering
423 # fill the 1st page (basketgroup information)
424 printhead($pdf, $basketgroup, $bookseller);
425 # fill the 2nd page (orders summary)
426 printbaskets($pdf, $basketgroup, $baskets, $bookseller, $GST, $orders);
427 # fill other pages (orders)
428 printorders($pdf, $basketgroup, $baskets, $orders);
429 # print something on each page (usually the footer, but you could also put a header
431 return $pdf->stringify;