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.
35 use Koha::AuthorisedValues;
40 use Date::Calc qw/Today Date_to_Days/;
41 use List::MoreUtils qw/uniq/;
43 my $maxreserves = C4::Context->preference("maxreserves");
47 # if RequestOnOpac (for placing holds) is disabled, leave immediately
48 if ( ! C4::Context->preference('RequestOnOpac') ) {
49 print $query->redirect("/cgi-bin/koha/errors/404.pl");
53 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
55 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;
70 output_html_with_http_headers(shift,shift,shift); # $query, $cookie, $template->output;
74 # get borrower information ....
75 my ( $borr ) = GetMember( borrowernumber => $borrowernumber );
76 my $patron = Koha::Patrons->find( $borrowernumber );
78 my $can_place_hold_if_available_at_pickup = C4::Context->preference('OPACHoldsIfAvailableAtPickup');
79 unless ( $can_place_hold_if_available_at_pickup ) {
80 my @patron_categories = split '\|', C4::Context->preference('OPACHoldsIfAvailableAtPickupExceptions');
81 if ( @patron_categories ) {
82 $can_place_hold_if_available_at_pickup = grep /$borr->{categorycode}/, @patron_categories;
86 # check if this user can place a reserve, -1 means use sys pref, 0 means dont block, 1 means block
87 if ( $patron->category->effective_BlockExpiredPatronOpacActions ) {
89 if ( $patron->is_expired ) {
91 # cannot reserve, their card has expired and the rules set mean this is not allowed
92 $template->param( message => 1, expired_patron => 1 );
93 get_out( $query, $cookie, $template->output );
97 # Pass through any reserve charge
98 my $reservefee = $patron->category->reservefee;
99 if ( $reservefee > 0){
100 $template->param( RESERVE_CHARGE => sprintf("%.2f",$reservefee));
103 my $itemTypes = GetItemTypes();
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 &get_out($query, $cookie, $template->output);
122 # Pass the numbers to the page so they can be fed back
123 # when the hold is confirmed. TODO: Not necessary?
124 $template->param( biblionumbers => $biblionumbers );
126 # Each biblio number is suffixed with '/', e.g. "1/2/3/"
127 my @biblionumbers = split /\//, $biblionumbers;
128 if (($#biblionumbers < 0) && (! $query->param('place_reserve'))) {
130 $template->param(message=>1, no_biblionumber=>1);
131 &get_out($query, $cookie, $template->output);
135 # pass the pickup branch along....
136 my $branch = $query->param('branch') || $borr->{'branchcode'} || C4::Context->userenv->{branch} || '' ;
137 $template->param( branch => $branch );
139 # Is the person allowed to choose their branch
140 my $OPACChooseBranch = (C4::Context->preference("OPACAllowUserToChooseBranch")) ? 1 : 0;
142 $template->param( choose_branch => $OPACChooseBranch);
146 # Build hashes of the requested biblio(item)s and items.
150 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
151 my %itemInfoHash; # Hash of itemnumber to item info.
152 foreach my $biblioNumber (@biblionumbers) {
154 my $biblioData = GetBiblioData($biblioNumber);
155 $biblioDataHash{$biblioNumber} = $biblioData;
157 my @itemInfos = GetItemsInfo($biblioNumber);
159 my $marcrecord= GetMarcBiblio($biblioNumber);
161 # flag indicating existence of at least one item linked via a host record
163 # adding items linked via host biblios
164 my @hostitemInfos = GetHostItemsInfo($marcrecord);
167 push (@itemInfos,@hostitemInfos);
170 $biblioData->{itemInfos} = \@itemInfos;
171 foreach my $itemInfo (@itemInfos) {
172 $itemInfoHash{$itemInfo->{itemnumber}} = $itemInfo;
175 # Compute the priority rank.
176 my $biblio = Koha::Biblios->find( $biblioNumber );
177 my $holds = $biblio->holds;
178 my $rank = $holds->count;
179 $biblioData->{reservecount} = 1; # new reserve
180 while ( my $hold = $holds->next ) {
181 if ( $hold->is_waiting ) {
185 $biblioData->{reservecount}++;
188 $biblioData->{rank} = $rank + 1;
193 # If this is the second time through this script, it
194 # means we are carrying out the hold request, possibly
195 # with a specific item for each biblionumber.
198 if ( $query->param('place_reserve') ) {
201 $reserve_cnt = GetReservesFromBorrowernumber( $borrowernumber );
204 # List is composed of alternating biblio/item/branch
205 my $selectedItems = $query->param('selecteditems');
207 if ($query->param('reserve_mode') eq 'single') {
208 # This indicates non-JavaScript mode, so there was
209 # only a single biblio number selected.
210 my $bib = $query->param('single_bib');
211 my $item = $query->param("checkitem_$bib");
212 if ($item eq 'any') {
215 my $branch = $query->param('branch');
216 $selectedItems = "$bib/$item/$branch/";
219 $selectedItems =~ s!/$!!;
220 my @selectedItems = split /\//, $selectedItems, -1;
222 # Make sure there is a biblionum/itemnum/branch triplet for each item.
223 # The itemnum can be 'any', meaning next available.
224 my $selectionCount = @selectedItems;
225 if (($selectionCount == 0) || (($selectionCount % 3) != 0)) {
226 $template->param(message=>1, bad_data=>1);
227 &get_out($query, $cookie, $template->output);
230 my $failed_holds = 0;
231 while (@selectedItems) {
232 my $biblioNum = shift(@selectedItems);
233 my $itemNum = shift(@selectedItems);
234 my $branch = shift(@selectedItems); # i.e., branch code, not name
238 my $singleBranchMode = Koha::Libraries->search->count == 1;
239 if ( $singleBranchMode || !$OPACChooseBranch )
240 { # single branch mode or disabled user choosing
241 $branch = $borr->{'branchcode'};
244 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
245 if ( $itemNum ne '' ) {
246 my $hostbiblioNum = GetBiblionumberFromItemnumber($itemNum);
247 if ( $hostbiblioNum ne $biblioNum ) {
248 $biblioNum = $hostbiblioNum;
252 my $biblioData = $biblioDataHash{$biblioNum};
255 # Check for user supplied reserve date
257 if ( C4::Context->preference('AllowHoldDateInFuture')
258 && C4::Context->preference('OPACAllowHoldDateInFuture') )
260 $startdate = $query->param("reserve_date_$biblioNum");
263 my $expiration_date = $query->param("expiration_date_$biblioNum");
265 # If a specific item was selected and the pickup branch is the same as the
266 # holdingbranch, force the value $rank and $found.
267 my $rank = $biblioData->{rank};
268 if ( $itemNum ne '' ) {
269 $canreserve = 1 if CanItemBeReserved( $borrowernumber, $itemNum ) eq 'OK';
270 $rank = '0' unless C4::Context->preference('ReservesNeedReturns');
271 my $item = GetItem($itemNum);
272 if ( $item->{'holdingbranch'} eq $branch ) {
274 unless C4::Context->preference('ReservesNeedReturns');
278 $canreserve = 1 if CanBookBeReserved( $borrowernumber, $biblioNum ) eq 'OK';
280 # Inserts a null into the 'itemnumber' field of 'reserves' table.
283 my $notes = $query->param('notes_'.$biblioNum)||'';
286 && $reserve_cnt >= $maxreserves )
291 unless ( $can_place_hold_if_available_at_pickup ) {
292 my $items_in_this_library = Koha::Items->search({ biblionumber => $biblioNum, holdingbranch => $branch });
293 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
294 my $nb_of_items_unavailable = $items_in_this_library->search({ -or => { lost => { '!=' => 0 }, damaged => { '!=' => 0 }, } });
295 if ( $items_in_this_library->count > $nb_of_items_issued + $nb_of_items_unavailable ) {
300 my $itemtype = $query->param('itemtype') || undef;
301 $itemtype = undef if $itemNum;
303 # Here we actually do the reserveration. Stage 3.
305 my $reserve_id = AddReserve(
306 $branch, $borrowernumber, $biblioNum,
307 [$biblioNum], $rank, $startdate,
308 $expiration_date, $notes, $biblioData->{title},
309 $itemNum, $found, $itemtype,
311 $failed_holds++ unless $reserve_id;
316 print $query->redirect("/cgi-bin/koha/opac-user.pl?" . ( $failed_holds ? "failed_holds=$failed_holds" : q|| ) . "#opac-user-holds");
322 # Here we check that the borrower can actually make reserves Stage 1.
326 my $maxoutstanding = C4::Context->preference("maxoutstanding");
327 $template->param( noreserve => 1 ) unless $maxoutstanding;
328 my ( $amountoutstanding ) = GetMemberAccountRecords($borrowernumber);
329 if ( $amountoutstanding && ($amountoutstanding > $maxoutstanding) ) {
330 my $amount = sprintf "%.02f", $amountoutstanding;
331 $template->param( message => 1 );
333 $template->param( too_much_oweing => $amount );
336 if ( $borr->{gonenoaddress} && ($borr->{gonenoaddress} == 1) ) {
344 if ( $borr->{lost} && ($borr->{lost} == 1) ) {
352 if ( Koha::Patrons->find( $borrowernumber )->is_debarred ) {
357 debarred_comment => $borr->{debarredcomment},
358 debarred_date => $borr->{debarred},
362 my @reserves = GetReservesFromBorrowernumber( $borrowernumber );
363 my $reserves_count = scalar(@reserves);
364 $template->param( RESERVES => \@reserves );
365 if ( $maxreserves && ( $reserves_count >= $maxreserves ) ) {
366 $template->param( message => 1 );
368 $template->param( too_many_reserves => scalar(@reserves));
371 unless ( $noreserves ) {
372 my $requested_reserves_count = scalar( @biblionumbers );
373 if ( $maxreserves && ( $reserves_count + $requested_reserves_count > $maxreserves ) ) {
374 $template->param( new_reserves_allowed => $maxreserves - $reserves_count );
378 unless ($noreserves) {
379 $template->param( select_item_types => 1 );
385 # Build the template parameters that will show the info
386 # and items for each biblionumber.
391 my $numBibsAvailable = 0;
392 my $itemdata_enumchron = 0;
394 my $itemLevelTypes = C4::Context->preference('item-level_itypes');
395 $template->param('item_level_itypes' => $itemLevelTypes);
397 foreach my $biblioNum (@biblionumbers) {
399 my @not_available_at = ();
400 my $record = GetMarcBiblio($biblioNum);
401 # Init the bib item with the choices for branch pickup
404 # Get relevant biblio data.
405 my $biblioData = $biblioDataHash{$biblioNum};
407 $template->param(message=>1, bad_biblionumber=>$biblioNum);
408 &get_out($query, $cookie, $template->output);
411 my $frameworkcode = GetFrameworkCode( $biblioData->{biblionumber} );
412 $biblioLoopIter{biblionumber} = $biblioData->{biblionumber};
413 $biblioLoopIter{title} = $biblioData->{title};
414 $biblioLoopIter{subtitle} = GetRecordValue('subtitle', $record, $frameworkcode);
415 $biblioLoopIter{author} = $biblioData->{author};
416 $biblioLoopIter{rank} = $biblioData->{rank};
417 $biblioLoopIter{reservecount} = $biblioData->{reservecount};
418 $biblioLoopIter{already_reserved} = $biblioData->{already_reserved};
419 $biblioLoopIter{reqholdnotes}=0; #TODO: For future use
421 if (!$itemLevelTypes && $biblioData->{itemtype}) {
422 $biblioLoopIter{translated_description} = $itemTypes->{$biblioData->{itemtype}}{translated_description};
423 $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$biblioData->{itemtype}}{imageurl};
426 foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
427 if ($itemLevelTypes && $itemInfo->{itype}) {
428 $itemInfo->{translated_description} = $itemTypes->{$itemInfo->{itype}}{translated_description};
429 $itemInfo->{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$itemInfo->{itype}}{imageurl};
432 if (!$itemInfo->{'notforloan'} && !($itemInfo->{'itemnotforloan'} > 0)) {
433 $biblioLoopIter{forloan} = 1;
437 my @notforloan_avs = Koha::AuthorisedValues->search_by_koha_field({ kohafield => 'items.notforloan', frameworkcode => $frameworkcode });
438 my $notforloan_label_of = { map { $_->authorised_value => $_->opac_description } @notforloan_avs };
440 $biblioLoopIter{itemLoop} = [];
441 my $numCopiesAvailable = 0;
442 my $numCopiesOPACAvailable = 0;
443 foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
444 my $itemNum = $itemInfo->{itemnumber};
445 my $itemLoopIter = {};
447 $itemLoopIter->{itemnumber} = $itemNum;
448 $itemLoopIter->{barcode} = $itemInfo->{barcode};
449 $itemLoopIter->{homeBranchName} = $itemInfo->{homebranch};
450 $itemLoopIter->{callNumber} = $itemInfo->{itemcallnumber};
451 $itemLoopIter->{enumchron} = $itemInfo->{enumchron};
452 $itemLoopIter->{copynumber} = $itemInfo->{copynumber};
453 if ($itemLevelTypes) {
454 $itemLoopIter->{translated_description} = $itemInfo->{translated_description};
455 $itemLoopIter->{itype} = $itemInfo->{itype};
456 $itemLoopIter->{imageurl} = $itemInfo->{imageurl};
459 # If the holdingbranch is different than the homebranch, we show the
460 # holdingbranch of the document too.
461 if ( $itemInfo->{homebranch} ne $itemInfo->{holdingbranch} ) {
462 $itemLoopIter->{holdingBranchName} = $itemInfo->{holdingbranch};
465 # If the item is currently on loan, we display its return date and
466 # change the background color.
467 my $issues= GetItemIssue($itemNum);
468 if ( $issues->{'date_due'} ) {
469 $itemLoopIter->{dateDue} = output_pref({ dt => dt_from_string($issues->{date_due}, 'sql'), as_due_date => 1 });
470 $itemLoopIter->{backgroundcolor} = 'onloan';
474 my $item = Koha::Items->find( $itemNum );
475 my $holds = $item->current_holds;
477 if ( my $first_hold = $holds->next ) {
478 my $ItemBorrowerReserveInfo = GetMember( borrowernumber => $first_hold->borrowernumber );
479 $itemLoopIter->{backgroundcolor} = 'reserved';
480 $itemLoopIter->{reservedate} = output_pref({ dt => dt_from_string($first_hold->reservedate), dateonly => 1 }); # FIXME Should be formatted in the template
481 $itemLoopIter->{ReservedForBorrowernumber} = $first_hold->borrowernumber;
482 $itemLoopIter->{ReservedForSurname} = $ItemBorrowerReserveInfo->{'surname'};
483 $itemLoopIter->{ReservedForFirstname} = $ItemBorrowerReserveInfo->{'firstname'};
484 $itemLoopIter->{ExpectedAtLibrary} = $first_hold->branchcode;
485 $itemLoopIter->{waitingdate} = $first_hold->waitingdate;
488 $itemLoopIter->{notforloan} = $itemInfo->{notforloan};
489 $itemLoopIter->{itemnotforloan} = $itemInfo->{itemnotforloan};
491 # Management of the notforloan document
492 if ( $itemLoopIter->{notforloan} || $itemLoopIter->{itemnotforloan}) {
493 $itemLoopIter->{backgroundcolor} = 'other';
494 $itemLoopIter->{notforloanvalue} =
495 $notforloan_label_of->{ $itemLoopIter->{notforloan} };
498 # Management of lost or long overdue items
499 if ( $itemInfo->{itemlost} ) {
501 # FIXME localized strings should never be in Perl code
502 $itemLoopIter->{message} =
503 $itemInfo->{itemlost} == 1 ? "(lost)"
504 : $itemInfo->{itemlost} == 2 ? "(long overdue)"
506 $itemInfo->{backgroundcolor} = 'other';
509 # Check of the transfered documents
510 my ( $transfertwhen, $transfertfrom, $transfertto ) =
511 GetTransfers($itemNum);
512 if ( $transfertwhen && ($transfertwhen ne '') ) {
513 $itemLoopIter->{transfertwhen} = output_pref({ dt => dt_from_string($transfertwhen), dateonly => 1 });
514 $itemLoopIter->{transfertfrom} = $transfertfrom;
515 $itemLoopIter->{transfertto} = $transfertto;
516 $itemLoopIter->{nocancel} = 1;
519 # if the items belongs to a host record, show link to host record
520 if ( $itemInfo->{biblionumber} ne $biblioNum ) {
521 $biblioLoopIter{hostitemsflag} = 1;
522 $itemLoopIter->{hostbiblionumber} = $itemInfo->{biblionumber};
523 $itemLoopIter->{hosttitle} = GetBiblioData( $itemInfo->{biblionumber} )->{title};
526 # If there is no loan, return and transfer, we show a checkbox.
527 $itemLoopIter->{notforloan} = $itemLoopIter->{notforloan} || 0;
529 my $branch = GetReservesControlBranch( $itemInfo, $borr );
531 my $policy_holdallowed = !$itemLoopIter->{already_reserved};
532 $policy_holdallowed &&=
533 IsAvailableForItemLevelRequest($itemInfo,$borr) &&
534 CanItemBeReserved($borrowernumber,$itemNum) eq 'OK';
536 if ($policy_holdallowed) {
537 if ( my $hold_allowed = OPACItemHoldsAllowed( $itemInfo, $borr ) ) {
538 $itemLoopIter->{available} = 1;
539 $numCopiesOPACAvailable++;
540 $biblioLoopIter{force_hold} = 1 if $hold_allowed eq 'F';
542 $numCopiesAvailable++;
544 unless ( $can_place_hold_if_available_at_pickup ) {
545 my $items_in_this_library = Koha::Items->search({ biblionumber => $itemInfo->{biblionumber}, holdingbranch => $itemInfo->{holdingbranch} });
546 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
547 if ( $items_in_this_library->count > $nb_of_items_issued ) {
548 push @not_available_at, $itemInfo->{holdingbranch};
553 $itemLoopIter->{imageurl} = getitemtypeimagelocation( 'opac', $itemTypes->{ $itemInfo->{itype} }{imageurl} );
555 # Show serial enumeration when needed
556 if ($itemLoopIter->{enumchron}) {
557 $itemdata_enumchron = 1;
560 push @{$biblioLoopIter{itemLoop}}, $itemLoopIter;
562 $template->param( itemdata_enumchron => $itemdata_enumchron );
564 if ($numCopiesAvailable > 0) {
566 $biblioLoopIter{bib_available} = 1;
567 $biblioLoopIter{holdable} = 1;
568 $biblioLoopIter{itemholdable} = 1 if $numCopiesOPACAvailable;
570 if ($biblioLoopIter{already_reserved}) {
571 $biblioLoopIter{holdable} = undef;
572 $biblioLoopIter{itemholdable} = undef;
574 if(not C4::Context->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron($borrowernumber,$biblioNum)) {
575 $biblioLoopIter{holdable} = undef;
576 $biblioLoopIter{already_patron_possession} = 1;
579 if ( $biblioLoopIter{holdable} ) {
580 @not_available_at = uniq @not_available_at;
581 $biblioLoopIter{not_available_at} = \@not_available_at ;
584 unless ( $can_place_hold_if_available_at_pickup ) {
585 @not_available_at = uniq @not_available_at;
586 $biblioLoopIter{not_available_at} = \@not_available_at ;
587 # The record is not holdable is not available at any of the libraries
588 if ( Koha::Libraries->search->count == @not_available_at ) {
589 $biblioLoopIter{holdable} = 0;
593 $biblioLoopIter{holdable} &&= CanBookBeReserved($borrowernumber,$biblioNum) eq 'OK';
595 # For multiple holds per record, if a patron has previously placed a hold,
596 # the patron can only place more holds of the same type. That is, if the
597 # patron placed a record level hold, all the holds the patron places must
598 # be record level. If the patron placed an item level hold, all holds
599 # the patron places must be item level
600 my $forced_hold_level = Koha::Holds->search(
602 borrowernumber => $borrowernumber,
603 biblionumber => $biblioNum,
606 )->forced_hold_level();
607 if ($forced_hold_level) {
608 $biblioLoopIter{force_hold} = 1 if $forced_hold_level eq 'item';
609 $biblioLoopIter{itemholdable} = 0 if $forced_hold_level eq 'record';
613 push @$biblioLoop, \%biblioLoopIter;
615 $anyholdable = 1 if $biblioLoopIter{holdable};
619 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
620 $template->param( none_available => 1 );
623 my $show_notes=C4::Context->preference('OpacHoldNotes');
624 $template->param(OpacHoldNotes=>$show_notes);
627 $template->param(bibitemloop => $biblioLoop);
628 # can set reserve date in future
630 C4::Context->preference( 'AllowHoldDateInFuture' ) &&
631 C4::Context->preference( 'OPACAllowHoldDateInFuture' )
634 reserve_in_future => 1,
638 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };