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 );
28 use C4::Reserves qw( CanItemBeReserved CanBookBeReserved AddReserve GetReservesControlBranch ItemsAnyAvailableAndNotRestricted IsAvailableForItemLevelRequest GetReserveFee );
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 $patron = Koha::Patrons->find( $borrowernumber, { prefetch => ['categorycode'] } );
64 my $category = $patron->category;
66 my $can_place_hold_if_available_at_pickup = C4::Context->preference('OPACHoldsIfAvailableAtPickup');
67 unless ( $can_place_hold_if_available_at_pickup ) {
68 my @patron_categories = split ',', C4::Context->preference('OPACHoldsIfAvailableAtPickupExceptions');
69 if ( @patron_categories ) {
70 my $categorycode = $patron->categorycode;
71 $can_place_hold_if_available_at_pickup = grep { $_ eq $categorycode } @patron_categories;
75 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
77 # There are two ways of calling this script, with a single biblio num
78 # or multiple biblio nums.
79 my $biblionumbers = $query->param('biblionumbers');
80 my $reserveMode = $query->param('reserve_mode');
81 if ($reserveMode && ($reserveMode eq 'single')) {
82 my $bib = $query->param('single_bib');
83 $biblionumbers = "$bib/";
85 if (! $biblionumbers) {
86 $biblionumbers = $query->param('biblionumber');
89 if ((! $biblionumbers) && (! $query->param('place_reserve'))) {
90 $template->param(message=>1, no_biblionumber=>1);
91 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
95 # Pass the numbers to the page so they can be fed back
96 # when the hold is confirmed. TODO: Not necessary?
97 $template->param( biblionumbers => $biblionumbers );
99 # Each biblio number is suffixed with '/', e.g. "1/2/3/"
100 my @biblionumbers = split /\//, $biblionumbers;
101 if (($#biblionumbers < 0) && (! $query->param('place_reserve'))) {
103 $template->param(message=>1, no_biblionumber=>1);
104 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
110 # Here we check that the borrower can actually make reserves Stage 1.
114 if ( $category->effective_BlockExpiredPatronOpacActions ) {
115 if ( $patron->is_expired ) {
116 # cannot reserve, their card has expired and the rules set mean this is not allowed
118 $template->param( message => 1, expired_patron => 1 );
122 my $maxoutstanding = C4::Context->preference("maxoutstanding");
123 my $amountoutstanding = $patron->account->balance;
124 if ( $amountoutstanding && ($amountoutstanding > $maxoutstanding) ) {
125 my $amount = sprintf "%.02f", $amountoutstanding;
126 $template->param( message => 1 );
128 $template->param( too_much_oweing => $amount );
131 if ( $patron->gonenoaddress && ($patron->gonenoaddress == 1) ) {
139 if ( $patron->lost && ($patron->lost == 1) ) {
147 if ( $patron->is_debarred ) {
152 debarred_comment => $patron->debarredcomment,
153 debarred_date => $patron->debarred,
157 my $holds = $patron->holds;
158 my $reserves_count = $holds->count;
159 $template->param( RESERVES => $holds->unblessed );
160 if ( $maxreserves && ( $reserves_count >= $maxreserves ) ) {
161 $template->param( message => 1 );
163 $template->param( too_many_reserves => $holds->count );
167 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
172 # pass the pickup branch along....
173 my $branch = $query->param('branch') || $patron->branchcode || C4::Context->userenv->{branch} || '' ;
174 $template->param( branch => $branch );
178 # Here we are carrying out the hold request, possibly
179 # with a specific item for each biblionumber.
182 if ( $query->param('place_reserve') ) {
185 $reserve_cnt = $patron->holds->count;
188 # List is composed of alternating biblio/item/branch
189 my $selectedItems = $query->param('selecteditems');
191 if ($query->param('reserve_mode') eq 'single') {
192 # This indicates non-JavaScript mode, so there was
193 # only a single biblio number selected.
194 my $bib = $query->param('single_bib');
195 my $item = $query->param("checkitem_$bib");
196 if ($item eq 'any') {
199 my $branch = $query->param('branch');
200 $selectedItems = "$bib/$item/$branch/";
203 $selectedItems =~ s!/$!!;
204 my @selectedItems = split /\//, $selectedItems, -1;
206 # Make sure there is a biblionum/itemnum/branch triplet for each item.
207 # The itemnum can be 'any', meaning next available.
208 my $selectionCount = @selectedItems;
209 if (($selectionCount == 0) || (($selectionCount % 3) != 0)) {
210 $template->param(message=>1, bad_data=>1);
211 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
215 my $failed_holds = 0;
216 while (@selectedItems) {
217 my $biblioNum = shift(@selectedItems);
218 my $itemNum = shift(@selectedItems);
219 my $branch = shift(@selectedItems); # i.e., branch code, not name
223 my $singleBranchMode = Koha::Libraries->search->count == 1;
224 if ( $singleBranchMode || ! C4::Context->preference("OPACAllowUserToChooseBranch") )
225 { # single branch mode or disabled user choosing
226 $branch = $patron->branchcode;
229 # FIXME We shouldn't need to fetch the item here
230 my $item = $itemNum ? Koha::Items->find( $itemNum ) : undef;
231 # When choosing a specific item, the default pickup library should be dictated by the default hold policy
232 if ( ! C4::Context->preference("OPACAllowUserToChooseBranch") && $item ) {
233 my $type = $item->effective_itemtype;
234 my $rule = GetBranchItemRule( $patron->branchcode, $type );
236 if ( $rule->{hold_fulfillment_policy} eq 'any' || $rule->{hold_fulfillment_policy} eq 'patrongroup' ) {
237 $branch = $patron->branchcode;
238 } elsif ( $rule->{hold_fulfillment_policy} eq 'holdgroup' ){
239 $branch = $item->homebranch;
241 my $policy = $rule->{hold_fulfillment_policy};
242 $branch = $item->$policy;
246 # if we have an item, we are placing the hold on the item's bib, in case of analytics
248 $biblioNum = $item->biblionumber;
251 # Check for user supplied reserve date
253 if ( C4::Context->preference('AllowHoldDateInFuture')
254 && C4::Context->preference('OPACAllowHoldDateInFuture') )
256 $startdate = $query->param("reserve_date_$biblioNum");
259 my $patron_expiration_date = $query->param("expiration_date_$biblioNum");
261 my $itemtype = $query->param('itemtype') || undef;
262 $itemtype = undef if $itemNum;
264 my $biblio = Koha::Biblios->find($biblioNum);
265 my $rank = $biblio->holds->search( { found => [ { "!=" => "W" }, undef ] } )->count + 1;
267 $canreserve = 1 if CanItemBeReserved( $patron, $item, $branch )->{status} eq 'OK';
271 if CanBookBeReserved( $borrowernumber, $biblioNum, $branch, { itemtype => $itemtype } )->{status} eq 'OK';
273 # Inserts a null into the 'itemnumber' field of 'reserves' table.
276 my $notes = $query->param('notes_'.$biblioNum)||'';
277 my $item_group_id = $query->param("item_group_id_$biblioNum") || undef;
280 && $reserve_cnt >= $maxreserves )
285 unless ( $can_place_hold_if_available_at_pickup ) {
286 my $items_in_this_library = Koha::Items->search({ biblionumber => $biblioNum, holdingbranch => $branch });
287 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
288 my $nb_of_items_unavailable = $items_in_this_library->search({ -or => { lost => { '!=' => 0 }, damaged => { '!=' => 0 }, } });
289 if ( $items_in_this_library->count > $nb_of_items_issued + $nb_of_items_unavailable ) {
294 # Here we actually do the reserveration. Stage 3.
296 my $reserve_id = AddReserve(
298 branchcode => $branch,
299 borrowernumber => $borrowernumber,
300 biblionumber => $biblioNum,
302 reservation_date => $startdate,
303 expiration_date => $patron_expiration_date,
305 title => $biblio->title,
306 itemnumber => $itemNum,
308 itemtype => $itemtype,
309 item_group_id => $item_group_id,
312 $failed_holds++ unless $reserve_id;
317 print $query->redirect("/cgi-bin/koha/opac-user.pl?" . ( $failed_holds ? "failed_holds=$failed_holds" : q|| ) . "#opac-user-holds");
323 # Build hashes of the requested biblio(item)s and items.
327 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
328 foreach my $biblioNumber (@biblionumbers) {
330 my $biblioData = GetBiblioData($biblioNumber);
331 $biblioDataHash{$biblioNumber} = $biblioData;
333 my $biblio = Koha::Biblios->find( $biblioNumber );
336 my $items = Koha::Items->search_ordered(
338 biblionumber => $biblioNumber,
341 $biblio->host_items->get_column('itemnumber')
345 { prefetch => [ 'issue', 'homebranch', 'holdingbranch' ] }
346 )->filter_by_visible_in_opac({ patron => $patron });
348 $biblioData->{items} = [$items->as_list]; # FIXME Potentially a lot in memory here!
350 # Compute the priority rank.
351 $biblioData->{object} = $biblio;
352 my $reservecount = $biblio->holds->search({ found => [ {"!=" => "W"},undef] })->count;
353 $biblioData->{reservecount} = $reservecount;
354 $biblioData->{rank} = $reservecount + 1;
358 my $requested_reserves_count = scalar( @biblionumbers );
359 if ( $maxreserves && ( $reserves_count + $requested_reserves_count > $maxreserves ) ) {
360 $template->param( new_reserves_allowed => $maxreserves - $reserves_count );
363 $template->param( select_item_types => 1 );
368 # Build the template parameters that will show the info
369 # and items for each biblionumber.
374 my $numBibsAvailable = 0;
375 my $itemdata_enumchron = 0;
376 my $itemdata_ccode = 0;
378 my $itemLevelTypes = C4::Context->preference('item-level_itypes');
379 my $pickup_locations = Koha::Libraries->search({ pickup_location => 1 });
380 $template->param('item_level_itypes' => $itemLevelTypes);
382 my $patron_unblessed = $patron->unblessed;
383 foreach my $biblioNum (@biblionumbers) {
385 # Init the bib item with the choices for branch pickup
388 # Get relevant biblio data.
389 my $biblioData = $biblioDataHash{$biblioNum};
391 $template->param(message=>1, bad_biblionumber=>$biblioNum);
392 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
396 my @not_available_at = ();
397 my $biblio = $biblioData->{object};
398 foreach my $library ( $pickup_locations->as_list ) {
399 push( @not_available_at, $library->branchcode ) unless $biblio->can_be_transferred({ to => $library });
402 my $frameworkcode = GetFrameworkCode( $biblioData->{biblionumber} );
403 $biblioLoopIter{biblionumber} = $biblioData->{biblionumber};
404 $biblioLoopIter{title} = $biblioData->{title};
405 $biblioLoopIter{subtitle} = $biblioData->{'subtitle'};
406 $biblioLoopIter{medium} = $biblioData->{medium};
407 $biblioLoopIter{part_number} = $biblioData->{part_number};
408 $biblioLoopIter{part_name} = $biblioData->{part_name};
409 $biblioLoopIter{author} = $biblioData->{author};
410 $biblioLoopIter{rank} = $biblioData->{rank};
411 $biblioLoopIter{reservecount} = $biblioData->{reservecount};
412 $biblioLoopIter{already_reserved} = $biblioData->{already_reserved};
413 $biblioLoopIter{object} = $biblio;
415 if (!$itemLevelTypes && $biblioData->{itemtype}) {
416 $biblioLoopIter{translated_description} = $itemtypes->{$biblioData->{itemtype}}{translated_description};
417 $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemtypes->{$biblioData->{itemtype}}{imageurl};
422 $biblioLoopIter{itemLoop} = [];
423 my $numCopiesAvailable = 0;
424 my $numCopiesOPACAvailable = 0;
425 # iterating through all items first to check if any of them available
426 # to pass this value further inside down to IsAvailableForItemLevelRequest to
427 # it's complicated logic to analyse.
428 # (before this loop was inside that sub loop so it was O(n^2) )
429 my $items_any_available;
430 $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $biblioNum, patron => $patron }) if $patron;
431 foreach my $item (@{$biblioData->{items}}) {
433 my $item_info = $item->unblessed;
434 $item_info->{holding_branch} = $item->holding_branch;
435 $item_info->{home_branch} = $item->home_branch;
436 if ($itemLevelTypes) {
437 my $itemtype = $item->itemtype;
438 $item_info->{'imageurl'} = getitemtypeimagelocation( 'opac',
439 $itemtypes->{ $itemtype->itemtype }->{'imageurl'} );
440 $item_info->{'translated_description'} =
441 $itemtypes->{ $itemtype->itemtype }->{translated_description};
445 my $holds = $item->current_holds;
446 if ( my $first_hold = $holds->next ) {
447 $item_info->{first_hold} = $first_hold;
450 $item_info->{checkout} = $item->checkout;
452 # Check of the transferred documents
453 my $transfer = $item->get_transfer;
454 if ( $transfer && $transfer->in_transit ) {
455 $item_info->{transfertwhen} = $transfer->datesent;
456 $item_info->{transfertfrom} = $transfer->frombranch;
457 $item_info->{transfertto} = $transfer->tobranch;
458 $item_info->{nocancel} = 1;
461 # if the items belongs to a host record, show link to host record
462 if ( $item_info->{biblionumber} ne $biblioNum ) {
463 $item_info->{hostbiblionumber} = $item->biblionumber;
464 $item_info->{hosttitle} = Koha::Biblios->find( $item_info->{biblionumber} )->title;
467 my $branch = GetReservesControlBranch( $item_info, $patron_unblessed );
469 # items_any_available defined outside of the current loop,
470 # so we avoiding loop inside IsAvailableForItemLevelRequest:
471 my $policy_holdallowed =
472 CanItemBeReserved( $patron, $item )->{status} eq 'OK' &&
473 IsAvailableForItemLevelRequest($item, $patron, undef, $items_any_available);
475 if ($policy_holdallowed) {
476 my $opac_hold_policy = Koha::CirculationRules->get_opacitemholds_policy( { item => $item, patron => $patron } );
477 if ( $opac_hold_policy ne 'N' ) { # If Y or F
478 $item_info->{available} = 1;
479 $numCopiesOPACAvailable++;
480 $biblioLoopIter{force_hold} = 1 if $opac_hold_policy eq 'F';
482 $numCopiesAvailable++;
484 unless ( $can_place_hold_if_available_at_pickup ) {
485 my $items_in_this_library = Koha::Items->search({ biblionumber => $item->biblionumber, holdingbranch => $item->holdingbranch });
486 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
487 if ( $items_in_this_library->count > $nb_of_items_issued ) {
488 push @not_available_at, $item->holdingbranch;
493 # Show serial enumeration when needed
494 if ($item_info->{enumchron}) {
495 $itemdata_enumchron = 1;
497 # Show collection when needed
498 if ($item_info->{ccode}) {
502 push @{$biblioLoopIter{itemLoop}}, $item_info;
505 itemdata_enumchron => $itemdata_enumchron,
506 itemdata_ccode => $itemdata_ccode,
509 if ($numCopiesAvailable > 0) {
511 $biblioLoopIter{bib_available} = 1;
512 $biblioLoopIter{holdable} = 1;
513 $biblioLoopIter{itemholdable} = 1 if $numCopiesOPACAvailable;
515 if ($biblioLoopIter{already_reserved}) {
516 $biblioLoopIter{holdable} = undef;
517 $biblioLoopIter{itemholdable} = undef;
519 if ( $biblioLoopIter{holdable} ) {
520 @not_available_at = uniq @not_available_at;
521 $biblioLoopIter{not_available_at} = \@not_available_at ;
524 unless ( $can_place_hold_if_available_at_pickup ) {
525 @not_available_at = uniq @not_available_at;
526 $biblioLoopIter{not_available_at} = \@not_available_at ;
527 # The record is not holdable is not available at any of the libraries
528 if ( Koha::Libraries->search->count == @not_available_at ) {
529 $biblioLoopIter{holdable} = 0;
533 my $status = CanBookBeReserved( $borrowernumber, $biblioNum )->{status};
534 $biblioLoopIter{holdable} &&= $status eq 'OK';
535 $biblioLoopIter{$status} = 1;
537 if ( $biblioLoopIter{holdable} and C4::Context->preference('AllowHoldItemTypeSelection') ) {
538 # build the allowed item types loop
539 my $rs = $biblio->items->search_ordered(
541 { select => [ { distinct => 'itype' } ],
547 grep { CanBookBeReserved( $borrowernumber, $biblioNum, $branch, { itemtype => $_ } )->{status} eq 'OK' }
548 $rs->get_column('item_type');
550 $biblioLoopIter{allowed_item_types} = \@item_types;
553 if ( $status eq 'recall' ) {
554 $biblioLoopIter{recall} = 1;
557 # For multiple holds per record, if a patron has previously placed a hold,
558 # the patron can only place more holds of the same type. That is, if the
559 # patron placed a record level hold, all the holds the patron places must
560 # be record level. If the patron placed an item level hold, all holds
561 # the patron places must be item level
562 my $forced_hold_level = Koha::Holds->search(
564 borrowernumber => $borrowernumber,
565 biblionumber => $biblioNum,
568 )->forced_hold_level();
569 if ($forced_hold_level) {
570 $biblioLoopIter{force_hold} = 1 if $forced_hold_level eq 'item';
571 $biblioLoopIter{force_hold} = 0 if $forced_hold_level eq 'item_group';
572 $biblioLoopIter{itemholdable} = 0 if $forced_hold_level eq 'record';
573 $biblioLoopIter{itemholdable} = 0 if $forced_hold_level eq 'item_group';
574 $biblioLoopIter{forced_hold_level} = $forced_hold_level;
577 # Pass through any reserve charge
578 $biblioLoopIter{reserve_charge} = GetReserveFee( $patron->id, $biblioNum );
580 push @$biblioLoop, \%biblioLoopIter;
582 $anyholdable = 1 if $biblioLoopIter{holdable};
585 unless ($pickup_locations->count) {
586 $numBibsAvailable = 0;
590 no_pickup_locations => 1
594 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
595 $template->param( none_available => 1 );
598 if (scalar @biblionumbers > 1) {
599 $template->param( multi_hold => 1);
602 my $show_notes=C4::Context->preference('OpacHoldNotes');
603 $template->param(OpacHoldNotes=>$show_notes);
606 $template->param(bibitemloop => $biblioLoop);
607 # can set reserve date in future
609 C4::Context->preference( 'AllowHoldDateInFuture' ) &&
610 C4::Context->preference( 'OPACAllowHoldDateInFuture' )
613 reserve_in_future => 1,
617 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };