Koha/acqui/pdfformat/layout2pages.pm
Mathieu Saby 2dab2cc223 Bug 12110: Display the order vendor note in basket and basketgroup CSV and PDF
This bug adds the "vendor note" for each order in the PDF for
basketgroups.  The note is displayed only if it exists, just under the
bibliographic information.

I added a separation line "--------" between bibliographic information
and the note, so that it could be visible at 1st glance.

It also replaces the internal note with the vendor in the CSV for basket
and basketgroup.  It is more logical and useful for libraries to export
the note made for vendor, as those files are destined to be sent to the
vendor.

Test plan :
- fill a basket with some orders, some with internal notes, some with
  vendor notes
- export the basket in CSV : only the vendor notes should be present
- put the basket in a basketgroup
- export the basketgroup in CSV : only the vendor notes should be
  present
- Select "English-2 pages" template for basketgroups in Sysprefs
- export the basket in PDF : the vendor notes should be present under
  the bibliographic information
- Select "English-3 pages" template for basketgroups in Sysprefs
- export the basket in PDF : the vendor notes should be present under
  the bibliographic information

Signed-off-by: Paola Rossi <paola.rossi@cineca.it>
Signed-off-by: Jonathan Druart <jonathan.druart@biblibre.com>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
2014-05-25 15:21:22 +00:00

286 lines
11 KiB
Perl

#!/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 2 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#you can use any PDF::API2 module, all you need to do is return the stringifyed pdf object from the printpdf sub.
package pdfformat::layout2pages;
use vars qw($VERSION @ISA @EXPORT);
use Number::Format qw(format_price);
use MIME::Base64;
use strict;
use warnings;
use utf8;
use C4::Branch qw(GetBranchDetail);
BEGIN {
use Exporter ();
our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
# set the version for version checking
$VERSION = 1.00;
@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 tranform 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");
my $num;
if ( $cur_format eq 'FR' ) {
$num = new Number::Format(
'decimal_fill' => '2',
'decimal_point' => ',',
'int_curr_symbol' => '',
'mon_thousands_sep' => ' ',
'thousands_sep' => ' ',
'mon_decimal_point' => ','
);
} else { # US by default..
$num = new Number::Format(
'int_curr_symbol' => '',
'mon_thousands_sep' => ',',
'mon_decimal_point' => '.'
);
}
$pdf->mediabox($height/mm, $width/mm);
my $page = $pdf->page();
my $pdftable = new PDF::Table();
my $abaskets;
my $arrbasket;
my @keys = ('Basket (No.)', 'Document', 'Qty', 'RRP tax inc.', 'Discount', 'GST', 'Total tax exc.', 'Total tax inc.');
for my $bkey (@keys) {
push(@$arrbasket, $bkey);
}
push(@$abaskets, $arrbasket);
my $titleinfo;
for my $basket (@$baskets){
for 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,
$basket->{basketno},
$titleinfo. ($line->{order_vendornote} ? "\n----------------\nNotes for vendor : " . $line->{order_vendornote} : '' ),
$line->{quantity},
$num->format_price($line->{rrpgsti}),
$num->format_price($line->{discount}).'%',
$num->format_price($line->{gstrate} * 100).'%',
$num->format_price($line->{totalgste}),
$num->format_price($line->{totalgsti}),
);
push(@$abaskets, $arrbasket);
}
}
$pdftable->table($pdf, $page, $abaskets,
x => 10/mm,
w => ($width - 20)/mm,
start_y => 285/mm,
next_y => 285/mm,
start_h => 260/mm,
next_h => 260/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 => 10,
bg_color => 'gray',
repeat => 1,
},
column_props => [
{ justify => 'left' },
{ min_w => 90/mm },
{ justify => 'right' },
{ justify => 'right' },
{ justify => 'right' },
{ justify => 'right' },
{ justify => 'right' },
{ justify => 'right' },
],
);
$pdf->mediabox($width/mm, $height/mm);
}
sub printhead {
my ($pdf, $basketgroup, $bookseller) = @_;
# get library name
my $libraryname = C4::Context->preference("LibraryName");
# get branch details
my $billingdetails = GetBranchDetail( $basketgroup->{billingplace} );
my $deliverydetails = GetBranchDetail( $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 = C4::Dates->today();
$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($billingdetails->{branchname});
$text->translate(100/mm, ($height-108.5)/mm);
$text->text($billingdetails->{branchphone});
$text->translate(100/mm, ($height-115.5)/mm);
$text->text($billingdetails->{branchfax});
$text->translate(100/mm, ($height-122.5)/mm);
$text->text($billingdetails->{branchaddress1});
$text->translate(100/mm, ($height-127.5)/mm);
$text->text($billingdetails->{branchaddress2});
$text->translate(100/mm, ($height-132.5)/mm);
$text->text($billingdetails->{branchaddress3});
$text->translate(100/mm, ($height-137.5)/mm);
$text->text(join(' ', $billingdetails->{branchzip}, $billingdetails->{branchcity}, $billingdetails->{branchcountry}));
$text->translate(100/mm, ($height-147.5)/mm);
$text->text($billingdetails->{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( $deliverydetails->{branchaddress1} );
$text->translate( 50 / mm, ( $height - 242 ) / mm );
$text->text( $deliverydetails->{branchaddress2} );
$text->translate( 50 / mm, ( $height - 247 ) / mm );
$text->text( $deliverydetails->{branchaddress3} );
$text->translate( 50 / mm, ( $height - 252 ) / mm );
$text->text( join( ' ', $deliverydetails->{branchzip}, $deliverydetails->{branchcity}, $deliverydetails->{branchcountry} ) );
}
$text->translate(50/mm, ($height-262)/mm);
$text->text($basketgroup->{deliverycomment});
}
sub printfooters {
my $pdf = shift;
for ( 1..$pdf->pages ) {
my $page = $pdf->openpage($_);
my $text = $page->text;
$text->font( $pdf->corefont("Times", -encoding => "utf8"), 3/mm );
$text->translate(10/mm, 10/mm);
$text->text("Page $_ / ".$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/layout2pages.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 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;