Bug 11559: (QA followup) fix several small issues
[koha.git] / opac / opac-reserve.pl
blobef81b1d1bfcf0b5719946c53bdf573d39641708c
1 #!/usr/bin/perl
3 # Copyright Katipo Communications 2002
4 # Copyright Koha Development team 2012
6 # This file is part of Koha.
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.
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.
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>.
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;
42 my $maxreserves = C4::Context->preference("maxreserves");
44 my $query = new CGI;
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;
52 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
54 template_name => "opac-reserve.tt",
55 query => $query,
56 type => "opac",
57 authnotrequired => 0,
58 debug => 1,
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;
68 sub get_out {
69 output_html_with_http_headers(shift,shift,shift); # $query, $cookie, $template->output;
70 exit;
73 # get borrower information ....
74 my ( $borr ) = GetMemberDetails( $borrowernumber );
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'} ) {
79 if ( $borr->{'is_expired'} ) {
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 );
87 # Pass through any reserve charge
88 if ($borr->{reservefee} > 0){
89 $template->param( RESERVE_CHARGE => sprintf("%.2f",$borr->{reservefee}));
91 # get branches and itemtypes
92 my $branches = GetBranches();
93 my $itemTypes = GetItemTypes();
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/";
103 if (! $biblionumbers) {
104 $biblionumbers = $query->param('biblionumber');
107 if ((! $biblionumbers) && (! $query->param('place_reserve'))) {
108 $template->param(message=>1, no_biblionumber=>1);
109 &get_out($query, $cookie, $template->output);
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 );
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);
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 );
130 # make branch selection options...
131 my $branchloop = GetBranchesLoop($branch);
133 # Is the person allowed to choose their branch
134 my $OPACChooseBranch = (C4::Context->preference("OPACAllowUserToChooseBranch")) ? 1 : 0;
136 $template->param( choose_branch => $OPACChooseBranch);
140 # Build hashes of the requested biblio(item)s and items.
144 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
145 my %itemInfoHash; # Hash of itemnumber to item info.
146 foreach my $biblioNumber (@biblionumbers) {
148 my $biblioData = GetBiblioData($biblioNumber);
149 $biblioDataHash{$biblioNumber} = $biblioData;
151 my @itemInfos = GetItemsInfo($biblioNumber);
153 my $marcrecord= GetMarcBiblio($biblioNumber);
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);
164 $biblioData->{itemInfos} = \@itemInfos;
165 foreach my $itemInfo (@itemInfos) {
166 $itemInfoHash{$itemInfo->{itemnumber}} = $itemInfo;
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--;
178 else {
179 $biblioData->{reservecount}++;
182 $biblioData->{rank} = $rank + 1;
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.
192 if ( $query->param('place_reserve') ) {
193 my $reserve_cnt = 0;
194 if ($maxreserves) {
195 $reserve_cnt = GetReservesFromBorrowernumber( $borrowernumber );
198 # List is composed of alternating biblio/item/branch
199 my $selectedItems = $query->param('selecteditems');
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 = '';
209 my $branch = $query->param('branch');
210 $selectedItems = "$bib/$item/$branch/";
213 $selectedItems =~ s!/$!!;
214 my @selectedItems = split /\//, $selectedItems, -1;
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);
224 my $failed_holds = 0;
225 while (@selectedItems) {
226 my $biblioNum = shift(@selectedItems);
227 my $itemNum = shift(@selectedItems);
228 my $branch = shift(@selectedItems); # i.e., branch code, not name
230 my $canreserve = 0;
232 my $singleBranchMode = C4::Context->preference("singleBranchMode");
233 if ( $singleBranchMode || !$OPACChooseBranch )
234 { # single branch mode or disabled user choosing
235 $branch = $borr->{'branchcode'};
238 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
239 if ( $itemNum ne '' ) {
240 my $hostbiblioNum = GetBiblionumberFromItemnumber($itemNum);
241 if ( $hostbiblioNum ne $biblioNum ) {
242 $biblioNum = $hostbiblioNum;
246 my $biblioData = $biblioDataHash{$biblioNum};
247 my $found;
249 # Check for user supplied reserve date
250 my $startdate;
251 if ( C4::Context->preference('AllowHoldDateInFuture')
252 && C4::Context->preference('OPACAllowHoldDateInFuture') )
254 $startdate = $query->param("reserve_date_$biblioNum");
257 my $expiration_date = $query->param("expiration_date_$biblioNum");
259 # If a specific item was selected and the pickup branch is the same as the
260 # holdingbranch, force the value $rank and $found.
261 my $rank = $biblioData->{rank};
262 if ( $itemNum ne '' ) {
263 $canreserve = 1 if CanItemBeReserved( $borrowernumber, $itemNum ) eq 'OK';
264 $rank = '0' unless C4::Context->preference('ReservesNeedReturns');
265 my $item = GetItem($itemNum);
266 if ( $item->{'holdingbranch'} eq $branch ) {
267 $found = 'W'
268 unless C4::Context->preference('ReservesNeedReturns');
271 else {
272 $canreserve = 1 if CanBookBeReserved( $borrowernumber, $biblioNum ) eq 'OK';
274 # Inserts a null into the 'itemnumber' field of 'reserves' table.
275 $itemNum = undef;
277 my $notes = $query->param('notes_'.$biblioNum)||'';
279 if ( $maxreserves
280 && $reserve_cnt >= $maxreserves )
282 $canreserve = 0;
285 # Here we actually do the reserveration. Stage 3.
286 if ($canreserve) {
287 my $reserve_id = AddReserve(
288 $branch, $borrowernumber,
289 $biblioNum,
290 [$biblioNum], $rank,
291 $startdate, $expiration_date,
292 $notes, $biblioData->{title},
293 $itemNum, $found
295 $failed_holds++ unless $reserve_id;
296 ++$reserve_cnt;
300 print $query->redirect("/cgi-bin/koha/opac-user.pl?" . ( $failed_holds ? "failed_holds=$failed_holds" : q|| ) . "#opac-user-holds");
301 exit;
306 # Here we check that the borrower can actually make reserves Stage 1.
309 my $noreserves = 0;
310 my $maxoutstanding = C4::Context->preference("maxoutstanding");
311 $template->param( noreserve => 1 ) unless $maxoutstanding;
312 if ( $borr->{'amountoutstanding'} && ($borr->{'amountoutstanding'} > $maxoutstanding) ) {
313 my $amount = sprintf "%.02f", $borr->{'amountoutstanding'};
314 $template->param( message => 1 );
315 $noreserves = 1;
316 $template->param( too_much_oweing => $amount );
318 if ( $borr->{gonenoaddress} && ($borr->{gonenoaddress} == 1) ) {
319 $noreserves = 1;
320 $template->param(
321 message => 1,
322 GNA => 1
325 if ( $borr->{lost} && ($borr->{lost} == 1) ) {
326 $noreserves = 1;
327 $template->param(
328 message => 1,
329 lost => 1
332 if ( IsDebarred($borrowernumber) ) {
333 $noreserves = 1;
334 $template->param(
335 message => 1,
336 debarred => 1
340 my @reserves = GetReservesFromBorrowernumber( $borrowernumber );
341 my $reserves_count = scalar(@reserves);
342 $template->param( RESERVES => \@reserves );
343 if ( $maxreserves && ( $reserves_count >= $maxreserves ) ) {
344 $template->param( message => 1 );
345 $noreserves = 1;
346 $template->param( too_many_reserves => scalar(@reserves));
349 unless ( $noreserves ) {
350 my $requested_reserves_count = scalar( @biblionumbers );
351 if ( $maxreserves && ( $reserves_count + $requested_reserves_count > $maxreserves ) ) {
352 $template->param( new_reserves_allowed => $maxreserves - $reserves_count );
356 foreach my $res (@reserves) {
357 foreach my $biblionumber (@biblionumbers) {
358 if ( $res->{'biblionumber'} == $biblionumber && $res->{'borrowernumber'} == $borrowernumber) {
359 # $template->param( message => 1 );
360 # $noreserves = 1;
361 # $template->param( already_reserved => 1 );
362 $biblioDataHash{$biblionumber}->{already_reserved} = 1;
367 unless ($noreserves) {
368 $template->param( select_item_types => 1 );
374 # Build the template parameters that will show the info
375 # and items for each biblionumber.
378 my $notforloan_label_of = get_notforloan_label_of();
380 my $biblioLoop = [];
381 my $numBibsAvailable = 0;
382 my $itemdata_enumchron = 0;
383 my $anyholdable = 0;
384 my $itemLevelTypes = C4::Context->preference('item-level_itypes');
385 $template->param('item_level_itypes' => $itemLevelTypes);
387 foreach my $biblioNum (@biblionumbers) {
389 my $record = GetMarcBiblio($biblioNum);
390 # Init the bib item with the choices for branch pickup
391 my %biblioLoopIter = ( branchloop => $branchloop );
393 # Get relevant biblio data.
394 my $biblioData = $biblioDataHash{$biblioNum};
395 if (! $biblioData) {
396 $template->param(message=>1, bad_biblionumber=>$biblioNum);
397 &get_out($query, $cookie, $template->output);
400 $biblioLoopIter{biblionumber} = $biblioData->{biblionumber};
401 $biblioLoopIter{title} = $biblioData->{title};
402 $biblioLoopIter{subtitle} = GetRecordValue('subtitle', $record, GetFrameworkCode($biblioData->{biblionumber}));
403 $biblioLoopIter{author} = $biblioData->{author};
404 $biblioLoopIter{rank} = $biblioData->{rank};
405 $biblioLoopIter{reservecount} = $biblioData->{reservecount};
406 $biblioLoopIter{already_reserved} = $biblioData->{already_reserved};
407 $biblioLoopIter{mandatorynotes}=0; #FIXME: For future use
409 if (!$itemLevelTypes && $biblioData->{itemtype}) {
410 $biblioLoopIter{description} = $itemTypes->{$biblioData->{itemtype}}{description};
411 $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$biblioData->{itemtype}}{imageurl};
414 foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
415 if ($itemLevelTypes && $itemInfo->{itype}) {
416 $itemInfo->{description} = $itemTypes->{$itemInfo->{itype}}{description};
417 $itemInfo->{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$itemInfo->{itype}}{imageurl};
420 if (!$itemInfo->{'notforloan'} && !($itemInfo->{'itemnotforloan'} > 0)) {
421 $biblioLoopIter{forloan} = 1;
425 $biblioLoopIter{itemLoop} = [];
426 my $numCopiesAvailable = 0;
427 my $numCopiesOPACAvailable = 0;
428 foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
429 my $itemNum = $itemInfo->{itemnumber};
430 my $itemLoopIter = {};
432 $itemLoopIter->{itemnumber} = $itemNum;
433 $itemLoopIter->{barcode} = $itemInfo->{barcode};
434 $itemLoopIter->{homeBranchName} = $branches->{$itemInfo->{homebranch}}{branchname};
435 $itemLoopIter->{callNumber} = $itemInfo->{itemcallnumber};
436 $itemLoopIter->{enumchron} = $itemInfo->{enumchron};
437 $itemLoopIter->{copynumber} = $itemInfo->{copynumber};
438 if ($itemLevelTypes) {
439 $itemLoopIter->{description} = $itemInfo->{description};
440 $itemLoopIter->{imageurl} = $itemInfo->{imageurl};
443 # If the holdingbranch is different than the homebranch, we show the
444 # holdingbranch of the document too.
445 if ( $itemInfo->{homebranch} ne $itemInfo->{holdingbranch} ) {
446 $itemLoopIter->{holdingBranchName} =
447 $branches->{ $itemInfo->{holdingbranch} }{branchname};
450 # If the item is currently on loan, we display its return date and
451 # change the background color.
452 my $issues= GetItemIssue($itemNum);
453 if ( $issues->{'date_due'} ) {
454 $itemLoopIter->{dateDue} = output_pref({ dt => dt_from_string($issues->{date_due}, 'sql'), as_due_date => 1 });
455 $itemLoopIter->{backgroundcolor} = 'onloan';
458 # checking reserve
459 my ($reservedate,$reservedfor,$expectedAt,undef,$wait) = GetReservesFromItemnumber($itemNum);
460 my $ItemBorrowerReserveInfo = GetMemberDetails( $reservedfor, 0);
462 # the item could be reserved for this borrower vi a host record, flag this
463 $reservedfor //= '';
464 if ($reservedfor eq $borrowernumber){
465 $itemLoopIter->{already_reserved} = 1;
468 if ( defined $reservedate ) {
469 $itemLoopIter->{backgroundcolor} = 'reserved';
470 $itemLoopIter->{reservedate} = format_date($reservedate);
471 $itemLoopIter->{ReservedForBorrowernumber} = $reservedfor;
472 $itemLoopIter->{ReservedForSurname} = $ItemBorrowerReserveInfo->{'surname'};
473 $itemLoopIter->{ReservedForFirstname} = $ItemBorrowerReserveInfo->{'firstname'};
474 $itemLoopIter->{ExpectedAtLibrary} = $expectedAt;
475 #waiting status
476 $itemLoopIter->{waitingdate} = $wait;
479 $itemLoopIter->{notforloan} = $itemInfo->{notforloan};
480 $itemLoopIter->{itemnotforloan} = $itemInfo->{itemnotforloan};
482 # Management of the notforloan document
483 if ( $itemLoopIter->{notforloan} || $itemLoopIter->{itemnotforloan}) {
484 $itemLoopIter->{backgroundcolor} = 'other';
485 $itemLoopIter->{notforloanvalue} =
486 $notforloan_label_of->{ $itemLoopIter->{notforloan} };
489 # Management of lost or long overdue items
490 if ( $itemInfo->{itemlost} ) {
492 # FIXME localized strings should never be in Perl code
493 $itemLoopIter->{message} =
494 $itemInfo->{itemlost} == 1 ? "(lost)"
495 : $itemInfo->{itemlost} == 2 ? "(long overdue)"
496 : "";
497 $itemInfo->{backgroundcolor} = 'other';
500 # Check of the transfered documents
501 my ( $transfertwhen, $transfertfrom, $transfertto ) =
502 GetTransfers($itemNum);
503 if ( $transfertwhen && ($transfertwhen ne '') ) {
504 $itemLoopIter->{transfertwhen} = format_date($transfertwhen);
505 $itemLoopIter->{transfertfrom} =
506 $branches->{$transfertfrom}{branchname};
507 $itemLoopIter->{transfertto} = $branches->{$transfertto}{branchname};
508 $itemLoopIter->{nocancel} = 1;
511 # if the items belongs to a host record, show link to host record
512 if ($itemInfo->{biblionumber} ne $biblioNum){
513 $biblioLoopIter{hostitemsflag} = 1;
514 $itemLoopIter->{hostbiblionumber} = $itemInfo->{biblionumber};
515 $itemLoopIter->{hosttitle} = GetBiblioData($itemInfo->{biblionumber})->{title};
518 # If there is no loan, return and transfer, we show a checkbox.
519 $itemLoopIter->{notforloan} = $itemLoopIter->{notforloan} || 0;
521 my $branch = GetReservesControlBranch( $itemInfo, $borr );
523 my $policy_holdallowed = !$itemLoopIter->{already_reserved};
524 $policy_holdallowed &&=
525 IsAvailableForItemLevelRequest($itemInfo,$borr) &&
526 CanItemBeReserved($borrowernumber,$itemNum) eq 'OK';
528 if ($policy_holdallowed) {
529 if ( my $hold_allowed = OPACItemHoldsAllowed( $itemInfo, $borr ) ) {
530 $itemLoopIter->{available} = 1;
531 $numCopiesOPACAvailable++;
532 $biblioLoopIter{force_hold} = 1 if $hold_allowed eq 'F';
534 $numCopiesAvailable++;
537 $itemLoopIter->{imageurl} = getitemtypeimagelocation( 'opac', $itemTypes->{ $itemInfo->{itype} }{imageurl} );
539 # Show serial enumeration when needed
540 if ($itemLoopIter->{enumchron}) {
541 $itemdata_enumchron = 1;
544 push @{$biblioLoopIter{itemLoop}}, $itemLoopIter;
546 $template->param( itemdata_enumchron => $itemdata_enumchron );
548 if ($numCopiesAvailable > 0) {
549 $numBibsAvailable++;
550 $biblioLoopIter{bib_available} = 1;
551 $biblioLoopIter{holdable} = 1;
552 $biblioLoopIter{itemholdable} = 1 if $numCopiesOPACAvailable;
554 if ($biblioLoopIter{already_reserved}) {
555 $biblioLoopIter{holdable} = undef;
556 $biblioLoopIter{itemholdable} = undef;
558 if(not C4::Context->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron($borrowernumber,$biblioNum)) {
559 $biblioLoopIter{holdable} = undef;
560 $biblioLoopIter{already_patron_possession} = 1;
563 $biblioLoopIter{holdable} &&= CanBookBeReserved($borrowernumber,$biblioNum) eq 'OK';
565 push @$biblioLoop, \%biblioLoopIter;
567 $anyholdable = 1 if $biblioLoopIter{holdable};
570 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
571 $template->param( none_available => 1 );
574 my $show_notes=C4::Context->preference('OpacHoldNotes');
575 $template->param(OpacHoldNotes=>$show_notes);
577 # display infos
578 $template->param(bibitemloop => $biblioLoop);
579 # can set reserve date in future
580 if (
581 C4::Context->preference( 'AllowHoldDateInFuture' ) &&
582 C4::Context->preference( 'OPACAllowHoldDateInFuture' )
584 $template->param(
585 reserve_in_future => 1,
589 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };