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.
36 use Koha::AuthorisedValues;
39 use Koha::CirculationRules;
45 use Date::Calc qw/Today Date_to_Days/;
46 use List::MoreUtils qw/uniq/;
48 my $maxreserves = C4::Context->preference("maxreserves");
52 # if RequestOnOpac (for placing holds) is disabled, leave immediately
53 if ( ! C4::Context->preference('RequestOnOpac') ) {
54 print $query->redirect("/cgi-bin/koha/errors/404.pl");
58 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
60 template_name => "opac-reserve.tt",
67 my ($show_holds_count, $show_priority);
68 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
69 m/holds/o and $show_holds_count = 1;
70 m/priority/ and $show_priority = 1;
73 my $patron = Koha::Patrons->find( $borrowernumber, { prefetch => ['categorycode'] } );
74 my $category = $patron->category;
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 my $categorycode = $patron->categorycode;
81 $can_place_hold_if_available_at_pickup = grep { $_ eq $categorycode } @patron_categories;
85 # check if this user can place a reserve, -1 means use sys pref, 0 means dont block, 1 means block
86 if ( $category->effective_BlockExpiredPatronOpacActions ) {
88 if ( $patron->is_expired ) {
90 # cannot reserve, their card has expired and the rules set mean this is not allowed
91 $template->param( message => 1, expired_patron => 1 );
92 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
97 # Pass through any reserve charge
98 my $reservefee = $category->reservefee;
99 if ( $reservefee > 0){
100 $template->param( RESERVE_CHARGE => $reservefee);
103 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
105 # There are two ways of calling this script, with a single biblio num
106 # or multiple biblio nums.
107 my $biblionumbers = $query->param('biblionumbers');
108 my $reserveMode = $query->param('reserve_mode');
109 if ($reserveMode && ($reserveMode eq 'single')) {
110 my $bib = $query->param('single_bib');
111 $biblionumbers = "$bib/";
113 if (! $biblionumbers) {
114 $biblionumbers = $query->param('biblionumber');
117 if ((! $biblionumbers) && (! $query->param('place_reserve'))) {
118 $template->param(message=>1, no_biblionumber=>1);
119 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
123 # Pass the numbers to the page so they can be fed back
124 # when the hold is confirmed. TODO: Not necessary?
125 $template->param( biblionumbers => $biblionumbers );
127 # Each biblio number is suffixed with '/', e.g. "1/2/3/"
128 my @biblionumbers = split /\//, $biblionumbers;
129 if (($#biblionumbers < 0) && (! $query->param('place_reserve'))) {
131 $template->param(message=>1, no_biblionumber=>1);
132 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
137 # pass the pickup branch along....
138 my $branch = $query->param('branch') || $patron->branchcode || C4::Context->userenv->{branch} || '' ;
139 $template->param( branch => $branch );
143 # Build hashes of the requested biblio(item)s and items.
147 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
148 my %itemInfoHash; # Hash of itemnumber to item info.
149 foreach my $biblioNumber (@biblionumbers) {
151 my $biblioData = GetBiblioData($biblioNumber);
152 $biblioDataHash{$biblioNumber} = $biblioData;
154 my @itemInfos = GetItemsInfo($biblioNumber);
156 my $marcrecord= GetMarcBiblio({ biblionumber => $biblioNumber });
158 # flag indicating existence of at least one item linked via a host record
160 # adding items linked via host biblios
161 my @hostitemInfos = GetHostItemsInfo($marcrecord);
164 push (@itemInfos,@hostitemInfos);
167 $biblioData->{itemInfos} = \@itemInfos;
168 foreach my $itemInfo (@itemInfos) {
169 $itemInfoHash{$itemInfo->{itemnumber}} = $itemInfo;
172 # Compute the priority rank.
173 my $biblio = Koha::Biblios->find( $biblioNumber );
174 $biblioData->{object} = $biblio;
175 my $holds = $biblio->holds;
176 my $rank = $holds->count;
177 $biblioData->{reservecount} = 1; # new reserve
178 while ( my $hold = $holds->next ) {
179 if ( $hold->is_waiting ) {
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 = $patron->holds->count;
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 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
229 my $failed_holds = 0;
230 while (@selectedItems) {
231 my $biblioNum = shift(@selectedItems);
232 my $itemNum = shift(@selectedItems);
233 my $branch = shift(@selectedItems); # i.e., branch code, not name
237 my $singleBranchMode = Koha::Libraries->search->count == 1;
238 if ( $singleBranchMode || ! C4::Context->preference("OPACAllowUserToChooseBranch") )
239 { # single branch mode or disabled user choosing
240 $branch = $patron->branchcode;
243 # When choosing a specific item, the default pickup library should be dictated by the default hold policy
244 if ( ! C4::Context->preference("OPACAllowUserToChooseBranch") && $itemNum ) {
245 my $item = Koha::Items->find( $itemNum );
246 my $type = $item->effective_itemtype;
247 my $rule = GetBranchItemRule( $patron->branchcode, $type );
249 if ( $rule->{hold_fulfillment_policy} eq 'any' || $rule->{hold_fulfillment_policy} eq 'patrongroup' ) {
250 $branch = $patron->branchcode;
251 } elsif ( $rule->{hold_fulfillment_policy} eq 'holdgroup' ){
252 $branch = $item->homebranch;
254 my $policy = $rule->{hold_fulfillment_policy};
255 $branch = $item->$policy;
259 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
260 if ( $itemNum ne '' ) {
261 my $item = Koha::Items->find( $itemNum );
262 my $hostbiblioNum = $item->biblio->biblionumber;
263 if ( $hostbiblioNum ne $biblioNum ) {
264 $biblioNum = $hostbiblioNum;
268 my $biblioData = $biblioDataHash{$biblioNum};
271 # Check for user supplied reserve date
273 if ( C4::Context->preference('AllowHoldDateInFuture')
274 && C4::Context->preference('OPACAllowHoldDateInFuture') )
276 $startdate = $query->param("reserve_date_$biblioNum");
279 my $expiration_date = $query->param("expiration_date_$biblioNum");
281 my $rank = $biblioData->{rank};
282 if ( $itemNum ne '' ) {
283 $canreserve = 1 if CanItemBeReserved( $borrowernumber, $itemNum, $branch )->{status} eq 'OK';
286 $canreserve = 1 if CanBookBeReserved( $borrowernumber, $biblioNum, $branch )->{status} eq 'OK';
288 # Inserts a null into the 'itemnumber' field of 'reserves' table.
291 my $notes = $query->param('notes_'.$biblioNum)||'';
294 && $reserve_cnt >= $maxreserves )
299 unless ( $can_place_hold_if_available_at_pickup ) {
300 my $items_in_this_library = Koha::Items->search({ biblionumber => $biblioNum, holdingbranch => $branch });
301 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
302 my $nb_of_items_unavailable = $items_in_this_library->search({ -or => { lost => { '!=' => 0 }, damaged => { '!=' => 0 }, } });
303 if ( $items_in_this_library->count > $nb_of_items_issued + $nb_of_items_unavailable ) {
308 my $itemtype = $query->param('itemtype') || undef;
309 $itemtype = undef if $itemNum;
311 # Here we actually do the reserveration. Stage 3.
313 my $reserve_id = AddReserve(
315 branchcode => $branch,
316 borrowernumber => $borrowernumber,
317 biblionumber => $biblioNum,
319 reservation_date => $startdate,
320 expiration_date => $expiration_date,
322 title => $biblioData->{title},
323 itemnumber => $itemNum,
325 itemtype => $itemtype,
328 $failed_holds++ unless $reserve_id;
333 print $query->redirect("/cgi-bin/koha/opac-user.pl?" . ( $failed_holds ? "failed_holds=$failed_holds" : q|| ) . "#opac-user-holds");
339 # Here we check that the borrower can actually make reserves Stage 1.
343 my $maxoutstanding = C4::Context->preference("maxoutstanding");
344 $template->param( noreserve => 1 ) unless $maxoutstanding;
345 my $amountoutstanding = $patron->account->balance;
346 if ( $amountoutstanding && ($amountoutstanding > $maxoutstanding) ) {
347 my $amount = sprintf "%.02f", $amountoutstanding;
348 $template->param( message => 1 );
350 $template->param( too_much_oweing => $amount );
353 if ( $patron->gonenoaddress && ($patron->gonenoaddress == 1) ) {
361 if ( $patron->lost && ($patron->lost == 1) ) {
369 if ( $patron->is_debarred ) {
374 debarred_comment => $patron->debarredcomment,
375 debarred_date => $patron->debarred,
379 my $holds = $patron->holds;
380 my $reserves_count = $holds->count;
381 $template->param( RESERVES => $holds->unblessed );
382 if ( $maxreserves && ( $reserves_count >= $maxreserves ) ) {
383 $template->param( message => 1 );
385 $template->param( too_many_reserves => $holds->count );
388 unless ( $noreserves ) {
389 my $requested_reserves_count = scalar( @biblionumbers );
390 if ( $maxreserves && ( $reserves_count + $requested_reserves_count > $maxreserves ) ) {
391 $template->param( new_reserves_allowed => $maxreserves - $reserves_count );
395 unless ($noreserves) {
396 $template->param( select_item_types => 1 );
402 # Build the template parameters that will show the info
403 # and items for each biblionumber.
408 my $numBibsAvailable = 0;
409 my $itemdata_enumchron = 0;
410 my $itemdata_ccode = 0;
412 my $itemLevelTypes = C4::Context->preference('item-level_itypes');
413 my $pickup_locations = Koha::Libraries->search({ pickup_location => 1 });
414 $template->param('item_level_itypes' => $itemLevelTypes);
416 foreach my $biblioNum (@biblionumbers) {
418 # Init the bib item with the choices for branch pickup
421 # Get relevant biblio data.
422 my $biblioData = $biblioDataHash{$biblioNum};
424 $template->param(message=>1, bad_biblionumber=>$biblioNum);
425 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
429 my @not_available_at = ();
430 my $biblio = $biblioData->{object};
431 foreach my $library ( $pickup_locations->as_list ) {
432 push( @not_available_at, $library->branchcode ) unless $biblio->can_be_transferred({ to => $library });
435 my $frameworkcode = GetFrameworkCode( $biblioData->{biblionumber} );
436 $biblioLoopIter{biblionumber} = $biblioData->{biblionumber};
437 $biblioLoopIter{title} = $biblioData->{title};
438 $biblioLoopIter{subtitle} = $biblioData->{'subtitle'};
439 $biblioLoopIter{medium} = $biblioData->{medium};
440 $biblioLoopIter{part_number} = $biblioData->{part_number};
441 $biblioLoopIter{part_name} = $biblioData->{part_name};
442 $biblioLoopIter{author} = $biblioData->{author};
443 $biblioLoopIter{rank} = $biblioData->{rank};
444 $biblioLoopIter{reservecount} = $biblioData->{reservecount};
445 $biblioLoopIter{already_reserved} = $biblioData->{already_reserved};
446 $biblioLoopIter{reqholdnotes}=0; #TODO: For future use
448 if (!$itemLevelTypes && $biblioData->{itemtype}) {
449 $biblioLoopIter{translated_description} = $itemtypes->{$biblioData->{itemtype}}{translated_description};
450 $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemtypes->{$biblioData->{itemtype}}{imageurl};
453 foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
454 if ($itemLevelTypes && $itemInfo->{itype}) {
455 $itemInfo->{translated_description} = $itemtypes->{$itemInfo->{itype}}{translated_description};
456 $itemInfo->{imageurl} = getitemtypeimagesrc() . "/". $itemtypes->{$itemInfo->{itype}}{imageurl};
459 if (!$itemInfo->{'notforloan'} && !($itemInfo->{'itemnotforloan'} > 0)) {
460 $biblioLoopIter{forloan} = 1;
464 my @notforloan_avs = Koha::AuthorisedValues->search_by_koha_field({ kohafield => 'items.notforloan', frameworkcode => $frameworkcode });
465 my $notforloan_label_of = { map { $_->authorised_value => $_->opac_description } @notforloan_avs };
467 my $visible_items = { map { $_->itemnumber => $_ } $biblio->items->filter_by_visible_in_opac( { patron => $patron } )->as_list };
469 # Only keep the items that are visible in the opac (i.e. those in %visible_items)
470 # FIXME: We should get rid of itemInfos altogether and use $visible_items
471 $biblioData->{itemInfos} = [ grep { $visible_items->{ $_->{itemnumber} } } @{ $biblioData->{itemInfos} } ];
473 $biblioLoopIter{itemLoop} = [];
474 my $numCopiesAvailable = 0;
475 my $numCopiesOPACAvailable = 0;
476 foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
477 my $itemNum = $itemInfo->{itemnumber};
478 my $item = $visible_items->{$itemNum};
479 my $itemLoopIter = {};
481 $itemLoopIter->{itemnumber} = $itemNum;
482 $itemLoopIter->{barcode} = $itemInfo->{barcode};
483 $itemLoopIter->{homeBranchName} = $itemInfo->{homebranch};
484 $itemLoopIter->{callNumber} = $itemInfo->{itemcallnumber};
485 $itemLoopIter->{enumchron} = $itemInfo->{enumchron};
486 $itemLoopIter->{ccode} = $itemInfo->{ccode};
487 $itemLoopIter->{copynumber} = $itemInfo->{copynumber};
488 if ($itemLevelTypes) {
489 $itemLoopIter->{translated_description} = $itemInfo->{translated_description};
490 $itemLoopIter->{itype} = $itemInfo->{itype};
491 $itemLoopIter->{imageurl} = $itemInfo->{imageurl};
494 # If the holdingbranch is different than the homebranch, we show the
495 # holdingbranch of the document too.
496 if ( $itemInfo->{homebranch} ne $itemInfo->{holdingbranch} ) {
497 $itemLoopIter->{holdingBranchName} = $itemInfo->{holdingbranch};
500 # If the item is currently on loan, we display its return date and
501 # change the background color.
502 my $issue = Koha::Checkouts->find( { itemnumber => $itemNum } );
504 $itemLoopIter->{dateDue} = output_pref({ dt => dt_from_string($issue->date_due, 'sql'), as_due_date => 1 });
505 $itemLoopIter->{backgroundcolor} = 'onloan';
509 my $holds = $item->current_holds;
511 if ( my $first_hold = $holds->next ) {
512 $itemLoopIter->{backgroundcolor} = 'reserved';
513 $itemLoopIter->{reservedate} = output_pref({ dt => dt_from_string($first_hold->reservedate), dateonly => 1 }); # FIXME Should be formatted in the template
514 $itemLoopIter->{ExpectedAtLibrary} = $first_hold->branchcode;
515 $itemLoopIter->{waitingdate} = $first_hold->waitingdate;
518 $itemLoopIter->{notforloan} = $itemInfo->{notforloan};
519 $itemLoopIter->{itemnotforloan} = $itemInfo->{itemnotforloan};
521 # Management of the notforloan document
522 if ( $itemLoopIter->{notforloan} || $itemLoopIter->{itemnotforloan}) {
523 $itemLoopIter->{backgroundcolor} = 'other';
524 $itemLoopIter->{notforloanvalue} =
525 $notforloan_label_of->{ $itemLoopIter->{notforloan} };
528 # Management of lost or long overdue items
529 if ( $itemInfo->{itemlost} ) {
531 # FIXME localized strings should never be in Perl code
532 $itemLoopIter->{message} =
533 $itemInfo->{itemlost} == 1 ? "(lost)"
534 : $itemInfo->{itemlost} == 2 ? "(long overdue)"
536 $itemInfo->{backgroundcolor} = 'other';
539 # Check of the transferred documents
540 my ( $transfertwhen, $transfertfrom, $transfertto ) =
541 GetTransfers($itemNum);
542 if ( $transfertwhen && ($transfertwhen ne '') ) {
543 $itemLoopIter->{transfertwhen} = output_pref({ dt => dt_from_string($transfertwhen), dateonly => 1 });
544 $itemLoopIter->{transfertfrom} = $transfertfrom;
545 $itemLoopIter->{transfertto} = $transfertto;
546 $itemLoopIter->{nocancel} = 1;
549 # if the items belongs to a host record, show link to host record
550 if ( $itemInfo->{biblionumber} ne $biblioNum ) {
551 $biblioLoopIter{hostitemsflag} = 1;
552 $itemLoopIter->{hostbiblionumber} = $itemInfo->{biblionumber};
553 $itemLoopIter->{hosttitle} = Koha::Biblios->find( $itemInfo->{biblionumber} )->title;
556 # If there is no loan, return and transfer, we show a checkbox.
557 $itemLoopIter->{notforloan} = $itemLoopIter->{notforloan} || 0;
559 my $patron_unblessed = $patron->unblessed;
560 my $branch = GetReservesControlBranch( $itemInfo, $patron_unblessed );
562 my $policy_holdallowed = !$itemLoopIter->{already_reserved};
563 $policy_holdallowed &&=
564 IsAvailableForItemLevelRequest($item, $patron) &&
565 CanItemBeReserved( $borrowernumber, $itemNum )->{status} eq 'OK';
567 if ($policy_holdallowed) {
568 my $opac_hold_policy = Koha::CirculationRules->get_opacitemholds_policy( { item => $item, patron => $patron } );
569 if ( $opac_hold_policy ne 'N' ) { # If Y or F
570 $itemLoopIter->{available} = 1;
571 $numCopiesOPACAvailable++;
572 $biblioLoopIter{force_hold} = 1 if $opac_hold_policy eq 'F';
574 $numCopiesAvailable++;
576 unless ( $can_place_hold_if_available_at_pickup ) {
577 my $items_in_this_library = Koha::Items->search({ biblionumber => $itemInfo->{biblionumber}, holdingbranch => $itemInfo->{holdingbranch} });
578 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
579 if ( $items_in_this_library->count > $nb_of_items_issued ) {
580 push @not_available_at, $itemInfo->{holdingbranch};
585 $itemLoopIter->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes->{ $itemInfo->{itype} }{imageurl} );
587 # Show serial enumeration when needed
588 if ($itemLoopIter->{enumchron}) {
589 $itemdata_enumchron = 1;
591 # Show collection when needed
592 if ($itemLoopIter->{ccode}) {
596 push @{$biblioLoopIter{itemLoop}}, $itemLoopIter;
599 itemdata_enumchron => $itemdata_enumchron,
600 itemdata_ccode => $itemdata_ccode,
603 if ($numCopiesAvailable > 0) {
605 $biblioLoopIter{bib_available} = 1;
606 $biblioLoopIter{holdable} = 1;
607 $biblioLoopIter{itemholdable} = 1 if $numCopiesOPACAvailable;
609 if ($biblioLoopIter{already_reserved}) {
610 $biblioLoopIter{holdable} = undef;
611 $biblioLoopIter{itemholdable} = undef;
613 if ( $biblioLoopIter{holdable} ) {
614 @not_available_at = uniq @not_available_at;
615 $biblioLoopIter{not_available_at} = \@not_available_at ;
618 unless ( $can_place_hold_if_available_at_pickup ) {
619 @not_available_at = uniq @not_available_at;
620 $biblioLoopIter{not_available_at} = \@not_available_at ;
621 # The record is not holdable is not available at any of the libraries
622 if ( Koha::Libraries->search->count == @not_available_at ) {
623 $biblioLoopIter{holdable} = 0;
627 my $status = CanBookBeReserved( $borrowernumber, $biblioNum )->{status};
628 $biblioLoopIter{holdable} &&= $status eq 'OK';
629 $biblioLoopIter{already_patron_possession} = $status eq 'alreadypossession';
631 # For multiple holds per record, if a patron has previously placed a hold,
632 # the patron can only place more holds of the same type. That is, if the
633 # patron placed a record level hold, all the holds the patron places must
634 # be record level. If the patron placed an item level hold, all holds
635 # the patron places must be item level
636 my $forced_hold_level = Koha::Holds->search(
638 borrowernumber => $borrowernumber,
639 biblionumber => $biblioNum,
642 )->forced_hold_level();
643 if ($forced_hold_level) {
644 $biblioLoopIter{force_hold} = 1 if $forced_hold_level eq 'item';
645 $biblioLoopIter{itemholdable} = 0 if $forced_hold_level eq 'record';
646 $biblioLoopIter{forced_hold_level} = $forced_hold_level;
650 push @$biblioLoop, \%biblioLoopIter;
652 $anyholdable = 1 if $biblioLoopIter{holdable};
655 unless ($pickup_locations->count) {
656 $numBibsAvailable = 0;
660 no_pickup_locations => 1
664 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
665 $template->param( none_available => 1 );
668 if (scalar @biblionumbers > 1) {
669 $template->param( multi_hold => 1);
672 my $show_notes=C4::Context->preference('OpacHoldNotes');
673 $template->param(OpacHoldNotes=>$show_notes);
676 $template->param(bibitemloop => $biblioLoop);
677 # can set reserve date in future
679 C4::Context->preference( 'AllowHoldDateInFuture' ) &&
680 C4::Context->preference( 'OPACAllowHoldDateInFuture' )
683 reserve_in_future => 1,
687 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };