Nick Clemens
0d33dbcf2e
To test: 1 - Apply patch, update database 2 - Note new syspref 'DumpSearchQueryTemplate' 3 - Leave it off 4 - Enable DumpTemplateVariablesOpac and Staff 5 - Search on staff and opac 6 - View the source 7 - Search for 'search_query' - you shouldn't find it 8 - Enable the new pref 9 - Repeat, but you should find the query 10 - Test staff/opac search and advanced search, cataloguing search, authority search, authfinder search, adding to a basket form a new biblio 11 - All should work and show the query 12 - This will work under both ES and Zebra Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
879 lines
33 KiB
Prolog
Executable file
879 lines
33 KiB
Prolog
Executable file
#!/usr/bin/perl
|
|
# Script to perform searching
|
|
# For documentation try 'perldoc /path/to/search'
|
|
#
|
|
# Copyright 2006 LibLime
|
|
# 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 3 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, see <http://www.gnu.org/licenses>.
|
|
|
|
=head1 NAME
|
|
|
|
search - a search script for finding records in a Koha system (Version 3)
|
|
|
|
=head1 OVERVIEW
|
|
|
|
This script utilizes a new search API for Koha 3. 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 support for the bib1 attribute set, extended
|
|
attribute sets defined in Zebra profiles, access to the full range of Z39.50
|
|
and SRU query options, federated searches on Z39.50/SRU targets, etc.
|
|
|
|
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.
|
|
-- Joshua Ferraro <jmf AT liblime DOT com>
|
|
|
|
=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 LOADING ADVANCED SEARCH PAGE
|
|
|
|
This is fairly straightforward, and I won't go into detail ;-)
|
|
|
|
=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 $query - the fully-built query 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 most non-Zebra
|
|
Z39.50 targets to accomplish the field weighting and relevance ranking.
|
|
|
|
=item 2 $simple_query - a simple query that doesn't contain the field weighting,
|
|
stemming, etc., suitable to pass off to other search 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 $query_cgi - passed to the template / saved for future refinements of
|
|
the query (by user)
|
|
|
|
This is a simple string that completely expresses the query as a CGI string that
|
|
can be used for future refinements of the query or as a part of a history feature.
|
|
|
|
=item 4 $query_desc - Human search description - what the user sees in search
|
|
feedback area
|
|
|
|
This is a simple string that is human readable. It will contain '=', ',', 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 Modern::Perl;
|
|
|
|
## STEP 1. Load things that are used in both search page and
|
|
# results page and decide which template to load, operations
|
|
# to perform, etc.
|
|
|
|
## load Koha modules
|
|
use C4::Context;
|
|
use C4::Output;
|
|
use C4::Auth qw(:DEFAULT get_session);
|
|
use C4::Search;
|
|
use C4::Languages qw(getLanguages);
|
|
use C4::Koha;
|
|
use URI::Escape;
|
|
use POSIX qw(ceil floor);
|
|
use C4::Search::History;
|
|
|
|
use Koha::ItemTypes;
|
|
use Koha::Library::Groups;
|
|
use Koha::Patrons;
|
|
use Koha::SearchEngine::Search;
|
|
use Koha::SearchEngine::QueryBuilder;
|
|
use Koha::Virtualshelves;
|
|
use Koha::SearchFields;
|
|
|
|
use URI::Escape;
|
|
|
|
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' -utf8 );
|
|
my $cgi = new CGI;
|
|
|
|
# decide which template to use
|
|
my $template_name;
|
|
my $template_type;
|
|
my @params = $cgi->multi_param("limit");
|
|
if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
|
|
$template_name = 'catalogue/results.tt';
|
|
$template_type = 'results';
|
|
}
|
|
else {
|
|
$template_name = 'catalogue/advsearch.tt';
|
|
$template_type = 'advsearch';
|
|
}
|
|
# load the template
|
|
my ($template, $borrowernumber, $cookie) = get_template_and_user({
|
|
template_name => $template_name,
|
|
query => $cgi,
|
|
type => "intranet",
|
|
authnotrequired => 0,
|
|
flagsrequired => { catalogue => 1 },
|
|
}
|
|
);
|
|
|
|
my $lang = C4::Languages::getlanguage($cgi);
|
|
|
|
if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
|
|
$template->param('UNIMARC' => 1);
|
|
}
|
|
|
|
if($cgi->cookie("holdfor")){
|
|
my $holdfor_patron = Koha::Patrons->find( $cgi->cookie("holdfor") );
|
|
$template->param(
|
|
holdfor => $cgi->cookie("holdfor"),
|
|
holdfor_surname => $holdfor_patron->surname,
|
|
holdfor_firstname => $holdfor_patron->firstname,
|
|
holdfor_cardnumber => $holdfor_patron->cardnumber,
|
|
);
|
|
}
|
|
|
|
if($cgi->cookie("holdforclub")){
|
|
my $holdfor_club = Koha::Clubs->find( $cgi->cookie("holdforclub") );
|
|
$template->param(
|
|
holdforclub => $cgi->cookie("holdforclub"),
|
|
holdforclub_name => $holdfor_club->name,
|
|
);
|
|
}
|
|
|
|
if($cgi->cookie("searchToOrder")){
|
|
my ( $basketno, $vendorid ) = split( /\//, $cgi->cookie("searchToOrder") );
|
|
$template->param(
|
|
searchtoorder_basketno => $basketno,
|
|
searchtoorder_vendorid => $vendorid
|
|
);
|
|
}
|
|
|
|
# get biblionumbers stored in the cart
|
|
my @cart_list;
|
|
|
|
if($cgi->cookie("intranet_bib_list")){
|
|
my $cart_list = $cgi->cookie("intranet_bib_list");
|
|
@cart_list = split(/\//, $cart_list);
|
|
}
|
|
|
|
my @search_groups =
|
|
Koha::Library::Groups->get_search_groups( { interface => 'staff' } );
|
|
@search_groups = sort { $a->title cmp $b->title } @search_groups;
|
|
|
|
$template->param(
|
|
selected_branchcode => ( C4::Context->IsSuperLibrarian ? C4::Context->userenv : '' ),
|
|
search_groups => \@search_groups,
|
|
);
|
|
|
|
# load the Type stuff
|
|
my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
|
|
# the index parameter is different for item-level itemtypes
|
|
my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
|
|
my @advancedsearchesloop;
|
|
my $cnt;
|
|
my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
|
|
my @advanced_search_types = split(/\|/, $advanced_search_types);
|
|
|
|
foreach my $advanced_srch_type (@advanced_search_types) {
|
|
$advanced_srch_type =~ s/^\s*//;
|
|
$advanced_srch_type =~ s/\s*$//;
|
|
if ($advanced_srch_type eq 'itemtypes') {
|
|
# itemtype is a special case, since it's not defined in authorized values
|
|
my @itypesloop;
|
|
foreach my $thisitemtype ( sort {$itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes ) {
|
|
my %row =( number=>$cnt++,
|
|
ccl => "$itype_or_itemtype,phr",
|
|
code => $thisitemtype,
|
|
description => $itemtypes->{$thisitemtype}->{translated_description},
|
|
imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
|
|
);
|
|
push @itypesloop, \%row;
|
|
}
|
|
my %search_code = ( advanced_search_type => $advanced_srch_type,
|
|
code_loop => \@itypesloop );
|
|
push @advancedsearchesloop, \%search_code;
|
|
} else {
|
|
# covers all the other cases: non-itemtype authorized values
|
|
my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
|
|
my @authvalueloop;
|
|
for my $thisitemtype (@$advsearchtypes) {
|
|
my %row =(
|
|
number=>$cnt++,
|
|
ccl => $advanced_srch_type,
|
|
code => $thisitemtype->{authorised_value},
|
|
description => $thisitemtype->{'lib'},
|
|
imageurl => getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
|
|
);
|
|
push @authvalueloop, \%row;
|
|
}
|
|
my %search_code = ( advanced_search_type => $advanced_srch_type,
|
|
code_loop => \@authvalueloop );
|
|
push @advancedsearchesloop, \%search_code;
|
|
}
|
|
}
|
|
$template->param(advancedsearchesloop => \@advancedsearchesloop);
|
|
my $types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
|
|
my $advancedsearchesloop = prepare_adv_search_types($types);
|
|
$template->param(advancedsearchesloop => $advancedsearchesloop);
|
|
|
|
# The following should only be loaded if we're bringing up the advanced search template
|
|
if ( $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 $secondary_servers_loop;
|
|
$template->param(outer_sup_servers_loop => $secondary_servers_loop,);
|
|
|
|
# set the default sorting
|
|
if ( C4::Context->preference('defaultSortField')
|
|
&& C4::Context->preference('defaultSortOrder') ) {
|
|
my $default_sort_by =
|
|
C4::Context->preference('defaultSortField') . '_'
|
|
. C4::Context->preference('defaultSortOrder');
|
|
$template->param( sort_by => $default_sort_by );
|
|
}
|
|
|
|
# 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.
|
|
my @search_boxes_array;
|
|
my $search_boxes_count = 3; # begin with 3 boxes
|
|
# FIXME: all this junk can be done in TMPL using __first__ and __last__
|
|
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, {scan_index => 1};
|
|
}
|
|
# if it's the last one, show the 'add field' box
|
|
elsif ($i==$search_boxes_count) {
|
|
push @search_boxes_array,
|
|
{
|
|
boolean => 1,
|
|
add_field => 1,
|
|
};
|
|
}
|
|
else {
|
|
push @search_boxes_array,
|
|
{
|
|
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 = getLanguages($lang, 1);
|
|
$template->param(search_languages_loop => $languages_limit_loop,);
|
|
|
|
# Expanded search options in advanced search:
|
|
# use the global setting by default, but let the user override it
|
|
{
|
|
my $expanded = $cgi->param('expanded_options');
|
|
$expanded = C4::Context->preference("expandedSearchOption") || 0
|
|
if !defined($expanded) || $expanded !~ /^0|1$/;
|
|
$template->param( expanded_options => $expanded );
|
|
}
|
|
|
|
$template->param(virtualshelves => C4::Context->preference("virtualshelves"));
|
|
|
|
output_html_with_http_headers $cgi, $cookie, $template->output;
|
|
exit;
|
|
}
|
|
|
|
### OK, if we're this far, we're performing a search, not just loading the advanced search page
|
|
|
|
# Fetch the paramater list as a hash in scalar context:
|
|
# * returns paramater list as tied hash ref
|
|
# * 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;
|
|
# 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;
|
|
my $default_sort_by;
|
|
if ( C4::Context->preference('defaultSortField')
|
|
&& C4::Context->preference('defaultSortOrder') ) {
|
|
$default_sort_by =
|
|
C4::Context->preference('defaultSortField') . '_'
|
|
. C4::Context->preference('defaultSortOrder');
|
|
}
|
|
|
|
@sort_by = $cgi->multi_param('sort_by');
|
|
$sort_by[0] = $default_sort_by unless $sort_by[0];
|
|
foreach my $sort (@sort_by) {
|
|
$template->param($sort => 1) if $sort;
|
|
}
|
|
$template->param('sort_by' => $sort_by[0]);
|
|
|
|
# Use the servers defined, or just search our local catalog(default)
|
|
my @servers = $cgi->multi_param('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 = map uri_unescape($_), $cgi->multi_param('op');
|
|
|
|
# indexes are query qualifiers, like 'title', 'author', etc. They
|
|
# can be single or multiple parameters separated by comma: kw,right-Truncation
|
|
my @indexes = map uri_unescape($_), $cgi->multi_param('idx');
|
|
|
|
# if a simple index (only one) display the index used in the top search box
|
|
if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
|
|
my $idx = "ms_".$indexes[0];
|
|
$idx =~ s/\,/comma/g; # template toolkit doesn't like variables with a , in it
|
|
$idx =~ s/-/dash/g; # template toolkit doesn't like variables with a dash in it
|
|
$template->param($idx => 1);
|
|
}
|
|
|
|
# an operand can be a single term, a phrase, or a complete ccl query
|
|
my @operands = map uri_unescape($_), $cgi->multi_param('q');
|
|
|
|
# if a simple search, display the value in the search box
|
|
if ($operands[0] && !$operands[1]) {
|
|
my $ms_query = $operands[0];
|
|
$ms_query =~ s/ #\S+//;
|
|
$template->param(ms_value => $ms_query);
|
|
}
|
|
|
|
# limits are use to limit to results to a pre-defined category such as branch or language
|
|
my @limits = map uri_unescape($_), $cgi->multi_param('limit');
|
|
my @nolimits = map uri_unescape($_), $cgi->multi_param('nolimit');
|
|
my %is_nolimit = map { $_ => 1 } @nolimits;
|
|
@limits = grep { not $is_nolimit{$_} } @limits;
|
|
|
|
if($params->{'multibranchlimit'}) {
|
|
my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
|
|
my @libraries = $search_group->all_libraries;
|
|
my $multibranch = '('.join( " OR ", map { '(homebranch: ' . $_->branchcode .')' } @libraries ) .')';
|
|
push @limits, $multibranch if ($multibranch ne '()');
|
|
}
|
|
|
|
my $available;
|
|
foreach my $limit(@limits) {
|
|
if ($limit =~/available/) {
|
|
$available = 1;
|
|
}
|
|
}
|
|
$template->param(available => $available);
|
|
|
|
# append year limits if they exist
|
|
my $limit_yr;
|
|
my $limit_yr_value;
|
|
if ($params->{'limit-yr'}) {
|
|
if ($params->{'limit-yr'} =~ /\d{4}/) {
|
|
$limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
|
|
$limit_yr_value = $params->{'limit-yr'};
|
|
}
|
|
push @limits,$limit_yr;
|
|
#FIXME: Should return a error to the user, incorect date format specified
|
|
}
|
|
|
|
# convert indexes and operands to corresponding parameter names for the z3950 search
|
|
# $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
|
|
my $z3950par;
|
|
my $indexes2z3950 = {
|
|
kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
|
|
'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
|
|
ti=>'title', 'ti,phr'=>'title', se=>'title'
|
|
};
|
|
for (my $ii = 0; $ii < @operands; ++$ii)
|
|
{
|
|
my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
|
|
if (defined $name && defined $operands[$ii])
|
|
{
|
|
$z3950par ||= {};
|
|
$z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
|
|
}
|
|
}
|
|
|
|
|
|
# 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 $whole_record = $params->{'whole_record'} || 0;
|
|
$offset = 0 if $offset < 0;
|
|
my $page = $cgi->param('page') || 1;
|
|
#my $offset = ($page-1)*$results_per_page;
|
|
|
|
# Define some global variables
|
|
my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
|
|
|
|
my $builder = Koha::SearchEngine::QueryBuilder->new(
|
|
{ index => $Koha::SearchEngine::BIBLIOS_INDEX } );
|
|
my $searcher = Koha::SearchEngine::Search->new(
|
|
{ index => $Koha::SearchEngine::BIBLIOS_INDEX } );
|
|
|
|
## I. BUILD THE QUERY
|
|
(
|
|
$error, $query, $simple_query, $query_cgi,
|
|
$query_desc, $limit, $limit_cgi, $limit_desc,
|
|
$query_type
|
|
)
|
|
= $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
|
|
\@sort_by, $scan, $lang, { weighted_fields => !$cgi->param('advsearch'), whole_record => $whole_record });
|
|
|
|
$template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
|
|
|
|
## parse the query_cgi string and put it into a form suitable for <input>s
|
|
my @query_inputs;
|
|
my $scan_index_to_use;
|
|
my $scan_search_term_to_use;
|
|
|
|
if ($query_cgi) {
|
|
for my $this_cgi ( split('&', $query_cgi) ) {
|
|
next unless $this_cgi;
|
|
$this_cgi =~ m/(.*?)=(.*)/;
|
|
my $input_name = $1;
|
|
my $input_value = $2;
|
|
push @query_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape( $input_value ) ) };
|
|
if ($input_name eq 'idx') {
|
|
# The form contains multiple fields, so take the first value as the scan index
|
|
$scan_index_to_use = $input_value unless $scan_index_to_use;
|
|
}
|
|
if (!defined $scan_search_term_to_use && $input_name eq 'q') {
|
|
$scan_search_term_to_use = Encode::decode_utf8( uri_unescape( $input_value ));
|
|
}
|
|
}
|
|
}
|
|
|
|
$template->param ( QUERY_INPUTS => \@query_inputs,
|
|
scan_index_to_use => $scan_index_to_use,
|
|
scan_search_term_to_use => $scan_search_term_to_use );
|
|
|
|
## parse the limit_cgi string and put it into a form suitable for <input>s
|
|
my @limit_inputs;
|
|
if ($limit_cgi) {
|
|
for my $this_cgi ( split('&', $limit_cgi) ) {
|
|
next unless $this_cgi;
|
|
# handle special case limit-yr
|
|
if ($this_cgi =~ /yr,st-numeric/) {
|
|
push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
|
|
next;
|
|
}
|
|
$this_cgi =~ m/(.*=)(.*)/;
|
|
my $input_name = $1;
|
|
my $input_value = $2;
|
|
$input_name =~ s/=$//;
|
|
push @limit_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape($input_value) ) };
|
|
}
|
|
}
|
|
$template->param ( LIMIT_INPUTS => \@limit_inputs );
|
|
|
|
## II. DO THE SEARCH AND GET THE RESULTS
|
|
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_hashref;
|
|
|
|
eval {
|
|
my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
|
|
( $error, $results_hashref, $facets ) = $searcher->search_compat(
|
|
$query, $simple_query, \@sort_by, \@servers,
|
|
$results_per_page, $offset, undef, $itemtypes,
|
|
$query_type, $scan
|
|
);
|
|
};
|
|
|
|
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++) {
|
|
my $server = $servers[$i];
|
|
if ($server =~/biblioserver/) { # this is the local bibliographic server
|
|
my $hits = $results_hashref->{$server}->{"hits"} // 0;
|
|
my $page = $cgi->param('page') || 0;
|
|
my @newresults = searchResults({ 'interface' => 'intranet' }, $query_desc, $hits, $results_per_page, $offset, $scan,
|
|
$results_hashref->{$server}->{"RECORDS"});
|
|
$total = $total + $hits;
|
|
|
|
# Search history
|
|
if (C4::Context->preference('EnableSearchHistory')) {
|
|
unless ( $offset ) {
|
|
my $path_info = $cgi->url(-path_info=>1);
|
|
my $query_cgi_history = $cgi->url(-query=>1);
|
|
$query_cgi_history =~ s/^$path_info\?//;
|
|
$query_cgi_history =~ s/;/&/g;
|
|
my $query_desc_history = $query_desc;
|
|
$query_desc_history .= ", $limit_desc"
|
|
if $limit_desc;
|
|
|
|
C4::Search::History::add({
|
|
userid => $borrowernumber,
|
|
sessionid => $cgi->cookie("CGISESSID"),
|
|
query_desc => $query_desc_history,
|
|
query_cgi => $query_cgi_history,
|
|
total => $total,
|
|
type => "biblio",
|
|
});
|
|
}
|
|
$template->param( EnableSearchHistory => 1 );
|
|
}
|
|
|
|
## If there's just one result, redirect to the detail page unless doing an index scan
|
|
if ($total == 1 && !$scan) {
|
|
my $biblionumber = $newresults[0]->{biblionumber};
|
|
my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
|
|
my $views = { C4::Search::enabled_staff_search_views };
|
|
if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
|
|
print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
|
|
} elsif ($defaultview eq 'marc' && $views->{can_view_MARC}) {
|
|
print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
|
|
} elsif ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
|
|
print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
|
|
} else {
|
|
print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
|
|
}
|
|
exit;
|
|
}
|
|
|
|
# set up parameters if user wishes to re-run the search
|
|
# as a Z39.50 search
|
|
$template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
|
|
|
|
if ($hits) {
|
|
$template->param(total => $hits);
|
|
if ($limit_cgi) {
|
|
my $limit_cgi_not_availablity = $limit_cgi;
|
|
$limit_cgi_not_availablity =~ s/&limit=available//g;
|
|
$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);
|
|
$template->param(offset => $offset);
|
|
$template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
|
|
if ($query_desc || $limit_desc) {
|
|
$template->param(searchdesc => 1);
|
|
}
|
|
$template->param(results_per_page => $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) {
|
|
if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
|
|
# while we're checking each line, see if item is in the cart
|
|
if ( grep {$_ eq $line->{'biblionumber'}} @cart_list) {
|
|
$line->{'incart'} = 1;
|
|
}
|
|
}
|
|
$template->param(SEARCH_RESULTS => \@newresults);
|
|
## FIXME: add a global function for this, it's better than the current global one
|
|
## Build the page numbers on the bottom of the page
|
|
my @page_numbers;
|
|
my $max_result_window = $searcher->max_result_window;
|
|
my $hits_to_paginate = ($max_result_window && $max_result_window < $hits) ? $max_result_window : $hits;
|
|
$template->param( hits_to_paginate => $hits_to_paginate );
|
|
# total number of pages there will be
|
|
my $pages = ceil($hits_to_paginate / $results_per_page);
|
|
my $last_page_offset = ( $pages -1 ) * $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;
|
|
if ( $offset >= $results_per_page ) {
|
|
$previous_page_offset = $offset - $results_per_page;
|
|
}
|
|
my $next_page_offset = $offset + $results_per_page;
|
|
# 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 (my $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;
|
|
# put it in the array
|
|
push @page_numbers,
|
|
{ offset => $this_offset,
|
|
pg => $this_page_number,
|
|
# it should only be highlighted if it's the current page
|
|
highlight => $this_page_number == $current_page_number,
|
|
sort_by => join ' ', @sort_by
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
# now, show twenty pages, with the current one smack in the middle
|
|
else {
|
|
for (my $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;
|
|
if ( $this_page_number <= $pages ) {
|
|
push @page_numbers,
|
|
{ offset => $this_offset,
|
|
pg => $this_page_number,
|
|
highlight => $this_page_number == $current_page_number,
|
|
sort_by => join ' ', @sort_by
|
|
};
|
|
}
|
|
}
|
|
}
|
|
# FIXME: no previous_page_offset when pages < 2
|
|
$template->param( PAGE_NUMBERS => \@page_numbers,
|
|
last_page_offset => $last_page_offset,
|
|
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 =~/authorityserver/) { # this is the local authority server
|
|
my @inner_sup_results_array;
|
|
for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
|
|
my $marc_record_object = C4::Search::new_record_from_zebra(
|
|
'authorityserver',
|
|
$sup_record
|
|
);
|
|
# warn "Authority Found: ".$marc_record_object->as_formatted();
|
|
push @inner_sup_results_array, {
|
|
'title' => $marc_record_object->field(100)->subfield('a'),
|
|
'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
|
|
};
|
|
}
|
|
push @sup_results_array, { servername => $server,
|
|
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);
|
|
|
|
$template->{'VARS'}->{'searchid'} = $cgi->param('searchid');
|
|
|
|
my $gotonumber = $cgi->param('gotoNumber');
|
|
if ( $gotonumber && ( $gotonumber eq 'last' || $gotonumber eq 'first' ) ) {
|
|
$template->{'VARS'}->{'gotoNumber'} = $gotonumber;
|
|
}
|
|
$template->{'VARS'}->{'gotoPage'} = 'detail.pl';
|
|
my $gotopage = $cgi->param('gotoPage');
|
|
$template->{'VARS'}->{'gotoPage'} = $gotopage
|
|
if $gotopage && $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
|
|
|
|
for my $facet ( @$facets ) {
|
|
for my $entry ( @{ $facet->{facets} } ) {
|
|
my $index = $entry->{type_link_value};
|
|
my $value = $entry->{facet_link_value};
|
|
$entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
|
|
}
|
|
}
|
|
|
|
$template->param(
|
|
#classlist => $classlist,
|
|
total => $total,
|
|
opacfacets => 1,
|
|
facets_loop => $facets,
|
|
displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
|
|
scan => $scan,
|
|
search_error => $error,
|
|
);
|
|
|
|
if ($query_desc || $limit_desc) {
|
|
$template->param(searchdesc => 1);
|
|
}
|
|
|
|
# VI. BUILD THE TEMPLATE
|
|
|
|
my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
|
|
{
|
|
borrowernumber => $borrowernumber,
|
|
add_allowed => 1,
|
|
category => 1,
|
|
}
|
|
);
|
|
my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
|
|
{
|
|
borrowernumber => $borrowernumber,
|
|
add_allowed => 1,
|
|
category => 2,
|
|
}
|
|
);
|
|
|
|
|
|
$template->param(
|
|
add_to_some_private_shelves => $some_private_shelves,
|
|
add_to_some_public_shelves => $some_public_shelves,
|
|
);
|
|
|
|
output_html_with_http_headers $cgi, $cookie, $template->output;
|
|
|
|
|
|
=head2 prepare_adv_search_types
|
|
|
|
my $type = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
|
|
my @advanced_search_types = prepare_adv_search_types($type);
|
|
|
|
Different types can be searched for in the advanced search. This takes the
|
|
system preference that defines these types and parses it into an arrayref for
|
|
the template.
|
|
|
|
"itemtypes" is handled specially, as itemtypes aren't an authorised value.
|
|
It also accounts for the "item-level_itypes" system preference.
|
|
|
|
=cut
|
|
|
|
sub prepare_adv_search_types {
|
|
my ($types) = @_;
|
|
|
|
my @advanced_search_types = split( /\|/, $types );
|
|
|
|
# the index parameter is different for item-level itemtypes
|
|
my $itype_or_itemtype =
|
|
( C4::Context->preference("item-level_itypes") ) ? 'itype' : 'itemtype';
|
|
my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
|
|
|
|
my ( $cnt, @result );
|
|
foreach my $advanced_srch_type (@advanced_search_types) {
|
|
$advanced_srch_type =~ s/^\s*//;
|
|
$advanced_srch_type =~ s/\s*$//;
|
|
if ( $advanced_srch_type eq 'itemtypes' ) {
|
|
|
|
# itemtype is a special case, since it's not defined in authorized values
|
|
my @itypesloop;
|
|
foreach my $thisitemtype (
|
|
sort {
|
|
$itemtypes->{$a}->{'translated_description'}
|
|
cmp $itemtypes->{$b}->{'translated_description'}
|
|
} keys %$itemtypes
|
|
)
|
|
{
|
|
my %row = (
|
|
number => $cnt++,
|
|
ccl => "$itype_or_itemtype,phr",
|
|
code => $thisitemtype,
|
|
description => $itemtypes->{$thisitemtype}->{'translated_description'},
|
|
imageurl => getitemtypeimagelocation(
|
|
'intranet', $itemtypes->{$thisitemtype}->{'imageurl'}
|
|
),
|
|
);
|
|
push @itypesloop, \%row;
|
|
}
|
|
my %search_code = (
|
|
advanced_search_type => $advanced_srch_type,
|
|
code_loop => \@itypesloop
|
|
);
|
|
push @result, \%search_code;
|
|
}
|
|
else {
|
|
# covers all the other cases: non-itemtype authorized values
|
|
my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
|
|
my @authvalueloop;
|
|
for my $thisitemtype (@$advsearchtypes) {
|
|
my %row = (
|
|
number => $cnt++,
|
|
ccl => $advanced_srch_type,
|
|
code => $thisitemtype->{authorised_value},
|
|
description => $thisitemtype->{'lib'},
|
|
imageurl => getitemtypeimagelocation(
|
|
'intranet', $thisitemtype->{'imageurl'}
|
|
),
|
|
);
|
|
push @authvalueloop, \%row;
|
|
}
|
|
my %search_code = (
|
|
advanced_search_type => $advanced_srch_type,
|
|
code_loop => \@authvalueloop
|
|
);
|
|
push @result, \%search_code;
|
|
}
|
|
}
|
|
return \@result;
|
|
}
|