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