#!/usr/bin/perl #example script to print a basketgroup #written 07/11/08 by john.soros@biblibre.com and paul.poulain@biblibre.com # Copyright 2008-2009 BibLibre SARL # # This file is part of Koha. # # Koha 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 3 of the License, or # (at your option) any later version. # # Koha 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 Koha; if not, see . #you can use any PDF::API2 module, all you need to do is return the stringifyed pdf object from the printpdf sub. package pdfformat::layout3pages; use vars qw(@ISA @EXPORT); use MIME::Base64; use List::MoreUtils qw/uniq/; use Modern::Perl; use utf8; use Koha::Number::Price; use Koha::DateUtils; use Koha::Libraries; BEGIN { use Exporter (); our (@ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS); @ISA = qw(Exporter); @EXPORT = qw(printpdf); } #be careful, all the sizes (height, width, etc...) are in mm, not PostScript points (the default measurment of PDF::API2). #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. use constant mm => 25.4 / 72; use constant in => 1 / 72; use constant pt => 1; use PDF::API2; #A4 paper specs my ($height, $width) = (297, 210); use PDF::Table; sub printorders { my ($pdf, $basketgroup, $baskets, $orders) = @_; my $cur_format = C4::Context->preference("CurrencyFormat"); $pdf->mediabox($height/mm, $width/mm); my $number = 3; for my $basket (@$baskets){ my $page = $pdf->page(); my $billing_library = Koha::Libraries->find( $basket->{billingplace} ); my $delivery_library = Koha::Libraries->find( $basket->{deliveryplace} ); # print basket header (box) my $box = $page->gfx; $box->rectxy(($width - 10)/mm, ($height - 5)/mm, 10/mm, ($height - 25)/mm); $box->stroke; # $box->restore(); # create a text my $text = $page->text; # add basketgroup number $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm ); $text->translate(20/mm, ($height-15)/mm); $text->text("Order no. ".$basketgroup->{'id'}.". Basket no. ".$basket->{basketno}.". ".$basket->{booksellernote}); $text->translate(20/mm, ($height-20)/mm); $text->font( $pdf->corefont("Times", -encoding => "utf8"), 4/mm ); $text->text( ( $billing_library ? "Billing at " . $billing_library->branchname : "" ) . ( $billing_library and $delivery_library ? " and " : "" ) . ( $delivery_library ? "delivery at " . $delivery_library->branchname : "" ) ); my $pdftable = new PDF::Table(); my $abaskets; my $arrbasket; my @keys = ('Document', 'Qty', 'RRP tax exc.', 'RRP tax inc.', 'Discount', 'Discount price', 'GST rate', 'Total tax exc.', 'Total tax inc.'); for my $bkey (@keys) { push(@$arrbasket, $bkey); } push(@$abaskets, $arrbasket); my $titleinfo; foreach my $line (@{$orders->{$basket->{basketno}}}) { $arrbasket = undef; $titleinfo = ""; if ( C4::Context->preference("marcflavour") eq 'UNIMARC' ) { $titleinfo = $line->{title} . " / " . $line->{author} . ( $line->{isbn} ? " ISBN: " . $line->{isbn} : '' ) . ( $line->{en} ? " EN: " . $line->{en} : '' ) . ( $line->{itemtype} ? ", " . $line->{itemtype} : '' ) . ( $line->{edition} ? ", " . $line->{edition} : '' ) . ( $line->{publishercode} ? ' published by '. $line->{publishercode} : '') . ( $line->{publicationyear} ? ', '. $line->{publicationyear} : ''); } else { # MARC21, NORMARC $titleinfo = $line->{title} . " " . $line->{author} . ( $line->{isbn} ? " ISBN: " . $line->{isbn} : '' ) . ( $line->{en} ? " EN: " . $line->{en} : '' ) . ( $line->{itemtype} ? " " . $line->{itemtype} : '' ) . ( $line->{edition} ? ", " . $line->{edition} : '' ) . ( $line->{publishercode} ? ' published by '. $line->{publishercode} : '') . ( $line->{copyrightdate} ? ' '. $line->{copyrightdate} : ''); } push( @$arrbasket, $titleinfo. ($line->{order_vendornote} ? "\n----------------\nNote for vendor : " . $line->{order_vendornote} : '' ), $line->{quantity}, Koha::Number::Price->new( $line->{rrp_tax_excluded} )->format, Koha::Number::Price->new( $line->{rrp_tax_included} )->format, Koha::Number::Price->new( $line->{discount} )->format . '%', Koha::Number::Price->new( $line->{rrp_tax_excluded} - $line->{ecost_tax_excluded})->format, Koha::Number::Price->new( $line->{tax_rate} * 100 )->format . '%', Koha::Number::Price->new( $line->{total_tax_excluded} )->format, Koha::Number::Price->new( $line->{total_tax_included} )->format, ); push(@$abaskets, $arrbasket); } $pdftable->table($pdf, $page, $abaskets, x => 10/mm, w => ($width - 20)/mm, start_y => 270/mm, next_y => 285/mm, start_h => 250/mm, next_h => 250/mm, padding => 5, padding_right => 5, background_color_odd => "lightgray", font => $pdf->corefont("Times", -encoding => "utf8"), font_size => 3/mm, header_props => { font => $pdf->corefont("Times", -encoding => "utf8"), font_size => 9, bg_color => 'gray', repeat => 1, }, column_props => [ { min_w => 85/mm, # Minimum column width. }, { justify => 'right', # One of left|right , }, { justify => 'right', # One of left|right , }, { justify => 'right', # One of left|right , }, { justify => 'right', # One of left|right , }, { justify => 'right', # One of left|right , }, { justify => 'right', # One of left|right , }, { justify => 'right', # One of left|right , }, { justify => 'right', # One of left|right , }, ], ); } $pdf->mediabox($width/mm, $height/mm); } sub printbaskets { my ($pdf, $basketgroup, $hbaskets, $bookseller, $GSTrate, $orders) = @_; # get library name my $libraryname = C4::Context->preference("LibraryName"); my $cur_format = C4::Context->preference("CurrencyFormat"); $pdf->mediabox($width/mm, $height/mm); my $page = $pdf->openpage(2); # create a text my $text = $page->text; # add basketgroup number $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm ); $text->translate(($width-40)/mm, ($height-53)/mm); $text->text("".$basketgroup->{'id'}); # print the libraryname in the header $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm ); $text->translate(30/mm, ($height-28.5)/mm); $text->text($libraryname); my $pdftable = new PDF::Table(); my $abaskets; my $arrbasket; # header of the table my @keys = ('Lot', 'Basket (No.)','Total RRP tax exc.', 'Total RRP tax inc.', 'GST rate', 'GST', 'Total discount', 'Total tax exc.', 'Total tax inc.'); for my $bkey (@keys) { push(@$arrbasket, $bkey); } my ($grandtotal_rrp_tax_included, $grandtotal_rrp_tax_excluded, $grandtotal_tax_included, $grandtotal_tax_excluded, $grandtotaltax_value, $grandtotaldiscount); # calculate each basket total push(@$abaskets, $arrbasket); for my $basket (@$hbaskets) { my @gst; $arrbasket = undef; my ($total_rrp_tax_excluded, $total_rrp_tax_included, $total_tax_excluded, $total_tax_included, $totaltax_value, $totaldiscount); my $ords = $orders->{$basket->{basketno}}; my $ordlength = @$ords; foreach my $ord (@$ords) { $total_tax_excluded += $ord->{total_tax_excluded}; $total_tax_included += $ord->{total_tax_included}; $totaltax_value += $ord->{tax_value}; $totaldiscount += ($ord->{rrp_tax_excluded} - $ord->{ecost_tax_excluded} ) * $ord->{quantity}; $total_rrp_tax_excluded += $ord->{rrp_tax_excluded} * $ord->{quantity}; $total_rrp_tax_included += $ord->{rrp_tax_included} * $ord->{quantity}; push @gst, $ord->{tax_rate}; } @gst = uniq map { $_ * 100 } @gst; $grandtotal_rrp_tax_excluded += $total_rrp_tax_excluded; $grandtotal_rrp_tax_included += $total_rrp_tax_included; $grandtotal_tax_included += $total_tax_included; $grandtotal_tax_excluded += $total_tax_excluded; $grandtotaltax_value += $totaltax_value; $grandtotaldiscount += $totaldiscount; my @gst_string = map { Koha::Number::Price->new($_)->format . '%' } @gst; push(@$arrbasket, $basket->{contractname}, $basket->{basketname} . ' (No. ' . $basket->{basketno} . ')', Koha::Number::Price->new( $total_rrp_tax_excluded )->format, Koha::Number::Price->new( $total_rrp_tax_included )->format, "@gst_string", Koha::Number::Price->new( $totaltax_value )->format, Koha::Number::Price->new( $totaldiscount )->format, Koha::Number::Price->new( $total_tax_excluded )->format, Koha::Number::Price->new( $total_tax_included )->format, ); push(@$abaskets, $arrbasket); } # now, push total undef $arrbasket; push @$arrbasket, '', 'Total', Koha::Number::Price->new( $grandtotal_rrp_tax_excluded )->format, Koha::Number::Price->new( $grandtotal_rrp_tax_included )->format, '', Koha::Number::Price->new( $grandtotaltax_value )->format, Koha::Number::Price->new( $grandtotaldiscount )->format, Koha::Number::Price->new( $grandtotal_tax_excluded )->format, Koha::Number::Price->new( $grandtotal_tax_included )->format; push @$abaskets,$arrbasket; # height is width and width is height in this function, as the pdf is in landscape mode for the Tables. $pdftable->table($pdf, $page, $abaskets, x => 5/mm, w => ($width - 10)/mm, start_y => 230/mm, next_y => 230/mm, start_h => 230/mm, next_h => 230/mm, font => $pdf->corefont("Times", -encoding => "utf8"), font_size => 3/mm, padding => 5, padding_right => 10, background_color_odd => "lightgray", header_props => { bg_color => 'gray', repeat => 1, }, column_props => [ { }, { }, { justify => 'right', }, { justify => 'right', }, { justify => 'right', }, { justify => 'right', }, { justify => 'right', }, ], ); $pdf->mediabox($height/mm, $width/mm); } sub printhead { my ($pdf, $basketgroup, $bookseller) = @_; # get library name my $libraryname = C4::Context->preference("LibraryName"); my $billing_library = Koha::Libraries->find( $basketgroup->{billingplace} ); my $delivery_library = Koha::Libraries->find( $basketgroup->{deliveryplace} ); my $freedeliveryplace = $basketgroup->{freedeliveryplace}; # get the subject my $subject; # open 1st page (with the header) my $page = $pdf->openpage(1); # create a text my $text = $page->text; # print the libraryname in the header $text->font( $pdf->corefont("Times", -encoding => "utf8"), 6/mm ); $text->translate(30/mm, ($height-28.5)/mm); $text->text($libraryname); # print order info, on the default PDF $text->font( $pdf->corefont("Times", -encoding => "utf8"), 8/mm ); $text->translate(100/mm, ($height-5-48)/mm); $text->text($basketgroup->{'id'}); # print the date my $today = output_pref({ dt => dt_from_string, dateonly => 1 }); $text->translate(130/mm, ($height-5-48)/mm); $text->text($today); $text->font( $pdf->corefont("Times", -encoding => "utf8"), 4/mm ); # print billing infos $text->translate(100/mm, ($height-86)/mm); $text->text($libraryname); $text->translate(100/mm, ($height-97)/mm); $text->text($billing_library->branchname); $text->translate(100/mm, ($height-108.5)/mm); $text->text($billing_library->branchphone); $text->translate(100/mm, ($height-115.5)/mm); $text->text($billing_library->branchfax); $text->translate(100/mm, ($height-122.5)/mm); $text->text($billing_library->branchaddress1); $text->translate(100/mm, ($height-127.5)/mm); $text->text($billing_library->branchaddress2); $text->translate(100/mm, ($height-132.5)/mm); $text->text($billing_library->branchaddress3); $text->translate(100/mm, ($height-137.5)/mm); $text->text(join(' ', $billing_library->branchzip, $billing_library->branchcity, $billing_library->branchcountry)); $text->translate(100/mm, ($height-147.5)/mm); $text->text($billing_library->branchemail); # print subject $text->translate(100/mm, ($height-145.5)/mm); $text->text($subject); # print bookseller infos $text->translate(100/mm, ($height-180)/mm); $text->text($bookseller->name); $text->translate(100/mm, ($height-185)/mm); $text->text($bookseller->postal); $text->translate(100/mm, ($height-190)/mm); $text->text($bookseller->address1); $text->translate(100/mm, ($height-195)/mm); $text->text($bookseller->address2); $text->translate(100/mm, ($height-200)/mm); $text->text($bookseller->address3); $text->translate(100/mm, ($height-205)/mm); $text->text($bookseller->accountnumber); # print delivery infos $text->font( $pdf->corefont("Times-Bold", -encoding => "utf8"), 4/mm ); $text->translate(50/mm, ($height-237)/mm); if ($freedeliveryplace) { my $start = 242; my @fdp = split('\n', $freedeliveryplace); foreach (@fdp) { $text->text($_); $text->translate( 50 / mm, ( $height - $start ) / mm ); $start += 5; } } else { $text->text($delivery_library->branchaddress1); $text->translate(50/mm, ($height-242)/mm); $text->text($delivery_library->branchaddress2); $text->translate(50/mm, ($height-247)/mm); $text->text($delivery_library->branchaddress3); $text->translate(50/mm, ($height-252)/mm); $text->text(join(' ', $delivery_library->branchzip, $delivery_library->branchcity, $delivery_library->branchcountry)); } $text->translate(50/mm, ($height-262)/mm); $text->text($basketgroup->{deliverycomment}); } sub printfooters { my ($pdf) = @_; for (my $i=1;$i <= $pdf->pages;$i++) { my $page = $pdf->openpage($i); my $text = $page->text; $text->font( $pdf->corefont("Times", -encoding => "utf8"), 3/mm ); $text->translate(10/mm, 10/mm); $text->text("Page $i / ".$pdf->pages); } } sub printpdf { my ($basketgroup, $bookseller, $baskets, $orders, $GST) = @_; # open the default PDF that will be used for base (1st page already filled) my $pdf_template = C4::Context->config('intrahtdocs') . '/' . C4::Context->preference('template') . '/pdf/layout3pages.pdf'; my $pdf = PDF::API2->open($pdf_template); $pdf->pageLabel( 0, { -style => 'roman', } ); # start with roman numbering # fill the 1st page (basketgroup information) printhead($pdf, $basketgroup, $bookseller); # fill the 2nd page (orders summary) printbaskets($pdf, $basketgroup, $baskets, $bookseller, $GST, $orders); # fill other pages (orders) printorders($pdf, $basketgroup, $baskets, $orders); # print something on each page (usually the footer, but you could also put a header printfooters($pdf); return $pdf->stringify; } 1;