acqui/basketgroup.pl

   1 #!/usr/bin/perl
   2
   3 #script to group (closed) baskets into basket groups for easier order management
   4 #written by john.soros@biblibre.com 01/10/2008
   5
   6 # Copyright 2008 - 2009 BibLibre SARL
   7 # Parts Copyright Catalyst 2010
   8 #
   9 # This file is part of Koha.
  10 #
  11 # Koha is free software; you can redistribute it and/or modify it
  12 # under the terms of the GNU General Public License as published by
  13 # the Free Software Foundation; either version 3 of the License, or
  14 # (at your option) any later version.
  15 #
  16 # Koha is distributed in the hope that it will be useful, but
  17 # WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19 # GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License
  22 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  23
  24
  25 =head1 NAME
  26
  27 basketgroup.pl
  28
  29 =head1 DESCRIPTION
  30
  31  This script lets the user group (closed) baskets into basket groups for easier order management. Note that the grouped baskets have to be from the same bookseller and
  32  have to be closed to be printed or exported.
  33
  34 =head1 CGI PARAMETERS
  35
  36 =over 4
  37
  38 =item $booksellerid
  39
  40 The bookseller who we want to display the baskets (and basketgroups) of.
  41
  42 =back
  43
  44 =cut
  45
  46 use Modern::Perl;
  47 use Carp;
  48
  49 use C4::Auth;
  50 use C4::Output;
  51 use CGI qw ( -utf8 );
  52 use File::Spec;
  53
  54 use C4::Acquisition qw/CloseBasketgroup ReOpenBasketgroup GetOrders GetBasketsByBasketgroup GetBasketsByBookseller ModBasketgroup NewBasketgroup DelBasketgroup GetBasketgroups ModBasket GetBasketgroup GetBasket GetBasketGroupAsCSV/;
  55 use Koha::EDI qw/create_edi_order get_edifact_ean/;
  56
  57 use Koha::Biblioitems;
  58 use Koha::Acquisition::Booksellers;
  59 use Koha::ItemTypes;
  60 use Koha::Patrons;
  61
  62 our $input=new CGI;
  63
  64 our ($template, $loggedinuser, $cookie)
  65     = get_template_and_user({template_name => "acqui/basketgroup.tt",
  66                              query => $input,
  67                              type => "intranet",
  68                              authnotrequired => 0,
  69                              flagsrequired => {acquisition => 'group_manage'},
  70                              debug => 1,
  71                 });
  72
  73 sub BasketTotal {
  74     my $basketno = shift;
  75     my $bookseller = shift;
  76     my $total = 0;
  77     my @orders = GetOrders($basketno);
  78     for my $order (@orders){
  79         # FIXME The following is wrong
  80         if ( $bookseller->listincgst ) {
  81             $total = $total + ( $order->{ecost_tax_included} * $order->{quantity} );
  82         } else {
  83             $total = $total + ( $order->{ecost_tax_excluded} * $order->{quantity} );
  84         }
  85     }
  86     return $total;
  87 }
  88
  89 #displays all basketgroups and all closed baskets (in their respective groups)
  90 sub displaybasketgroups {
  91     my $basketgroups = shift;
  92     my $bookseller = shift;
  93     my $baskets = shift;
  94     if (scalar @$basketgroups != 0) {
  95         foreach my $basketgroup (@$basketgroups){
  96             my $i = 0;
  97             my $basketsqty = 0;
  98             while($i < scalar(@$baskets)){
  99                 my $basket = @$baskets[$i];
 100                 if($basket->{'basketgroupid'} && $basket->{'basketgroupid'} == $basketgroup->{'id'}){
 101                     $basket->{total} = BasketTotal($basket->{basketno}, $bookseller);
 102                     push(@{$basketgroup->{'baskets'}}, $basket);
 103                     splice(@$baskets, $i, 1);
 104                     ++$basketsqty;
 105                     --$i;
 106                 }
 107                 ++$i;
 108             }
 109             $basketgroup -> {'basketsqty'} = $basketsqty;
 110         }
 111         $template->param(basketgroups => $basketgroups);
 112     }
 113     for(my $i=0; $i < scalar @$baskets; ++$i) {
 114         if( ! @$baskets[$i]->{'closedate'} ) {
 115             splice(@$baskets, $i, 1);
 116             --$i;
 117         }else{
 118             @$baskets[$i]->{total} = BasketTotal(@$baskets[$i]->{basketno}, $bookseller);
 119         }
 120     }
 121     $template->param(baskets => $baskets);
 122     $template->param( booksellername => $bookseller->name);
 123 }
 124
 125 sub printbasketgrouppdf{
 126     my ($basketgroupid) = @_;
 127
 128     my $pdfformat = C4::Context->preference("OrderPdfFormat");
 129     my @valid_pdfformats = qw(pdfformat::layout3pages pdfformat::layout2pages pdfformat::layout3pagesfr pdfformat::layout2pagesde);
 130     if (grep {$_ eq $pdfformat} @valid_pdfformats) {
 131         $pdfformat = "Koha::$pdfformat";
 132         my $pdfformat_filepath = File::Spec->catfile(split /::/, $pdfformat) . '.pm';
 133         require $pdfformat_filepath;
 134         import $pdfformat;
 135     }
 136     else {
 137         print $input->header;
 138         print $input->start_html;  # FIXME Should do a nicer page
 139         print "<h1>Invalid PDF Format set</h1>";
 140         print "Please go to the systempreferences and set a valid pdfformat";
 141         exit;
 142     }
 143
 144     my $basketgroup = GetBasketgroup($basketgroupid);
 145     my $bookseller = Koha::Acquisition::Booksellers->find( $basketgroup->{booksellerid} );
 146     my $baskets = GetBasketsByBasketgroup($basketgroupid);
 147
 148     my %orders;
 149     for my $basket (@$baskets) {
 150         my @ba_orders;
 151         my @ords = &GetOrders($basket->{basketno});
 152         for my $ord (@ords) {
 153
 154             next unless ( $ord->{biblionumber} or $ord->{quantity}> 0 );
 155             eval {
 156                 require C4::Biblio;
 157                 import C4::Biblio;
 158             };
 159             if ($@){
 160                 croak $@;
 161             }
 162             eval {
 163                 require C4::Koha;
 164                 import C4::Koha;
 165             };
 166             if ($@){
 167                 croak $@;
 168             }
 169
 170             $ord->{tax_value} = $ord->{tax_value_on_ordering};
 171             $ord->{tax_rate} = $ord->{tax_rate_on_ordering};
 172             $ord->{total_tax_included} = $ord->{ecost_tax_included} * $ord->{quantity};
 173             $ord->{total_tax_excluded} = $ord->{ecost_tax_excluded} * $ord->{quantity};
 174
 175             my $biblioitem = Koha::Biblioitems->search({ biblionumber => $ord->{biblionumber} })->next;
 176
 177             #FIXME DELETE ME
 178             # 0      1        2        3         4            5         6       7      8        9
 179             #isbn, itemtype, author, title, publishercode, quantity, listprice ecost discount tax_rate
 180
 181             # Editor Number
 182             my $en;
 183             my $edition;
 184             $ord->{marcxml} = C4::Biblio::GetXmlBiblio( $ord->{biblionumber} );
 185             my $marcrecord=eval{MARC::Record::new_from_xml( $ord->{marcxml},'UTF-8' )};
 186             if ($marcrecord){
 187                 if ( C4::Context->preference("marcflavour") eq 'UNIMARC' ) {
 188                     $en = $marcrecord->subfield( '345', "b" );
 189                     $edition = $marcrecord->subfield( '205', 'a' );
 190                 } elsif ( C4::Context->preference("marcflavour") eq 'MARC21' ) {
 191                     $en = $marcrecord->subfield( '037', "a" );
 192                     $edition = $marcrecord->subfield( '250', 'a' );
 193                 }
 194             }
 195
 196             my $itemtype = ( $ord->{itemtype} and $biblioitem->itemtype )
 197                 ? Koha::ItemTypes->find( $biblioitem->itemtype )
 198                 : undef;
 199             $ord->{itemtype} = $itemtype ? $itemtype->description : undef;
 200
 201             $ord->{en} = $en ? $en : undef;
 202             $ord->{edition} = $edition ? $edition : undef;
 203
 204             push(@ba_orders, $ord);
 205         }
 206         $orders{$basket->{basketno}} = \@ba_orders;
 207     }
 208     print $input->header(
 209         -type       => 'application/pdf',
 210         -attachment => ( $basketgroup->{name} || $basketgroupid ) . '.pdf'
 211     );
 212     my $pdf = printpdf($basketgroup, $bookseller, $baskets, \%orders, $bookseller->tax_rate // C4::Context->preference("gist")) || die "pdf generation failed";
 213     print $pdf;
 214
 215 }
 216
 217 sub generate_edifact_orders {
 218     my $basketgroupid = shift;
 219     my $baskets       = GetBasketsByBasketgroup($basketgroupid);
 220     my $ean           = get_edifact_ean();
 221
 222     if($ean) {
 223         for my $basket ( @{$baskets} ) {
 224             create_edi_order( { ean => $ean, basketno => $basket->{basketno}, } );
 225         }
 226     } else {
 227         my $booksellerid = $input->param('booksellerid') || 0;
 228         print $input->redirect('/cgi-bin/koha/acqui/basketgroup.pl?booksellerid=' .
 229                                $booksellerid .
 230                                '&message=No%20EDIFACT%20Setup');
 231     }
 232     return;
 233 }
 234
 235 my $op = $input->param('op') || 'display';
 236 # possible values of $op :
 237 # - add : adds a new basketgroup, or edit an open basketgroup, or display a closed basketgroup
 238 # - mod_basket : modify an individual basket of the basketgroup
 239 # - closeandprint : close and print an closed basketgroup in pdf. called by clicking on "Close and print" button in closed basketgroups list
 240 # - print : print a closed basketgroup. called by clicking on "Print" button in closed basketgroups list
 241 # - ediprint : generate edi order messages for the baskets in the group
 242 # - export : export in CSV a closed basketgroup. called by clicking on "Export" button in closed basketgroups list
 243 # - delete : delete an open basketgroup. called by clicking on "Delete" button in open basketgroups list
 244 # - reopen : reopen a closed basketgroup. called by clicking on "Reopen" button in closed basketgroup list
 245 # - attachbasket : save a modified basketgroup, or creates a new basketgroup when a basket is closed. called from basket page
 246 # - display : display the list of all basketgroups for a vendor
 247 my $booksellerid = $input->param('booksellerid');
 248 $template->param(booksellerid => $booksellerid);
 249 my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
 250
 251 my $schema = Koha::Database->new()->schema();
 252 my $rs = $schema->resultset('VendorEdiAccount')->search(
 253     { vendor_id => $booksellerid, } );
 254 $template->param( ediaccount => ($rs->count > 0));
 255
 256 if ( $op eq "add" ) {
 257 #
 258 # if no param('basketgroupid') is not defined, adds a new basketgroup
 259 # else, edit (if it is open) or display (if it is close) the basketgroup basketgroupid
 260 # the template will know if basketgroup must be displayed or edited, depending on the value of closed key
 261 #
 262     my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
 263     my $basketgroupid = $input->param('basketgroupid');
 264     my $billingplace;
 265     my $deliveryplace;
 266     my $freedeliveryplace;
 267     if ( $basketgroupid ) {
 268         # Get the selected baskets in the basketgroup to display them
 269         my $selecteds = GetBasketsByBasketgroup($basketgroupid);
 270         foreach my $basket(@{$selecteds}){
 271             $basket->{total} = BasketTotal($basket->{basketno}, $bookseller);
 272         }
 273         $template->param(basketgroupid => $basketgroupid,
 274                          selectedbaskets => $selecteds);
 275
 276         # Get general informations about the basket group to prefill the form
 277         my $basketgroup = GetBasketgroup($basketgroupid);
 278         $template->param(
 279             name            => $basketgroup->{name},
 280             deliverycomment => $basketgroup->{deliverycomment},
 281             freedeliveryplace => $basketgroup->{freedeliveryplace},
 282         );
 283         $billingplace  = $basketgroup->{billingplace};
 284         $deliveryplace = $basketgroup->{deliveryplace};
 285         $freedeliveryplace = $basketgroup->{freedeliveryplace};
 286         $template->param( closedbg => ($basketgroup ->{'closed'}) ? 1 : 0);
 287     } else {
 288         $template->param( closedbg => 0);
 289     }
 290     # determine default billing and delivery places depending on librarian homebranch and existing basketgroup data
 291     my $patron = Koha::Patrons->find( $loggedinuser ); # FIXME Not needed if billingplace and deliveryplace are set
 292     $billingplace  = $billingplace  || $patron->branchcode;
 293     $deliveryplace = $deliveryplace || $patron->branchcode;
 294
 295     $template->param( billingplace => $billingplace );
 296     $template->param( deliveryplace => $deliveryplace );
 297     $template->param( booksellerid => $booksellerid );
 298
 299     # the template will display a unique basketgroup
 300     $template->param(grouping => 1);
 301     my $basketgroups = &GetBasketgroups($booksellerid);
 302     my $baskets = &GetBasketsByBookseller($booksellerid);
 303     displaybasketgroups($basketgroups, $bookseller, $baskets);
 304 } elsif ($op eq 'mod_basket') {
 305 #
 306 # edit an individual basket contained in this basketgroup
 307 #
 308   my $basketno=$input->param('basketno');
 309   my $basketgroupid=$input->param('basketgroupid');
 310   ModBasket( { basketno => $basketno,
 311                          basketgroupid => $basketgroupid } );
 312   print $input->redirect("basket.pl?basketno=" . $basketno);
 313 } elsif ( $op eq 'closeandprint') {
 314 #
 315 # close an open basketgroup and generates a pdf
 316 #
 317     my $basketgroupid = $input->param('basketgroupid');
 318     CloseBasketgroup($basketgroupid);
 319     printbasketgrouppdf($basketgroupid);
 320     exit;
 321 }elsif ($op eq 'print'){
 322 #
 323 # print a closed basketgroup
 324 #
 325     my $basketgroupid = $input->param('basketgroupid');
 326     printbasketgrouppdf($basketgroupid);
 327     exit;
 328 }elsif ( $op eq "export" ) {
 329 #
 330 # export a closed basketgroup in csv
 331 #
 332     my $basketgroupid = $input->param('basketgroupid');
 333     print $input->header(
 334         -type       => 'text/csv',
 335         -attachment => 'basketgroup' . $basketgroupid . '.csv',
 336     );
 337     print GetBasketGroupAsCSV( $basketgroupid, $input );
 338     exit;
 339 }elsif( $op eq "delete"){
 340 #
 341 # delete an closed basketgroup
 342 #
 343     my $basketgroupid = $input->param('basketgroupid');
 344     DelBasketgroup($basketgroupid);
 345     print $input->redirect('/cgi-bin/koha/acqui/basketgroup.pl?booksellerid=' . $booksellerid.'&amp;listclosed=1');
 346 }elsif ( $op eq 'reopen'){
 347 #
 348 # reopen a closed basketgroup
 349 #
 350     my $basketgroupid   = $input->param('basketgroupid');
 351     my $booksellerid    = $input->param('booksellerid');
 352     ReOpenBasketgroup($basketgroupid);
 353     my $redirectpath = ((defined $input->param('mode'))&& ($input->param('mode') eq 'singlebg')) ?'/cgi-bin/koha/acqui/basketgroup.pl?op=add&amp;basketgroupid='.$basketgroupid.'&amp;booksellerid='.$booksellerid : '/cgi-bin/koha/acqui/basketgroup.pl?booksellerid=' .$booksellerid.'&amp;listclosed=1';
 354     print $input->redirect($redirectpath);
 355 } elsif ( $op eq 'attachbasket') {
 356 #
 357 # save a modified basketgroup, or creates a new basketgroup when a basket is closed. called from basket page
 358 #
 359     # Getting parameters
 360     my $basketgroup       = {};
 361     my @baskets           = $input->multi_param('basket');
 362     my $basketgroupid     = $input->param('basketgroupid');
 363     my $basketgroupname   = $input->param('basketgroupname');
 364     my $booksellerid      = $input->param('booksellerid');
 365     my $billingplace      = $input->param('billingplace');
 366     my $deliveryplace     = $input->param('deliveryplace');
 367     my $freedeliveryplace = $input->param('freedeliveryplace');
 368     my $deliverycomment   = $input->param('deliverycomment');
 369     my $closedbg          = $input->param('closedbg') ? 1 : 0;
 370     if ($basketgroupid) {
 371     # If we have a basketgroupid we edit the basketgroup
 372         $basketgroup = {
 373               name              => $basketgroupname,
 374               id                => $basketgroupid,
 375               basketlist        => \@baskets,
 376               billingplace      => $billingplace,
 377               deliveryplace     => $deliveryplace,
 378               freedeliveryplace => $freedeliveryplace,
 379               deliverycomment   => $deliverycomment,
 380               closed            => $closedbg,
 381         };
 382         ModBasketgroup($basketgroup);
 383         if($closedbg){
 384 # FIXME
 385         }
 386     }else{
 387     # we create a new basketgroup (with a closed basket)
 388         $basketgroup = {
 389             name              => $basketgroupname,
 390             booksellerid      => $booksellerid,
 391             basketlist        => \@baskets,
 392             billingplace      => $billingplace,
 393             deliveryplace     => $deliveryplace,
 394             freedeliveryplace => $freedeliveryplace,
 395             deliverycomment   => $deliverycomment,
 396             closed            => $closedbg,
 397         };
 398         $basketgroupid = NewBasketgroup($basketgroup);
 399     }
 400     my $redirectpath = ((defined $input->param('mode')) && ($input->param('mode') eq 'singlebg')) ?'/cgi-bin/koha/acqui/basketgroup.pl?op=add&amp;basketgroupid='.$basketgroupid.'&amp;booksellerid='.$booksellerid : '/cgi-bin/koha/acqui/basketgroup.pl?booksellerid=' . $booksellerid;
 401     $redirectpath .=  "&amp;listclosed=1" if $closedbg ;
 402     print $input->redirect($redirectpath );
 403
 404 } elsif ( $op eq 'ediprint') {
 405     my $basketgroupid = $input->param('basketgroupid');
 406     if ($template->param( 'ediaccount' )) {
 407         generate_edifact_orders( $basketgroupid );
 408         exit;
 409     } else {
 410         $template->param('NoEDIMessage' => 1);
 411         my $basketgroups = &GetBasketgroups($booksellerid);
 412         my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
 413         my $baskets = &GetBasketsByBookseller($booksellerid);
 414
 415         displaybasketgroups($basketgroups, $bookseller, $baskets);
 416     }
 417 }else{
 418 # no param : display the list of all basketgroups for a given vendor
 419     my $basketgroups = &GetBasketgroups($booksellerid);
 420     my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
 421     my $baskets = &GetBasketsByBookseller($booksellerid);
 422
 423     displaybasketgroups($basketgroups, $bookseller, $baskets);
 424 }
 425 $template->param(listclosed => ((defined $input->param('listclosed')) && ($input->param('listclosed') eq '1'))? 1:0 );
 426 #prolly won't use all these, maybe just use print, the rest can be done inside validate
 427 output_html_with_http_headers $input, $cookie, $template->output;