4 # Copyright Katipo Communications 2002
5 # Copyright Koha Development team 2012
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 use C4::Auth qw( get_template_and_user );
26 use C4::Koha qw( getitemtypeimagelocation getitemtypeimagesrc );
27 use C4::Circulation qw( GetBranchItemRule GetTransfers );
28 use C4::Reserves qw( CanItemBeReserved CanBookBeReserved AddReserve GetReservesControlBranch ItemsAnyAvailableAndNotRestricted IsAvailableForItemLevelRequest );
29 use C4::Biblio qw( GetBiblioData GetFrameworkCode );
30 use C4::Output qw( output_html_with_http_headers );
35 use Koha::AuthorisedValues;
37 use Koha::CirculationRules;
43 use List::MoreUtils qw( uniq );
45 my $maxreserves = C4::Context->preference("maxreserves");
49 # if OPACHoldRequests (for placing holds) is disabled, leave immediately
50 if ( ! C4::Context->preference('OPACHoldRequests') ) {
51 print $query->redirect("/cgi-bin/koha/errors/404.pl");
55 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
57 template_name => "opac-reserve.tt",
63 my ($show_holds_count, $show_priority);
64 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
65 m/holds/o and $show_holds_count = 1;
66 m/priority/ and $show_priority = 1;
69 my $patron = Koha::Patrons->find( $borrowernumber, { prefetch => ['categorycode'] } );
70 my $category = $patron->category;
72 my $can_place_hold_if_available_at_pickup = C4::Context->preference('OPACHoldsIfAvailableAtPickup');
73 unless ( $can_place_hold_if_available_at_pickup ) {
74 my @patron_categories = split ',', C4::Context->preference('OPACHoldsIfAvailableAtPickupExceptions');
75 if ( @patron_categories ) {
76 my $categorycode = $patron->categorycode;
77 $can_place_hold_if_available_at_pickup = grep { $_ eq $categorycode } @patron_categories;
81 # check if this user can place a reserve, -1 means use sys pref, 0 means dont block, 1 means block
82 if ( $category->effective_BlockExpiredPatronOpacActions ) {
84 if ( $patron->is_expired ) {
86 # cannot reserve, their card has expired and the rules set mean this is not allowed
87 $template->param( message => 1, expired_patron => 1 );
88 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
93 # Pass through any reserve charge
94 my $reservefee = $category->reservefee;
95 if ( $reservefee > 0){
96 $template->param( RESERVE_CHARGE => $reservefee);
99 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
101 # There are two ways of calling this script, with a single biblio num
102 # or multiple biblio nums.
103 my $biblionumbers = $query->param('biblionumbers');
104 my $reserveMode = $query->param('reserve_mode');
105 if ($reserveMode && ($reserveMode eq 'single')) {
106 my $bib = $query->param('single_bib');
107 $biblionumbers = "$bib/";
109 if (! $biblionumbers) {
110 $biblionumbers = $query->param('biblionumber');
113 if ((! $biblionumbers) && (! $query->param('place_reserve'))) {
114 $template->param(message=>1, no_biblionumber=>1);
115 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
119 # Pass the numbers to the page so they can be fed back
120 # when the hold is confirmed. TODO: Not necessary?
121 $template->param( biblionumbers => $biblionumbers );
123 # Each biblio number is suffixed with '/', e.g. "1/2/3/"
124 my @biblionumbers = split /\//, $biblionumbers;
125 if (($#biblionumbers < 0) && (! $query->param('place_reserve'))) {
127 $template->param(message=>1, no_biblionumber=>1);
128 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
133 # pass the pickup branch along....
134 my $branch = $query->param('branch') || $patron->branchcode || C4::Context->userenv->{branch} || '' ;
135 $template->param( branch => $branch );
139 # Build hashes of the requested biblio(item)s and items.
143 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
144 foreach my $biblioNumber (@biblionumbers) {
146 my $biblioData = GetBiblioData($biblioNumber);
147 $biblioDataHash{$biblioNumber} = $biblioData;
149 my $biblio = Koha::Biblios->find( $biblioNumber );
152 my $marcrecord = $biblio->metadata->record;
154 my $items = Koha::Items->search_ordered(
156 biblionumber => $biblioNumber,
159 $biblio->host_items->get_column('itemnumber')
163 { prefetch => [ 'issue', 'homebranch', 'holdingbranch' ] }
164 )->filter_by_visible_in_opac({ patron => $patron });
166 $biblioData->{items} = [$items->as_list]; # FIXME Potentially a lot in memory here!
168 # Compute the priority rank.
169 $biblioData->{object} = $biblio;
170 my $holds = $biblio->holds;
171 my $rank = $holds->count;
172 $biblioData->{reservecount} = 1; # new reserve
173 while ( my $hold = $holds->next ) {
174 if ( $hold->is_waiting ) {
178 $biblioData->{reservecount}++;
181 $biblioData->{rank} = $rank + 1;
186 # If this is the second time through this script, it
187 # means we are carrying out the hold request, possibly
188 # with a specific item for each biblionumber.
191 if ( $query->param('place_reserve') ) {
194 $reserve_cnt = $patron->holds->count;
197 # List is composed of alternating biblio/item/branch
198 my $selectedItems = $query->param('selecteditems');
200 if ($query->param('reserve_mode') eq 'single') {
201 # This indicates non-JavaScript mode, so there was
202 # only a single biblio number selected.
203 my $bib = $query->param('single_bib');
204 my $item = $query->param("checkitem_$bib");
205 if ($item eq 'any') {
208 my $branch = $query->param('branch');
209 $selectedItems = "$bib/$item/$branch/";
212 $selectedItems =~ s!/$!!;
213 my @selectedItems = split /\//, $selectedItems, -1;
215 # Make sure there is a biblionum/itemnum/branch triplet for each item.
216 # The itemnum can be 'any', meaning next available.
217 my $selectionCount = @selectedItems;
218 if (($selectionCount == 0) || (($selectionCount % 3) != 0)) {
219 $template->param(message=>1, bad_data=>1);
220 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
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
232 my $singleBranchMode = Koha::Libraries->search->count == 1;
233 if ( $singleBranchMode || ! C4::Context->preference("OPACAllowUserToChooseBranch") )
234 { # single branch mode or disabled user choosing
235 $branch = $patron->branchcode;
238 # FIXME We shouldn't need to fetch the item here
239 my $item = $itemNum ? Koha::Items->find( $itemNum ) : undef;
240 # When choosing a specific item, the default pickup library should be dictated by the default hold policy
241 if ( ! C4::Context->preference("OPACAllowUserToChooseBranch") && $item ) {
242 my $type = $item->effective_itemtype;
243 my $rule = GetBranchItemRule( $patron->branchcode, $type );
245 if ( $rule->{hold_fulfillment_policy} eq 'any' || $rule->{hold_fulfillment_policy} eq 'patrongroup' ) {
246 $branch = $patron->branchcode;
247 } elsif ( $rule->{hold_fulfillment_policy} eq 'holdgroup' ){
248 $branch = $item->homebranch;
250 my $policy = $rule->{hold_fulfillment_policy};
251 $branch = $item->$policy;
255 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
257 my $hostbiblioNum = $item->biblio->biblionumber;
258 if ( $hostbiblioNum ne $biblioNum ) {
259 $biblioNum = $hostbiblioNum;
263 my $biblioData = $biblioDataHash{$biblioNum};
266 # Check for user supplied reserve date
268 if ( C4::Context->preference('AllowHoldDateInFuture')
269 && C4::Context->preference('OPACAllowHoldDateInFuture') )
271 $startdate = $query->param("reserve_date_$biblioNum");
274 my $patron_expiration_date = $query->param("expiration_date_$biblioNum");
276 my $itemtype = $query->param('itemtype') || undef;
277 $itemtype = undef if $itemNum;
279 my $rank = $biblioData->{rank};
280 my $patron = Koha::Patrons->find( $borrowernumber );
282 $canreserve = 1 if CanItemBeReserved( $patron, $item, $branch )->{status} eq 'OK';
286 if CanBookBeReserved( $borrowernumber, $biblioNum, $branch, { itemtype => $itemtype } )->{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 # Here we actually do the reserveration. Stage 3.
310 my $reserve_id = AddReserve(
312 branchcode => $branch,
313 borrowernumber => $borrowernumber,
314 biblionumber => $biblioNum,
316 reservation_date => $startdate,
317 expiration_date => $patron_expiration_date,
319 title => $biblioData->{title},
320 itemnumber => $itemNum,
322 itemtype => $itemtype,
325 $failed_holds++ unless $reserve_id;
330 print $query->redirect("/cgi-bin/koha/opac-user.pl?" . ( $failed_holds ? "failed_holds=$failed_holds" : q|| ) . "#opac-user-holds");
336 # Here we check that the borrower can actually make reserves Stage 1.
340 my $maxoutstanding = C4::Context->preference("maxoutstanding");
341 $template->param( noreserve => 1 ) unless $maxoutstanding;
342 my $amountoutstanding = $patron->account->balance;
343 if ( $amountoutstanding && ($amountoutstanding > $maxoutstanding) ) {
344 my $amount = sprintf "%.02f", $amountoutstanding;
345 $template->param( message => 1 );
347 $template->param( too_much_oweing => $amount );
350 if ( $patron->gonenoaddress && ($patron->gonenoaddress == 1) ) {
358 if ( $patron->lost && ($patron->lost == 1) ) {
366 if ( $patron->is_debarred ) {
371 debarred_comment => $patron->debarredcomment,
372 debarred_date => $patron->debarred,
376 my $holds = $patron->holds;
377 my $reserves_count = $holds->count;
378 $template->param( RESERVES => $holds->unblessed );
379 if ( $maxreserves && ( $reserves_count >= $maxreserves ) ) {
380 $template->param( message => 1 );
382 $template->param( too_many_reserves => $holds->count );
385 unless ( $noreserves ) {
386 my $requested_reserves_count = scalar( @biblionumbers );
387 if ( $maxreserves && ( $reserves_count + $requested_reserves_count > $maxreserves ) ) {
388 $template->param( new_reserves_allowed => $maxreserves - $reserves_count );
392 unless ($noreserves) {
393 $template->param( select_item_types => 1 );
399 # Build the template parameters that will show the info
400 # and items for each biblionumber.
405 my $numBibsAvailable = 0;
406 my $itemdata_enumchron = 0;
407 my $itemdata_ccode = 0;
409 my $itemLevelTypes = C4::Context->preference('item-level_itypes');
410 my $pickup_locations = Koha::Libraries->search({ pickup_location => 1 });
411 $template->param('item_level_itypes' => $itemLevelTypes);
413 my $patron_unblessed = $patron->unblessed;
414 foreach my $biblioNum (@biblionumbers) {
416 # Init the bib item with the choices for branch pickup
419 # Get relevant biblio data.
420 my $biblioData = $biblioDataHash{$biblioNum};
422 $template->param(message=>1, bad_biblionumber=>$biblioNum);
423 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
427 my @not_available_at = ();
428 my $biblio = $biblioData->{object};
429 foreach my $library ( $pickup_locations->as_list ) {
430 push( @not_available_at, $library->branchcode ) unless $biblio->can_be_transferred({ to => $library });
433 my $frameworkcode = GetFrameworkCode( $biblioData->{biblionumber} );
434 $biblioLoopIter{biblionumber} = $biblioData->{biblionumber};
435 $biblioLoopIter{title} = $biblioData->{title};
436 $biblioLoopIter{subtitle} = $biblioData->{'subtitle'};
437 $biblioLoopIter{medium} = $biblioData->{medium};
438 $biblioLoopIter{part_number} = $biblioData->{part_number};
439 $biblioLoopIter{part_name} = $biblioData->{part_name};
440 $biblioLoopIter{author} = $biblioData->{author};
441 $biblioLoopIter{rank} = $biblioData->{rank};
442 $biblioLoopIter{reservecount} = $biblioData->{reservecount};
443 $biblioLoopIter{already_reserved} = $biblioData->{already_reserved};
444 $biblioLoopIter{reqholdnotes}=0; #TODO: For future use
446 if (!$itemLevelTypes && $biblioData->{itemtype}) {
447 $biblioLoopIter{translated_description} = $itemtypes->{$biblioData->{itemtype}}{translated_description};
448 $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemtypes->{$biblioData->{itemtype}}{imageurl};
453 $biblioLoopIter{itemLoop} = [];
454 my $numCopiesAvailable = 0;
455 my $numCopiesOPACAvailable = 0;
456 # iterating through all items first to check if any of them available
457 # to pass this value further inside down to IsAvailableForItemLevelRequest to
458 # it's complicated logic to analyse.
459 # (before this loop was inside that sub loop so it was O(n^2) )
460 my $items_any_available;
461 $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $biblioNum, patron => $patron }) if $patron;
462 foreach my $item (@{$biblioData->{items}}) {
464 my $item_info = $item->unblessed;
465 $item_info->{holding_branch} = $item->holding_branch;
466 $item_info->{home_branch} = $item->home_branch;
467 if ($itemLevelTypes) {
468 my $itemtype = $item->itemtype;
469 $item_info->{'imageurl'} = getitemtypeimagelocation( 'opac',
470 $itemtypes->{ $itemtype->itemtype }->{'imageurl'} );
471 $item_info->{'translated_description'} =
472 $itemtypes->{ $itemtype->itemtype }->{translated_description};
476 my $holds = $item->current_holds;
477 if ( my $first_hold = $holds->next ) {
478 $item_info->{first_hold} = $first_hold;
481 $item_info->{checkout} = $item->checkout;
483 # Check of the transferred documents
484 my ( $transfertwhen, $transfertfrom, $transfertto ) =
485 GetTransfers($item->itemnumber);
486 if ( $transfertwhen && ($transfertwhen ne '') ) {
487 $item_info->{transfertwhen} = $transfertwhen;
488 $item_info->{transfertfrom} = $transfertfrom;
489 $item_info->{transfertto} = $transfertto;
490 $item_info->{nocancel} = 1;
493 # if the items belongs to a host record, show link to host record
494 if ( $item_info->{biblionumber} ne $biblioNum ) {
495 $item_info->{hostbiblionumber} = $item->biblionumber;
496 $item_info->{hosttitle} = Koha::Biblios->find( $item_info->{biblionumber} )->title;
499 my $branch = GetReservesControlBranch( $item_info, $patron_unblessed );
501 # items_any_available defined outside of the current loop,
502 # so we avoiding loop inside IsAvailableForItemLevelRequest:
503 my $policy_holdallowed =
504 CanItemBeReserved( $patron, $item )->{status} eq 'OK' &&
505 IsAvailableForItemLevelRequest($item, $patron, undef, $items_any_available);
507 if ($policy_holdallowed) {
508 my $opac_hold_policy = Koha::CirculationRules->get_opacitemholds_policy( { item => $item, patron => $patron } );
509 if ( $opac_hold_policy ne 'N' ) { # If Y or F
510 $item_info->{available} = 1;
511 $numCopiesOPACAvailable++;
512 $biblioLoopIter{force_hold} = 1 if $opac_hold_policy eq 'F';
514 $numCopiesAvailable++;
516 unless ( $can_place_hold_if_available_at_pickup ) {
517 my $items_in_this_library = Koha::Items->search({ biblionumber => $item->biblionumber, holdingbranch => $item->holdingbranch });
518 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
519 if ( $items_in_this_library->count > $nb_of_items_issued ) {
520 push @not_available_at, $item->holdingbranch;
525 # Show serial enumeration when needed
526 if ($item_info->{enumchron}) {
527 $itemdata_enumchron = 1;
529 # Show collection when needed
530 if ($item_info->{ccode}) {
534 push @{$biblioLoopIter{itemLoop}}, $item_info;
537 itemdata_enumchron => $itemdata_enumchron,
538 itemdata_ccode => $itemdata_ccode,
541 if ($numCopiesAvailable > 0) {
543 $biblioLoopIter{bib_available} = 1;
544 $biblioLoopIter{holdable} = 1;
545 $biblioLoopIter{itemholdable} = 1 if $numCopiesOPACAvailable;
547 if ($biblioLoopIter{already_reserved}) {
548 $biblioLoopIter{holdable} = undef;
549 $biblioLoopIter{itemholdable} = undef;
551 if ( $biblioLoopIter{holdable} ) {
552 @not_available_at = uniq @not_available_at;
553 $biblioLoopIter{not_available_at} = \@not_available_at ;
556 unless ( $can_place_hold_if_available_at_pickup ) {
557 @not_available_at = uniq @not_available_at;
558 $biblioLoopIter{not_available_at} = \@not_available_at ;
559 # The record is not holdable is not available at any of the libraries
560 if ( Koha::Libraries->search->count == @not_available_at ) {
561 $biblioLoopIter{holdable} = 0;
565 my $status = CanBookBeReserved( $borrowernumber, $biblioNum )->{status};
566 $biblioLoopIter{holdable} &&= $status eq 'OK';
567 $biblioLoopIter{$status} = 1;
569 if ( $biblioLoopIter{holdable} and C4::Context->preference('AllowHoldItemTypeSelection') ) {
570 # build the allowed item types loop
571 my $rs = $biblio->items->search_ordered(
573 { select => [ { distinct => 'itype' } ],
579 grep { CanBookBeReserved( $borrowernumber, $biblioNum, $branch, { itemtype => $_ } )->{status} eq 'OK' }
580 $rs->get_column('item_type');
582 $biblioLoopIter{allowed_item_types} = \@item_types;
585 if ( $status eq 'recall' ) {
586 $biblioLoopIter{recall} = 1;
589 # For multiple holds per record, if a patron has previously placed a hold,
590 # the patron can only place more holds of the same type. That is, if the
591 # patron placed a record level hold, all the holds the patron places must
592 # be record level. If the patron placed an item level hold, all holds
593 # the patron places must be item level
594 my $forced_hold_level = Koha::Holds->search(
596 borrowernumber => $borrowernumber,
597 biblionumber => $biblioNum,
600 )->forced_hold_level();
601 if ($forced_hold_level) {
602 $biblioLoopIter{force_hold} = 1 if $forced_hold_level eq 'item';
603 $biblioLoopIter{itemholdable} = 0 if $forced_hold_level eq 'record';
604 $biblioLoopIter{forced_hold_level} = $forced_hold_level;
608 push @$biblioLoop, \%biblioLoopIter;
610 $anyholdable = 1 if $biblioLoopIter{holdable};
613 unless ($pickup_locations->count) {
614 $numBibsAvailable = 0;
618 no_pickup_locations => 1
622 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
623 $template->param( none_available => 1 );
626 if (scalar @biblionumbers > 1) {
627 $template->param( multi_hold => 1);
630 my $show_notes=C4::Context->preference('OpacHoldNotes');
631 $template->param(OpacHoldNotes=>$show_notes);
634 $template->param(bibitemloop => $biblioLoop);
635 # can set reserve date in future
637 C4::Context->preference( 'AllowHoldDateInFuture' ) &&
638 C4::Context->preference( 'OPACAllowHoldDateInFuture' )
641 reserve_in_future => 1,
645 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };