Bug 19540: Tell the patron why a hold cannot be placed on items
[srvgit] / opac / opac-reserve.pl
index f893deb..e32a41e 100755 (executable)
@@ -1,5 +1,6 @@
 #!/usr/bin/perl
 
+
 # Copyright Katipo Communications 2002
 # Copyright Koha Development team 2012
 #
 use Modern::Perl;
 
 use CGI qw ( -utf8 );
-use C4::Auth;    # checkauth, getborrowernumber.
-use C4::Koha;
-use C4::Circulation;
-use C4::Reserves;
-use C4::Biblio;
-use C4::Items;
-use C4::Output;
+use C4::Auth qw( get_template_and_user );
+use C4::Koha qw( getitemtypeimagelocation getitemtypeimagesrc );
+use C4::Circulation qw( GetBranchItemRule GetTransfers );
+use C4::Reserves qw( CanItemBeReserved CanBookBeReserved AddReserve GetReservesControlBranch ItemsAnyAvailableAndNotRestricted IsAvailableForItemLevelRequest );
+use C4::Biblio qw( GetBiblioData GetFrameworkCode );
+use C4::Output qw( output_html_with_http_headers );
 use C4::Context;
 use C4::Members;
 use C4::Overdues;
-use C4::Debug;
 
 use Koha::AuthorisedValues;
 use Koha::Biblios;
-use Koha::DateUtils;
+use Koha::DateUtils qw( dt_from_string output_pref );
 use Koha::CirculationRules;
 use Koha::Items;
 use Koha::ItemTypes;
 use Koha::Checkouts;
 use Koha::Libraries;
 use Koha::Patrons;
-use Date::Calc qw/Today Date_to_Days/;
-use List::MoreUtils qw/uniq/;
+use List::MoreUtils qw( uniq );
 
 my $maxreserves = C4::Context->preference("maxreserves");
 
 my $query = CGI->new;
 
-# if RequestOnOpac (for placing holds) is disabled, leave immediately
-if ( ! C4::Context->preference('RequestOnOpac') ) {
+# if OPACHoldRequests (for placing holds) is disabled, leave immediately
+if ( ! C4::Context->preference('OPACHoldRequests') ) {
     print $query->redirect("/cgi-bin/koha/errors/404.pl");
     exit;
 }
@@ -60,7 +58,6 @@ my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
         template_name   => "opac-reserve.tt",
         query           => $query,
         type            => "opac",
-        debug           => 1,
     }
 );
 
@@ -72,15 +69,10 @@ for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
 
 my $patron = Koha::Patrons->find( $borrowernumber, { prefetch => ['categorycode'] } );
 my $category = $patron->category;
-# no OpacHiddenItems rules used if category is excepted
-my $item_hide_rules =
-    ( $category->override_hidden_items )
-    ? {}
-    : C4::Context->yaml_preference('OpacHiddenItems');
 
 my $can_place_hold_if_available_at_pickup = C4::Context->preference('OPACHoldsIfAvailableAtPickup');
 unless ( $can_place_hold_if_available_at_pickup ) {
-    my @patron_categories = split '\|', C4::Context->preference('OPACHoldsIfAvailableAtPickupExceptions');
+    my @patron_categories = split ',', C4::Context->preference('OPACHoldsIfAvailableAtPickupExceptions');
     if ( @patron_categories ) {
         my $categorycode = $patron->categorycode;
         $can_place_hold_if_available_at_pickup = grep { $_ eq $categorycode } @patron_categories;
@@ -150,32 +142,31 @@ $template->param( branch => $branch );
 #
 
 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
-my %itemInfoHash; # Hash of itemnumber to item info.
 foreach my $biblioNumber (@biblionumbers) {
 
     my $biblioData = GetBiblioData($biblioNumber);
     $biblioDataHash{$biblioNumber} = $biblioData;
 
-    my @itemInfos = GetItemsInfo($biblioNumber);
+    my $biblio = Koha::Biblios->find( $biblioNumber );
+    next unless $biblio;
 
-    my $marcrecord= GetMarcBiblio({ biblionumber => $biblioNumber });
+    my $marcrecord = $biblio->metadata->record;
 
-    # flag indicating existence of at least one item linked via a host record
-    my $hostitemsflag;
-    # adding items linked via host biblios
-    my @hostitemInfos = GetHostItemsInfo($marcrecord);
-    if (@hostitemInfos){
-        $hostitemsflag =1;
-        push (@itemInfos,@hostitemInfos);
-    }
+    my $items = Koha::Items->search_ordered(
+        [
+            biblionumber => $biblioNumber,
+            'me.itemnumber' => {
+                -in => [
+                    $biblio->host_items->get_column('itemnumber')
+                ]
+            }
+        ],
+        { prefetch => [ 'issue', 'homebranch', 'holdingbranch' ] }
+    )->filter_by_visible_in_opac({ patron => $patron });
 
-    $biblioData->{itemInfos} = \@itemInfos;
-    foreach my $itemInfo (@itemInfos) {
-        $itemInfoHash{$itemInfo->{itemnumber}} = $itemInfo;
-    }
+    $biblioData->{items} = [$items->as_list]; # FIXME Potentially a lot in memory here!
 
     # Compute the priority rank.
-    my $biblio = Koha::Biblios->find( $biblioNumber );
     $biblioData->{object} = $biblio;
     my $holds = $biblio->holds;
     my $rank = $holds->count;
@@ -245,14 +236,17 @@ if ( $query->param('place_reserve') ) {
             $branch = $patron->branchcode;
         }
 
+        # FIXME We shouldn't need to fetch the item here
+        my $item = $itemNum ? Koha::Items->find( $itemNum ) : undef;
         # When choosing a specific item, the default pickup library should be dictated by the default hold policy
-        if ( ! C4::Context->preference("OPACAllowUserToChooseBranch") && $itemNum ) {
-            my $item = Koha::Items->find( $itemNum );
+        if ( ! C4::Context->preference("OPACAllowUserToChooseBranch") && $item ) {
             my $type = $item->effective_itemtype;
             my $rule = GetBranchItemRule( $patron->branchcode, $type );
 
-            if ( $rule->{hold_fulfillment_policy} eq 'any' ) {
+            if ( $rule->{hold_fulfillment_policy} eq 'any' || $rule->{hold_fulfillment_policy} eq 'patrongroup' ) {
                 $branch = $patron->branchcode;
+            } elsif ( $rule->{hold_fulfillment_policy} eq 'holdgroup' ){
+                $branch = $item->homebranch;
             } else {
                 my $policy = $rule->{hold_fulfillment_policy};
                 $branch = $item->$policy;
@@ -260,8 +254,7 @@ if ( $query->param('place_reserve') ) {
         }
 
 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
-        if ( $itemNum ne '' ) {
-            my $item = Koha::Items->find( $itemNum );
+        if ( $item ) {
             my $hostbiblioNum = $item->biblio->biblionumber;
             if ( $hostbiblioNum ne $biblioNum ) {
                 $biblioNum = $hostbiblioNum;
@@ -279,14 +272,19 @@ if ( $query->param('place_reserve') ) {
             $startdate = $query->param("reserve_date_$biblioNum");
         }
 
-        my $expiration_date = $query->param("expiration_date_$biblioNum");
+        my $patron_expiration_date = $query->param("expiration_date_$biblioNum");
+
+        my $itemtype = $query->param('itemtype') || undef;
+        $itemtype = undef if $itemNum;
 
         my $rank = $biblioData->{rank};
-        if ( $itemNum ne '' ) {
-            $canreserve = 1 if CanItemBeReserved( $borrowernumber, $itemNum, $branch )->{status} eq 'OK';
+        my $patron = Koha::Patrons->find( $borrowernumber );
+        if ( $item ) {
+            $canreserve = 1 if CanItemBeReserved( $patron, $item, $branch )->{status} eq 'OK';
         }
         else {
-            $canreserve = 1 if CanBookBeReserved( $borrowernumber, $biblioNum, $branch )->{status} eq 'OK';
+            $canreserve = 1
+              if CanBookBeReserved( $borrowernumber, $biblioNum, $branch, { itemtype => $itemtype } )->{status} eq 'OK';
 
             # Inserts a null into the 'itemnumber' field of 'reserves' table.
             $itemNum = undef;
@@ -308,9 +306,6 @@ if ( $query->param('place_reserve') ) {
             }
         }
 
-        my $itemtype = $query->param('itemtype') || undef;
-        $itemtype = undef if $itemNum;
-
         # Here we actually do the reserveration. Stage 3.
         if ($canreserve) {
             my $reserve_id = AddReserve(
@@ -320,7 +315,7 @@ if ( $query->param('place_reserve') ) {
                     biblionumber     => $biblioNum,
                     priority         => $rank,
                     reservation_date => $startdate,
-                    expiration_date  => $expiration_date,
+                    expiration_date  => $patron_expiration_date,
                     notes            => $notes,
                     title            => $biblioData->{title},
                     itemnumber       => $itemNum,
@@ -416,6 +411,7 @@ my $itemLevelTypes = C4::Context->preference('item-level_itypes');
 my $pickup_locations = Koha::Libraries->search({ pickup_location => 1 });
 $template->param('item_level_itypes' => $itemLevelTypes);
 
+my $patron_unblessed = $patron->unblessed;
 foreach my $biblioNum (@biblionumbers) {
 
     # Init the bib item with the choices for branch pickup
@@ -453,150 +449,90 @@ foreach my $biblioNum (@biblionumbers) {
         $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemtypes->{$biblioData->{itemtype}}{imageurl};
     }
 
-    foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
-        if ($itemLevelTypes && $itemInfo->{itype}) {
-            $itemInfo->{translated_description} = $itemtypes->{$itemInfo->{itype}}{translated_description};
-            $itemInfo->{imageurl} = getitemtypeimagesrc() . "/". $itemtypes->{$itemInfo->{itype}}{imageurl};
-        }
-
-        if (!$itemInfo->{'notforloan'} && !($itemInfo->{'itemnotforloan'} > 0)) {
-            $biblioLoopIter{forloan} = 1;
-        }
-    }
-
-    my @notforloan_avs = Koha::AuthorisedValues->search_by_koha_field({ kohafield => 'items.notforloan', frameworkcode => $frameworkcode });
-    my $notforloan_label_of = { map { $_->authorised_value => $_->opac_description } @notforloan_avs };
-
-    my $visible_items = { map { $_->itemnumber => 1 } $biblio->items->filter_by_visible_in_opac( { rules => $item_hide_rules } ) };
 
-    # Only keep the items that are visible in the opac (i.e. those in %visible_items)
-    # FIXME: We should get rid of itemInfos altogether and use $visible_items
-    $biblioData->{itemInfos} = [ grep { $visible_items->{ $_->{itemnumber} } } @{ $biblioData->{itemInfos} } ];
 
     $biblioLoopIter{itemLoop} = [];
     my $numCopiesAvailable = 0;
     my $numCopiesOPACAvailable = 0;
-    foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
-        my $itemNum = $itemInfo->{itemnumber};
-        my $item = Koha::Items->find( $itemNum );
-        my $itemLoopIter = {};
-
-        $itemLoopIter->{itemnumber} = $itemNum;
-        $itemLoopIter->{barcode} = $itemInfo->{barcode};
-        $itemLoopIter->{homeBranchName} = $itemInfo->{homebranch};
-        $itemLoopIter->{callNumber} = $itemInfo->{itemcallnumber};
-        $itemLoopIter->{enumchron} = $itemInfo->{enumchron};
-        $itemLoopIter->{ccode} = $itemInfo->{ccode};
-        $itemLoopIter->{copynumber} = $itemInfo->{copynumber};
+    # iterating through all items first to check if any of them available
+    # to pass this value further inside down to IsAvailableForItemLevelRequest to
+    # it's complicated logic to analyse.
+    # (before this loop was inside that sub loop so it was O(n^2) )
+    my $items_any_available;
+    $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $biblioNum, patron => $patron }) if $patron;
+    foreach my $item (@{$biblioData->{items}}) {
+
+        my $item_info = $item->unblessed;
+        $item_info->{holding_branch} = $item->holding_branch;
+        $item_info->{home_branch}    = $item->home_branch;
         if ($itemLevelTypes) {
-            $itemLoopIter->{translated_description} = $itemInfo->{translated_description};
-            $itemLoopIter->{itype} = $itemInfo->{itype};
-            $itemLoopIter->{imageurl} = $itemInfo->{imageurl};
+            my $itemtype = $item->itemtype;
+            $item_info->{'imageurl'} = getitemtypeimagelocation( 'opac',
+                $itemtypes->{ $itemtype->itemtype }->{'imageurl'} );
+            $item_info->{'translated_description'} =
+              $itemtypes->{ $itemtype->itemtype }->{translated_description};
         }
 
-        # If the holdingbranch is different than the homebranch, we show the
-        # holdingbranch of the document too.
-        if ( $itemInfo->{homebranch} ne $itemInfo->{holdingbranch} ) {
-            $itemLoopIter->{holdingBranchName} = $itemInfo->{holdingbranch};
-        }
-
-        # If the item is currently on loan, we display its return date and
-        # change the background color.
-        my $issue = Koha::Checkouts->find( { itemnumber => $itemNum } );
-        if ( $issue ) {
-            $itemLoopIter->{dateDue} = output_pref({ dt => dt_from_string($issue->date_due, 'sql'), as_due_date => 1 });
-            $itemLoopIter->{backgroundcolor} = 'onloan';
-        }
-
-        # checking reserve
+        # checking for holds
         my $holds = $item->current_holds;
-
         if ( my $first_hold = $holds->next ) {
-            $itemLoopIter->{backgroundcolor} = 'reserved';
-            $itemLoopIter->{reservedate}     = output_pref({ dt => dt_from_string($first_hold->reservedate), dateonly => 1 }); # FIXME Should be formatted in the template
-            $itemLoopIter->{ExpectedAtLibrary}         = $first_hold->branchcode;
-            $itemLoopIter->{waitingdate} = $first_hold->waitingdate;
+            $item_info->{first_hold} = $first_hold;
         }
 
-        $itemLoopIter->{notforloan} = $itemInfo->{notforloan};
-        $itemLoopIter->{itemnotforloan} = $itemInfo->{itemnotforloan};
-
-        # Management of the notforloan document
-        if ( $itemLoopIter->{notforloan} || $itemLoopIter->{itemnotforloan}) {
-            $itemLoopIter->{backgroundcolor} = 'other';
-            $itemLoopIter->{notforloanvalue} =
-              $notforloan_label_of->{ $itemLoopIter->{notforloan} };
-        }
-
-        # Management of lost or long overdue items
-        if ( $itemInfo->{itemlost} ) {
-
-            # FIXME localized strings should never be in Perl code
-            $itemLoopIter->{message} =
-                $itemInfo->{itemlost} == 1 ? "(lost)"
-              : $itemInfo->{itemlost} == 2 ? "(long overdue)"
-              : "";
-            $itemInfo->{backgroundcolor} = 'other';
-        }
+        $item_info->{checkout} = $item->checkout;
 
         # Check of the transferred documents
         my ( $transfertwhen, $transfertfrom, $transfertto ) =
-          GetTransfers($itemNum);
+          GetTransfers($item->itemnumber);
         if ( $transfertwhen && ($transfertwhen ne '') ) {
-            $itemLoopIter->{transfertwhen} = output_pref({ dt => dt_from_string($transfertwhen), dateonly => 1 });
-            $itemLoopIter->{transfertfrom} = $transfertfrom;
-            $itemLoopIter->{transfertto} = $transfertto;
-            $itemLoopIter->{nocancel} = 1;
+            $item_info->{transfertwhen} = $transfertwhen;
+            $item_info->{transfertfrom} = $transfertfrom;
+            $item_info->{transfertto} = $transfertto;
+            $item_info->{nocancel} = 1;
         }
 
         # if the items belongs to a host record, show link to host record
-        if ( $itemInfo->{biblionumber} ne $biblioNum ) {
-            $biblioLoopIter{hostitemsflag}    = 1;
-            $itemLoopIter->{hostbiblionumber} = $itemInfo->{biblionumber};
-            $itemLoopIter->{hosttitle}        = Koha::Biblios->find( $itemInfo->{biblionumber} )->title;
+        if ( $item_info->{biblionumber} ne $biblioNum ) {
+            $item_info->{hostbiblionumber} = $item->biblionumber;
+            $item_info->{hosttitle}        = Koha::Biblios->find( $item_info->{biblionumber} )->title;
         }
 
-        # If there is no loan, return and transfer, we show a checkbox.
-        $itemLoopIter->{notforloan} = $itemLoopIter->{notforloan} || 0;
-
-        my $patron_unblessed = $patron->unblessed;
-        my $branch = GetReservesControlBranch( $itemInfo, $patron_unblessed );
+        my $branch = GetReservesControlBranch( $item_info, $patron_unblessed );
 
-        my $policy_holdallowed = !$itemLoopIter->{already_reserved};
-        $policy_holdallowed &&=
-            IsAvailableForItemLevelRequest($item, $patron) &&
-            CanItemBeReserved( $borrowernumber, $itemNum )->{status} eq 'OK';
+        # items_any_available defined outside of the current loop,
+        # so we avoiding loop inside IsAvailableForItemLevelRequest:
+        my $policy_holdallowed =
+            CanItemBeReserved( $patron, $item )->{status} eq 'OK' &&
+            IsAvailableForItemLevelRequest($item, $patron, undef, $items_any_available);
 
         if ($policy_holdallowed) {
             my $opac_hold_policy = Koha::CirculationRules->get_opacitemholds_policy( { item => $item, patron => $patron } );
             if ( $opac_hold_policy ne 'N' ) { # If Y or F
-                $itemLoopIter->{available} = 1;
+                $item_info->{available} = 1;
                 $numCopiesOPACAvailable++;
                 $biblioLoopIter{force_hold} = 1 if $opac_hold_policy eq 'F';
             }
             $numCopiesAvailable++;
 
             unless ( $can_place_hold_if_available_at_pickup ) {
-                my $items_in_this_library = Koha::Items->search({ biblionumber => $itemInfo->{biblionumber}, holdingbranch => $itemInfo->{holdingbranch} });
+                my $items_in_this_library = Koha::Items->search({ biblionumber => $item->biblionumber, holdingbranch => $item->holdingbranch });
                 my $nb_of_items_issued = $items_in_this_library->search({ 'issue.itemnumber' => { not => undef }}, { join => 'issue' })->count;
                 if ( $items_in_this_library->count > $nb_of_items_issued ) {
-                    push @not_available_at, $itemInfo->{holdingbranch};
+                    push @not_available_at, $item->holdingbranch;
                 }
             }
         }
 
-        $itemLoopIter->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes->{ $itemInfo->{itype} }{imageurl} );
-
-    # Show serial enumeration when needed
-        if ($itemLoopIter->{enumchron}) {
+        # Show serial enumeration when needed
+        if ($item_info->{enumchron}) {
             $itemdata_enumchron = 1;
         }
-    # Show collection when needed
-        if ($itemLoopIter->{ccode}) {
+        # Show collection when needed
+        if ($item_info->{ccode}) {
             $itemdata_ccode = 1;
         }
 
-        push @{$biblioLoopIter{itemLoop}}, $itemLoopIter;
+        push @{$biblioLoopIter{itemLoop}}, $item_info;
     }
     $template->param(
         itemdata_enumchron => $itemdata_enumchron,
@@ -629,7 +565,27 @@ foreach my $biblioNum (@biblionumbers) {
 
     my $status = CanBookBeReserved( $borrowernumber, $biblioNum )->{status};
     $biblioLoopIter{holdable} &&= $status eq 'OK';
-    $biblioLoopIter{already_patron_possession} = $status eq 'alreadypossession';
+    $biblioLoopIter{$status} = 1;
+
+    if ( $biblioLoopIter{holdable} and C4::Context->preference('AllowHoldItemTypeSelection') ) {
+        # build the allowed item types loop
+        my $rs = $biblio->items->search_ordered(
+            undef,
+            {   select => [ { distinct => 'itype' } ],
+                as     => 'item_type'
+            }
+        );
+
+        my @item_types =
+          grep { CanBookBeReserved( $borrowernumber, $biblioNum, $branch, { itemtype => $_ } )->{status} eq 'OK' }
+          $rs->get_column('item_type');
+
+        $biblioLoopIter{allowed_item_types} = \@item_types;
+    }
+
+    if ( $status eq 'recall' ) {
+        $biblioLoopIter{recall} = 1;
+    }
 
     # For multiple holds per record, if a patron has previously placed a hold,
     # the patron can only place more holds of the same type. That is, if the