3 # Copyright 2000-2002 Katipo Communications
5 # 2007 BibLibre, Paul POULAIN
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 script to execute returns of books
29 #use warnings; FIXME - Bug 2505
33 use C4
::Auth qw
/:DEFAULT get_session/;
36 use C4
::Dates qw
/format_date/;
37 use Date
::Calc qw
/Add_Delta_Days/;
44 use C4
::Branch
; # GetBranches GetBranchName
45 use C4
::Koha
; # FIXME : is it still useful ?
46 use C4
::RotatingCollections
;
50 if (!C4
::Context
->userenv){
51 my $sessionID = $query->cookie("CGISESSID");
52 my $session = get_session
($sessionID);
53 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
54 # no branch set we can't return
55 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
61 my ( $template, $librarian, $cookie ) = get_template_and_user
(
63 template_name
=> "circ/returns.tmpl",
67 flagsrequired
=> { circulate
=> "circulate_remaining_permissions" },
73 my $branches = GetBranches
();
74 my $printers = GetPrinters
();
76 my $printer = C4
::Context
->userenv ? C4
::Context
->userenv->{'branchprinter'} : "";
77 my $overduecharges = (C4
::Context
->preference('finesMode') && C4
::Context
->preference('finesMode') ne 'off');
79 my $userenv_branch = C4
::Context
->userenv->{'branch'} || '';
81 # Some code to handle the error if there is no branch or printer setting.....
84 # Set up the item stack ....
89 foreach ( $query->param ) {
102 my $barcode = $query->param("ri-$counter");
103 my $duedate = $query->param("dd-$counter");
104 my $borrowernumber = $query->param("bn-$counter");
107 # decode barcode ## Didn't we already decode them before passing them back last time??
108 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
109 $barcode = barcodedecode
($barcode) if(C4
::Context
->preference('itemBarcodeInputFilter'));
111 ######################
112 #Are these lines still useful ?
113 $returneditems{$counter} = $barcode;
114 $riduedate{$counter} = $duedate;
115 $riborrowernumber{$counter} = $borrowernumber;
117 #######################
118 $input{counter
} = $counter;
119 $input{barcode
} = $barcode;
120 $input{duedate
} = $duedate;
121 $input{borrowernumber
} = $borrowernumber;
122 push( @inputloop, \
%input );
126 # Deal with the requests....
128 if ($query->param('WT-itemNumber')){
129 updateWrongTransfer
($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
132 if ( $query->param('resbarcode') ) {
133 my $item = $query->param('itemnumber');
134 my $borrowernumber = $query->param('borrowernumber');
135 my $resbarcode = $query->param('resbarcode');
136 my $diffBranchReturned = $query->param('diffBranch');
137 my $iteminfo = GetBiblioFromItemNumber
($item);
138 # fix up item type for display
139 $iteminfo->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$iteminfo->{'itype'} : $iteminfo->{'itemtype'};
140 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ?
$diffBranchReturned : undef;
141 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
142 # i.e., whether to apply waiting status
143 ModReserveAffect
( $item, $borrowernumber, $diffBranchSend);
144 # check if we have other reserves for this document, if we have a return send the message of transfer
145 my ( $messages, $nextreservinfo ) = GetOtherReserves
($item);
147 my ($borr) = GetMemberDetails
( $nextreservinfo, 0 );
148 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
149 if ( $messages->{'transfert'} ) {
151 itemtitle
=> $iteminfo->{'title'},
152 itembiblionumber
=> $iteminfo->{'biblionumber'},
153 iteminfo
=> $iteminfo->{'author'},
154 tobranchname
=> GetBranchName
($messages->{'transfert'}),
156 borrowernumber
=> $borrowernumber,
157 borcnum
=> $borr->{'cardnumber'},
158 borfirstname
=> $borr->{'firstname'},
159 borsurname
=> $borr->{'surname'},
168 my $issueinformation;
170 my $barcode = $query->param('barcode');
171 my $exemptfine = $query->param('exemptfine');
172 my $dropboxmode = $query->param('dropboxmode');
173 my $dotransfer = $query->param('dotransfer');
174 my $calendar = C4
::Calendar
->new( branchcode
=> $userenv_branch );
175 #dropbox: get last open day (today - 1)
176 my $today = C4
::Dates
->new();
177 my $today_iso = $today->output('iso');
178 my $dropboxdate = $calendar->addDate($today, -1);
180 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
181 my $transferitem = $query->param('transferitem');
182 my $tobranch = $query->param('tobranch');
183 ModItemTransfer
($transferitem, $userenv_branch, $tobranch);
186 # actually return book and prepare item table.....
188 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
189 $barcode = barcodedecode
($barcode) if C4
::Context
->preference('itemBarcodeInputFilter');
190 $itemnumber = GetItemnumberFromBarcode
($barcode);
192 if ( C4
::Context
->preference("InProcessingToShelvingCart") ) {
193 my $item = GetItem
( $itemnumber );
194 if ( $item->{'location'} eq 'PROC' ) {
195 $item->{'location'} = 'CART';
196 ModItem
( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
200 if ( C4
::Context
->preference("ReturnToShelvingCart") ) {
201 my $item = GetItem
( $itemnumber );
202 $item->{'location'} = 'CART';
203 ModItem
( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
209 ( $returned, $messages, $issueinformation, $borrower ) =
210 AddReturn
( $barcode, $userenv_branch, $exemptfine, $dropboxmode); # do the return
212 # get biblio description
213 my $biblio = GetBiblioFromItemNumber
($itemnumber);
214 # fix up item type for display
215 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
218 title
=> $biblio->{'title'},
219 homebranch
=> $biblio->{'homebranch'},
220 homebranchname
=> GetBranchName
( $biblio->{'homebranch'} ),
221 author
=> $biblio->{'author'},
222 itembarcode
=> $biblio->{'barcode'},
223 itemtype
=> $biblio->{'itemtype'},
224 ccode
=> $biblio->{'ccode'},
225 itembiblionumber
=> $biblio->{'biblionumber'},
235 my $duedate = $issueinformation->{'date_due'};
236 $returneditems{0} = $barcode;
237 $riborrowernumber{0} = $borrower->{'borrowernumber'};
238 $riduedate{0} = $duedate;
239 $input{borrowernumber
} = $borrower->{'borrowernumber'};
240 $input{duedate
} = $duedate;
241 $input{return_overdue
} = 1 if ($duedate and $duedate lt $today->output('iso'));
242 push( @inputloop, \
%input );
244 elsif ( !$messages->{'BadBarcode'} ) {
246 $returneditems{0} = $barcode;
248 if ( $messages->{'wthdrawn'} ) {
249 $input{withdrawn
} = 1;
250 $input{borrowernumber
} = 'Item Cancelled'; # FIXME: should be in display layer ?
251 $riborrowernumber{0} = 'Item Cancelled';
254 $input{borrowernumber
} = ' '; # This seems clearly bogus.
255 $riborrowernumber{0} = ' ';
257 push( @inputloop, \
%input );
260 $template->param( inputloop
=> \
@inputloop );
266 # new op dev : we check if the document must be returned to his homebranch directly,
267 # if the document is transfered, we have warning message .
269 if ( $messages->{'WasTransfered'} ) {
276 if ( $messages->{'NeedsTransfer'} ){
280 itemnumber
=> $itemnumber,
284 if ( $messages->{'Wrongbranch'} ){
290 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
292 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
293 $messages->{'WrongTransfer'} = GetBranchName
( $messages->{'WrongTransfer'} );
296 TransferWaitingAt
=> $messages->{'WrongTransfer'},
297 WrongTransferItem
=> $messages->{'WrongTransferItem'},
300 my $reserve = $messages->{'ResFound'};
301 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
302 my ($borr) = GetMemberDetails
( $reserve->{'borrowernumber'}, 0 );
303 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
306 wborfirstname
=> $borr->{'firstname'},
307 wborsurname
=> $borr->{'surname'},
308 wbortitle
=> $borr->{'title'},
309 wborphone
=> $borr->{'phone'},
310 wboremail
=> $borr->{'email'},
311 wboraddress
=> $borr->{'address'},
312 wboraddress2
=> $borr->{'address2'},
313 wborcity
=> $borr->{'city'},
314 wborzip
=> $borr->{'zipcode'},
315 wborrowernumber
=> $reserve->{'borrowernumber'},
316 wborcnum
=> $borr->{'cardnumber'},
317 wtransfertFrom
=> $userenv_branch,
322 # reserve found and item arrived at the expected branch
324 if ( $messages->{'ResFound'}) {
325 my $reserve = $messages->{'ResFound'};
326 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
327 my ($borr) = GetMemberDetails
( $reserve->{'borrowernumber'}, 0 );
329 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
330 if ( $reserve->{'ResFound'} eq "Waiting" ) {
332 waiting
=> ($userenv_branch eq $reserve->{'branchcode'} ?
1 : 0 ),
334 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
336 intransit
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
337 transfertodo
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
338 resbarcode
=> $barcode,
343 # same params for Waiting or Reserved
346 currentbranch
=> $branches->{$userenv_branch}->{'branchname'},
347 destbranchname
=> $branches->{ $reserve->{'branchcode'} }->{'branchname'},
348 name
=> $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
349 borfirstname
=> $borr->{'firstname'},
350 borsurname
=> $borr->{'surname'},
351 bortitle
=> $borr->{'title'},
352 borphone
=> $borr->{'phone'},
353 boremail
=> $borr->{'email'},
354 boraddress
=> $borr->{'address'},
355 boraddress2
=> $borr->{'address2'},
356 borcity
=> $borr->{'city'},
357 borzip
=> $borr->{'zipcode'},
358 borcnum
=> $borr->{'cardnumber'},
359 debarred
=> $borr->{'debarred'},
360 gonenoaddress
=> $borr->{'gonenoaddress'},
362 destbranch
=> $reserve->{'branchcode'},
363 borrowernumber
=> $reserve->{'borrowernumber'},
364 itemnumber
=> $reserve->{'itemnumber'},
365 reservenotes
=> $reserve->{'reservenotes'},
367 } # else { ; } # error?
372 foreach my $code ( keys %$messages ) {
374 my $exit_required_p = 0;
375 if ( $code eq 'BadBarcode' ) {
376 $err{badbarcode
} = 1;
377 $err{msg
} = $messages->{'BadBarcode'};
379 elsif ( $code eq 'NotIssued' ) {
381 $err{msg
} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
383 elsif ( $code eq 'WasLost' ) {
386 elsif ( $code eq 'ResFound' ) {
387 ; # FIXME... anything to do here?
389 elsif ( $code eq 'WasReturned' ) {
390 ; # FIXME... anything to do here?
392 elsif ( $code eq 'WasTransfered' ) {
393 ; # FIXME... anything to do here?
395 elsif ( $code eq 'wthdrawn' ) {
397 $exit_required_p = 1;
399 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
400 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
401 $err{ispermanent
} = 1;
403 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
406 elsif ( $code eq 'WrongTransfer' ) {
407 ; # FIXME... anything to do here?
409 elsif ( $code eq 'WrongTransferItem' ) {
410 ; # FIXME... anything to do here?
412 elsif ( $code eq 'NeedsTransfer' ) {
414 elsif ( $code eq 'Wrongbranch' ) {
418 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
419 # This forces the issue of staying in sync w/ Circulation.pm
422 push( @errmsgloop, \
%err );
424 last if $exit_required_p;
426 $template->param( errmsgloop
=> \
@errmsgloop );
430 my $flags = $borrower->{'flags'};
433 foreach my $flag ( sort keys %$flags ) {
435 unless ($flagset) { $flagset = 1; }
436 $flaginfo{redfont
} = ( $flags->{$flag}->{'noissues'} );
437 $flaginfo{flag
} = $flag;
438 if ( $flag eq 'CHARGES' ) {
439 $flaginfo{msg
} = $flag;
440 $flaginfo{charges
} = 1;
441 $flaginfo{chargeamount
} = $flags->{$flag}->{amount
};
442 $flaginfo{borrowernumber
} = $borrower->{borrowernumber
};
444 elsif ( $flag eq 'WAITING' ) {
445 $flaginfo{msg
} = $flag;
446 $flaginfo{waiting
} = 1;
448 my $items = $flags->{$flag}->{'itemlist'};
449 foreach my $item (@
$items) {
450 my $biblio = GetBiblioFromItemNumber
( $item->{'itemnumber'});
451 push @waitingitemloop, {
452 biblionum
=> $biblio->{'biblionumber'},
453 barcode
=> $biblio->{'barcode'},
454 title
=> $biblio->{'title'},
455 brname
=> $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
458 $flaginfo{itemloop
} = \
@waitingitemloop;
460 elsif ( $flag eq 'ODUES' ) {
461 my $items = $flags->{$flag}->{'itemlist'};
463 foreach my $item ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
466 my $biblio = GetBiblioFromItemNumber
( $item->{'itemnumber'});
468 duedate
=> format_date
($item->{'date_due'}),
469 biblionum
=> $biblio->{'biblionumber'},
470 barcode
=> $biblio->{'barcode'},
471 title
=> $biblio->{'title'},
472 brname
=> $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
475 $flaginfo{itemloop
} = \
@itemloop;
476 $flaginfo{overdue
} = 1;
479 $flaginfo{other
} = 1;
480 $flaginfo{msg
} = $flags->{$flag}->{'message'};
482 push( @flagloop, \
%flaginfo );
486 flagloop
=> \
@flagloop,
487 riborrowernumber
=> $borrower->{'borrowernumber'},
488 riborcnum
=> $borrower->{'cardnumber'},
489 riborsurname
=> $borrower->{'surname'},
490 ribortitle
=> $borrower->{'title'},
491 riborfirstname
=> $borrower->{'firstname'}
495 #set up so only the last 8 returned items display (make for faster loading pages)
496 my $returned_counter = ( C4
::Context
->preference('numReturnedItemsToShow') ) ? C4
::Context
->preference('numReturnedItemsToShow') : 8;
499 foreach ( sort { $a <=> $b } keys %returneditems ) {
501 if ( $count++ < $returned_counter ) {
502 my $bar_code = $returneditems{$_};
503 my $duedate = $riduedate{$_};
505 my @tempdate = split( /-/, $duedate );
506 $ri{year
} = $tempdate[0];
507 $ri{month
} = $tempdate[1];
508 $ri{day
} = $tempdate[2];
509 $ri{duedate
} = format_date
($duedate);
510 my ($b) = GetMemberDetails
( $riborrowernumber{$_}, 0 );
511 $ri{return_overdue
} = 1 if ($duedate lt $today->output('iso'));
512 $ri{borrowernumber
} = $b->{'borrowernumber'};
513 $ri{borcnum
} = $b->{'cardnumber'};
514 $ri{borfirstname
} = $b->{'firstname'};
515 $ri{borsurname
} = $b->{'surname'};
516 $ri{bortitle
} = $b->{'title'};
517 $ri{bornote
} = $b->{'borrowernotes'};
518 $ri{borcategorycode
}= $b->{'categorycode'};
521 $ri{borrowernumber
} = $riborrowernumber{$_};
525 my $biblio = GetBiblioFromItemNumber
(GetItemnumberFromBarcode
($bar_code));
526 # fix up item type for display
527 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
528 $ri{itembiblionumber
} = $biblio->{'biblionumber'};
529 $ri{itemtitle
} = $biblio->{'title'};
530 $ri{itemauthor
} = $biblio->{'author'};
531 $ri{itemtype
} = $biblio->{'itemtype'};
532 $ri{itemnote
} = $biblio->{'itemnotes'};
533 $ri{ccode
} = $biblio->{'ccode'};
534 $ri{itemnumber
} = $biblio->{'itemnumber'};
535 $ri{barcode
} = $bar_code;
545 genbrname
=> $branches->{$userenv_branch}->{'branchname'},
546 genprname
=> $printers->{$printer}->{'printername'},
547 branchname
=> $branches->{$userenv_branch}->{'branchname'},
549 errmsgloop
=> \
@errmsgloop,
550 exemptfine
=> $exemptfine,
551 dropboxmode
=> $dropboxmode,
552 dropboxdate
=> $dropboxdate->output(),
553 overduecharges
=> $overduecharges,
554 soundon
=> C4
::Context
->preference("SoundOn"),
557 my $itemnumber = GetItemnumberFromBarcode
( $query->param('barcode') );
559 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches
( $itemnumber );
560 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
562 collectionItemNeedsTransferred
=> 1,
563 collectionBranch
=> GetBranchName
($collectionBranch),
568 # actually print the page!
569 output_html_with_http_headers
$query, $cookie, $template->output;