Merge remote branch 'kc/new/enh/bug_6003' into kcmaster
[wip/koha-chris_n.git] / 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 #
7 # This file is part of Koha.
8 #
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
12 # version.
13 #
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.
17 #
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.
21
22 =head1 returns.pl
23
24 script to execute returns of books
25
26 =cut
27
28 use strict;
29 #use warnings; FIXME - Bug 2505
30
31 use CGI;
32 use C4::Context;
33 use C4::Auth qw/:DEFAULT get_session/;
34 use C4::Output;
35 use C4::Circulation;
36 use C4::Dates qw/format_date/;
37 use Date::Calc qw/Add_Delta_Days/;
38 use C4::Calendar;
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
48 my $query = new CGI;
49
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");
56         exit;
57     }
58
59
60 #getting the template
61 my ( $template, $librarian, $cookie ) = get_template_and_user(
62     {
63         template_name   => "circ/returns.tmpl",
64         query           => $query,
65         type            => "intranet",
66         authnotrequired => 0,
67         flagsrequired   => { circulate => "circulate_remaining_permissions" },
68     }
69 );
70
71 #####################
72 #Global vars
73 my $branches = GetBranches();
74 my $printers = GetPrinters();
75
76 my $printer = C4::Context->userenv ? C4::Context->userenv->{'branchprinter'} : "";
77 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
78
79 my $userenv_branch = C4::Context->userenv->{'branch'} || '';
80 #
81 # Some code to handle the error if there is no branch or printer setting.....
82 #
83
84 # Set up the item stack ....
85 my %returneditems;
86 my %riduedate;
87 my %riborrowernumber;
88 my @inputloop;
89 foreach ( $query->param ) {
90     my $counter;
91     if (/ri-(\d*)/) {
92         $counter = $1;
93         if ($counter > 20) {
94             next;
95         }
96     }
97     else {
98         next;
99     }
100
101     my %input;
102     my $barcode        = $query->param("ri-$counter");
103     my $duedate        = $query->param("dd-$counter");
104     my $borrowernumber = $query->param("bn-$counter");
105     $counter++;
106
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'));
110
111     ######################
112     #Are these lines still useful ?
113     $returneditems{$counter}    = $barcode;
114     $riduedate{$counter}        = $duedate;
115     $riborrowernumber{$counter} = $borrowernumber;
116
117     #######################
118     $input{counter}        = $counter;
119     $input{barcode}        = $barcode;
120     $input{duedate}        = $duedate;
121     $input{borrowernumber} = $borrowernumber;
122     push( @inputloop, \%input );
123 }
124
125 ############
126 # Deal with the requests....
127
128 if ($query->param('WT-itemNumber')){
129         updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
130 }
131
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);
146
147     my ($borr) = GetMemberDetails( $nextreservinfo, 0 );
148     my $name   = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
149     if ( $messages->{'transfert'} ) {
150         $template->param(
151             itemtitle      => $iteminfo->{'title'},
152             itembiblionumber => $iteminfo->{'biblionumber'},
153             iteminfo       => $iteminfo->{'author'},
154             tobranchname   => GetBranchName($messages->{'transfert'}),
155             name           => $name,
156             borrowernumber => $borrowernumber,
157             borcnum        => $borr->{'cardnumber'},
158             borfirstname   => $borr->{'firstname'},
159             borsurname     => $borr->{'surname'},
160             diffbranch     => 1,
161         );
162     }
163 }
164
165 my $borrower;
166 my $returned = 0;
167 my $messages;
168 my $issueinformation;
169 my $itemnumber;
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);
179 if ($dotransfer){
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); 
184 }
185
186 # actually return book and prepare item table.....
187 if ($barcode) {
188     $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
189     $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
190     $itemnumber = GetItemnumberFromBarcode($barcode);
191
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'} );
197         }
198     }
199
200     if ( C4::Context->preference("ReturnToShelvingCart") ) {
201         my $item = GetItem( $itemnumber );
202         $item->{'location'} = 'CART';
203         ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
204     }
205
206 #
207 # save the return
208 #
209     ( $returned, $messages, $issueinformation, $borrower ) =
210       AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode);     # do the return
211     my $homeorholdingbranchreturn = C4::Context->preference('HomeOrHoldingBranchReturn') or 'homebranch';
212
213     # get biblio description
214     my $biblio = GetBiblioFromItemNumber($itemnumber);
215     # fix up item type for display
216     $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
217
218     $template->param(
219         title            => $biblio->{'title'},
220         homebranch       => $biblio->{'homebranch'},
221         homebranchname   => GetBranchName( $biblio->{$homeorholdingbranchreturn} ),
222         author           => $biblio->{'author'},
223         itembarcode      => $biblio->{'barcode'},
224         itemtype         => $biblio->{'itemtype'},
225         ccode            => $biblio->{'ccode'},
226         itembiblionumber => $biblio->{'biblionumber'},    
227     );
228
229     my %input = (
230         counter => 0,
231         first   => 1,
232         barcode => $barcode,
233     );
234
235     if ($returned) {
236         my $duedate = $issueinformation->{'date_due'};
237         $returneditems{0}      = $barcode;
238         $riborrowernumber{0}   = $borrower->{'borrowernumber'};
239         $riduedate{0}          = $duedate;
240         $input{borrowernumber} = $borrower->{'borrowernumber'};
241         $input{duedate}        = $duedate;
242         $input{return_overdue} = 1 if ($duedate and $duedate lt $today->output('iso'));
243         push( @inputloop, \%input );
244
245         if ( C4::Context->preference("FineNotifyAtCheckin") ) {
246             my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
247             if ($fines > 0) {
248                 $template->param( fines => sprintf("%.2f",$fines) );
249                 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
250             }
251         }
252
253     }
254     elsif ( !$messages->{'BadBarcode'} ) {
255         $input{duedate}   = 0;
256         $returneditems{0} = $barcode;
257         $riduedate{0}     = 0;
258         if ( $messages->{'wthdrawn'} ) {
259             $input{withdrawn}      = 1;
260             $input{borrowernumber} = 'Item Cancelled';  # FIXME: should be in display layer ?
261             $riborrowernumber{0}   = 'Item Cancelled';
262         }
263         else {
264             $input{borrowernumber} = ' ';  # This seems clearly bogus.
265             $riborrowernumber{0}   = ' ';
266         }
267         push( @inputloop, \%input );
268     }
269 }
270 $template->param( inputloop => \@inputloop );
271
272 my $found    = 0;
273 my $waiting  = 0;
274 my $reserved = 0;
275
276 # new op dev : we check if the document must be returned to his homebranch directly,
277 #  if the document is transfered, we have warning message .
278
279 if ( $messages->{'WasTransfered'} ) {
280     $template->param(
281         found          => 1,
282         transfer       => 1,
283     );
284 }
285
286 if ( $messages->{'NeedsTransfer'} ){
287     $template->param(
288         found          => 1,
289         needstransfer  => 1,
290         itemnumber     => $itemnumber,
291     );
292 }
293
294 if ( $messages->{'Wrongbranch'} ){
295     $template->param(
296         wrongbranch => 1,
297     );
298 }
299
300 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
301
302 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
303     $messages->{'WrongTransfer'} = GetBranchName( $messages->{'WrongTransfer'} );
304     $template->param(
305         WrongTransfer  => 1,
306         TransferWaitingAt => $messages->{'WrongTransfer'},
307         WrongTransferItem => $messages->{'WrongTransferItem'},
308     );
309
310     my $reserve    = $messages->{'ResFound'};
311     my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
312     my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
313     my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
314     $template->param(
315             wname           => $name,
316             wborfirstname   => $borr->{'firstname'},
317             wborsurname     => $borr->{'surname'},
318             wbortitle       => $borr->{'title'},
319             wborphone       => $borr->{'phone'},
320             wboremail       => $borr->{'email'},
321             wboraddress     => $borr->{'address'},
322             wboraddress2    => $borr->{'address2'},
323             wborcity        => $borr->{'city'},
324             wborzip         => $borr->{'zipcode'},
325             wborrowernumber => $reserve->{'borrowernumber'},
326             wborcnum        => $borr->{'cardnumber'},
327             wtransfertFrom  => $userenv_branch,
328     );
329 }
330
331 #
332 # reserve found and item arrived at the expected branch
333 #
334 if ( $messages->{'ResFound'}) {
335     my $reserve    = $messages->{'ResFound'};
336     my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
337     my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
338
339     if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
340         if ( $reserve->{'ResFound'} eq "Waiting" ) {
341             $template->param(
342                 waiting      => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
343             );
344         } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
345             $template->param(
346                 intransit    => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
347                 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
348                 resbarcode   => $barcode,
349                 reserved     => 1,
350             );
351         }
352
353         # same params for Waiting or Reserved
354         $template->param(
355             found          => 1,
356             currentbranch  => $branches->{$userenv_branch}->{'branchname'},
357             destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
358             name           => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
359             borfirstname   => $borr->{'firstname'},
360             borsurname     => $borr->{'surname'},
361             bortitle       => $borr->{'title'},
362             borphone       => $borr->{'phone'},
363             boremail       => $borr->{'email'},
364             boraddress     => $borr->{'address'},
365             boraddress2    => $borr->{'address2'},
366             borcity        => $borr->{'city'},
367             borzip         => $borr->{'zipcode'},
368             borcnum        => $borr->{'cardnumber'},
369             debarred       => $borr->{'debarred'},
370             gonenoaddress  => $borr->{'gonenoaddress'},
371             barcode        => $barcode,
372             destbranch     => $reserve->{'branchcode'},
373             borrowernumber => $reserve->{'borrowernumber'},
374             itemnumber     => $reserve->{'itemnumber'},
375             reservenotes   => $reserve->{'reservenotes'},
376         );
377     } # else { ; }  # error?
378 }
379
380 # Error Messages
381 my @errmsgloop;
382 foreach my $code ( keys %$messages ) {
383     my %err;
384     my $exit_required_p = 0;
385     if ( $code eq 'BadBarcode' ) {
386         $err{badbarcode} = 1;
387         $err{msg}        = $messages->{'BadBarcode'};
388     }
389     elsif ( $code eq 'NotIssued' ) {
390         $err{notissued} = 1;
391         $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
392     }
393     elsif ( $code eq 'WasLost' ) {
394         $err{waslost} = 1;
395     }
396     elsif ( $code eq 'ResFound' ) {
397         ;    # FIXME... anything to do here?
398     }
399     elsif ( $code eq 'WasReturned' ) {
400         ;    # FIXME... anything to do here?
401     }
402     elsif ( $code eq 'WasTransfered' ) {
403         ;    # FIXME... anything to do here?
404     }
405     elsif ( $code eq 'wthdrawn' ) {
406         $err{withdrawn} = 1;
407         $exit_required_p = 1;
408     }
409     elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
410         if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
411             $err{ispermanent} = 1;
412             $err{msg}         =
413               $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
414         }
415     }
416     elsif ( $code eq 'WrongTransfer' ) {
417         ;    # FIXME... anything to do here?
418     }
419     elsif ( $code eq 'WrongTransferItem' ) {
420         ;    # FIXME... anything to do here?
421     }
422     elsif ( $code eq 'NeedsTransfer' ) {
423     }
424     elsif ( $code eq 'Wrongbranch' ) {
425     }
426
427     else {
428         die "Unknown error code $code";    # note we need all the (empty) elsif's above, or we die.
429         # This forces the issue of staying in sync w/ Circulation.pm
430     }
431     if (%err) {
432         push( @errmsgloop, \%err );
433     }
434     last if $exit_required_p;
435 }
436 $template->param( errmsgloop => \@errmsgloop );
437
438 # patrontable ....
439 if ($borrower) {
440     my $flags = $borrower->{'flags'};
441     my @flagloop;
442     my $flagset;
443     foreach my $flag ( sort keys %$flags ) {
444         my %flaginfo;
445         unless ($flagset) { $flagset = 1; }
446         $flaginfo{redfont} = ( $flags->{$flag}->{'noissues'} );
447         $flaginfo{flag}    = $flag;
448         if ( $flag eq 'CHARGES' ) {
449             $flaginfo{msg}            = $flag;
450             $flaginfo{charges}        = 1;
451             $flaginfo{chargeamount}   = $flags->{$flag}->{amount};
452             $flaginfo{borrowernumber} = $borrower->{borrowernumber};
453         }
454         elsif ( $flag eq 'WAITING' ) {
455             $flaginfo{msg}     = $flag;
456             $flaginfo{waiting} = 1;
457             my @waitingitemloop;
458             my $items = $flags->{$flag}->{'itemlist'};
459             foreach my $item (@$items) {
460                 my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
461                 push @waitingitemloop, {
462                     biblionum => $biblio->{'biblionumber'},
463                     barcode   => $biblio->{'barcode'},
464                     title     => $biblio->{'title'},
465                     brname    => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
466                 };
467             }
468             $flaginfo{itemloop} = \@waitingitemloop;
469         }
470         elsif ( $flag eq 'ODUES' ) {
471             my $items = $flags->{$flag}->{'itemlist'};
472             my @itemloop;
473             foreach my $item ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
474                 @$items )
475             {
476                 my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
477                 push @itemloop, {
478                     duedate   => format_date($item->{'date_due'}),
479                     biblionum => $biblio->{'biblionumber'},
480                     barcode   => $biblio->{'barcode'},
481                     title     => $biblio->{'title'},
482                     brname    => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
483                 };
484             }
485             $flaginfo{itemloop} = \@itemloop;
486             $flaginfo{overdue}  = 1;
487         }
488         else {
489             $flaginfo{other} = 1;
490             $flaginfo{msg}   = $flags->{$flag}->{'message'};
491         }
492         push( @flagloop, \%flaginfo );
493     }
494     $template->param(
495         flagset          => $flagset,
496         flagloop         => \@flagloop,
497         riborrowernumber => $borrower->{'borrowernumber'},
498         riborcnum        => $borrower->{'cardnumber'},
499         riborsurname     => $borrower->{'surname'},
500         ribortitle       => $borrower->{'title'},
501         riborfirstname   => $borrower->{'firstname'}
502     );
503 }
504
505 #set up so only the last 8 returned items display (make for faster loading pages)
506 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
507 my $count = 0;
508 my @riloop;
509 foreach ( sort { $a <=> $b } keys %returneditems ) {
510     my %ri;
511     if ( $count++ < $returned_counter ) {
512         my $bar_code = $returneditems{$_};
513         my $duedate = $riduedate{$_};
514         if ($duedate) {
515             my @tempdate = split( /-/, $duedate );
516             $ri{year}  = $tempdate[0];
517             $ri{month} = $tempdate[1];
518             $ri{day}   = $tempdate[2];
519             $ri{duedate} = format_date($duedate);
520             my ($b)      = GetMemberDetails( $riborrowernumber{$_}, 0 );
521             $ri{return_overdue} = 1 if ($duedate lt $today->output('iso'));
522             $ri{borrowernumber} = $b->{'borrowernumber'};
523             $ri{borcnum}        = $b->{'cardnumber'};
524             $ri{borfirstname}   = $b->{'firstname'};
525             $ri{borsurname}     = $b->{'surname'};
526             $ri{bortitle}       = $b->{'title'};
527             $ri{bornote}        = $b->{'borrowernotes'};
528             $ri{borcategorycode}= $b->{'categorycode'};
529         }
530         else {
531             $ri{borrowernumber} = $riborrowernumber{$_};
532         }
533
534         #        my %ri;
535         my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
536         # fix up item type for display
537         $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
538         $ri{itembiblionumber} = $biblio->{'biblionumber'};
539         $ri{itemtitle}        = $biblio->{'title'};
540         $ri{itemauthor}       = $biblio->{'author'};
541         $ri{itemcallnumber}   = $biblio->{'itemcallnumber'};
542         $ri{itemtype}         = $biblio->{'itemtype'};
543         $ri{itemnote}         = $biblio->{'itemnotes'};
544         $ri{ccode}            = $biblio->{'ccode'};
545         $ri{itemnumber}       = $biblio->{'itemnumber'};
546         $ri{barcode}          = $bar_code;
547     }
548     else {
549         last;
550     }
551     push @riloop, \%ri;
552 }
553
554 $template->param(
555     riloop         => \@riloop,
556     genbrname      => $branches->{$userenv_branch}->{'branchname'},
557     genprname      => $printers->{$printer}->{'printername'},
558     branchname     => $branches->{$userenv_branch}->{'branchname'},
559     printer        => $printer,
560     errmsgloop     => \@errmsgloop,
561     exemptfine     => $exemptfine,
562     dropboxmode    => $dropboxmode,
563     dropboxdate    => $dropboxdate->output(),
564     overduecharges => $overduecharges,
565     soundon        => C4::Context->preference("SoundOn"),
566 );
567
568 ### Comment out rotating collections for now to allow it a little more time to bake
569 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
570 ### to fill hold requests
571 ### -- Galen Charlton 2010-10-06
572 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
573 #if ( $itemnumber ) {
574 #   my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
575 #    if ( ! ( $holdingBranch eq $collectionBranch ) ) {
576 #        $template->param(
577 #          collectionItemNeedsTransferred => 1,
578 #          collectionBranch => GetBranchName($collectionBranch),
579 #        );
580 #    }
581 #}                                                                                                            
582
583 # actually print the page!
584 output_html_with_http_headers $query, $cookie, $template->output;