Bug 10852: (follow-up) fix POD for C4::Serials::NewSubscription
[koha.git] / circ / returns.pl
blob93f36f213095d6eab7ada0e299244ba5f8dee3ac
1 #!/usr/bin/perl
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.
9 # This file is part of Koha.
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.
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.
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.
24 =head1 returns.pl
26 script to execute returns of books
28 =cut
30 use strict;
31 use warnings;
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;
50 my $query = new CGI;
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;
62 #getting the template
63 my ( $template, $librarian, $cookie ) = get_template_and_user(
65 template_name => "circ/returns.tmpl",
66 query => $query,
67 type => "intranet",
68 authnotrequired => 0,
69 flagsrequired => { circulate => "circulate_remaining_permissions" },
73 #####################
74 #Global vars
75 my $branches = GetBranches();
76 my $printers = GetPrinters();
78 my $printer = C4::Context->userenv ? C4::Context->userenv->{'branchprinter'} : "";
79 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
81 my $userenv_branch = C4::Context->userenv->{'branch'} || '';
83 # Some code to handle the error if there is no branch or printer setting.....
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;
99 else {
100 next;
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++;
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'));
113 ######################
114 #Are these lines still useful ?
115 $returneditems{$counter} = $barcode;
116 $riduedate{$counter} = $duedate;
117 $riborrowernumber{$counter} = $borrowernumber;
119 #######################
120 $input{counter} = $counter;
121 $input{barcode} = $barcode;
122 $input{duedate} = $duedate;
123 $input{borrowernumber} = $borrowernumber;
124 push( @inputloop, \%input );
127 ############
128 # Deal with the requests....
130 if ($query->param('WT-itemNumber')){
131 updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
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);
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,
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);
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);
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);
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'} );
216 # save the return
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';
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'};
228 # Check if we should display a checkin message, based on the the item
229 # type of the checked in item
230 my $itemtype = C4::ItemType->get( $biblio->{'itemtype'} );
231 if ( $itemtype->{'checkinmsg'} ) {
232 $template->param(
233 checkinmsg => $itemtype->{'checkinmsg'},
234 checkinmsgtype => $itemtype->{'checkinmsgtype'},
238 $template->param(
239 title => $biblio->{'title'},
240 homebranch => $biblio->{'homebranch'},
241 homebranchname => GetBranchName( $biblio->{$homeorholdingbranchreturn} ),
242 author => $biblio->{'author'},
243 itembarcode => $biblio->{'barcode'},
244 itemtype => $biblio->{'itemtype'},
245 ccode => $biblio->{'ccode'},
246 itembiblionumber => $biblio->{'biblionumber'},
247 additional_materials => $biblio->{'materials'}
250 my %input = (
251 counter => 0,
252 first => 1,
253 barcode => $barcode,
256 if ($returned) {
257 my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
258 my $duedate = $issueinformation->{date_due}->strftime('%Y-%m-%d %H:%M');
259 $returneditems{0} = $barcode;
260 $riborrowernumber{0} = $borrower->{'borrowernumber'};
261 $riduedate{0} = $duedate;
262 $input{borrowernumber} = $borrower->{'borrowernumber'};
263 $input{duedate} = $duedate;
264 $input{return_overdue} = 1 if (DateTime->compare($issueinformation->{date_due}, $time_now) == -1);
265 push( @inputloop, \%input );
267 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
268 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
269 if ($fines > 0) {
270 $template->param( fines => sprintf("%.2f",$fines) );
271 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
275 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
276 #Check for waiting holds
277 my @reserves = GetReservesFromBorrowernumber($borrower->{'borrowernumber'});
278 my $waiting_holds;
279 foreach my $num_res (@reserves) {
280 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
281 $waiting_holds++;
284 if ($waiting_holds > 0) {
285 $template->param(
286 waiting_holds => $waiting_holds,
287 holdsborrowernumber => $borrower->{'borrowernumber'},
288 holdsfirstname => $borrower->{'firstname'},
289 holdssurname => $borrower->{'surname'},
294 elsif ( !$messages->{'BadBarcode'} ) {
295 $input{duedate} = 0;
296 $returneditems{0} = $barcode;
297 $riduedate{0} = 0;
298 push( @inputloop, \%input );
301 $template->param( inputloop => \@inputloop );
303 my $found = 0;
304 my $waiting = 0;
305 my $reserved = 0;
307 # new op dev : we check if the document must be returned to his homebranch directly,
308 # if the document is transfered, we have warning message .
310 if ( $messages->{'WasTransfered'} ) {
311 $template->param(
312 found => 1,
313 transfer => 1,
314 itemnumber => $itemnumber,
318 if ( $messages->{'NeedsTransfer'} ){
319 $template->param(
320 found => 1,
321 needstransfer => 1,
322 itemnumber => $itemnumber,
326 if ( $messages->{'Wrongbranch'} ){
327 $template->param(
328 wrongbranch => 1,
332 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
334 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
335 $template->param(
336 WrongTransfer => 1,
337 TransferWaitingAt => $messages->{'WrongTransfer'},
338 WrongTransferItem => $messages->{'WrongTransferItem'},
339 itemnumber => $itemnumber,
342 my $reserve = $messages->{'ResFound'};
343 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
344 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
345 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
346 $template->param(
347 wname => $name,
348 wborfirstname => $borr->{'firstname'},
349 wborsurname => $borr->{'surname'},
350 wbortitle => $borr->{'title'},
351 wborphone => $borr->{'phone'},
352 wboremail => $borr->{'email'},
353 wboraddress => $borr->{'address'},
354 wboraddress2 => $borr->{'address2'},
355 wborcity => $borr->{'city'},
356 wborzip => $borr->{'zipcode'},
357 wborrowernumber => $reserve->{'borrowernumber'},
358 wborcnum => $borr->{'cardnumber'},
359 wtransfertFrom => $userenv_branch,
364 # reserve found and item arrived at the expected branch
366 if ( $messages->{'ResFound'}) {
367 my $reserve = $messages->{'ResFound'};
368 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
369 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
371 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
372 if ( $reserve->{'ResFound'} eq "Waiting" ) {
373 $template->param(
374 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
376 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
377 $template->param(
378 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
379 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
380 resbarcode => $barcode,
381 reserved => 1,
385 # same params for Waiting or Reserved
386 $template->param(
387 found => 1,
388 currentbranch => $branches->{$userenv_branch}->{'branchname'},
389 destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
390 name => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
391 borfirstname => $borr->{'firstname'},
392 borsurname => $borr->{'surname'},
393 bortitle => $borr->{'title'},
394 borphone => $borr->{'phone'},
395 boremail => $borr->{'email'},
396 boraddress => $borr->{'address'},
397 boraddress2 => $borr->{'address2'},
398 borcity => $borr->{'city'},
399 borzip => $borr->{'zipcode'},
400 borcnum => $borr->{'cardnumber'},
401 debarred => $borr->{'debarred'},
402 gonenoaddress => $borr->{'gonenoaddress'},
403 barcode => $barcode,
404 destbranch => $reserve->{'branchcode'},
405 borrowernumber => $reserve->{'borrowernumber'},
406 itemnumber => $reserve->{'itemnumber'},
407 reservenotes => $reserve->{'reservenotes'},
409 } # else { ; } # error?
412 # Error Messages
413 my @errmsgloop;
414 foreach my $code ( keys %$messages ) {
415 my %err;
416 my $exit_required_p = 0;
417 if ( $code eq 'BadBarcode' ) {
418 $err{badbarcode} = 1;
419 $err{msg} = $messages->{'BadBarcode'};
421 elsif ( $code eq 'NotIssued' ) {
422 $err{notissued} = 1;
423 $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
425 elsif ( $code eq 'LocalUse' ) {
426 $err{localuse} = 1;
428 elsif ( $code eq 'WasLost' ) {
429 $err{waslost} = 1;
431 elsif ( $code eq 'LostItemFeeRefunded' ) {
432 $template->param( LostItemFeeRefunded => 1 );
434 elsif ( $code eq 'ResFound' ) {
435 ; # FIXME... anything to do here?
437 elsif ( $code eq 'WasReturned' ) {
438 ; # FIXME... anything to do here?
440 elsif ( $code eq 'WasTransfered' ) {
441 ; # FIXME... anything to do here?
443 elsif ( $code eq 'withdrawn' ) {
444 $err{withdrawn} = 1;
445 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
447 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
448 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
449 $err{ispermanent} = 1;
450 $err{msg} =
451 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
454 elsif ( $code eq 'WrongTransfer' ) {
455 ; # FIXME... anything to do here?
457 elsif ( $code eq 'WrongTransferItem' ) {
458 ; # FIXME... anything to do here?
460 elsif ( $code eq 'NeedsTransfer' ) {
462 elsif ( $code eq 'Wrongbranch' ) {
464 elsif ( $code eq 'Debarred' ) {
465 $err{debarred} = $messages->{'Debarred'};
466 $err{debarcardnumber} = $borrower->{cardnumber};
467 $err{debarborrowernumber} = $borrower->{borrowernumber};
468 $err{debarname} = "$borrower->{firstname} $borrower->{surname}";
470 else {
471 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
472 # This forces the issue of staying in sync w/ Circulation.pm
474 if (%err) {
475 push( @errmsgloop, \%err );
477 last if $exit_required_p;
479 $template->param( errmsgloop => \@errmsgloop );
481 #set up so only the last 8 returned items display (make for faster loading pages)
482 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
483 my $count = 0;
484 my @riloop;
485 my $shelflocations = GetKohaAuthorisedValues('items.location','');
486 foreach ( sort { $a <=> $b } keys %returneditems ) {
487 my %ri;
488 if ( $count++ < $returned_counter ) {
489 my $bar_code = $returneditems{$_};
490 if ($riduedate{$_}) {
491 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
492 $ri{year} = $duedate->year();
493 $ri{month} = $duedate->month();
494 $ri{day} = $duedate->day();
495 $ri{hour} = $duedate->hour();
496 $ri{minute} = $duedate->minute();
497 $ri{duedate} = output_pref($duedate);
498 my ($b) = GetMemberDetails( $riborrowernumber{$_}, 0 );
499 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1 );
500 $ri{borrowernumber} = $b->{'borrowernumber'};
501 $ri{borcnum} = $b->{'cardnumber'};
502 $ri{borfirstname} = $b->{'firstname'};
503 $ri{borsurname} = $b->{'surname'};
504 $ri{bortitle} = $b->{'title'};
505 $ri{bornote} = $b->{'borrowernotes'};
506 $ri{borcategorycode}= $b->{'categorycode'};
508 else {
509 $ri{borrowernumber} = $riborrowernumber{$_};
512 # my %ri;
513 my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
514 my $item = GetItem( GetItemnumberFromBarcode($bar_code) );
515 # fix up item type for display
516 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
517 $ri{itembiblionumber} = $biblio->{'biblionumber'};
518 $ri{itemtitle} = $biblio->{'title'};
519 $ri{itemauthor} = $biblio->{'author'};
520 $ri{itemcallnumber} = $biblio->{'itemcallnumber'};
521 $ri{itemtype} = $biblio->{'itemtype'};
522 $ri{itemnote} = $biblio->{'itemnotes'};
523 $ri{ccode} = $biblio->{'ccode'};
524 $ri{itemnumber} = $biblio->{'itemnumber'};
525 $ri{barcode} = $bar_code;
526 $ri{homebranch} = $item->{'homebranch'};
527 $ri{holdingbranch} = $item->{'holdingbranch'};
529 $ri{location} = $biblio->{'location'};
530 my $shelfcode = $ri{'location'};
531 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
534 else {
535 last;
537 push @riloop, \%ri;
539 $template->param(
540 riloop => \@riloop,
541 genbrname => $branches->{$userenv_branch}->{'branchname'},
542 genprname => $printers->{$printer}->{'printername'},
543 branchname => $branches->{$userenv_branch}->{'branchname'},
544 printer => $printer,
545 errmsgloop => \@errmsgloop,
546 exemptfine => $exemptfine,
547 dropboxmode => $dropboxmode,
548 dropboxdate => output_pref($dropboxdate),
549 overduecharges => $overduecharges,
550 soundon => C4::Context->preference("SoundOn"),
551 BlockReturnOfWithdrawnItems => C4::Context->preference("BlockReturnOfWithdrawnItems"),
554 ### Comment out rotating collections for now to allow it a little more time to bake
555 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
556 ### to fill hold requests
557 ### -- Galen Charlton 2010-10-06
558 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
559 #if ( $itemnumber ) {
560 # my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
561 # if ( ! ( $holdingBranch eq $collectionBranch ) ) {
562 # $template->param(
563 # collectionItemNeedsTransferred => 1,
564 # collectionBranch => GetBranchName($collectionBranch),
565 # );
569 # actually print the page!
570 output_html_with_http_headers $query, $cookie, $template->output;