3 # Copyright 2000-2002 Katipo Communications
5 # 2007-2010 BibLibre, Paul POULAIN
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
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.
26 script to execute returns of books
36 use C4
::Auth qw
/:DEFAULT get_session/;
44 use C4
::Branch
; # GetBranches GetBranchName
45 use C4
::Koha
; # FIXME : is it still useful ?
46 use C4
::RotatingCollections
;
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");
63 my ( $template, $librarian, $cookie ) = get_template_and_user
(
65 template_name
=> "circ/returns.tmpl",
69 flagsrequired
=> { circulate
=> "circulate_remaining_permissions" },
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 ....
91 foreach ( $query->param ) {
104 my $barcode = $query->param("ri-$counter");
105 my $duedate = $query->param("dd-$counter");
106 my $borrowernumber = $query->param("bn-$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 );
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'} ) {
153 itemtitle
=> $iteminfo->{'title'},
154 itemnumber
=> $iteminfo->{'itemnumber'},
155 itembiblionumber
=> $iteminfo->{'biblionumber'},
156 iteminfo
=> $iteminfo->{'author'},
157 tobranchname
=> GetBranchName
($messages->{'transfert'}),
159 borrowernumber
=> $borrowernumber,
160 borcnum
=> $borr->{'cardnumber'},
161 borfirstname
=> $borr->{'firstname'},
162 borsurname
=> $borr->{'surname'},
171 my $issueinformation;
173 my $barcode = $query->param('barcode');
174 my $exemptfine = $query->param('exemptfine');
177 !C4
::Auth
::haspermission
(C4
::Context
->userenv->{'id'}, {'updatecharges' => 'writeoff'})
179 # silently prevent unauthorized operator from forgiving overdue
180 # fines by manually tweaking form parameters
183 my $dropboxmode = $query->param('dropboxmode');
184 my $dotransfer = $query->param('dotransfer');
185 my $canceltransfer = $query->param('canceltransfer');
186 my $dest = $query->param('dest');
187 my $calendar = Koha
::Calendar
->new( branchcode
=> $userenv_branch );
188 #dropbox: get last open day (today - 1)
189 my $today = DateTime
->now( time_zone
=> C4
::Context
->tz());
190 my $dropboxdate = $calendar->addDate($today, -1);
192 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
193 my $transferitem = $query->param('transferitem');
194 my $tobranch = $query->param('tobranch');
195 ModItemTransfer
($transferitem, $userenv_branch, $tobranch);
198 if ($canceltransfer){
199 $itemnumber=$query->param('itemnumber');
200 DeleteTransfer
($itemnumber);
202 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
205 $template->param( transfercancelled
=> 1);
209 # actually return book and prepare item table.....
211 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
212 $barcode = barcodedecode
($barcode) if C4
::Context
->preference('itemBarcodeInputFilter');
213 $itemnumber = GetItemnumberFromBarcode
($barcode);
215 if ( C4
::Context
->preference("InProcessingToShelvingCart") ) {
216 my $item = GetItem
( $itemnumber );
217 if ( $item->{'location'} eq 'PROC' ) {
218 $item->{'location'} = 'CART';
219 ModItem
( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
226 ( $returned, $messages, $issueinformation, $borrower ) =
227 AddReturn
( $barcode, $userenv_branch, $exemptfine, $dropboxmode); # do the return
228 my $homeorholdingbranchreturn = C4
::Context
->preference('HomeOrHoldingBranchReturn');
229 $homeorholdingbranchreturn ||= 'homebranch';
231 # get biblio description
232 my $biblio = GetBiblioFromItemNumber
($itemnumber);
233 # fix up item type for display
234 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
236 # Check if we should display a checkin message, based on the the item
237 # type of the checked in item
238 my $itemtype = C4
::ItemType
->get( $biblio->{'itemtype'} );
239 if ( $itemtype->{'checkinmsg'} ) {
241 checkinmsg
=> $itemtype->{'checkinmsg'},
242 checkinmsgtype
=> $itemtype->{'checkinmsgtype'},
247 title
=> $biblio->{'title'},
248 homebranch
=> $biblio->{'homebranch'},
249 homebranchname
=> GetBranchName
( $biblio->{$homeorholdingbranchreturn} ),
250 author
=> $biblio->{'author'},
251 itembarcode
=> $biblio->{'barcode'},
252 itemtype
=> $biblio->{'itemtype'},
253 ccode
=> $biblio->{'ccode'},
254 itembiblionumber
=> $biblio->{'biblionumber'},
255 additional_materials
=> $biblio->{'materials'}
265 my $time_now = DateTime
->now( time_zone
=> C4
::Context
->tz )->truncate( to
=> 'minute');
266 my $duedate = $issueinformation->{date_due
}->strftime('%Y-%m-%d %H:%M');
267 $returneditems{0} = $barcode;
268 $riborrowernumber{0} = $borrower->{'borrowernumber'};
269 $riduedate{0} = $duedate;
270 $input{borrowernumber
} = $borrower->{'borrowernumber'};
271 $input{duedate
} = $duedate;
272 $input{return_overdue
} = 1 if (DateTime
->compare($issueinformation->{date_due
}, $time_now) == -1);
273 push( @inputloop, \
%input );
275 if ( C4
::Context
->preference("FineNotifyAtCheckin") ) {
276 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
( $borrower->{'borrowernumber'} );
278 $template->param( fines
=> sprintf("%.2f",$fines) );
279 $template->param( fineborrowernumber
=> $borrower->{'borrowernumber'} );
283 if (C4
::Context
->preference("WaitingNotifyAtCheckin") ) {
284 #Check for waiting holds
285 my @reserves = GetReservesFromBorrowernumber
($borrower->{'borrowernumber'});
287 foreach my $num_res (@reserves) {
288 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
292 if ($waiting_holds > 0) {
294 waiting_holds
=> $waiting_holds,
295 holdsborrowernumber
=> $borrower->{'borrowernumber'},
296 holdsfirstname
=> $borrower->{'firstname'},
297 holdssurname
=> $borrower->{'surname'},
302 elsif ( !$messages->{'BadBarcode'} ) {
304 $returneditems{0} = $barcode;
306 push( @inputloop, \
%input );
309 $template->param( inputloop
=> \
@inputloop );
315 # new op dev : we check if the document must be returned to his homebranch directly,
316 # if the document is transfered, we have warning message .
318 if ( $messages->{'WasTransfered'} ) {
322 itemnumber
=> $itemnumber,
326 if ( $messages->{'NeedsTransfer'} ){
330 itemnumber
=> $itemnumber,
334 if ( $messages->{'Wrongbranch'} ){
340 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
342 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
345 TransferWaitingAt
=> $messages->{'WrongTransfer'},
346 WrongTransferItem
=> $messages->{'WrongTransferItem'},
347 itemnumber
=> $itemnumber,
350 my $reserve = $messages->{'ResFound'};
351 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
352 my ($borr) = GetMemberDetails
( $reserve->{'borrowernumber'}, 0 );
353 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
356 wborfirstname
=> $borr->{'firstname'},
357 wborsurname
=> $borr->{'surname'},
358 wbortitle
=> $borr->{'title'},
359 wborphone
=> $borr->{'phone'},
360 wboremail
=> $borr->{'email'},
361 wboraddress
=> $borr->{'address'},
362 wboraddress2
=> $borr->{'address2'},
363 wborcity
=> $borr->{'city'},
364 wborzip
=> $borr->{'zipcode'},
365 wborrowernumber
=> $reserve->{'borrowernumber'},
366 wborcnum
=> $borr->{'cardnumber'},
367 wtransfertFrom
=> $userenv_branch,
372 # reserve found and item arrived at the expected branch
374 if ( $messages->{'ResFound'}) {
375 my $reserve = $messages->{'ResFound'};
376 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
377 my ($borr) = GetMemberDetails
( $reserve->{'borrowernumber'}, 0 );
379 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
380 if ( $reserve->{'ResFound'} eq "Waiting" ) {
382 waiting
=> ($userenv_branch eq $reserve->{'branchcode'} ?
1 : 0 ),
384 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
386 intransit
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
387 transfertodo
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
388 resbarcode
=> $barcode,
393 # same params for Waiting or Reserved
396 currentbranch
=> $branches->{$userenv_branch}->{'branchname'},
397 destbranchname
=> $branches->{ $reserve->{'branchcode'} }->{'branchname'},
398 name
=> $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
399 borfirstname
=> $borr->{'firstname'},
400 borsurname
=> $borr->{'surname'},
401 bortitle
=> $borr->{'title'},
402 borphone
=> $borr->{'phone'},
403 boremail
=> $borr->{'email'},
404 boraddress
=> $borr->{'address'},
405 boraddress2
=> $borr->{'address2'},
406 borcity
=> $borr->{'city'},
407 borzip
=> $borr->{'zipcode'},
408 borcnum
=> $borr->{'cardnumber'},
409 debarred
=> $borr->{'debarred'},
410 gonenoaddress
=> $borr->{'gonenoaddress'},
412 destbranch
=> $reserve->{'branchcode'},
413 borrowernumber
=> $reserve->{'borrowernumber'},
414 itemnumber
=> $reserve->{'itemnumber'},
415 reservenotes
=> $reserve->{'reservenotes'},
417 } # else { ; } # error?
422 foreach my $code ( keys %$messages ) {
424 my $exit_required_p = 0;
425 if ( $code eq 'BadBarcode' ) {
426 $err{badbarcode
} = 1;
427 $err{msg
} = $messages->{'BadBarcode'};
429 elsif ( $code eq 'NotIssued' ) {
431 $err{msg
} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
433 elsif ( $code eq 'LocalUse' ) {
436 elsif ( $code eq 'WasLost' ) {
439 elsif ( $code eq 'LostItemFeeRefunded' ) {
440 $template->param( LostItemFeeRefunded
=> 1 );
442 elsif ( $code eq 'ResFound' ) {
443 ; # FIXME... anything to do here?
445 elsif ( $code eq 'WasReturned' ) {
446 ; # FIXME... anything to do here?
448 elsif ( $code eq 'WasTransfered' ) {
449 ; # FIXME... anything to do here?
451 elsif ( $code eq 'withdrawn' ) {
453 $exit_required_p = 1 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
455 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
456 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
457 $err{ispermanent
} = 1;
459 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
462 elsif ( $code eq 'WrongTransfer' ) {
463 ; # FIXME... anything to do here?
465 elsif ( $code eq 'WrongTransferItem' ) {
466 ; # FIXME... anything to do here?
468 elsif ( $code eq 'NeedsTransfer' ) {
470 elsif ( $code eq 'Wrongbranch' ) {
472 elsif ( $code eq 'Debarred' ) {
473 $err{debarred
} = $messages->{'Debarred'};
474 $err{debarcardnumber
} = $borrower->{cardnumber
};
475 $err{debarborrowernumber
} = $borrower->{borrowernumber
};
476 $err{debarname
} = "$borrower->{firstname} $borrower->{surname}";
479 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
480 # This forces the issue of staying in sync w/ Circulation.pm
483 push( @errmsgloop, \
%err );
485 last if $exit_required_p;
487 $template->param( errmsgloop
=> \
@errmsgloop );
489 #set up so only the last 8 returned items display (make for faster loading pages)
490 my $returned_counter = ( C4
::Context
->preference('numReturnedItemsToShow') ) ? C4
::Context
->preference('numReturnedItemsToShow') : 8;
493 my $shelflocations = GetKohaAuthorisedValues
('items.location','');
494 foreach ( sort { $a <=> $b } keys %returneditems ) {
496 if ( $count++ < $returned_counter ) {
497 my $bar_code = $returneditems{$_};
498 if ($riduedate{$_}) {
499 my $duedate = dt_from_string
( $riduedate{$_}, 'sql');
500 $ri{year
} = $duedate->year();
501 $ri{month
} = $duedate->month();
502 $ri{day
} = $duedate->day();
503 $ri{hour
} = $duedate->hour();
504 $ri{minute
} = $duedate->minute();
505 $ri{duedate
} = output_pref
($duedate);
506 my ($b) = GetMemberDetails
( $riborrowernumber{$_}, 0 );
507 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, DateTime
->now()) == -1 );
508 $ri{borrowernumber
} = $b->{'borrowernumber'};
509 $ri{borcnum
} = $b->{'cardnumber'};
510 $ri{borfirstname
} = $b->{'firstname'};
511 $ri{borsurname
} = $b->{'surname'};
512 $ri{bortitle
} = $b->{'title'};
513 $ri{bornote
} = $b->{'borrowernotes'};
514 $ri{borcategorycode
}= $b->{'categorycode'};
517 $ri{borrowernumber
} = $riborrowernumber{$_};
521 my $biblio = GetBiblioFromItemNumber
(GetItemnumberFromBarcode
($bar_code));
522 my $item = GetItem
( GetItemnumberFromBarcode
($bar_code) );
523 # fix up item type for display
524 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
525 $ri{itembiblionumber
} = $biblio->{'biblionumber'};
526 $ri{itemtitle
} = $biblio->{'title'};
527 $ri{itemauthor
} = $biblio->{'author'};
528 $ri{itemcallnumber
} = $biblio->{'itemcallnumber'};
529 $ri{itemtype
} = $biblio->{'itemtype'};
530 $ri{itemnote
} = $biblio->{'itemnotes'};
531 $ri{ccode
} = $biblio->{'ccode'};
532 $ri{itemnumber
} = $biblio->{'itemnumber'};
533 $ri{barcode
} = $bar_code;
534 $ri{homebranch
} = $item->{'homebranch'};
535 $ri{holdingbranch
} = $item->{'holdingbranch'};
537 $ri{location
} = $biblio->{'location'};
538 my $shelfcode = $ri{'location'};
539 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
549 genbrname
=> $branches->{$userenv_branch}->{'branchname'},
550 genprname
=> $printers->{$printer}->{'printername'},
551 branchname
=> $branches->{$userenv_branch}->{'branchname'},
553 errmsgloop
=> \
@errmsgloop,
554 exemptfine
=> $exemptfine,
555 dropboxmode
=> $dropboxmode,
556 dropboxdate
=> output_pref
($dropboxdate),
557 overduecharges
=> $overduecharges,
558 soundon
=> C4
::Context
->preference("SoundOn"),
559 BlockReturnOfWithdrawnItems
=> C4
::Context
->preference("BlockReturnOfWithdrawnItems"),
562 ### Comment out rotating collections for now to allow it a little more time to bake
563 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
564 ### to fill hold requests
565 ### -- Galen Charlton 2010-10-06
566 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
567 #if ( $itemnumber ) {
568 # my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
569 # if ( ! ( $holdingBranch eq $collectionBranch ) ) {
571 # collectionItemNeedsTransferred => 1,
572 # collectionBranch => GetBranchName($collectionBranch),
577 # actually print the page!
578 output_html_with_http_headers
$query, $cookie, $template->output;