Add item paging support to search availability.

Author: EreMaijala

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Anything marked with [**BC**] is known to affect backward compatibility with previous versions.
 
+## [23.11.07] - 2024-08-07
+
+### Added
+
+- Added support for paging items in biblio search availability (limit and offset query parameters). Also the total item count (items_total) and checked item count (items_checked) is now returned.
+
 ## [23.11.06] - 2024-06-20
 
 ### Added

Koha/Plugin/Fi/KohaSuomi/DI/AvailabilityController.pm

@@ -152,6 +152,8 @@ sub biblio_search {
             };
             $params->{'include_found_in_hold_queue'} = 1 if $include_found_in_hold_queue;
             $params->{'include_suspended_in_hold_queue'} = 1 if $include_suspended_in_hold_queue;
+            $params->{'limit'} = $c->validation->param('limit');
+            $params->{'offset'} = $c->validation->param('offset');
             $availability = Koha::Plugin::Fi::KohaSuomi::DI::Koha::Availability::Search->biblio($params);
             return $c->render(status => 200, openapi => $availability->in_opac->to_api);
         }

Koha/Plugin/Fi/KohaSuomi/DI/Koha/Biblio/Availability.pm

@@ -183,6 +183,12 @@ sub to_api {
     if (defined $self->{'hold_queue_length'}) {
         $hash->{'hold_queue_length'} = 0+$self->{'hold_queue_length'};
     }
+    if (defined $self->{'items_total'}) {
+        $hash->{'items_total'} = 0+$self->{'items_total'};
+    }
+    if (defined $self->{'items_checked'}) {
+        $hash->{'items_checked'} = 0+$self->{'items_checked'};
+    }
     return $hash;
 }
 

Koha/Plugin/Fi/KohaSuomi/DI/Koha/Biblio/Availability/Search.pm

@@ -66,6 +66,12 @@ sub new {
 
     my $self = $class->SUPER::new($params);
 
+    # Check only first n items.
+    $self->{'limit'} = $params->{'limit'};
+
+    # Check items starting at offset of n.
+    $self->{'offset'} = $params->{'offset'};
+
     return $self;
 }
 
@@ -95,36 +101,40 @@ sub _item_looper {
 
     if (scalar(@items) == 0) {
         $self->unavailable(Koha::Plugin::Fi::KohaSuomi::DI::Koha::Exceptions::Biblio::NoAvailableItems->new);
+        $self->{'items_total'} = 0;
         return;
     }
 
+    # Sort items for paging
+    sort { $a->itemnumber <=> $b->itemnumber } @items;
+ 
     my $opachiddenitems_rules = C4::Context->yaml_preference('OpacHiddenItems');
 
-    # Stop calculating item availabilities after $limit available items are found.
-    # E.g. parameter 'limit' with value 1 will find only one available item and
-    # return biblio as available if no other unavailabilities are found. If you
-    # want to calculate availability of every item in this biblio, do not give this
-    # parameter.
-    my $limit = $params->{'limit'};
     my $avoid_queries_after = $params->{'MaxSearchResultsItemsPerRecordStatusCheck'}
         ? C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') : undef;
     my $count = 0;
+    my $checked = 0;
 
     $self->{'hold_queue_length'} = $self->get_hold_queue_length();
 
     foreach my $item (@items) {
-        # Break out of loop after $limit items are found available
-        if (defined $limit && @{$self->{'item_availabilities'}} >= $limit) {
-            last;
-        }
-
         next if ($item->hidden_in_opac({ rules => $opachiddenitems_rules }));
 
+        $count++;
+        # Skip this item if we haven't reached the offset yet
+        next if (defined $self->offset && $count <= $self->offset);
+
+        # Skip this item if we have reached the limit. We still need to
+        # loop all items for total count of items visible in opac.
+        next if (defined $self->limit && $checked >= $self->limit);
+
+        $checked++;
+
         my $item_availability = Koha::Plugin::Fi::KohaSuomi::DI::Koha::Item::Availability::Search->new({
             item => $item,
         });
         if ($params->{'MaxSearchResultsItemsPerRecordStatusCheck'} &&
-                $count >= $avoid_queries_after) {
+            $count > $avoid_queries_after) {
             # A couple heuristics to limit how many times
             # we query the database for item transfer information, sacrificing
             # accuracy in some cases for speed;
@@ -144,7 +154,6 @@ sub _item_looper {
         } else {
             push @{$self->{'item_unavailabilities'}}, $item_availability;
         }
-        $count++;
     }
 
     # After going through items, if none are found available, set the biblio
@@ -153,6 +162,10 @@ sub _item_looper {
         $self->unavailable(Koha::Plugin::Fi::KohaSuomi::DI::Koha::Exceptions::Biblio::NoAvailableItems->new);
     }
 
+    # Add total and checked item count
+    $self->{'items_total'} = $count;
+    $self->{'items_checked'} = $checked;
+
     return $self;
 }
 

Koha/Plugin/Fi/KohaSuomi/DI/openapi.yaml

@@ -227,6 +227,16 @@ paths:
           name: include_suspended_in_hold_queue
           required: false
           type: integer
+        - description: Check availability of first n items only. Note that this may affect the returned biblio availability as well.
+          in: query
+          name: limit
+          required: false
+          type: integer
+        - description: Offset to start checking item availability. Note that this may affect the returned biblio availability as well.
+          in: query
+          name: offset
+          required: false
+          type: integer
       produces:
         - application/json
       responses:

Koha/Plugin/Fi/KohaSuomi/DI/openapi/definitions/availability/biblio.yaml

@@ -12,4 +12,10 @@ properties:
     type:
       - array
       - "null"
+  items_total:
+    description: Total item count
+    type: integer
+  items_checked:
+    description: Checked item count
+    type: integer
 type: object

Koha/Plugin/Fi/KohaSuomi/sample_requests.http

@@ -36,6 +36,21 @@ grant_type=client_credentials&client_id={{clientId}}&client_secret={{clientSecre
 GET {{baseUrl}}/contrib/kohasuomi/availability/biblios/2/search HTTP/1.1
 Authorization: Bearer {{token}}
 
+###
+# @name item_statuses_limit
+GET {{baseUrl}}/contrib/kohasuomi/availability/biblios/2/search?limit=1 HTTP/1.1
+Authorization: Bearer {{token}}
+
+###
+# @name item_statuses_offset
+GET {{baseUrl}}/contrib/kohasuomi/availability/biblios/2/search?offset=1 HTTP/1.1
+Authorization: Bearer {{token}}
+
+###
+# @name item_statuses_limit_offset
+GET {{baseUrl}}/contrib/kohasuomi/availability/biblios/2/search?limit=3&offset=1 HTTP/1.1
+Authorization: Bearer {{token}}
+
 ###
 # @name hold_availability
 GET {{baseUrl}}/contrib/kohasuomi/availability/biblios/2/hold?patron_id=57&include_found_in_hold_queue=0 HTTP/1.1