Bug 4943: Search history cookie size limit
[koha.git] / opac / opac-search.pl
index e1e66a9..a38d6f9 100755 (executable)
@@ -1,4 +1,23 @@
 #!/usr/bin/perl
+
+# Copyright 2008 Garry Collum and the Koha Koha Development team
+# Copyright 2010 BibLibre
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 # Script to perform searching
 # Mostly copied from search.pl, see POD there
 use strict;            # always use
@@ -11,13 +30,18 @@ use warnings;
 use C4::Context;
 use C4::Output;
 use C4::Auth qw(:DEFAULT get_session);
+use C4::Languages qw(getAllLanguages);
 use C4::Search;
 use C4::Biblio;  # GetBiblioData
 use C4::Koha;
 use C4::Tags qw(get_tags);
-use POSIX qw(ceil floor strftime);
 use C4::Branch; # GetBranches
+use POSIX qw(ceil floor strftime);
+use URI::Escape;
+use Storable qw(thaw freeze);
 
+
+my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
 # create a new CGI object
 # FIXME: no_undef_params needs to be tested
 use CGI qw('-no_undef_params');
@@ -37,8 +61,9 @@ my $template_name;
 my $template_type = 'basic';
 my @params = $cgi->param("limit");
 
+my $format = $cgi->param("format") || '';
 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
-if ($cgi->param("format") && $cgi->param("format") =~ /(rss|atom|opensearchdescription)/) {
+if ($format =~ /(rss|atom|opensearchdescription)/) {
        $template_name = 'opac-opensearch.tmpl';
 }
 elsif ($build_grouped_results) {
@@ -56,28 +81,24 @@ else {
     template_name => $template_name,
     query => $cgi,
     type => "opac",
-    authnotrequired => 1,
+    authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
     }
 );
 
-if ($cgi->param("format") && $cgi->param("format") eq 'rss2') {
-       $template->param("rss2" => 1);
-}
-elsif ($cgi->param("format") && $cgi->param("format") eq 'atom') {
-       $template->param("atom" => 1);
+if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
+       $template->param($format => 1);
+    $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom'); 
     # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
     # entry, but not sure if that's worth an extra database query for each bib
-    $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime));
-}
-elsif ($cgi->param("format") && $cgi->param("format") eq 'opensearchdescription') {
-       $template->param("opensearchdescription" => 1);
 }
 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
     $template->param('UNIMARC' => 1);
 }
-if (C4::Context->preference("marcflavour") eq "MARC21" ) {
+elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
     $template->param('usmarc' => 1);
 }
+$template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
+$template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
 
 if (C4::Context->preference('BakerTaylorEnabled')) {
        $template->param(
@@ -119,22 +140,15 @@ if (C4::Context->preference('TagsEnabled')) {
 #}
 
 # load the branches
-my $mybranch = ( C4::Context->preference( 'SearchMyLibraryFirst' ) && C4::Context->userenv ) ? C4::Context->userenv->{branch} : '';
-my $branches = GetBranches();
-# FIXME: next line duplicates GetBranchesLoop(0,0);
-my @branch_loop = map {
-                    {
-                        value => $_,
-                        branchname => $branches->{$_}->{branchname},
-                        selected => ( $mybranch eq $_ ) ? 1 : 0
-                    }
-                } sort {
-                    $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname}
-                } keys %$branches;
 
-my $categories = GetBranchCategories(undef,'searchdomain');
+my $branches = GetBranches();   # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
+$template->param(
+    searchdomainloop => GetBranchCategories(undef,'searchdomain'),
+);
 
-$template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
+# load the language limits (for search)
+my $languages_limit_loop = getAllLanguages();
+$template->param(search_languages_loop => $languages_limit_loop,);
 
 # load the Type stuff
 my $itemtypes = GetItemTypes;
@@ -147,7 +161,7 @@ my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
 
 if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
        foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
-    my %row =(  number=>$cnt++,
+        my %row =(  number=>$cnt++,
                                ccl => $itype_or_itemtype,
                 code => $thisitemtype,
                 selected => $selected,
@@ -155,12 +169,11 @@ if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
                 count5 => $cnt % 4,
                 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
             );
-       $selected = 0 if ($selected) ;
+       $selected = 0; # set to zero after first pass through
        push @itemtypesloop, \%row;
        }
-       $template->param(itemtypeloop => \@itemtypesloop);
 } else {
-    my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
+    my $advsearchtypes = GetAuthorisedValues($advanced_search_types, '', 'opac');
        for my $thisitemtype (@$advsearchtypes) {
                my %row =(
                                number=>$cnt++,
@@ -173,8 +186,8 @@ if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
             );
                push @itemtypesloop, \%row;
        }
-       $template->param(itemtypeloop => \@itemtypesloop);
 }
+$template->param(itemtypeloop => \@itemtypesloop);
 
 # # load the itypes (Called item types in the template -- just authorized values for searching)
 # my ($itypecount,@itype_loop) = GetCcodes();
@@ -187,7 +200,7 @@ if ( $template_type && $template_type eq 'advsearch' ) {
     my $primary_servers_loop;# = displayPrimaryServers();
     $template->param(outer_servers_loop =>  $primary_servers_loop,);
     
-    my $secondary_servers_loop;# = displaySecondaryServers();
+    my $secondary_servers_loop;
     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 
     # set the default sorting
@@ -199,7 +212,7 @@ if ( $template_type && $template_type eq 'advsearch' ) {
     # shouldn't appear on the first one, scan indexes should, adding a new
     # box should only appear on the last, etc.
     my @search_boxes_array;
-    my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") || 3; # FIXME: should be a syspref
+    my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") || 3;
     for (my $i=1;$i<=$search_boxes_count;$i++) {
         # if it's the first one, don't display boolean option, but show scan indexes
         if ($i==1) {
@@ -225,19 +238,20 @@ if ( $template_type && $template_type eq 'advsearch' ) {
         }
 
     }
-    $template->param(uc(C4::Context->preference("marcflavour")) => 1,
+    $template->param(uc(C4::Context->preference("marcflavour")) => 1,   # we already did this for UNIMARC
                                          advsearch => 1,
                       search_boxes_loop => \@search_boxes_array);
 
 # use the global setting by default
-       if ( C4::Context->preference("expandedSearchOption") ) {
+       if ( C4::Context->preference("expandedSearchOption") == 1 ) {
                $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
        }
        # but let the user override it
-       if ( $cgi->param("expanded_options") && (($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 )) ) {
-       $template->param( expanded_options => $cgi->param('expanded_options'));
-       }
-
+       if (defined $cgi->param('expanded_options')) {
+           if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
+           $template->param( expanded_options => $cgi->param('expanded_options'));
+           }
+        }
     output_html_with_http_headers $cgi, $cookie, $template->output;
     exit;
 }
@@ -262,7 +276,7 @@ my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Co
 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
 foreach my $sort (@sort_by) {
-    $template->param($sort => 1);
+    $template->param($sort => 1);   # FIXME: security hole.  can set any TMPL_VAR here
 }
 $template->param('sort_by' => $sort_by[0]);
 
@@ -303,7 +317,7 @@ my @limits;
 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
 
 if($params->{'multibranchlimit'}) {
-push @limits, join(" or ", map { "branch: $_ "}  @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
+    push @limits, '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
 }
 
 my $available;
@@ -344,7 +358,8 @@ my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_
 my @results;
 
 ## I. BUILD THE QUERY
-( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
+my $lang = C4::Output::getlanguagecookie($cgi);
+( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by, 0, $lang);
 
 sub _input_cgi_parse ($) { 
     my @elements;
@@ -364,11 +379,11 @@ $template->param ( QUERY_INPUTS => \@query_inputs );
 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
 
 # add OPAC 'hidelostitems'
-if (C4::Context->preference('hidelostitems') == 1) {
-    # either lost ge 0 or no value in the lost register
-    $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
-}
-
+#if (C4::Context->preference('hidelostitems') == 1) {
+#    # either lost ge 0 or no value in the lost register
+#    $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
+#}
+#
 # add OPAC suppression - requires at least one item indexed with Suppress
 if (C4::Context->preference('OpacSuppression')) {
     $query = "($query) not Suppress=1";
@@ -384,6 +399,7 @@ my $results_hashref;
 my @coins;
 
 if ($tag) {
+       $query_cgi = "tag=" .$tag . "&" . $query_cgi;
        my $taglist = get_tags({term=>$tag, approved=>1});
        $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
        my @biblist  = (map {GetBiblioData($_->{biblionumber})} @$taglist);
@@ -406,6 +422,13 @@ elsif (C4::Context->preference('NoZebra')) {
         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
     };
 }
+# This sorts the facets into alphabetical order
+if ($facets) {
+    foreach my $f (@$facets) {
+        $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
+    }
+}
+
 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
 if ($@ || $error) {
     $template->param(query_error => $error.$@);
@@ -416,7 +439,7 @@ if ($@ || $error) {
 # At this point, each server has given us a result set
 # now we build that set for template display
 my @sup_results_array;
-for (my $i=0;$i<=@servers;$i++) {
+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"};
@@ -427,18 +450,20 @@ for (my $i=0;$i<=@servers;$i++) {
                 # because pazGetRecords handles retieving only the records
                 # we want as specified by $offset and $results_per_page,
                 # we need to set the offset parameter of searchResults to 0
-                my @group_results = searchResults( $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
-                                                   @{ $group->{"RECORDS"} });
+                my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
+                                                   @{ $group->{"RECORDS"} }, C4::Context->preference('hidelostitems'));
                 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
             }
         } else {
-            @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,$scan,@{$results_hashref->{$server}->{"RECORDS"}});
+            @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
+                                        @{$results_hashref->{$server}->{"RECORDS"}},, C4::Context->preference('hidelostitems'));
         }
                my $tag_quantity;
                if (C4::Context->preference('TagsEnabled') and
                        $tag_quantity = C4::Context->preference('TagsShowOnList')) {
                        foreach (@newresults) {
                                my $bibnum = $_->{biblionumber} or next;
+                               $_->{itemsissued} = CountItemsIssued( $bibnum );
                                $_ ->{'TagLoop'} = get_tags({biblionumber=>$bibnum, approved=>1, 'sort'=>'-weight',
                                                                                limit=>$tag_quantity });
                        }
@@ -450,8 +475,56 @@ for (my $i=0;$i<=@servers;$i++) {
        if ($results_hashref->{$server}->{"hits"}){
            $total = $total + $results_hashref->{$server}->{"hits"};
        }
-        ## If there's just one result, redirect to the detail page
-        if ($total == 1) {         
+       # Opac search history
+       my $newsearchcookie;
+       if (C4::Context->preference('EnableOpacSearchHistory')) {
+           my @recentSearches; 
+           # Getting the (maybe) already sent cookie
+           my $searchcookie = $cgi->cookie('KohaOpacRecentSearches');
+           if ($searchcookie){
+               $searchcookie = uri_unescape($searchcookie);
+               if (thaw($searchcookie)) {
+                   @recentSearches = @{thaw($searchcookie)};
+               }
+           }
+           # Adding the new search if needed
+           if (!$borrowernumber || $borrowernumber eq '') {
+           # To a cookie (the user is not logged in)
+               if (($params->{'offset'}||'') eq '') {
+                   push @recentSearches, {
+                                           "query_desc" => $query_desc || "unknown", 
+                                           "query_cgi"  => $query_cgi  || "unknown", 
+                                           "time"       => time(),
+                                           "total"      => $total
+                                         };
+                   $template->param(ShowOpacRecentSearchLink => 1);
+               }
+            shift @recentSearches if (@recentSearches > 15);
+               # Pushing the cookie back 
+               $newsearchcookie = $cgi->cookie(
+                                           -name => 'KohaOpacRecentSearches',
+                                           # We uri_escape the whole freezed structure so we're sure we won't have any encoding problems
+                                           -value => uri_escape(freeze(\@recentSearches)),
+                                           -expires => ''
+                       );
+                       $cookie = [$cookie, $newsearchcookie];
+           } 
+               else {
+           # To the session (the user is logged in)
+                       if (($params->{'offset'}||'') eq '') {
+                               AddSearchHistory($borrowernumber, $cgi->cookie("CGISESSID"), $query_desc, $query_cgi, $total);
+                   $template->param(ShowOpacRecentSearchLink => 1);
+               }
+           }
+       }
+    ## If there's just one result, redirect to the detail page
+        if ($total == 1 && $format ne 'rss2'
+           && $format ne 'opensearchdescription' && $format ne 'atom') {   
             my $biblionumber=$newresults[0]->{biblionumber};
             if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
                 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
@@ -471,6 +544,8 @@ for (my $i=0;$i<=@servers;$i++) {
             $template->param(query_cgi => $query_cgi);
             $template->param(query_desc => $query_desc);
             $template->param(limit_desc => $limit_desc);
+            $template->param(offset     => $offset);
+            $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
             if ($query_desc || $limit_desc) {
                 $template->param(searchdesc => 1);
             }
@@ -535,7 +610,6 @@ for (my $i=0;$i<=@servers;$i++) {
         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
             my $title_field = $marc_record_object->field(100);
-             warn "Authority Found: ".$marc_record_object->as_formatted();
             push @inner_sup_results_array, {
                 'title' => $title_field->subfield('a'),
                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
@@ -555,6 +629,7 @@ $template->param(
             total => $total,
             opacfacets => 1,
             facets_loop => $facets,
+           displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
             scan => $scan,
             search_error => $error,
 );
@@ -563,52 +638,6 @@ if ($query_desc || $limit_desc) {
     $template->param(searchdesc => 1);
 }
 
-## Now let's find out if we have any supplemental data to show the user
-#  and in the meantime, save the current query for statistical purposes, etc.
-my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
-my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
-my $phrases = $query_desc;
-my $ipaddress;
-
-if ( C4::Context->preference("kohaspsuggest") ) {
-        my ($suggest_host, $suggest_dbname, $suggest_user, $suggest_pwd) = split(':', C4::Context->preference("kohaspsuggest"));
-        eval {
-            my $koha_spsuggest_dbh;
-            # FIXME: this needs to be moved to Context.pm
-            eval {
-                $koha_spsuggest_dbh=DBI->connect("DBI:mysql:$suggest_dbname:$suggest_host","$suggest_user","$suggest_pwd");
-            };
-            if ($@) { 
-                warn "can't connect to spsuggest db";
-            }
-            else {
-                my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
-                my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
-                my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
-                $koha_spsuggest_sth->execute($phrases);
-                while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
-                    $spsuggestion =~ s/(:|\/)//g;
-                    my %line;
-                    $line{spsuggestion} = $spsuggestion;
-                    push @koha_spsuggest,\%line;
-                    $koha_spsuggest = 1;
-                }
-
-                # Now save the current query
-                $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
-                #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
-                $koha_spsuggest_sth->finish;
-
-                $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
-                $template->param( SPELL_SUGGEST => \@koha_spsuggest,
-                );
-            }
-    };
-    if ($@) {
-            warn "Kohaspsuggest failure:".$@;
-    }
-}
-
 # VI. BUILD THE TEMPLATE
 # Build drop-down list for 'Add To:' menu...
 my $session = get_session($cgi->cookie("CGISESSID"));
@@ -630,15 +659,7 @@ if (defined $barshelves) {
        $template->param( addbarshelvesloop => $barshelves);
 }
 
-my $content_type;
-
-if ($cgi->param('format') && $cgi->param('format') =~ /rss/) {
-    $content_type = 'rss'
-} elsif ($cgi->param('format') && $cgi->param('format') =~ /atom/) {
-    $content_type = 'atom'
-} else {
-    $content_type = 'html'
-}
+my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
 
 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens 
 if (C4::Context->preference('GoogleIndicTransliteration')) {