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>.
24 use C4
::Auth
; # checkauth, getborrowernumber.
38 use Date
::Calc qw
/Today Date_to_Days/;
39 use List
::MoreUtils qw
/uniq/;
41 my $maxreserves = C4
::Context
->preference("maxreserves");
45 # if RequestOnOpac (for placing holds) is disabled, leave immediately
46 if ( ! C4
::Context
->preference('RequestOnOpac') ) {
47 print $query->redirect("/cgi-bin/koha/errors/404.pl");
51 my ( $template, $borrowernumber, $cookie ) = get_template_and_user
(
53 template_name
=> "opac-reserve.tt",
61 my ($show_holds_count, $show_priority);
62 for ( C4
::Context
->preference("OPACShowHoldQueueDetails") ) {
63 m/holds/o and $show_holds_count = 1;
64 m/priority/ and $show_priority = 1;
68 output_html_with_http_headers
(shift,shift,shift); # $query, $cookie, $template->output;
72 # get borrower information ....
73 my ( $borr ) = GetMember
( borrowernumber
=> $borrowernumber );
74 my $patron = Koha
::Patrons
->find( $borrowernumber );
76 my $can_place_hold_if_available_at_pickup = C4
::Context
->preference('OPACHoldsIfAvailableAtPickup');
77 unless ( $can_place_hold_if_available_at_pickup ) {
78 my @patron_categories = split '\|', C4
::Context
->preference('OPACHoldsIfAvailableAtPickupExceptions');
79 if ( @patron_categories ) {
80 $can_place_hold_if_available_at_pickup = grep /$borr->{categorycode}/, @patron_categories;
84 # check if this user can place a reserve, -1 means use sys pref, 0 means dont block, 1 means block
85 if ( $patron->category->effective_BlockExpiredPatronOpacActions ) {
87 if ( $patron->is_expired ) {
89 # cannot reserve, their card has expired and the rules set mean this is not allowed
90 $template->param( message
=> 1, expired_patron
=> 1 );
91 get_out
( $query, $cookie, $template->output );
95 # Pass through any reserve charge
96 my $reservefee = $patron->category->reservefee;
97 if ( $reservefee > 0){
98 $template->param( RESERVE_CHARGE
=> sprintf("%.2f",$reservefee));
101 my $itemTypes = GetItemTypes
();
103 # There are two ways of calling this script, with a single biblio num
104 # or multiple biblio nums.
105 my $biblionumbers = $query->param('biblionumbers');
106 my $reserveMode = $query->param('reserve_mode');
107 if ($reserveMode && ($reserveMode eq 'single')) {
108 my $bib = $query->param('single_bib');
109 $biblionumbers = "$bib/";
111 if (! $biblionumbers) {
112 $biblionumbers = $query->param('biblionumber');
115 if ((! $biblionumbers) && (! $query->param('place_reserve'))) {
116 $template->param(message
=>1, no_biblionumber
=>1);
117 &get_out
($query, $cookie, $template->output);
120 # Pass the numbers to the page so they can be fed back
121 # when the hold is confirmed. TODO: Not necessary?
122 $template->param( biblionumbers
=> $biblionumbers );
124 # Each biblio number is suffixed with '/', e.g. "1/2/3/"
125 my @biblionumbers = split /\//, $biblionumbers;
126 if (($#biblionumbers < 0) && (! $query->param('place_reserve'))) {
128 $template->param(message
=>1, no_biblionumber
=>1);
129 &get_out
($query, $cookie, $template->output);
133 # pass the pickup branch along....
134 my $branch = $query->param('branch') || $borr->{'branchcode'} || C4
::Context
->userenv->{branch
} || '' ;
135 $template->param( branch
=> $branch );
137 # Is the person allowed to choose their branch
138 my $OPACChooseBranch = (C4
::Context
->preference("OPACAllowUserToChooseBranch")) ?
1 : 0;
140 $template->param( choose_branch
=> $OPACChooseBranch);
144 # Build hashes of the requested biblio(item)s and items.
148 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
149 my %itemInfoHash; # Hash of itemnumber to item info.
150 foreach my $biblioNumber (@biblionumbers) {
152 my $biblioData = GetBiblioData
($biblioNumber);
153 $biblioDataHash{$biblioNumber} = $biblioData;
155 my @itemInfos = GetItemsInfo
($biblioNumber);
157 my $marcrecord= GetMarcBiblio
($biblioNumber);
159 # flag indicating existence of at least one item linked via a host record
161 # adding items linked via host biblios
162 my @hostitemInfos = GetHostItemsInfo
($marcrecord);
165 push (@itemInfos,@hostitemInfos);
168 $biblioData->{itemInfos
} = \
@itemInfos;
169 foreach my $itemInfo (@itemInfos) {
170 $itemInfoHash{$itemInfo->{itemnumber
}} = $itemInfo;
173 # Compute the priority rank.
174 my $reserves = GetReservesFromBiblionumber
({ biblionumber
=> $biblioNumber, all_dates
=> 1 });
175 my $rank = scalar( @
$reserves );
176 $biblioData->{reservecount
} = 1; # new reserve
177 foreach my $res (@
{$reserves}) {
178 my $found = $res->{found
};
179 if ( $found && $found eq 'W' ) {
183 $biblioData->{reservecount
}++;
186 $biblioData->{rank
} = $rank + 1;
191 # If this is the second time through this script, it
192 # means we are carrying out the hold request, possibly
193 # with a specific item for each biblionumber.
196 if ( $query->param('place_reserve') ) {
199 $reserve_cnt = GetReservesFromBorrowernumber
( $borrowernumber );
202 # List is composed of alternating biblio/item/branch
203 my $selectedItems = $query->param('selecteditems');
205 if ($query->param('reserve_mode') eq 'single') {
206 # This indicates non-JavaScript mode, so there was
207 # only a single biblio number selected.
208 my $bib = $query->param('single_bib');
209 my $item = $query->param("checkitem_$bib");
210 if ($item eq 'any') {
213 my $branch = $query->param('branch');
214 $selectedItems = "$bib/$item/$branch/";
217 $selectedItems =~ s!/$!!;
218 my @selectedItems = split /\//, $selectedItems, -1;
220 # Make sure there is a biblionum/itemnum/branch triplet for each item.
221 # The itemnum can be 'any', meaning next available.
222 my $selectionCount = @selectedItems;
223 if (($selectionCount == 0) || (($selectionCount % 3) != 0)) {
224 $template->param(message
=>1, bad_data
=>1);
225 &get_out
($query, $cookie, $template->output);
228 my $failed_holds = 0;
229 while (@selectedItems) {
230 my $biblioNum = shift(@selectedItems);
231 my $itemNum = shift(@selectedItems);
232 my $branch = shift(@selectedItems); # i.e., branch code, not name
236 my $singleBranchMode = Koha
::Libraries
->search->count == 1;
237 if ( $singleBranchMode || !$OPACChooseBranch )
238 { # single branch mode or disabled user choosing
239 $branch = $borr->{'branchcode'};
242 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
243 if ( $itemNum ne '' ) {
244 my $hostbiblioNum = GetBiblionumberFromItemnumber
($itemNum);
245 if ( $hostbiblioNum ne $biblioNum ) {
246 $biblioNum = $hostbiblioNum;
250 my $biblioData = $biblioDataHash{$biblioNum};
253 # Check for user supplied reserve date
255 if ( C4
::Context
->preference('AllowHoldDateInFuture')
256 && C4
::Context
->preference('OPACAllowHoldDateInFuture') )
258 $startdate = $query->param("reserve_date_$biblioNum");
261 my $expiration_date = $query->param("expiration_date_$biblioNum");
263 # If a specific item was selected and the pickup branch is the same as the
264 # holdingbranch, force the value $rank and $found.
265 my $rank = $biblioData->{rank
};
266 if ( $itemNum ne '' ) {
267 $canreserve = 1 if CanItemBeReserved
( $borrowernumber, $itemNum ) eq 'OK';
268 $rank = '0' unless C4
::Context
->preference('ReservesNeedReturns');
269 my $item = GetItem
($itemNum);
270 if ( $item->{'holdingbranch'} eq $branch ) {
272 unless C4
::Context
->preference('ReservesNeedReturns');
276 $canreserve = 1 if CanBookBeReserved
( $borrowernumber, $biblioNum ) eq 'OK';
278 # Inserts a null into the 'itemnumber' field of 'reserves' table.
281 my $notes = $query->param('notes_'.$biblioNum)||'';
284 && $reserve_cnt >= $maxreserves )
289 unless ( $can_place_hold_if_available_at_pickup ) {
290 my $items_in_this_library = Koha
::Items
->search({ biblionumber
=> $biblioNum, holdingbranch
=> $branch });
291 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
292 my $nb_of_items_unavailable = $items_in_this_library->search({ -or => { lost
=> { '!=' => 0 }, damaged
=> { '!=' => 0 }, } });
293 if ( $items_in_this_library->count > $nb_of_items_issued + $nb_of_items_unavailable ) {
298 my $itemtype = $query->param('itemtype') || undef;
299 $itemtype = undef if $itemNum;
301 # Here we actually do the reserveration. Stage 3.
303 my $reserve_id = AddReserve
(
304 $branch, $borrowernumber, $biblioNum,
305 [$biblioNum], $rank, $startdate,
306 $expiration_date, $notes, $biblioData->{title
},
307 $itemNum, $found, $itemtype,
309 $failed_holds++ unless $reserve_id;
314 print $query->redirect("/cgi-bin/koha/opac-user.pl?" . ( $failed_holds ?
"failed_holds=$failed_holds" : q
|| ) . "#opac-user-holds");
320 # Here we check that the borrower can actually make reserves Stage 1.
324 my $maxoutstanding = C4
::Context
->preference("maxoutstanding");
325 $template->param( noreserve
=> 1 ) unless $maxoutstanding;
326 my ( $amountoutstanding ) = GetMemberAccountRecords
($borrowernumber);
327 if ( $amountoutstanding && ($amountoutstanding > $maxoutstanding) ) {
328 my $amount = sprintf "%.02f", $amountoutstanding;
329 $template->param( message
=> 1 );
331 $template->param( too_much_oweing
=> $amount );
334 if ( $borr->{gonenoaddress
} && ($borr->{gonenoaddress
} == 1) ) {
342 if ( $borr->{lost
} && ($borr->{lost
} == 1) ) {
350 if ( Koha
::Patrons
->find( $borrowernumber )->is_debarred ) {
355 debarred_comment
=> $borr->{debarredcomment
},
356 debarred_date
=> $borr->{debarred
},
360 my @reserves = GetReservesFromBorrowernumber
( $borrowernumber );
361 my $reserves_count = scalar(@reserves);
362 $template->param( RESERVES
=> \
@reserves );
363 if ( $maxreserves && ( $reserves_count >= $maxreserves ) ) {
364 $template->param( message
=> 1 );
366 $template->param( too_many_reserves
=> scalar(@reserves));
369 unless ( $noreserves ) {
370 my $requested_reserves_count = scalar( @biblionumbers );
371 if ( $maxreserves && ( $reserves_count + $requested_reserves_count > $maxreserves ) ) {
372 $template->param( new_reserves_allowed
=> $maxreserves - $reserves_count );
376 unless ($noreserves) {
377 $template->param( select_item_types
=> 1 );
383 # Build the template parameters that will show the info
384 # and items for each biblionumber.
387 my $notforloan_label_of = get_notforloan_label_of
();
390 my $numBibsAvailable = 0;
391 my $itemdata_enumchron = 0;
393 my $itemLevelTypes = C4
::Context
->preference('item-level_itypes');
394 $template->param('item_level_itypes' => $itemLevelTypes);
396 foreach my $biblioNum (@biblionumbers) {
398 my @not_available_at = ();
399 my $record = GetMarcBiblio
($biblioNum);
400 # Init the bib item with the choices for branch pickup
403 # Get relevant biblio data.
404 my $biblioData = $biblioDataHash{$biblioNum};
406 $template->param(message
=>1, bad_biblionumber
=>$biblioNum);
407 &get_out
($query, $cookie, $template->output);
410 $biblioLoopIter{biblionumber
} = $biblioData->{biblionumber
};
411 $biblioLoopIter{title
} = $biblioData->{title
};
412 $biblioLoopIter{subtitle
} = GetRecordValue
('subtitle', $record, GetFrameworkCode
($biblioData->{biblionumber
}));
413 $biblioLoopIter{author
} = $biblioData->{author
};
414 $biblioLoopIter{rank
} = $biblioData->{rank
};
415 $biblioLoopIter{reservecount
} = $biblioData->{reservecount
};
416 $biblioLoopIter{already_reserved
} = $biblioData->{already_reserved
};
417 $biblioLoopIter{reqholdnotes
}=0; #TODO: For future use
419 if (!$itemLevelTypes && $biblioData->{itemtype
}) {
420 $biblioLoopIter{translated_description
} = $itemTypes->{$biblioData->{itemtype
}}{translated_description
};
421 $biblioLoopIter{imageurl
} = getitemtypeimagesrc
() . "/". $itemTypes->{$biblioData->{itemtype
}}{imageurl
};
424 foreach my $itemInfo (@
{$biblioData->{itemInfos
}}) {
425 if ($itemLevelTypes && $itemInfo->{itype
}) {
426 $itemInfo->{translated_description
} = $itemTypes->{$itemInfo->{itype
}}{translated_description
};
427 $itemInfo->{imageurl
} = getitemtypeimagesrc
() . "/". $itemTypes->{$itemInfo->{itype
}}{imageurl
};
430 if (!$itemInfo->{'notforloan'} && !($itemInfo->{'itemnotforloan'} > 0)) {
431 $biblioLoopIter{forloan
} = 1;
435 $biblioLoopIter{itemLoop
} = [];
436 my $numCopiesAvailable = 0;
437 my $numCopiesOPACAvailable = 0;
438 foreach my $itemInfo (@
{$biblioData->{itemInfos
}}) {
439 my $itemNum = $itemInfo->{itemnumber
};
440 my $itemLoopIter = {};
442 $itemLoopIter->{itemnumber
} = $itemNum;
443 $itemLoopIter->{barcode
} = $itemInfo->{barcode
};
444 $itemLoopIter->{homeBranchName
} = $itemInfo->{homebranch
};
445 $itemLoopIter->{callNumber
} = $itemInfo->{itemcallnumber
};
446 $itemLoopIter->{enumchron
} = $itemInfo->{enumchron
};
447 $itemLoopIter->{copynumber
} = $itemInfo->{copynumber
};
448 if ($itemLevelTypes) {
449 $itemLoopIter->{translated_description
} = $itemInfo->{translated_description
};
450 $itemLoopIter->{itype
} = $itemInfo->{itype
};
451 $itemLoopIter->{imageurl
} = $itemInfo->{imageurl
};
454 # If the holdingbranch is different than the homebranch, we show the
455 # holdingbranch of the document too.
456 if ( $itemInfo->{homebranch
} ne $itemInfo->{holdingbranch
} ) {
457 $itemLoopIter->{holdingBranchName
} = $itemInfo->{holdingbranch
};
460 # If the item is currently on loan, we display its return date and
461 # change the background color.
462 my $issues= GetItemIssue
($itemNum);
463 if ( $issues->{'date_due'} ) {
464 $itemLoopIter->{dateDue
} = output_pref
({ dt
=> dt_from_string
($issues->{date_due
}, 'sql'), as_due_date
=> 1 });
465 $itemLoopIter->{backgroundcolor
} = 'onloan';
469 my ($reservedate,$reservedfor,$expectedAt,undef,$wait) = GetReservesFromItemnumber
($itemNum);
470 my $ItemBorrowerReserveInfo = GetMember
( borrowernumber
=> $reservedfor );
472 # the item could be reserved for this borrower vi a host record, flag this
475 if ( defined $reservedate ) {
476 $itemLoopIter->{backgroundcolor
} = 'reserved';
477 $itemLoopIter->{reservedate
} = output_pref
({ dt
=> dt_from_string
($reservedate), dateonly
=> 1 });
478 $itemLoopIter->{ReservedForBorrowernumber
} = $reservedfor;
479 $itemLoopIter->{ReservedForSurname
} = $ItemBorrowerReserveInfo->{'surname'};
480 $itemLoopIter->{ReservedForFirstname
} = $ItemBorrowerReserveInfo->{'firstname'};
481 $itemLoopIter->{ExpectedAtLibrary
} = $expectedAt;
483 $itemLoopIter->{waitingdate
} = $wait;
486 $itemLoopIter->{notforloan
} = $itemInfo->{notforloan
};
487 $itemLoopIter->{itemnotforloan
} = $itemInfo->{itemnotforloan
};
489 # Management of the notforloan document
490 if ( $itemLoopIter->{notforloan
} || $itemLoopIter->{itemnotforloan
}) {
491 $itemLoopIter->{backgroundcolor
} = 'other';
492 $itemLoopIter->{notforloanvalue
} =
493 $notforloan_label_of->{ $itemLoopIter->{notforloan
} };
496 # Management of lost or long overdue items
497 if ( $itemInfo->{itemlost
} ) {
499 # FIXME localized strings should never be in Perl code
500 $itemLoopIter->{message
} =
501 $itemInfo->{itemlost
} == 1 ?
"(lost)"
502 : $itemInfo->{itemlost
} == 2 ?
"(long overdue)"
504 $itemInfo->{backgroundcolor
} = 'other';
507 # Check of the transfered documents
508 my ( $transfertwhen, $transfertfrom, $transfertto ) =
509 GetTransfers
($itemNum);
510 if ( $transfertwhen && ($transfertwhen ne '') ) {
511 $itemLoopIter->{transfertwhen
} = output_pref
({ dt
=> dt_from_string
($transfertwhen), dateonly
=> 1 });
512 $itemLoopIter->{transfertfrom
} = $transfertfrom;
513 $itemLoopIter->{transfertto
} = $transfertto;
514 $itemLoopIter->{nocancel
} = 1;
517 # if the items belongs to a host record, show link to host record
518 if ( $itemInfo->{biblionumber
} ne $biblioNum ) {
519 $biblioLoopIter{hostitemsflag
} = 1;
520 $itemLoopIter->{hostbiblionumber
} = $itemInfo->{biblionumber
};
521 $itemLoopIter->{hosttitle
} = GetBiblioData
( $itemInfo->{biblionumber
} )->{title
};
524 # If there is no loan, return and transfer, we show a checkbox.
525 $itemLoopIter->{notforloan
} = $itemLoopIter->{notforloan
} || 0;
527 my $branch = GetReservesControlBranch
( $itemInfo, $borr );
529 my $policy_holdallowed = !$itemLoopIter->{already_reserved
};
530 $policy_holdallowed &&=
531 IsAvailableForItemLevelRequest
($itemInfo,$borr) &&
532 CanItemBeReserved
($borrowernumber,$itemNum) eq 'OK';
534 if ($policy_holdallowed) {
535 if ( my $hold_allowed = OPACItemHoldsAllowed
( $itemInfo, $borr ) ) {
536 $itemLoopIter->{available
} = 1;
537 $numCopiesOPACAvailable++;
538 $biblioLoopIter{force_hold
} = 1 if $hold_allowed eq 'F';
540 $numCopiesAvailable++;
542 unless ( $can_place_hold_if_available_at_pickup ) {
543 my $items_in_this_library = Koha
::Items
->search({ biblionumber
=> $itemInfo->{biblionumber
}, holdingbranch
=> $itemInfo->{holdingbranch
} });
544 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
545 if ( $items_in_this_library->count > $nb_of_items_issued ) {
546 push @not_available_at, $itemInfo->{holdingbranch
};
551 $itemLoopIter->{imageurl
} = getitemtypeimagelocation
( 'opac', $itemTypes->{ $itemInfo->{itype
} }{imageurl
} );
553 # Show serial enumeration when needed
554 if ($itemLoopIter->{enumchron
}) {
555 $itemdata_enumchron = 1;
558 push @
{$biblioLoopIter{itemLoop
}}, $itemLoopIter;
560 $template->param( itemdata_enumchron
=> $itemdata_enumchron );
562 if ($numCopiesAvailable > 0) {
564 $biblioLoopIter{bib_available
} = 1;
565 $biblioLoopIter{holdable
} = 1;
566 $biblioLoopIter{itemholdable
} = 1 if $numCopiesOPACAvailable;
568 if ($biblioLoopIter{already_reserved
}) {
569 $biblioLoopIter{holdable
} = undef;
570 $biblioLoopIter{itemholdable
} = undef;
572 if(not C4
::Context
->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron
($borrowernumber,$biblioNum)) {
573 $biblioLoopIter{holdable
} = undef;
574 $biblioLoopIter{already_patron_possession
} = 1;
577 if ( $biblioLoopIter{holdable
} ) {
578 @not_available_at = uniq
@not_available_at;
579 $biblioLoopIter{not_available_at
} = \
@not_available_at ;
582 unless ( $can_place_hold_if_available_at_pickup ) {
583 @not_available_at = uniq
@not_available_at;
584 $biblioLoopIter{not_available_at
} = \
@not_available_at ;
585 # The record is not holdable is not available at any of the libraries
586 if ( Koha
::Libraries
->search->count == @not_available_at ) {
587 $biblioLoopIter{holdable
} = 0;
591 $biblioLoopIter{holdable
} &&= CanBookBeReserved
($borrowernumber,$biblioNum) eq 'OK';
593 # For multiple holds per record, if a patron has previously placed a hold,
594 # the patron can only place more holds of the same type. That is, if the
595 # patron placed a record level hold, all the holds the patron places must
596 # be record level. If the patron placed an item level hold, all holds
597 # the patron places must be item level
598 my $forced_hold_level = Koha
::Holds
->search(
600 borrowernumber
=> $borrowernumber,
601 biblionumber
=> $biblioNum,
604 )->forced_hold_level();
605 if ($forced_hold_level) {
606 $biblioLoopIter{force_hold
} = 1 if $forced_hold_level eq 'item';
607 $biblioLoopIter{itemholdable
} = 0 if $forced_hold_level eq 'record';
611 push @
$biblioLoop, \
%biblioLoopIter;
613 $anyholdable = 1 if $biblioLoopIter{holdable
};
617 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
618 $template->param( none_available
=> 1 );
621 my $show_notes=C4
::Context
->preference('OpacHoldNotes');
622 $template->param(OpacHoldNotes
=>$show_notes);
625 $template->param(bibitemloop
=> $biblioLoop);
626 # can set reserve date in future
628 C4
::Context
->preference( 'AllowHoldDateInFuture' ) &&
629 C4
::Context
->preference( 'OPACAllowHoldDateInFuture' )
632 reserve_in_future
=> 1,
636 output_html_with_http_headers
$query, $cookie, $template->output, undef, { force_no_caching
=> 1 };