circ/returns.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #           2006 SAN-OP
   5 #           2007-2010 BibLibre, Paul POULAIN
   6 #           2010 Catalyst IT
   7 #           2011 PTFS-Europe Ltd.
   8 #
   9 # This file is part of Koha.
  10 #
  11 # Koha is free software; you can redistribute it and/or modify it under the
  12 # terms of the GNU General Public License as published by the Free Software
  13 # Foundation; either version 2 of the License, or (at your option) any later
  14 # version.
  15 #
  16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  18 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License along
  21 # with Koha; if not, write to the Free Software Foundation, Inc.,
  22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23
  24 =head1 returns.pl
  25
  26 script to execute returns of books
  27
  28 =cut
  29
  30 use strict;
  31 use warnings;
  32
  33 use CGI;
  34 use DateTime;
  35 use C4::Context;
  36 use C4::Auth qw/:DEFAULT get_session/;
  37 use C4::Output;
  38 use C4::Circulation;
  39 use C4::Print;
  40 use C4::Reserves;
  41 use C4::Biblio;
  42 use C4::Items;
  43 use C4::Members;
  44 use C4::Branch; # GetBranches GetBranchName
  45 use C4::Koha;   # FIXME : is it still useful ?
  46 use C4::RotatingCollections;
  47 use Koha::DateUtils;
  48 use Koha::Calendar;
  49
  50 my $query = new CGI;
  51
  52 if (!C4::Context->userenv){
  53     my $sessionID = $query->cookie("CGISESSID");
  54     my $session = get_session($sessionID);
  55     if ($session->param('branch') eq 'NO_LIBRARY_SET'){
  56         # no branch set we can't return
  57         print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
  58         exit;
  59     }
  60 }
  61
  62 #getting the template
  63 my ( $template, $librarian, $cookie ) = get_template_and_user(
  64     {
  65         template_name   => "circ/returns.tmpl",
  66         query           => $query,
  67         type            => "intranet",
  68         authnotrequired => 0,
  69         flagsrequired   => { circulate => "circulate_remaining_permissions" },
  70     }
  71 );
  72
  73 #####################
  74 #Global vars
  75 my $branches = GetBranches();
  76 my $printers = GetPrinters();
  77
  78 my $printer = C4::Context->userenv ? C4::Context->userenv->{'branchprinter'} : "";
  79 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
  80
  81 my $userenv_branch = C4::Context->userenv->{'branch'} || '';
  82 #
  83 # Some code to handle the error if there is no branch or printer setting.....
  84 #
  85
  86 # Set up the item stack ....
  87 my %returneditems;
  88 my %riduedate;
  89 my %riborrowernumber;
  90 my @inputloop;
  91 foreach ( $query->param ) {
  92     my $counter;
  93     if (/ri-(\d*)/) {
  94         $counter = $1;
  95         if ($counter > 20) {
  96             next;
  97         }
  98     }
  99     else {
 100         next;
 101     }
 102
 103     my %input;
 104     my $barcode        = $query->param("ri-$counter");
 105     my $duedate        = $query->param("dd-$counter");
 106     my $borrowernumber = $query->param("bn-$counter");
 107     $counter++;
 108
 109     # decode barcode    ## Didn't we already decode them before passing them back last time??
 110     $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
 111     $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
 112
 113     ######################
 114     #Are these lines still useful ?
 115     $returneditems{$counter}    = $barcode;
 116     $riduedate{$counter}        = $duedate;
 117     $riborrowernumber{$counter} = $borrowernumber;
 118
 119     #######################
 120     $input{counter}        = $counter;
 121     $input{barcode}        = $barcode;
 122     $input{duedate}        = $duedate;
 123     $input{borrowernumber} = $borrowernumber;
 124     push( @inputloop, \%input );
 125 }
 126
 127 ############
 128 # Deal with the requests....
 129
 130 if ($query->param('WT-itemNumber')){
 131         updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
 132 }
 133
 134 if ( $query->param('resbarcode') ) {
 135     my $item           = $query->param('itemnumber');
 136     my $borrowernumber = $query->param('borrowernumber');
 137     my $resbarcode     = $query->param('resbarcode');
 138     my $diffBranchReturned = $query->param('diffBranch');
 139     my $iteminfo   = GetBiblioFromItemNumber($item);
 140     # fix up item type for display
 141     $iteminfo->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $iteminfo->{'itype'} : $iteminfo->{'itemtype'};
 142     my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
 143 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
 144 # i.e., whether to apply waiting status
 145     ModReserveAffect( $item, $borrowernumber, $diffBranchSend);
 146 #   check if we have other reserves for this document, if we have a return send the message of transfer
 147     my ( $messages, $nextreservinfo ) = GetOtherReserves($item);
 148
 149     my ($borr) = GetMemberDetails( $nextreservinfo, 0 );
 150     my $name   = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
 151     if ( $messages->{'transfert'} ) {
 152         $template->param(
 153             itemtitle      => $iteminfo->{'title'},
 154             itemnumber     => $iteminfo->{'itemnumber'},
 155             itembiblionumber => $iteminfo->{'biblionumber'},
 156             iteminfo       => $iteminfo->{'author'},
 157             tobranchname   => GetBranchName($messages->{'transfert'}),
 158             name           => $name,
 159             borrowernumber => $borrowernumber,
 160             borcnum        => $borr->{'cardnumber'},
 161             borfirstname   => $borr->{'firstname'},
 162             borsurname     => $borr->{'surname'},
 163             diffbranch     => 1,
 164         );
 165     }
 166 }
 167
 168 my $borrower;
 169 my $returned = 0;
 170 my $messages;
 171 my $issueinformation;
 172 my $itemnumber;
 173 my $barcode     = $query->param('barcode');
 174 my $exemptfine  = $query->param('exemptfine');
 175 my $dropboxmode = $query->param('dropboxmode');
 176 my $dotransfer  = $query->param('dotransfer');
 177 my $canceltransfer = $query->param('canceltransfer');
 178 my $dest = $query->param('dest');
 179 my $calendar    = Koha::Calendar->new( branchcode => $userenv_branch );
 180 #dropbox: get last open day (today - 1)
 181 my $today       = DateTime->now( time_zone => C4::Context->tz());
 182 my $dropboxdate = $calendar->addDate($today, -1);
 183 if ($dotransfer){
 184 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
 185     my $transferitem = $query->param('transferitem');
 186     my $tobranch     = $query->param('tobranch');
 187     ModItemTransfer($transferitem, $userenv_branch, $tobranch);
 188 }
 189
 190 if ($canceltransfer){
 191     $itemnumber=$query->param('itemnumber');
 192     DeleteTransfer($itemnumber);
 193     if($dest eq "ttr"){
 194         print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
 195         exit;
 196     } else {
 197         $template->param( transfercancelled => 1);
 198     }
 199 }
 200
 201 # actually return book and prepare item table.....
 202 if ($barcode) {
 203     $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
 204     $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
 205     $itemnumber = GetItemnumberFromBarcode($barcode);
 206
 207     if ( C4::Context->preference("InProcessingToShelvingCart") ) {
 208         my $item = GetItem( $itemnumber );
 209         if ( $item->{'location'} eq 'PROC' ) {
 210             $item->{'location'} = 'CART';
 211             ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
 212         }
 213     }
 214
 215 #
 216 # save the return
 217 #
 218     ( $returned, $messages, $issueinformation, $borrower ) =
 219       AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode);     # do the return
 220     my $homeorholdingbranchreturn = C4::Context->preference('HomeOrHoldingBranchReturn');
 221     $homeorholdingbranchreturn ||= 'homebranch';
 222
 223     # get biblio description
 224     my $biblio = GetBiblioFromItemNumber($itemnumber);
 225     # fix up item type for display
 226     $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
 227
 228     $template->param(
 229         title            => $biblio->{'title'},
 230         homebranch       => $biblio->{'homebranch'},
 231         homebranchname   => GetBranchName( $biblio->{$homeorholdingbranchreturn} ),
 232         author           => $biblio->{'author'},
 233         itembarcode      => $biblio->{'barcode'},
 234         itemtype         => $biblio->{'itemtype'},
 235         ccode            => $biblio->{'ccode'},
 236         itembiblionumber => $biblio->{'biblionumber'},
 237         additional_materials => $biblio->{'materials'}
 238     );
 239
 240     my %input = (
 241         counter => 0,
 242         first   => 1,
 243         barcode => $barcode,
 244     );
 245
 246     if ($returned) {
 247         my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
 248         my $duedate = $issueinformation->{date_due}->strftime('%Y-%m-%d %H:%M');
 249         $returneditems{0}      = $barcode;
 250         $riborrowernumber{0}   = $borrower->{'borrowernumber'};
 251         $riduedate{0}          = $duedate;
 252         $input{borrowernumber} = $borrower->{'borrowernumber'};
 253         $input{duedate}        = $duedate;
 254         $input{return_overdue} = 1 if (DateTime->compare($issueinformation->{date_due}, $time_now) == -1);
 255         push( @inputloop, \%input );
 256
 257         if ( C4::Context->preference("FineNotifyAtCheckin") ) {
 258             my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
 259             if ($fines > 0) {
 260                 $template->param( fines => sprintf("%.2f",$fines) );
 261                 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
 262             }
 263         }
 264
 265         if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
 266             #Check for waiting holds
 267             my @reserves = GetReservesFromBorrowernumber($borrower->{'borrowernumber'});
 268             my $waiting_holds;
 269             foreach my $num_res (@reserves) {
 270                 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
 271                     $waiting_holds++;
 272                 }
 273             }
 274             if ($waiting_holds > 0) {
 275                 $template->param(
 276                     waiting_holds       => $waiting_holds,
 277                     holdsborrowernumber => $borrower->{'borrowernumber'},
 278                     holdsfirstname => $borrower->{'firstname'},
 279                     holdssurname => $borrower->{'surname'},
 280                 );
 281             }
 282         }
 283     }
 284     elsif ( !$messages->{'BadBarcode'} ) {
 285         $input{duedate}   = 0;
 286         $returneditems{0} = $barcode;
 287         $riduedate{0}     = 0;
 288         push( @inputloop, \%input );
 289     }
 290 }
 291 $template->param( inputloop => \@inputloop );
 292
 293 my $found    = 0;
 294 my $waiting  = 0;
 295 my $reserved = 0;
 296
 297 # new op dev : we check if the document must be returned to his homebranch directly,
 298 #  if the document is transfered, we have warning message .
 299
 300 if ( $messages->{'WasTransfered'} ) {
 301     $template->param(
 302         found          => 1,
 303         transfer       => 1,
 304         itemnumber     => $itemnumber,
 305     );
 306 }
 307
 308 if ( $messages->{'NeedsTransfer'} ){
 309     $template->param(
 310         found          => 1,
 311         needstransfer  => 1,
 312         itemnumber     => $itemnumber,
 313     );
 314 }
 315
 316 if ( $messages->{'Wrongbranch'} ){
 317     $template->param(
 318         wrongbranch => 1,
 319     );
 320 }
 321
 322 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
 323
 324 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
 325     $template->param(
 326         WrongTransfer  => 1,
 327         TransferWaitingAt => $messages->{'WrongTransfer'},
 328         WrongTransferItem => $messages->{'WrongTransferItem'},
 329         itemnumber => $itemnumber,
 330     );
 331
 332     my $reserve    = $messages->{'ResFound'};
 333     my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
 334     my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
 335     my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
 336     $template->param(
 337             wname           => $name,
 338             wborfirstname   => $borr->{'firstname'},
 339             wborsurname     => $borr->{'surname'},
 340             wbortitle       => $borr->{'title'},
 341             wborphone       => $borr->{'phone'},
 342             wboremail       => $borr->{'email'},
 343             wboraddress     => $borr->{'address'},
 344             wboraddress2    => $borr->{'address2'},
 345             wborcity        => $borr->{'city'},
 346             wborzip         => $borr->{'zipcode'},
 347             wborrowernumber => $reserve->{'borrowernumber'},
 348             wborcnum        => $borr->{'cardnumber'},
 349             wtransfertFrom  => $userenv_branch,
 350     );
 351 }
 352
 353 #
 354 # reserve found and item arrived at the expected branch
 355 #
 356 if ( $messages->{'ResFound'}) {
 357     my $reserve    = $messages->{'ResFound'};
 358     my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
 359     my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
 360
 361     if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
 362         if ( $reserve->{'ResFound'} eq "Waiting" ) {
 363             $template->param(
 364                 waiting      => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
 365             );
 366         } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
 367             $template->param(
 368                 intransit    => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
 369                 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
 370                 resbarcode   => $barcode,
 371                 reserved     => 1,
 372             );
 373         }
 374
 375         # same params for Waiting or Reserved
 376         $template->param(
 377             found          => 1,
 378             currentbranch  => $branches->{$userenv_branch}->{'branchname'},
 379             destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
 380             name           => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
 381             borfirstname   => $borr->{'firstname'},
 382             borsurname     => $borr->{'surname'},
 383             bortitle       => $borr->{'title'},
 384             borphone       => $borr->{'phone'},
 385             boremail       => $borr->{'email'},
 386             boraddress     => $borr->{'address'},
 387             boraddress2    => $borr->{'address2'},
 388             borcity        => $borr->{'city'},
 389             borzip         => $borr->{'zipcode'},
 390             borcnum        => $borr->{'cardnumber'},
 391             debarred       => $borr->{'debarred'},
 392             gonenoaddress  => $borr->{'gonenoaddress'},
 393             barcode        => $barcode,
 394             destbranch     => $reserve->{'branchcode'},
 395             borrowernumber => $reserve->{'borrowernumber'},
 396             itemnumber     => $reserve->{'itemnumber'},
 397             reservenotes   => $reserve->{'reservenotes'},
 398         );
 399     } # else { ; }  # error?
 400 }
 401
 402 # Error Messages
 403 my @errmsgloop;
 404 foreach my $code ( keys %$messages ) {
 405     my %err;
 406     my $exit_required_p = 0;
 407     if ( $code eq 'BadBarcode' ) {
 408         $err{badbarcode} = 1;
 409         $err{msg}        = $messages->{'BadBarcode'};
 410     }
 411     elsif ( $code eq 'NotIssued' ) {
 412         $err{notissued} = 1;
 413         $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
 414     }
 415     elsif ( $code eq 'LocalUse' ) {
 416         $err{localuse} = 1;
 417     }
 418     elsif ( $code eq 'WasLost' ) {
 419         $err{waslost} = 1;
 420     }
 421     elsif ( $code eq 'ResFound' ) {
 422         ;    # FIXME... anything to do here?
 423     }
 424     elsif ( $code eq 'WasReturned' ) {
 425         ;    # FIXME... anything to do here?
 426     }
 427     elsif ( $code eq 'WasTransfered' ) {
 428         ;    # FIXME... anything to do here?
 429     }
 430     elsif ( $code eq 'wthdrawn' ) {
 431         $err{withdrawn} = 1;
 432         $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
 433     }
 434     elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
 435         if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
 436             $err{ispermanent} = 1;
 437             $err{msg}         =
 438               $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
 439         }
 440     }
 441     elsif ( $code eq 'WrongTransfer' ) {
 442         ;    # FIXME... anything to do here?
 443     }
 444     elsif ( $code eq 'WrongTransferItem' ) {
 445         ;    # FIXME... anything to do here?
 446     }
 447     elsif ( $code eq 'NeedsTransfer' ) {
 448     }
 449     elsif ( $code eq 'Wrongbranch' ) {
 450     }
 451     elsif ( $code eq 'Debarred' ) {
 452         $err{debarred}            = $messages->{'Debarred'};
 453         $err{debarcardnumber}     = $borrower->{cardnumber};
 454         $err{debarborrowernumber} = $borrower->{borrowernumber};
 455         $err{debarname}           = "$borrower->{firstname} $borrower->{surname}";
 456     }
 457     else {
 458         die "Unknown error code $code";    # note we need all the (empty) elsif's above, or we die.
 459         # This forces the issue of staying in sync w/ Circulation.pm
 460     }
 461     if (%err) {
 462         push( @errmsgloop, \%err );
 463     }
 464     last if $exit_required_p;
 465 }
 466 $template->param( errmsgloop => \@errmsgloop );
 467
 468 #set up so only the last 8 returned items display (make for faster loading pages)
 469 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
 470 my $count = 0;
 471 my @riloop;
 472 my $shelflocations = GetKohaAuthorisedValues('items.location','');
 473 foreach ( sort { $a <=> $b } keys %returneditems ) {
 474     my %ri;
 475     if ( $count++ < $returned_counter ) {
 476         my $bar_code = $returneditems{$_};
 477         if ($riduedate{$_}) {
 478             my $duedate = dt_from_string( $riduedate{$_}, 'sql');
 479             $ri{year}  = $duedate->year();
 480             $ri{month} = $duedate->month();
 481             $ri{day}   = $duedate->day();
 482             $ri{hour}   = $duedate->hour();
 483             $ri{minute}   = $duedate->minute();
 484             $ri{duedate} = output_pref($duedate);
 485             my ($b)      = GetMemberDetails( $riborrowernumber{$_}, 0 );
 486             $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1 );
 487             $ri{borrowernumber} = $b->{'borrowernumber'};
 488             $ri{borcnum}        = $b->{'cardnumber'};
 489             $ri{borfirstname}   = $b->{'firstname'};
 490             $ri{borsurname}     = $b->{'surname'};
 491             $ri{bortitle}       = $b->{'title'};
 492             $ri{bornote}        = $b->{'borrowernotes'};
 493             $ri{borcategorycode}= $b->{'categorycode'};
 494         }
 495         else {
 496             $ri{borrowernumber} = $riborrowernumber{$_};
 497         }
 498
 499         #        my %ri;
 500         my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
 501         my $item   = GetItem( GetItemnumberFromBarcode($bar_code) );
 502         # fix up item type for display
 503         $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
 504         $ri{itembiblionumber} = $biblio->{'biblionumber'};
 505         $ri{itemtitle}        = $biblio->{'title'};
 506         $ri{itemauthor}       = $biblio->{'author'};
 507         $ri{itemcallnumber}   = $biblio->{'itemcallnumber'};
 508         $ri{itemtype}         = $biblio->{'itemtype'};
 509         $ri{itemnote}         = $biblio->{'itemnotes'};
 510         $ri{ccode}            = $biblio->{'ccode'};
 511         $ri{itemnumber}       = $biblio->{'itemnumber'};
 512         $ri{barcode}          = $bar_code;
 513         $ri{homebranch}       = $item->{'homebranch'};
 514         $ri{holdingbranch}    = $item->{'holdingbranch'};
 515
 516         $ri{location}         = $biblio->{'location'};
 517         my $shelfcode = $ri{'location'};
 518         $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
 519
 520     }
 521     else {
 522         last;
 523     }
 524     push @riloop, \%ri;
 525 }
 526 $template->param(
 527     riloop         => \@riloop,
 528     genbrname      => $branches->{$userenv_branch}->{'branchname'},
 529     genprname      => $printers->{$printer}->{'printername'},
 530     branchname     => $branches->{$userenv_branch}->{'branchname'},
 531     printer        => $printer,
 532     errmsgloop     => \@errmsgloop,
 533     exemptfine     => $exemptfine,
 534     dropboxmode    => $dropboxmode,
 535     dropboxdate    => output_pref($dropboxdate),
 536     overduecharges => $overduecharges,
 537     soundon        => C4::Context->preference("SoundOn"),
 538     BlockReturnOfWithdrawnItems => C4::Context->preference("BlockReturnOfWithdrawnItems"),
 539 );
 540
 541 ### Comment out rotating collections for now to allow it a little more time to bake
 542 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
 543 ### to fill hold requests
 544 ### -- Galen Charlton 2010-10-06
 545 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
 546 #if ( $itemnumber ) {
 547 #   my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
 548 #    if ( ! ( $holdingBranch eq $collectionBranch ) ) {
 549 #        $template->param(
 550 #          collectionItemNeedsTransferred => 1,
 551 #          collectionBranch => GetBranchName($collectionBranch),
 552 #        );
 553 #    }
 554 #}
 555
 556 # actually print the page!
 557 output_html_with_http_headers $query, $cookie, $template->output;