From 899ccae2c8e1914df7846ed68f4303cbcd7179a3 Mon Sep 17 00:00:00 2001
From: Martin Stenberg <martin@xinxidi.net>
Date: Tue, 25 Aug 2015 20:21:25 +0200
Subject: [PATCH] Bug 14715: results per page setting for catalog search

Add new select field to catalog search results pages which allows user to set number
of results to be shown per page. Setting saved in cookie "results_per_page".
---
 C4/Search.pm                                       |  4 ++--
 catalogue/search.pl                                |  8 ++++----
 .../prog/en/modules/catalogue/results.tt           | 23 ++++++++++++++++++----
 .../opac-tmpl/bootstrap/en/modules/opac-results.tt | 15 ++++++++++++++
 opac/opac-search.pl                                | 14 +++++++++----
 5 files changed, 50 insertions(+), 14 deletions(-)

diff --git a/C4/Search.pm b/C4/Search.pm
index d9a193c..35a698f 100644
--- a/C4/Search.pm
+++ b/C4/Search.pm
@@ -439,7 +439,7 @@ sub getRecords {
                 # loop through the results
                 $results_hash->{'hits'} = $size;
                 my $times;
-                if ( $offset + $results_per_page <= $size ) {
+                if ( $results_per_page != 'all' && ($offset + $results_per_page <= $size) ) {
                     $times = $offset + $results_per_page;
                 }
                 else {
@@ -1874,7 +1874,7 @@ sub searchResults {
 
     # handle which records to actually retrieve
     my $times;
-    if ( $hits && $offset + $results_per_page <= $hits ) {
+    if ( $hits && $results_per_page != 'all' && ($offset + $results_per_page <= $hits) ) {
         $times = $offset + $results_per_page;
     }
     else {
diff --git a/catalogue/search.pl b/catalogue/search.pl
index 3fa25c0..11261c2 100755
--- a/catalogue/search.pl
+++ b/catalogue/search.pl
@@ -465,10 +465,9 @@ for (my $ii = 0; $ii < @operands; ++$ii)
 # Params that can only have one value
 my $scan = $params->{'scan'};
 my $count = C4::Context->preference('numSearchResults') || 20;
-my $results_per_page = $params->{'count'} || $count;
-my $offset = $params->{'offset'} || 0;
+my $results_per_page = $params->{'results_per_page'} || $cgi->cookie("results_per_page") || $count;
 my $page = $cgi->param('page') || 1;
-#my $offset = ($page-1)*$results_per_page;
+my $offset = $results_per_page != 'all' ? ($page-1)*$results_per_page : 0;
 my $hits;
 my $expanded_facet = $params->{'expand'};
 
@@ -555,6 +554,7 @@ for (my $i=0;$i<@servers;$i++) {
     my $server = $servers[$i];
     if ($server =~/biblioserver/) { # this is the local bibliographic server
         $hits = $results_hashref->{$server}->{"hits"};
+        $results_per_page = $hits if $results_per_page == 'all';
         my $page = $cgi->param('page') || 0;
         my @newresults = searchResults('intranet', $query_desc, $hits, $results_per_page, $offset, $scan,
                                        $results_hashref->{$server}->{"RECORDS"});
@@ -618,7 +618,7 @@ for (my $i=0;$i<@servers;$i++) {
             if ($query_desc || $limit_desc) {
                 $template->param(searchdesc => 1);
             }
-            $template->param(results_per_page =>  $results_per_page);
+            $template->param(results_per_page =>  $results_per_page == $hits ? 'all' : $results_per_page);
             # must define a value for size if not present in DB
             # in order to avoid problems generated by the default size value in TT
             foreach my $line (@newresults) {
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt
index 3cecf8a..191ad07 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt
@@ -95,9 +95,13 @@ $("#forgetholdfor").click(function(){
     $(".btn-group").removeClass("open");
     return false;
 });
-$('#sortbyform').find("input:submit").hide();
+$('#resultoptionsform').find("input:submit").hide();
 $('#sort_by').change(function() {
-        $('#sortbyform').submit();
+        $('#resultoptionsform').submit();
+    });
+$('#results_per_page').change(function() {
+        $.cookie('results_per_page', $(this).val());
+        $('#resultoptionsform').submit();
     });
         var param1 = "<label for=\"addto\">"+_("Add to:")+"<\/label><select name=\"addto\" id=\"addto\"><option value=\"\"><\/option>";
         [% IF ( intranetbookbag ) %]     param1 += "<option value=\"addtocart\">"+_("Cart")+"<\/option>"; [% END %]
@@ -342,7 +346,7 @@ var holdForPatron = function () {
 
     [% IF ( total ) %]
         <div id="searchheader">
-            <form action="/cgi-bin/koha/catalogue/search.pl" method="get" id="sortbyform">
+            <form action="/cgi-bin/koha/catalogue/search.pl" method="get" id="resultoptionsform">
                 [% IF ( searchdesc ) %]
                     [% FOREACH QUERY_INPUT IN QUERY_INPUTS %]
                     <input type="hidden" name="[% QUERY_INPUT.input_name |html %]" value="[% QUERY_INPUT.input_value |html %]"/>
@@ -356,8 +360,19 @@ var holdForPatron = function () {
                     <select id="sort_by" name="sort_by">
                     [% INCLUDE 'resort_form.inc' %]
                     </select>
-                    <input type="submit" value="Go" />
                 <!-- RESORT END -->
+                <!-- RESULTS_PER_PAGE START -->
+                    <label for="results_per_page">Results per page: </label>
+                    <select id="results_per_page" name="results_per_page">
+                        <option value="20" [% 'SELECTED' IF results_per_page == '20' %]>20</option>
+                        <option value="40" [% 'SELECTED' IF results_per_page == '40' %]>40</option>
+                        <option value="60" [% 'SELECTED' IF results_per_page == '60' %]>60</option>
+                        <option value="80" [% 'SELECTED' IF results_per_page == '80' %]>80</option>
+                        <option value="100" [% 'SELECTED' IF results_per_page == '100' %]>100</option>
+                        <option value="all" [% 'SELECTED' IF results_per_page == 'all' %]>all</option>
+                    </select>
+                <!-- RESULTS_PER_PAGE END -->
+                    <input type="submit" value="Go" />
             </form>
             <h3>
                 [% total %] result(s) found [% IF ( query_desc ) %]for <span style="font-weight: bold;">'[% query_desc |html %]'</span>[% END %][% IF limit_desc  %]&nbsp;with limit(s): <span style="font-weight: bold;">'[% limit_desc | html %]'</span>[% END %][% IF ( LibraryName ) %] in [% LibraryName %] Catalog[% END %].<br />&nbsp;
diff --git a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt
index 7021638..ae1d7a8 100644
--- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt
+++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt
@@ -145,6 +145,17 @@
                                     [% UNLESS tag %]
                                         <div class="sort_by pull-right">
                                             <select id="sort_by" class="resort" name="sort_by"> [% INCLUDE 'resort_form.inc' %] </select>
+
+                                            <label for="results_per_page">Results per page: </label>
+                                            <select id="results_per_page" name="results_per_page">
+                                                <option value="20" [% 'SELECTED' IF results_per_page == '20' %]>20</option>
+                                                <option value="40" [% 'SELECTED' IF results_per_page == '40' %]>40</option>
+                                                <option value="60" [% 'SELECTED' IF results_per_page == '60' %]>60</option>
+                                                <option value="80" [% 'SELECTED' IF results_per_page == '80' %]>80</option>
+                                                <option value="100" [% 'SELECTED' IF results_per_page == '100' %]>100</option>
+                                                <option value="all" [% 'SELECTED' IF results_per_page == 'all' %]>all</option>
+                                            </select>
+
                                             <input type="submit" class="btn btn-small clearfix" id="sortsubmit" value="Go" />
                                         </div>
                                     [% END %]
@@ -774,6 +785,10 @@ $(document).ready(function(){
     $('.resort').change(function() {
         $('#bookbag_form').submit();
     });
+    $('#results_per_page').change(function() {
+        $.cookie('results_per_page', $(this).val());
+        $('#bookbag_form').submit();
+    });
     $("span.clearall").html("<a id=\"CheckNone\" href=\"#\">"+_("Clear all")+"<\/a>");
     $("span.checkall").html("<a id=\"CheckAll\" href=\"#\">"+_("Select all")+"<\/a>");
 
diff --git a/opac/opac-search.pl b/opac/opac-search.pl
index 64b8800..358915b 100755
--- a/opac/opac-search.pl
+++ b/opac/opac-search.pl
@@ -523,10 +523,9 @@ if ($params->{'limit-yr'}) {
 my $scan = $params->{'scan'};
 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
 my $countRSS         = C4::Context->preference('numSearchRSSResults') || 50;
-my $results_per_page = $params->{'count'} || $count;
-my $offset = $params->{'offset'} || 0;
+my $results_per_page = $params->{'results_per_page'} || $cgi->cookie("results_per_page") || $count;
 my $page = $cgi->param('page') || 1;
-$offset = ($page-1)*$results_per_page if $page>1;
+my $offset = $results_per_page != 'all' ? ($page-1)*$results_per_page : 0;
 my $hits;
 my $expanded_facet = $params->{'expand'};
 
@@ -608,6 +607,12 @@ if ($tag) {
     # FIXME: No facets for tags search.
 } elsif ($build_grouped_results) {
     eval {
+        unless($results_per_page =~ /\d+/) { # all
+            # pazpar2 expects $results_per_page to be an integer, we hack around
+            # this by setting $results_per_page to the max value of a 32bit
+            # signed int - as defined by parpaz2 session.c:perform_termlist()
+            $results_per_page = 2147483647;
+        }
         ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
     };
 } else {
@@ -634,6 +639,7 @@ for (my $i=0;$i<@servers;$i++) {
     my $server = $servers[$i];
     if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
         $hits = $results_hashref->{$server}->{"hits"};
+        $results_per_page = $hits if $results_per_page == 'all';
         my $page = $cgi->param('page') || 0;
         my @newresults;
         if ($build_grouped_results) {
@@ -785,7 +791,7 @@ for (my $i=0;$i<@servers;$i++) {
             if ($query_desc || $limit_desc) {
                 $template->param(searchdesc => 1);
             }
-            $template->param(results_per_page =>  $results_per_page);
+            $template->param(results_per_page =>  $results_per_page == $hits ? 'all' : $results_per_page);
             my $hide = C4::Context->preference('OpacHiddenItems');
             $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
             my $branch = '';
-- 
2.1.4