Bug 9809: Update AddReserve prototype to remove constraint parameter
[koha.git] / opac / opac-reserve.pl
1 #!/usr/bin/perl
2
3 # Copyright Katipo Communications 2002
4 # Copyright Koha Development team 2012
5 #
6 # This file is part of Koha.
7 #
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20
21 use strict;
22 use warnings;
23 use CGI qw ( -utf8 );
24 use C4::Auth;    # checkauth, getborrowernumber.
25 use C4::Koha;
26 use C4::Circulation;
27 use C4::Reserves;
28 use C4::Biblio;
29 use C4::Items;
30 use C4::Output;
31 use C4::Dates qw/format_date/;
32 use C4::Context;
33 use C4::Members;
34 use C4::Branch; # GetBranches
35 use C4::Overdues;
36 use C4::Debug;
37 use Koha::DateUtils;
38 use Koha::Borrower::Debarments qw(IsDebarred);
39 use Date::Calc qw/Today Date_to_Days/;
40 # use Data::Dumper;
41
42 my $maxreserves = C4::Context->preference("maxreserves");
43
44 my $query = new CGI;
45
46 # if RequestOnOpac (for placing holds) is disabled, leave immediately
47 if ( ! C4::Context->preference('RequestOnOpac') ) {
48     print $query->redirect("/cgi-bin/koha/errors/404.pl");
49     exit;
50 }
51
52 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
53     {
54         template_name   => "opac-reserve.tt",
55         query           => $query,
56         type            => "opac",
57         authnotrequired => 0,
58         debug           => 1,
59     }
60 );
61
62 my ($show_holds_count, $show_priority);
63 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
64     m/holds/o and $show_holds_count = 1;
65     m/priority/ and $show_priority = 1;
66 }
67
68 sub get_out {
69         output_html_with_http_headers(shift,shift,shift); # $query, $cookie, $template->output;
70         exit;
71 }
72
73 # get borrower information ....
74 my ( $borr ) = GetMemberDetails( $borrowernumber );
75
76 # check if this user can place a reserve, -1 means use sys pref, 0 means dont block, 1 means block
77 if ( $borr->{'BlockExpiredPatronOpacActions'} ) {
78
79     if ( $borr->{'is_expired'} ) {
80
81         # cannot reserve, their card has expired and the rules set mean this is not allowed
82         $template->param( message => 1, expired_patron => 1 );
83         get_out( $query, $cookie, $template->output );
84     }
85 }
86
87 # Pass through any reserve charge
88 if ($borr->{reservefee} > 0){
89     $template->param( RESERVE_CHARGE => sprintf("%.2f",$borr->{reservefee}));
90 }
91 # get branches and itemtypes
92 my $branches = GetBranches();
93 my $itemTypes = GetItemTypes();
94
95 # There are two ways of calling this script, with a single biblio num
96 # or multiple biblio nums.
97 my $biblionumbers = $query->param('biblionumbers');
98 my $reserveMode = $query->param('reserve_mode');
99 if ($reserveMode && ($reserveMode eq 'single')) {
100     my $bib = $query->param('single_bib');
101     $biblionumbers = "$bib/";
102 }
103 if (! $biblionumbers) {
104     $biblionumbers = $query->param('biblionumber');
105 }
106
107 if ((! $biblionumbers) && (! $query->param('place_reserve'))) {
108     $template->param(message=>1, no_biblionumber=>1);
109     &get_out($query, $cookie, $template->output);
110 }
111
112 # Pass the numbers to the page so they can be fed back
113 # when the hold is confirmed. TODO: Not necessary?
114 $template->param( biblionumbers => $biblionumbers );
115
116 # Each biblio number is suffixed with '/', e.g. "1/2/3/"
117 my @biblionumbers = split /\//, $biblionumbers;
118 if (($#biblionumbers < 0) && (! $query->param('place_reserve'))) {
119     # TODO: New message?
120     $template->param(message=>1, no_biblionumber=>1);
121     &get_out($query, $cookie, $template->output);
122 }
123
124
125 # pass the pickup branch along....
126 my $branch = $query->param('branch') || $borr->{'branchcode'} || C4::Context->userenv->{branch} || '' ;
127 ($branches->{$branch}) or $branch = "";     # Confirm branch is real
128 $template->param( branch => $branch );
129
130 # make branch selection options...
131 my $branchloop = GetBranchesLoop($branch);
132
133 # Is the person allowed to choose their branch
134 my $OPACChooseBranch = (C4::Context->preference("OPACAllowUserToChooseBranch")) ? 1 : 0;
135
136 $template->param( choose_branch => $OPACChooseBranch);
137
138 #
139 #
140 # Build hashes of the requested biblio(item)s and items.
141 #
142 #
143
144 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
145 my %itemInfoHash; # Hash of itemnumber to item info.
146 foreach my $biblioNumber (@biblionumbers) {
147
148     my $biblioData = GetBiblioData($biblioNumber);
149     $biblioDataHash{$biblioNumber} = $biblioData;
150
151     my @itemInfos = GetItemsInfo($biblioNumber);
152
153     my $marcrecord= GetMarcBiblio($biblioNumber);
154
155     # flag indicating existence of at least one item linked via a host record
156     my $hostitemsflag;
157     # adding items linked via host biblios
158     my @hostitemInfos = GetHostItemsInfo($marcrecord);
159     if (@hostitemInfos){
160         $hostitemsflag =1;
161         push (@itemInfos,@hostitemInfos);
162     }
163
164     $biblioData->{itemInfos} = \@itemInfos;
165     foreach my $itemInfo (@itemInfos) {
166         $itemInfoHash{$itemInfo->{itemnumber}} = $itemInfo;
167     }
168
169     # Compute the priority rank.
170     my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblioNumber, all_dates => 1 });
171     my $rank = scalar( @$reserves );
172     $biblioData->{reservecount} = 1;    # new reserve
173     foreach my $res (@{$reserves}) {
174         my $found = $res->{found};
175         if ( $found && $found eq 'W' ) {
176             $rank--;
177         }
178         else {
179             $biblioData->{reservecount}++;
180         }
181     }
182     $biblioData->{rank} = $rank + 1;
183 }
184
185 #
186 #
187 # If this is the second time through this script, it
188 # means we are carrying out the hold request, possibly
189 # with a specific item for each biblionumber.
190 #
191 #
192 if ( $query->param('place_reserve') ) {
193     my $reserve_cnt = 0;
194     if ($maxreserves) {
195         $reserve_cnt = GetReservesFromBorrowernumber( $borrowernumber );
196     }
197
198     # List is composed of alternating biblio/item/branch
199     my $selectedItems = $query->param('selecteditems');
200
201     if ($query->param('reserve_mode') eq 'single') {
202         # This indicates non-JavaScript mode, so there was
203         # only a single biblio number selected.
204         my $bib = $query->param('single_bib');
205         my $item = $query->param("checkitem_$bib");
206         if ($item eq 'any') {
207             $item = '';
208         }
209         my $branch = $query->param('branch');
210         $selectedItems = "$bib/$item/$branch/";
211     }
212
213     $selectedItems =~ s!/$!!;
214     my @selectedItems = split /\//, $selectedItems, -1;
215
216     # Make sure there is a biblionum/itemnum/branch triplet for each item.
217     # The itemnum can be 'any', meaning next available.
218     my $selectionCount = @selectedItems;
219     if (($selectionCount == 0) || (($selectionCount % 3) != 0)) {
220         $template->param(message=>1, bad_data=>1);
221         &get_out($query, $cookie, $template->output);
222     }
223
224     while (@selectedItems) {
225         my $biblioNum = shift(@selectedItems);
226         my $itemNum   = shift(@selectedItems);
227         my $branch    = shift(@selectedItems);    # i.e., branch code, not name
228
229         my $canreserve = 0;
230
231         my $singleBranchMode = C4::Context->preference("singleBranchMode");
232         if ( $singleBranchMode || !$OPACChooseBranch )
233         {    # single branch mode or disabled user choosing
234             $branch = $borr->{'branchcode'};
235         }
236
237 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
238         if ( $itemNum ne '' ) {
239             my $hostbiblioNum = GetBiblionumberFromItemnumber($itemNum);
240             if ( $hostbiblioNum ne $biblioNum ) {
241                 $biblioNum = $hostbiblioNum;
242             }
243         }
244
245         my $biblioData = $biblioDataHash{$biblioNum};
246         my $found;
247
248         # Check for user supplied reserve date
249         my $startdate;
250         if (   C4::Context->preference('AllowHoldDateInFuture')
251             && C4::Context->preference('OPACAllowHoldDateInFuture') )
252         {
253             $startdate = $query->param("reserve_date_$biblioNum");
254         }
255
256         my $expiration_date = $query->param("expiration_date_$biblioNum");
257
258       # If a specific item was selected and the pickup branch is the same as the
259       # holdingbranch, force the value $rank and $found.
260         my $rank = $biblioData->{rank};
261         if ( $itemNum ne '' ) {
262             $canreserve = 1 if CanItemBeReserved( $borrowernumber, $itemNum ) eq 'OK';
263             $rank = '0' unless C4::Context->preference('ReservesNeedReturns');
264             my $item = GetItem($itemNum);
265             if ( $item->{'holdingbranch'} eq $branch ) {
266                 $found = 'W'
267                   unless C4::Context->preference('ReservesNeedReturns');
268             }
269         }
270         else {
271             $canreserve = 1 if CanBookBeReserved( $borrowernumber, $biblioNum ) eq 'OK';
272
273             # Inserts a null into the 'itemnumber' field of 'reserves' table.
274             $itemNum = undef;
275         }
276         my $notes = $query->param('notes_'.$biblioNum)||'';
277
278         if (   $maxreserves
279             && $reserve_cnt >= $maxreserves )
280         {
281             $canreserve = 0;
282         }
283
284         # Here we actually do the reserveration. Stage 3.
285         if ($canreserve) {
286             AddReserve(
287                 $branch,      $borrowernumber,
288                 $biblioNum,
289                 [$biblioNum], $rank,
290                 $startdate,   $expiration_date,
291                 $notes,       $biblioData->{title},
292                 $itemNum,     $found
293             );
294             ++$reserve_cnt;
295         }
296     }
297
298     print $query->redirect("/cgi-bin/koha/opac-user.pl#opac-user-holds");
299     exit;
300 }
301
302 #
303 #
304 # Here we check that the borrower can actually make reserves Stage 1.
305 #
306 #
307 my $noreserves     = 0;
308 my $maxoutstanding = C4::Context->preference("maxoutstanding");
309 $template->param( noreserve => 1 ) unless $maxoutstanding;
310 if ( $borr->{'amountoutstanding'} && ($borr->{'amountoutstanding'} > $maxoutstanding) ) {
311     my $amount = sprintf "%.02f", $borr->{'amountoutstanding'};
312     $template->param( message => 1 );
313     $noreserves = 1;
314     $template->param( too_much_oweing => $amount );
315 }
316 if ( $borr->{gonenoaddress} && ($borr->{gonenoaddress} == 1) ) {
317     $noreserves = 1;
318     $template->param(
319         message => 1,
320         GNA     => 1
321     );
322 }
323 if ( $borr->{lost} && ($borr->{lost} == 1) ) {
324     $noreserves = 1;
325     $template->param(
326         message => 1,
327         lost    => 1
328     );
329 }
330 if ( IsDebarred($borrowernumber) ) {
331     $noreserves = 1;
332     $template->param(
333         message  => 1,
334         debarred => 1
335     );
336 }
337
338 my @reserves = GetReservesFromBorrowernumber( $borrowernumber );
339 my $reserves_count = scalar(@reserves);
340 $template->param( RESERVES => \@reserves );
341 if ( $maxreserves && ( $reserves_count >= $maxreserves ) ) {
342     $template->param( message => 1 );
343     $noreserves = 1;
344     $template->param( too_many_reserves => scalar(@reserves));
345 }
346
347 unless ( $noreserves ) {
348     my $requested_reserves_count = scalar( @biblionumbers );
349     if ( $maxreserves && ( $reserves_count + $requested_reserves_count > $maxreserves ) ) {
350         $template->param( new_reserves_allowed => $maxreserves - $reserves_count );
351     }
352 }
353
354 foreach my $res (@reserves) {
355     foreach my $biblionumber (@biblionumbers) {
356         if ( $res->{'biblionumber'} == $biblionumber && $res->{'borrowernumber'} == $borrowernumber) {
357 #            $template->param( message => 1 );
358 #            $noreserves = 1;
359 #            $template->param( already_reserved => 1 );
360             $biblioDataHash{$biblionumber}->{already_reserved} = 1;
361         }
362     }
363 }
364
365 unless ($noreserves) {
366     $template->param( select_item_types => 1 );
367 }
368
369
370 #
371 #
372 # Build the template parameters that will show the info
373 # and items for each biblionumber.
374 #
375 #
376 my $notforloan_label_of = get_notforloan_label_of();
377
378 my $biblioLoop = [];
379 my $numBibsAvailable = 0;
380 my $itemdata_enumchron = 0;
381 my $anyholdable = 0;
382 my $itemLevelTypes = C4::Context->preference('item-level_itypes');
383 $template->param('item_level_itypes' => $itemLevelTypes);
384
385 foreach my $biblioNum (@biblionumbers) {
386
387     my $record = GetMarcBiblio($biblioNum);
388     # Init the bib item with the choices for branch pickup
389     my %biblioLoopIter = ( branchloop => $branchloop );
390
391     # Get relevant biblio data.
392     my $biblioData = $biblioDataHash{$biblioNum};
393     if (! $biblioData) {
394         $template->param(message=>1, bad_biblionumber=>$biblioNum);
395         &get_out($query, $cookie, $template->output);
396     }
397
398     $biblioLoopIter{biblionumber} = $biblioData->{biblionumber};
399     $biblioLoopIter{title} = $biblioData->{title};
400     $biblioLoopIter{subtitle} = GetRecordValue('subtitle', $record, GetFrameworkCode($biblioData->{biblionumber}));
401     $biblioLoopIter{author} = $biblioData->{author};
402     $biblioLoopIter{rank} = $biblioData->{rank};
403     $biblioLoopIter{reservecount} = $biblioData->{reservecount};
404     $biblioLoopIter{already_reserved} = $biblioData->{already_reserved};
405     $biblioLoopIter{mandatorynotes}=0; #FIXME: For future use
406
407     if (!$itemLevelTypes && $biblioData->{itemtype}) {
408         $biblioLoopIter{description} = $itemTypes->{$biblioData->{itemtype}}{description};
409         $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$biblioData->{itemtype}}{imageurl};
410     }
411
412     foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
413         $debug and warn $itemInfo->{'notforloan'};
414
415         # Get reserve fee.
416         my $fee = GetReserveFee(undef, $borrowernumber, $itemInfo->{'biblionumber'}, 'a',
417                                 ( $itemInfo->{'biblioitemnumber'} ) );
418         $itemInfo->{'reservefee'} = sprintf "%.02f", ($fee ? $fee : 0.0);
419
420         if ($itemLevelTypes && $itemInfo->{itype}) {
421             $itemInfo->{description} = $itemTypes->{$itemInfo->{itype}}{description};
422             $itemInfo->{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$itemInfo->{itype}}{imageurl};
423         }
424
425         if (!$itemInfo->{'notforloan'} && !($itemInfo->{'itemnotforloan'} > 0)) {
426             $biblioLoopIter{forloan} = 1;
427         }
428     }
429
430     $biblioLoopIter{itemLoop} = [];
431     my $numCopiesAvailable = 0;
432     my $numCopiesOPACAvailable = 0;
433     foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
434         my $itemNum = $itemInfo->{itemnumber};
435         my $itemLoopIter = {};
436
437         $itemLoopIter->{itemnumber} = $itemNum;
438         $itemLoopIter->{barcode} = $itemInfo->{barcode};
439         $itemLoopIter->{homeBranchName} = $branches->{$itemInfo->{homebranch}}{branchname};
440         $itemLoopIter->{callNumber} = $itemInfo->{itemcallnumber};
441         $itemLoopIter->{enumchron} = $itemInfo->{enumchron};
442         $itemLoopIter->{copynumber} = $itemInfo->{copynumber};
443         if ($itemLevelTypes) {
444             $itemLoopIter->{description} = $itemInfo->{description};
445             $itemLoopIter->{imageurl} = $itemInfo->{imageurl};
446         }
447
448         # If the holdingbranch is different than the homebranch, we show the
449         # holdingbranch of the document too.
450         if ( $itemInfo->{homebranch} ne $itemInfo->{holdingbranch} ) {
451             $itemLoopIter->{holdingBranchName} =
452               $branches->{ $itemInfo->{holdingbranch} }{branchname};
453         }
454
455         # If the item is currently on loan, we display its return date and
456         # change the background color.
457         my $issues= GetItemIssue($itemNum);
458         if ( $issues->{'date_due'} ) {
459             $itemLoopIter->{dateDue} = output_pref({ dt => dt_from_string($issues->{date_due}, 'sql'), as_due_date => 1 });
460             $itemLoopIter->{backgroundcolor} = 'onloan';
461         }
462
463         # checking reserve
464         my ($reservedate,$reservedfor,$expectedAt,undef,$wait) = GetReservesFromItemnumber($itemNum);
465         my $ItemBorrowerReserveInfo = GetMemberDetails( $reservedfor, 0);
466
467         # the item could be reserved for this borrower vi a host record, flag this
468         $reservedfor //= '';
469         if ($reservedfor eq $borrowernumber){
470             $itemLoopIter->{already_reserved} = 1;
471         }
472
473         if ( defined $reservedate ) {
474             $itemLoopIter->{backgroundcolor} = 'reserved';
475             $itemLoopIter->{reservedate}     = format_date($reservedate);
476             $itemLoopIter->{ReservedForBorrowernumber} = $reservedfor;
477             $itemLoopIter->{ReservedForSurname}        = $ItemBorrowerReserveInfo->{'surname'};
478             $itemLoopIter->{ReservedForFirstname}      = $ItemBorrowerReserveInfo->{'firstname'};
479             $itemLoopIter->{ExpectedAtLibrary}         = $expectedAt;
480             #waiting status
481             $itemLoopIter->{waitingdate} = $wait;
482         }
483
484         $itemLoopIter->{notforloan} = $itemInfo->{notforloan};
485         $itemLoopIter->{itemnotforloan} = $itemInfo->{itemnotforloan};
486
487         # Management of the notforloan document
488         if ( $itemLoopIter->{notforloan} || $itemLoopIter->{itemnotforloan}) {
489             $itemLoopIter->{backgroundcolor} = 'other';
490             $itemLoopIter->{notforloanvalue} =
491               $notforloan_label_of->{ $itemLoopIter->{notforloan} };
492         }
493
494         # Management of lost or long overdue items
495         if ( $itemInfo->{itemlost} ) {
496
497             # FIXME localized strings should never be in Perl code
498             $itemLoopIter->{message} =
499                 $itemInfo->{itemlost} == 1 ? "(lost)"
500               : $itemInfo->{itemlost} == 2 ? "(long overdue)"
501               : "";
502             $itemInfo->{backgroundcolor} = 'other';
503         }
504
505         # Check of the transfered documents
506         my ( $transfertwhen, $transfertfrom, $transfertto ) =
507           GetTransfers($itemNum);
508         if ( $transfertwhen && ($transfertwhen ne '') ) {
509             $itemLoopIter->{transfertwhen} = format_date($transfertwhen);
510             $itemLoopIter->{transfertfrom} =
511               $branches->{$transfertfrom}{branchname};
512             $itemLoopIter->{transfertto} = $branches->{$transfertto}{branchname};
513             $itemLoopIter->{nocancel} = 1;
514         }
515
516         # if the items belongs to a host record, show link to host record
517         if ($itemInfo->{biblionumber} ne $biblioNum){
518                 $biblioLoopIter{hostitemsflag} = 1;
519                 $itemLoopIter->{hostbiblionumber} = $itemInfo->{biblionumber};
520                 $itemLoopIter->{hosttitle} = GetBiblioData($itemInfo->{biblionumber})->{title};
521         }
522
523         # If there is no loan, return and transfer, we show a checkbox.
524         $itemLoopIter->{notforloan} = $itemLoopIter->{notforloan} || 0;
525
526         my $branch = GetReservesControlBranch( $itemInfo, $borr );
527
528         my $policy_holdallowed = !$itemLoopIter->{already_reserved};
529         $policy_holdallowed &&=
530             IsAvailableForItemLevelRequest($itemInfo,$borr) &&
531             CanItemBeReserved($borrowernumber,$itemNum) eq 'OK';
532
533         if ($policy_holdallowed) {
534             if ( my $hold_allowed = OPACItemHoldsAllowed( $itemInfo, $borr ) ) {
535                 $itemLoopIter->{available} = 1;
536                 $numCopiesOPACAvailable++;
537                 $biblioLoopIter{force_hold} = 1 if $hold_allowed eq 'F';
538             }
539             $numCopiesAvailable++;
540         }
541
542         $itemLoopIter->{imageurl} = getitemtypeimagelocation( 'opac', $itemTypes->{ $itemInfo->{itype} }{imageurl} );
543
544     # Show serial enumeration when needed
545         if ($itemLoopIter->{enumchron}) {
546             $itemdata_enumchron = 1;
547         }
548
549         push @{$biblioLoopIter{itemLoop}}, $itemLoopIter;
550     }
551     $template->param( itemdata_enumchron => $itemdata_enumchron );
552
553     if ($numCopiesAvailable > 0) {
554         $numBibsAvailable++;
555         $biblioLoopIter{bib_available} = 1;
556         $biblioLoopIter{holdable} = 1;
557         $biblioLoopIter{itemholdable} = 1 if $numCopiesOPACAvailable;
558     }
559     if ($biblioLoopIter{already_reserved}) {
560         $biblioLoopIter{holdable} = undef;
561         $biblioLoopIter{itemholdable} = undef;
562     }
563     if(not C4::Context->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron($borrowernumber,$biblioNum)) {
564         $biblioLoopIter{holdable} = undef;
565         $biblioLoopIter{already_patron_possession} = 1;
566     }
567
568     $biblioLoopIter{holdable} &&= CanBookBeReserved($borrowernumber,$biblioNum) eq 'OK';
569
570     push @$biblioLoop, \%biblioLoopIter;
571
572     $anyholdable = 1 if $biblioLoopIter{holdable};
573 }
574
575 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
576     $template->param( none_available => 1 );
577 }
578
579 my $show_notes=C4::Context->preference('OpacHoldNotes');
580 $template->param(OpacHoldNotes=>$show_notes);
581
582 # display infos
583 $template->param(bibitemloop => $biblioLoop);
584 # can set reserve date in future
585 if (
586     C4::Context->preference( 'AllowHoldDateInFuture' ) &&
587     C4::Context->preference( 'OPACAllowHoldDateInFuture' )
588     ) {
589     $template->param(
590             reserve_in_future         => 1,
591     );
592 }
593
594 output_html_with_http_headers $query, $cookie, $template->output;
595