#!/usr/bin/perl
-# Script to perform searching
-# For documentation try 'perldoc /path/to/search'
-#
-# $Header$
-#
-# Copyright 2006 LibLime
+# Copyright 2008 Garry Collum and the Koha Koha Development team
#
-# This file is part of Koha
+# 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
# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
# Suite 330, Boston, MA 02111-1307 USA
-=head1 NAME
-
-search - a search script for finding records in a Koha system (Version 2.4)
-
-=head1 OVERVIEW
-
-This script contains a demonstration of a new search API for Koha 2.4. It is
-designed to be simple to use and configure, yet capable of performing feats
-like stemming, field weighting, relevance ranking, support for multiple
-query language formats (CCL, CQL, PQF), full or nearly full support for the
-bib1 attribute set, extended attribute sets defined in Zebra profiles, access
-to the full range of Z39.50 query options, federated searches on Z39.50
-targets, etc.
-
-I believe the API as represented in this script is mostly sound, even if the
-individual functions in Search.pm and Koha.pm need to be cleaned up. Of course,
-you are free to disagree :-)
-
-I will attempt to describe what is happening at each part of this script.
--- JF
-
-=head2 INTRO
-
-This script performs two functions:
-
-=over
-
-=item 1. interacts with Koha to retrieve and display the results of a search
-
-=item 2. loads the advanced search page
-
-=back
-
-These two functions share many of the same variables and modules, so the first
-task is to load what they have in common and determine which template to use.
-Once determined, proceed to only load the variables and procedures necessary
-for that function.
-
-=head2 THE ADVANCED SEARCH PAGE
-
-If we're loading the advanced search page this script will call a number of
-display* routines which populate objects that are sent to the template for
-display of things like search indexes, languages, search limits, branches,
-etc. These are not stored in the template for two reasons:
-
-=over
-
-=item 1. Efficiency - we have more control over objects inside the script, and it's possible to not duplicate things like indexes (if the search indexes were stored in the template they would need to be repeated)
-
-=item 2. Customization - if these elements were moved to the sql database it would allow a simple librarian to determine which fields to display on the page without editing any html (also how the fields should behave when being searched).
-
-=back
-
-However, they create one problem : the strings aren't translated. I have an idea
-for how to do this that I will purusue soon.
-
-=head2 PERFORMING A SEARCH
-
-If we're performing a search, this script performs three primary
-operations:
-
-=over
-
-=item 1. builds query strings (yes, plural)
-
-=item 2. perform the search and return the results array
-
-=item 3. build the HTML for output to the template
-
-=back
-
-There are several additional secondary functions performed that I will
-not cover in detail.
-
-=head3 1. Building Query Strings
-
-There are several types of queries needed in the process of search and retrieve:
-
-=over
-
-=item 1 Koha query - the query that is passed to Zebra
-
-This is the most complex query that needs to be built.The original design goal was to use a custom CCL2PQF query parser to translate an incoming CCL query into a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field weighting, koha-specific relevance ranking, and stemming. When I have a chance I'll try to flesh out this section to better explain.
-
-This query incorporates query profiles that aren't compatible with non-Zebra Z39.50 targets to acomplish the field weighting and relevance ranking.
-
-=item 2 Federated query - the query that is passed to other Z39.50 targets
-
-This query is just the user's query expressed in CCL CQL, or PQF for passing to a non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
-
-=item 3 Search description - passed to the template / saved for future refinements of the query (by user)
-
-This is a simple string that completely expresses the query in a way that can be parsed by Koha for future refinements of the query or as a part of a history feature. It differs from the human search description in several ways:
-
-1. it does not contain commas or = signs
-2.
-
-=item 4 Human search description - what the user sees in the search_desc area
-
-This is a simple string nearly identical to the Search description, but more human readable. It will contain = signs or commas, etc.
-
-=back
-
-=head3 2. Perform the Search
-
-This section takes the query strings and performs searches on the named servers, including the Koha Zebra server, stores the results in a deeply nested object, builds 'faceted results', and returns these objects.
-
-=head3 3. Build HTML
-
-The final major section of this script takes the objects collected thusfar and builds the HTML for output to the template and user.
-
-=head3 Additional Notes
-
-Not yet completed...
-
-=cut
-
-use strict; # always use
-
-#use warnings; # use only for development
+# Script to perform searching
+# Mostly copied from search.pl, see POD there
+use strict; # always use
+use warnings;
## STEP 1. Load things that are used in both search page and
-# results page and decide which template to load, operations
+# results page and decide which template to load, operations
# to perform, etc.
## load Koha modules
use C4::Context;
use C4::Output;
-use C4::Auth;
+use C4::Auth qw(:DEFAULT get_session);
+use C4::Languages qw(getAllLanguages);
use C4::Search;
-use C4::Languages; # getAllLanguages
+use C4::Biblio; # GetBiblioData
use C4::Koha;
+use C4::Tags qw(get_tags);
use C4::Branch; # GetBranches
-use POSIX qw(ceil floor);
+use POSIX qw(ceil floor strftime);
+use URI::Escape;
+use Storable qw(thaw freeze);
+
# create a new CGI object
-# not sure undef_params option is working, need to test
+# FIXME: no_undef_params needs to be tested
use CGI qw('-no_undef_params');
my $cgi = new CGI;
-my ( $template, $borrowernumber, $cookie );
+BEGIN {
+ if (C4::Context->preference('BakerTaylorEnabled')) {
+ require C4::External::BakerTaylor;
+ import C4::External::BakerTaylor qw(&image_url &link_url);
+ }
+}
+
+my ($template,$borrowernumber,$cookie);
# decide which template to use
my $template_name;
+my $template_type = 'basic';
my @params = $cgi->param("limit");
-if ( ( @params > 1 ) || ( $cgi->param("q") ) ) {
- $template_name = 'opac-results.tmpl';
+my $format = $cgi->param("format") || '';
+my $build_grouped_results = C4::Context->preference('OPACGroupResults');
+if ($format =~ /(rss|atom|opensearchdescription)/) {
+ $template_name = 'opac-opensearch.tmpl';
+}
+elsif ($build_grouped_results) {
+ $template_name = 'opac-results-grouped.tmpl';
+}
+elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
+ $template_name = 'opac-results.tmpl';
}
else {
-
$template_name = 'opac-advsearch.tmpl';
+ $template_type = 'advsearch';
}
-
# load the template
-( $template, $borrowernumber, $cookie ) = get_template_and_user(
- {
- template_name => $template_name,
- query => $cgi,
- type => "opac",
- authnotrequired => 1,
+($template, $borrowernumber, $cookie) = get_template_and_user({
+ template_name => $template_name,
+ query => $cgi,
+ type => "opac",
+ authnotrequired => 1,
}
);
-=head1 BUGS and FIXMEs
-
-There are many, most are documented in the code. The one that
-isn't fully documented, but referred to is the need for a full
-query parser.
-
-=cut
+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
+}
+if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
+ $template->param('UNIMARC' => 1);
+}
+elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
+ $template->param('usmarc' => 1);
+}
+$template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
+
+if (C4::Context->preference('BakerTaylorEnabled')) {
+ $template->param(
+ BakerTaylorEnabled => 1,
+ BakerTaylorImageURL => &image_url(),
+ BakerTaylorLinkURL => &link_url(),
+ BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
+ );
+}
+if (C4::Context->preference('TagsEnabled')) {
+ $template->param(TagsEnabled => 1);
+ foreach (qw(TagsShowOnList TagsInputOnList)) {
+ C4::Context->preference($_) and $template->param($_ => 1);
+ }
+}
## URI Re-Writing
-# FIXME: URI re-writing should be tested more carefully and may better
-# handled by mod_rewrite or something else. The code below almost works,
-# but doesn't quite handle limits correctly when they are the only
-# param passed -- I'll work on this soon -- JF
+# Deprecated, but preserved because it's interesting :-)
+# The same thing can be accomplished with mod_rewrite in
+# a more elegant way
+#
#my $rewrite_flag;
#my $uri = $cgi->url(-base => 1);
#my $relative_url = $cgi->url(-relative=>1);
#warn "URI:$uri";
#my @cgi_params_list = $cgi->param();
#my $url_params = $cgi->Vars;
-
+#
#for my $each_param_set (@cgi_params_list) {
# $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
#}
#}
# load the branches
-my $branches = GetBranches();
-my @branch_loop;
-for my $branch_hash (sort keys %$branches ) {
- my $selected=(C4::Context->userenv && ($branch_hash eq C4::Context->userenv->{branch})) if (C4::Context->preference('SearchMyLibraryFirst'));
- push @branch_loop,
- {
- value => "branch: $branch_hash",
- branchname => $branches->{$branch_hash}->{'branchname'},
- selected => $selected
- };
-}
-$template->param( branchloop => \@branch_loop, "mylibraryfirst"=>C4::Context->preference("SearchMyLibraryFirst"));
+my $mybranch = ( C4::Context->preference('SearchMyLibraryFirst') && C4::Context->userenv && C4::Context->userenv->{branch} ) ? C4::Context->userenv->{branch} : '';
+my $branches = GetBranches(); # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
+$template->param(
+ branchloop => GetBranchesLoop($mybranch, 0),
+ searchdomainloop => GetBranchCategories(undef,'searchdomain'),
+);
+
+# load the language limits (for search)
+my $languages_limit_loop = getAllLanguages();
+$template->param(search_languages_loop => $languages_limit_loop,);
-# load the itemtypes (Called Collection Codes in the template -- used for circ rules )
+# load the Type stuff
my $itemtypes = GetItemTypes;
+# the index parameter is different for item-level itemtypes
+my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
my @itemtypesloop;
-my $selected = 1;
+my $selected=1;
my $cnt;
-my $imgdir = getitemtypeimagesrc();
-foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
- my %row = (
- number => $cnt++,
- imageurl => $itemtypes->{$thisitemtype}->{'imageurl'}?$imgdir . "/" . $itemtypes->{$thisitemtype}->{'imageurl'}:'',
- code => $thisitemtype,
- selected => $selected,
- description => $itemtypes->{$thisitemtype}->{'description'},
- count5 => $cnt % 4,
- );
- $selected = 0 if ($selected);
- push @itemtypesloop, \%row;
+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++,
+ ccl => $itype_or_itemtype,
+ code => $thisitemtype,
+ selected => $selected,
+ description => $itemtypes->{$thisitemtype}->{'description'},
+ count5 => $cnt % 4,
+ imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
+ );
+ $selected = 0; # set to zero after first pass through
+ push @itemtypesloop, \%row;
+ }
+} else {
+ my $advsearchtypes = GetAuthorisedValues($advanced_search_types, '', 'opac');
+ for my $thisitemtype (@$advsearchtypes) {
+ my %row =(
+ number=>$cnt++,
+ ccl => $advanced_search_types,
+ code => $thisitemtype->{authorised_value},
+ selected => $selected,
+ description => $thisitemtype->{'lib'},
+ count5 => $cnt % 4,
+ imageurl=> getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
+ );
+ 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();
# $template->param(itypeloop=>\@itype_loop,);
-# load the languages ( for switching from one template to another )
-# my @languages_options = displayLanguages($cgi);
-# my $languages_count = @languages_options;
-# if($languages_count > 1){
-# $template->param(languages => \@languages_options);
-# }
-
# The following should only be loaded if we're bringing up the advanced search template
-if ( $template_name eq "opac-advsearch.tmpl" ) {
+if ( $template_type && $template_type eq 'advsearch' ) {
# load the servers (used for searching -- to do federated searching, etc.)
- my $primary_servers_loop; # = displayPrimaryServers();
- $template->param( outer_servers_loop => $primary_servers_loop, );
+ my $primary_servers_loop;# = displayPrimaryServers();
+ $template->param(outer_servers_loop => $primary_servers_loop,);
+
+ my $secondary_servers_loop;
+ $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
- my $secondary_servers_loop; # = displaySecondaryServers();
- $template->param( outer_sup_servers_loop => $secondary_servers_loop, );
+ # set the default sorting
+ my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder')
+ if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
+ $template->param($default_sort_by => 1);
# determine what to display next to the search boxes (ie, boolean option
# shouldn't appear on the first one, scan indexes should, adding a new
# box should only appear on the last, etc.
- # FIXME: this stuff should be cleaned up a bit and the html should be turned
- # into flags for the template -- I'll work on that soon -- JF
my @search_boxes_array;
- my $search_boxes_count = 1; # should be a syspref
- for ( my $i = 0 ; $i <= $search_boxes_count ; $i++ ) {
- if ( $i == 0 ) {
+ 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) {
push @search_boxes_array,
- {
- search_boxes_label => "<span class='labels'>Search for:</span>",
- scan_index => 1,
- };
-
+ {
+ scan_index => 1,
+ };
+
}
- elsif ( $i == $search_boxes_count ) {
+ # if it's the last one, show the 'add field' box
+ elsif ($i==$search_boxes_count) {
push @search_boxes_array,
- {
- left_content =>
-" <select name='op'><option value='and' selected='selected'>and</option><option value='or'>or</option><option value='not'>not</option></select>",
- add_field => "1"
- };
+ {
+ boolean => 1,
+ add_field => 1,
+ };
}
else {
push @search_boxes_array,
- {
- left_content =>
-" <select name='op'><option value='and' selected='selected'>and</option><option value='or'>or</option><option value='not'>not</option></select>",
- };
+ {
+ boolean => 1,
+ };
}
- }
- $template->param(
- uc( C4::Context->preference("marcflavour") ) => 1,
- search_boxes_loop => \@search_boxes_array
- );
-
- # load the language limits (for search)
- my $languages_limit_loop = getAllLanguages();
- $template->param( search_languages_loop => $languages_limit_loop, );
-
- my $expanded_options;
- if ( C4::Context->preference("expandedSearchOption") ) {
- $expanded_options = C4::Context->preference("expandedSearchOption");
- }
- else {
- $expanded_options = $cgi->param('expanded_options');
- }
-
- $template->param( expanded_options => $expanded_options );
-
- # load the sort_by options for the template
- my $sort_by = $cgi->param('sort_by');
- $sort_by=$1.($2 eq "lt"?'d':'a') if ($sort_by=~/1=(\d+) \&([a-z]+)\;/);
- $template->param( sort_by => $sort_by);
+ }
+ $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") == 1 ) {
+ $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
+ }
+ # but let the user override it
+ 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;
}
# * we can edit the values by changing the key
# * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
my $params = $cgi->Vars;
+my $tag;
+$tag = $params->{tag} if $params->{tag};
# Params that can have more than one value
# sort by is used to sort the query
+# in theory can have more than one but generally there's just one
my @sort_by;
-@sort_by = split( "\0", $params->{'sort_by'} ) if $params->{'sort_by'};
+my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder')
+ if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
-# load the sort_by options for the template
-my $sort_by = $params->{'sort_by'};
-$sort_by=~$1.($2 eq "lt"?'d':'a') if ($sort_by=~/1=(\d+) \&([a-z]+)\;/);
-$template->param( sort_by => $sort_by);
+@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); # FIXME: security hole. can set any TMPL_VAR here
+}
+$template->param('sort_by' => $sort_by[0]);
-#
# Use the servers defined, or just search our local catalog(default)
my @servers;
-@servers = split( "\0", $params->{'server'} ) if $params->{'server'};
+@servers = split("\0",$params->{'server'}) if $params->{'server'};
unless (@servers) {
-
#FIXME: this should be handled using Context.pm
@servers = ("biblioserver");
-
# @servers = C4::Context->config("biblioserver");
}
# operators include boolean and proximity operators and are used
# to evaluate multiple operands
my @operators;
-@operators = split( "\0", $params->{'op'} ) if $params->{'op'};
+@operators = split("\0",$params->{'op'}) if $params->{'op'};
# indexes are query qualifiers, like 'title', 'author', etc. They
-# can be simple or complex
+# can be single or multiple parameters separated by comma: kw,right-Truncation
my @indexes;
-if ($params->{'idx'}) {
- @indexes = split("\0",$params->{'idx'});
-} else {
- $indexes[0] = 'kw,wrdl';
-}
+@indexes = split("\0",$params->{'idx'}) if $params->{'idx'};
+# if a simple index (only one) display the index used in the top search box
+if ($indexes[0] && !$indexes[1]) {
+ $template->param("ms_".$indexes[0] => 1);
+}
# an operand can be a single term, a phrase, or a complete ccl query
my @operands;
-@operands = split( "\0", $params->{'q'} ) if $params->{'q'};
+@operands = split("\0",$params->{'q'}) if $params->{'q'};
+
+# if a simple search, display the value in the search box
+if ($operands[0] && !$operands[1]) {
+ $template->param(ms_value => $operands[0]);
+}
# limits are use to limit to results to a pre-defined category such as branch or language
my @limits;
-@limits = split( "\0", $params->{'limit'} ) if $params->{'limit'};
+@limits = split("\0",$params->{'limit'}) if $params->{'limit'};
+
+if($params->{'multibranchlimit'}) {
+push @limits, join(" or ", map { "branch: $_ "} @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
+}
my $available;
-foreach my $limit (@limits) {
- if ( $limit =~ /available/ ) {
+foreach my $limit(@limits) {
+ if ($limit =~/available/) {
$available = 1;
}
}
-$template->param( available => $available );
-push @limits, map "yr:" . $_, split( "\0", $params->{'limit-yr'} )
- if $params->{'limit-yr'};
+$template->param(available => $available);
+
+# append year limits if they exist
+if ($params->{'limit-yr'}) {
+ if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
+ my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
+ push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
+ }
+ elsif ($params->{'limit-yr'} =~ /\d{4}/) {
+ push @limits, "yr,st-numeric=$params->{'limit-yr'}";
+ }
+ else {
+ #FIXME: Should return a error to the user, incorect date format specified
+ }
+}
# Params that can only have one value
-my $query = $params->{'q'};
-my $scan = $params->{'scan'};
-my $results_per_page = $params->{'count'} || 20;
-my $offset = $params->{'offset'} || 0;
+my $scan = $params->{'scan'};
+my $count = C4::Context->preference('OPACnumSearchResults') || 20;
+my $results_per_page = $params->{'count'} || $count;
+my $offset = $params->{'offset'} || 0;
+my $page = $cgi->param('page') || 1;
+$offset = ($page-1)*$results_per_page if $page>1;
my $hits;
my $expanded_facet = $params->{'expand'};
# Define some global variables
-my $error; # used for error handling
-my $search_desc; # the query expressed in terms that humans understand
-my $koha_query; # the query expressed in terms that zoom understands with field weighting and stemming
-my $federated_query;
-my $query_type; # usually not needed, but can be used to trigger ccl, cql, or pqf queries if set
+my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
+
my @results;
## I. BUILD THE QUERY
-( $error, $search_desc, $koha_query, $federated_query, $query_type ) =
- buildQuery( $query, \@operators, \@operands, \@indexes, \@limits );
+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;
+ for my $this_cgi ( split('&',shift) ) {
+ next unless $this_cgi;
+ $this_cgi =~ /(.*?)=(.*)/;
+ push @elements, { input_name => $1, input_value => $2 };
+ }
+ return @elements;
+}
+
+## parse the query_cgi string and put it into a form suitable for <input>s
+my @query_inputs = _input_cgi_parse($query_cgi);
+$template->param ( QUERY_INPUTS => \@query_inputs );
+
+## parse the limit_cgi string and put it into a form suitable for <input>s
+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='') )";
+#}
+#
+# add OPAC suppression - requires at least one item indexed with Suppress
+if (C4::Context->preference('OpacSuppression')) {
+ $query = "($query) not Suppress=1";
+}
+
+$template->param ( LIMIT_INPUTS => \@limit_inputs );
-# warn "query : $koha_query";
## II. DO THE SEARCH AND GET THE RESULTS
-my $total; # the total results for the whole set
+my $total = 0; # the total results for the whole set
my $facets; # this object stores the faceted results that display on the left-hand of the results page
my @results_array;
my $results_hashref;
-
-if (C4::Context->preference('NoZebra')) {
+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);
+ my @marclist = (map {$_->{marc}} @biblist );
+ $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
+ $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
+ # FIXME: tag search and standard search should work together, not exclusively
+ # FIXME: No facets for tags search.
+}
+elsif (C4::Context->preference('NoZebra')) {
+ eval {
+ ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+ };
+} elsif ($build_grouped_results) {
eval {
- ($error, $results_hashref, $facets) = NZgetRecords($koha_query,$federated_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+ ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
};
} else {
eval {
- ($error, $results_hashref, $facets) = getRecords($koha_query,$federated_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+ ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
};
}
-if ( $@ || $error ) {
- $template->param( query_error => $error . $@ );
-
- # warn "error: ".$error.$@;
+# use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
+if ($@ || $error) {
+ $template->param(query_error => $error.$@);
output_html_with_http_headers $cgi, $cookie, $template->output;
exit;
}
# 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 =~ /biblioserver/ ) { # this is the local bibliographic server
+ if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
$hits = $results_hashref->{$server}->{"hits"};
- my @newresults =
- searchResults( $search_desc, $hits, $results_per_page, $offset,
- @{ $results_hashref->{$server}->{"RECORDS"} } );
- $total = $total + $results_hashref->{$server}->{"hits"};
+ my $page = $cgi->param('page') || 0;
+ my @newresults;
+ if ($build_grouped_results) {
+ foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
+ # 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"} }, 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"}},, 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 });
+ }
+ }
+ foreach (@newresults) {
+ $_->{coins} = GetCOinSBiblio($_->{'biblionumber'});
+ }
+
+ if ($results_hashref->{$server}->{"hits"}){
+ $total = $total + $results_hashref->{$server}->{"hits"};
+ }
+ # 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 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);
+ }
+
+ # 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) {
+ my $biblionumber=$newresults[0]->{biblionumber};
+ if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
+ print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
+ } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
+ print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
+ } else {
+ print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
+ }
+ exit;
+ }
if ($hits) {
- $template->param( total => $hits );
- $template->param( searchdesc => $search_desc );
- $template->param( results_per_page => $results_per_page );
- $template->param( SEARCH_RESULTS => \@newresults );
-
+ $template->param(total => $hits);
+ my $limit_cgi_not_availablity = $limit_cgi;
+ $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
+ $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
+ $template->param(limit_cgi => $limit_cgi);
+ $template->param(query_cgi => $query_cgi);
+ $template->param(query_desc => $query_desc);
+ $template->param(limit_desc => $limit_desc);
+ if ($query_desc || $limit_desc) {
+ $template->param(searchdesc => 1);
+ }
+ $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
+ $template->param(results_per_page => $results_per_page);
+ $template->param(SEARCH_RESULTS => \@newresults,
+ OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay") eq "itemdetails"?1:0),
+ );
+ ## Build the page numbers on the bottom of the page
my @page_numbers;
- my $pages = ceil( $hits / $results_per_page );
+ # total number of pages there will be
+ my $pages = ceil($hits / $results_per_page);
+ # default page number
my $current_page_number = 1;
- $current_page_number = ( $offset / $results_per_page + 1 )
- if $offset;
- my $previous_page_offset = $offset - $results_per_page
- unless ( $offset - $results_per_page < 0 );
+ $current_page_number = ($offset / $results_per_page + 1) if $offset;
+ my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
my $next_page_offset = $offset + $results_per_page;
- for ( $i = 1 ; $i <= $pages ; $i++ ) {
- my $this_offset =
- ( ( $i * $results_per_page ) - $results_per_page );
- my $this_page_number = $i;
- my $highlight = 1
- if ( $this_page_number == $current_page_number );
- if ($this_page_number <= $pages) {
- push @page_numbers,
- {
- offset => $this_offset,
- pg => $this_page_number,
- highlight => $highlight,
- sort_by => join " ",
- @sort_by
- };
+ # If we're within the first 10 pages, keep it simple
+ #warn "current page:".$current_page_number;
+ if ($current_page_number < 10) {
+ # just show the first 10 pages
+ # Loop through the pages
+ my $pages_to_show = 10;
+ $pages_to_show = $pages if $pages<10;
+ for ($i=1; $i<=$pages_to_show;$i++) {
+ # the offset for this page
+ my $this_offset = (($i*$results_per_page)-$results_per_page);
+ # the page number for this page
+ my $this_page_number = $i;
+ # it should only be highlighted if it's the current page
+ my $highlight = 1 if ($this_page_number == $current_page_number);
+ # put it in the array
+ push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
+
}
+
}
- $template->param(
- PAGE_NUMBERS => \@page_numbers,
- previous_page_offset => $previous_page_offset,
- next_page_offset => $next_page_offset
- ) unless $pages < 2;
- }
- } # end of the if local
- else {
-
- # check if it's a z3950 or opensearch source
- my $zed3950 = 0; # FIXME :: Hardcoded value.
- if ($zed3950) {
- my @inner_sup_results_array;
- for my $sup_record ( @{ $results_hashref->{$server}->{"RECORDS"} } )
- {
- my $marc_record_object =
- MARC::Record->new_from_usmarc($sup_record);
- my $control_number =
- $marc_record_object->field('010')->subfield('a')
- if $marc_record_object->field('010');
- $control_number =~ s/^ //g;
- my $link =
- "http://catalog.loc.gov/cgi-bin/Pwebrecon.cgi?SAB1="
- . $control_number
- . "&BOOL1=all+of+these&FLD1=LC+Control+Number+LCCN+%28K010%29+%28K010%29&GRP1=AND+with+next+set&SAB2=&BOOL2=all+of+these&FLD2=Keyword+Anywhere+%28GKEY%29+%28GKEY%29&PID=6211&SEQ=20060816121838&CNT=25&HIST=1";
- my $title = $marc_record_object->title();
- push @inner_sup_results_array,
- {
- 'title' => $title,
- 'link' => $link,
- };
+ # now, show twenty pages, with the current one smack in the middle
+ else {
+ for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
+ my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
+ my $this_page_number = $i-9;
+ my $highlight = 1 if ($this_page_number == $current_page_number);
+ if ($this_page_number <= $pages) {
+ push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
+ }
+ }
+
}
- my $servername = $server;
- push @sup_results_array,
- {
- servername => $servername,
- inner_sup_results_loop => \@inner_sup_results_array
- };
- $template->param( outer_sup_results_loop => \@sup_results_array );
+ $template->param( PAGE_NUMBERS => \@page_numbers,
+ previous_page_offset => $previous_page_offset) unless $pages < 2;
+ $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
+ }
+ # no hits
+ else {
+ $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
}
+ } # end of the if local
+ # asynchronously search the authority server
+ elsif ($server && $server =~/authorityserver/) { # this is the local authority server
+ my @inner_sup_results_array;
+ 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' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
+ };
+ }
+ my $servername = $server;
+ push @sup_results_array, { servername => $servername,
+ inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
}
+ # FIXME: can add support for other targets as needed here
+ $template->param( outer_sup_results_loop => \@sup_results_array);
+} #/end of the for loop
+#$template->param(FEDERATED_RESULTS => \@results_array);
-} #/end of the for loop
+$template->param(
+ #classlist => $classlist,
+ total => $total,
+ opacfacets => 1,
+ facets_loop => $facets,
+ scan => $scan,
+ search_error => $error,
+);
-#$template->param(FEDERATED_RESULTS => \@results_array);
-# adding the $RequestOnOpac param
-my $RequestOnOpac;
-if (C4::Context->preference("RequestOnOpac")) {
- $RequestOnOpac = 1;
+if ($query_desc || $limit_desc) {
+ $template->param(searchdesc => 1);
}
-# get site URL (for RSS link)
-$cgi->url() =~ /(.*)\/(.*)/;
-my $site_url = $1;
-$template->param(
+# VI. BUILD THE TEMPLATE
+# Build drop-down list for 'Add To:' menu...
+my $session = get_session($cgi->cookie("CGISESSID"));
+my @addpubshelves;
+my $pubshelves = $session->param('pubshelves');
+my $barshelves = $session->param('barshelves');
+foreach my $shelf (@$pubshelves) {
+ next if ( ($shelf->{'owner'} != ($borrowernumber ? $borrowernumber : -1)) && ($shelf->{'category'} < 3) );
+ push (@addpubshelves, $shelf);
+}
- #classlist => $classlist,
- total => $total,
- searchdesc => $search_desc,
- opacfacets => 1,
- facets_loop => $facets,
- "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
- scan_use => $scan,
- search_error => $error,
- RequestOnOpac => $RequestOnOpac,
- RSS=> 1,
- site_url => $site_url,
-);
-## 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 = $search_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;
- }
+if (@addpubshelves) {
+ $template->param( addpubshelves => scalar (@addpubshelves));
+ $template->param( addpubshelvesloop => \@addpubshelves);
+}
- # Now save the current query
- $koha_spsuggest_sth =
- $koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
+if (defined $barshelves) {
+ $template->param( addbarshelves => scalar (@$barshelves));
+ $template->param( addbarshelvesloop => $barshelves);
+}
- #$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:" . $@;
- }
+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')) {
+ $template->param('GoogleIndicTransliteration' => 1);
}
-# VI. BUILD THE TEMPLATE
-output_html_with_http_headers $cgi, $cookie, $template->output;
+output_with_http_headers $cgi, $cookie, $template->output, $content_type;
projects / koha.git / blobdiff