2 # Script to perform searching
3 # For documentation try 'perldoc /path/to/search'
7 # Copyright 2006 LibLime
9 # This file is part of Koha
11 # Koha is free software; you can redistribute it and/or modify it under the
12 # terms of the GNU General Public License as published by the Free Software
13 # Foundation; either version 2 of the License, or (at your option) any later
16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License along with
21 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
22 # Suite 330, Boston, MA 02111-1307 USA
26 search - a search script for finding records in a Koha system (Version 3.0)
30 This script contains a new search API for Koha 3.0. It is designed to be
31 simple to use and configure, yet capable of performing feats like stemming,
32 field weighting, relevance ranking, support for multiple query language
33 formats (CCL, CQL, PQF), full or nearly full support for the
34 bib1 attribute set, extended attribute sets defined in Zebra profiles, access
35 to the full range of Z39.50 query options, federated searches on Z39.50
38 I believe the API as represented in this script is mostly sound, even if the
39 individual functions in Search.pm and Koha.pm need to be cleaned up. Of course,
40 you are free to disagree :-)
42 I will attempt to describe what is happening at each part of this script.
47 This script performs two functions:
51 =item 1. interacts with Koha to retrieve and display the results of a search
53 =item 2. loads the advanced search page
57 These two functions share many of the same variables and modules, so the first
58 task is to load what they have in common and determine which template to use.
59 Once determined, proceed to only load the variables and procedures necessary
62 =head2 THE ADVANCED SEARCH PAGE
64 If we're loading the advanced search page this script will call a number of
65 display* routines which populate objects that are sent to the template for
66 display of things like search indexes, languages, search limits, branches,
67 etc. These are not stored in the template for two reasons:
71 =item 1. Efficiency - we have more control over objects inside the script,
72 and it's possible to not duplicate things like indexes (if the search indexes
73 were stored in the template they would need to be repeated)
75 =item 2. Customization - if these elements were moved to the sql database it
76 would allow a simple librarian to determine which fields to display on the page
77 without editing any html (also how the fields should behave when being searched).
81 However, they create one problem : the strings aren't translated. I have an idea
82 for how to do this that I will purusue soon.
84 =head2 PERFORMING A SEARCH
86 If we're performing a search, this script performs three primary
91 =item 1. builds query strings (yes, plural)
93 =item 2. perform the search and return the results array
95 =item 3. build the HTML for output to the template
99 There are several additional secondary functions performed that I will
102 =head3 1. Building Query Strings
104 There are several types of queries needed in the process of search and retrieve:
108 =item 1 Koha query - the query that is passed to Zebra
110 This is the most complex query that needs to be built. The original design goal
111 was to use a custom CCL2PQF query parser to translate an incoming CCL query into
112 a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field
113 weighting, koha-specific relevance ranking, and stemming. When I have a chance
114 I'll try to flesh out this section to better explain.
116 This query incorporates query profiles that aren't compatible with non-Zebra
117 Z39.50 targets to acomplish the field weighting and relevance ranking.
119 =item 2 Federated query - the query that is passed to other Z39.50 targets
121 This query is just the user's query expressed in CCL CQL, or PQF for passing to a
122 non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
124 =item 3 Search description - passed to the template / saved for future refinements of
127 This is a simple string that completely expresses the query in a way that can be parsed
128 by Koha for future refinements of the query or as a part of a history feature. It differs
129 from the human search description:
131 1. it does not contain commas or = signs
133 =item 4 Human search description - what the user sees in the search_desc area
135 This is a simple string nearly identical to the Search description, but more human
136 readable. It will contain = signs or commas, etc.
140 =head3 2. Perform the Search
142 This section takes the query strings and performs searches on the named servers, including
143 the Koha Zebra server, stores the results in a deeply nested object, builds 'faceted results',
144 and returns these objects.
148 The final major section of this script takes the objects collected thusfar and builds the
149 HTML for output to the template and user.
151 =head3 Additional Notes
157 use strict; # always use
159 ## STEP 1. Load things that are used in both search page and
160 # results page and decide which template to load, operations
167 use C4::Languages; # getAllLanguages
169 use POSIX qw(ceil floor);
170 use C4::Branch; # GetBranches
171 # create a new CGI object
172 # not sure undef_params option is working, need to test
173 use CGI qw('-no_undef_params');
176 my ($template,$borrowernumber,$cookie);
178 # decide which template to use
181 my @params = $cgi->param("limit");
182 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
183 $template_name = 'catalogue/results.tmpl';
186 $template_name = 'catalogue/advsearch.tmpl';
187 $template_type = 'advsearch';
190 ($template, $borrowernumber, $cookie) = get_template_and_user({
191 template_name => $template_name,
194 authnotrequired => 0,
195 flagsrequired => { catalogue => 1 },
198 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
199 $template->param('UNIMARC' => 1);
202 =head1 BUGS and FIXMEs
204 There are many, most are documented in the code. The one that
205 isn't fully documented, but referred to is the need for a full
211 # Deprecated, but preserved because it's interesting :-)
213 #my $uri = $cgi->url(-base => 1);
214 #my $relative_url = $cgi->url(-relative=>1);
215 #$uri.="/".$relative_url."?";
217 #my @cgi_params_list = $cgi->param();
218 #my $url_params = $cgi->Vars;
220 #for my $each_param_set (@cgi_params_list) {
221 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
223 #warn "New URI:$uri";
224 # Only re-write a URI if there are params or if it already hasn't been re-written
225 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
226 # print $cgi->redirect( -uri=>$uri."&r=1",
227 # -cookie => $cookie);
232 my $branches = GetBranches();
234 #push @branch_loop, {value => "", branchname => "All Branches", };
235 for my $branch_hash (sort keys %$branches) {
236 push @branch_loop, {value => "$branch_hash" , branchname => $branches->{$branch_hash}->{'branchname'}, };
239 my $categories = GetBranchCategories(undef,'searchdomain');
241 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
244 my $itemtypes = GetItemTypes;
248 my $imgdir = getitemtypeimagesrc();
249 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
250 my %row =( number=>$cnt++,
251 imageurl=> $itemtypes->{$thisitemtype}->{'imageurl'}?($imgdir."/".$itemtypes->{$thisitemtype}->{'imageurl'}):"",
252 code => $thisitemtype,
253 selected => $selected,
254 description => $itemtypes->{$thisitemtype}->{'description'},
257 $selected = 0 if ($selected) ;
258 push @itemtypesloop, \%row;
260 $template->param(itemtypeloop => \@itemtypesloop);
262 # # load the itypes (Called item types in the template -- just authorized values for searching)
263 # my ($itypecount,@itype_loop) = GetCcodes();
264 # $template->param(itypeloop=>\@itype_loop,);
266 # load the languages ( for switching from one template to another )
267 $template->param(languages_loop => getTranslatedLanguages('intranet','prog'));
269 # The following should only be loaded if we're bringing up the advanced search template
270 if ( $template_type eq 'advsearch' ) {
271 # load the servers (used for searching -- to do federated searching, etc.)
272 my $primary_servers_loop;# = displayPrimaryServers();
273 $template->param(outer_servers_loop => $primary_servers_loop,);
275 my $secondary_servers_loop;# = displaySecondaryServers();
276 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
278 # determine what to display next to the search boxes (ie, boolean option
279 # shouldn't appear on the first one, scan indexes should, adding a new
280 # box should only appear on the last, etc.
281 my @search_boxes_array;
282 my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") | 3; # FIXME: should be a syspref
283 for (my $i=1;$i<=$search_boxes_count;$i++) {
284 # if it's the first one, don't display boolean option, but show scan indexes
286 push @search_boxes_array,
292 # if it's the last one, show the 'add field' box
293 elsif ($i==$search_boxes_count) {
294 push @search_boxes_array,
301 push @search_boxes_array,
308 $template->param(uc(C4::Context->preference("marcflavour")) => 1,
309 search_boxes_loop => \@search_boxes_array);
311 # load the language limits (for search)
312 my $languages_limit_loop = getAllLanguages();
313 $template->param(search_languages_loop => $languages_limit_loop,);
315 # use the global setting by default
316 if ( C4::Context->preference("expandedSearchOption") == 1) {
317 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
319 # but let the user override it
320 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
321 $template->param( expanded_options => $cgi->param('expanded_options'));
324 # load the sort_by options for the template
325 my $sort_by = $cgi->param('sort_by');
327 output_html_with_http_headers $cgi, $cookie, $template->output;
331 ### OK, if we're this far, we're performing an actual search
333 # Fetch the paramater list as a hash in scalar context:
334 # * returns paramater list as tied hash ref
335 # * we can edit the values by changing the key
336 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
337 my $params = $cgi->Vars;
339 # Params that can have more than one value
340 # sort by is used to sort the query
342 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
344 # FIXME: this is a quick hack
345 foreach my $sort (@sort_by) {
346 $template->param($sort => 1);
349 # Use the servers defined, or just search our local catalog(default)
351 @servers = split("\0",$params->{'server'}) if $params->{'server'};
353 #FIXME: this should be handled using Context.pm
354 @servers = ("biblioserver");
355 # @servers = C4::Context->config("biblioserver");
358 # operators include boolean and proximity operators and are used
359 # to evaluate multiple operands
361 @operators = split("\0",$params->{'op'}) if $params->{'op'};
363 # indexes are query qualifiers, like 'title', 'author', etc. They
364 # can be single or multiple parameters separated by comma: kw,right-Truncation
366 @indexes = split("\0",$params->{'idx'});
368 # an operand can be a single term, a phrase, or a complete ccl query
370 @operands = split("\0",$params->{'q'}) if $params->{'q'};
372 # limits are use to limit to results to a pre-defined category such as branch or language
374 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
376 if($params->{'multibranchlimit'}) {
377 push @limits, join(" or ", map { "homebranch: $_ "} @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
381 foreach my $limit(@limits) {
382 if ($limit =~/available/) {
386 $template->param(available => $available);
387 push @limits, map "yr:".$_, split("\0",$params->{'limit-yr'}) if $params->{'limit-yr'};
389 # Params that can only have one value
390 my $scan = $params->{'scan'};
391 my $results_per_page = $params->{'count'} || 20;
392 my $page = $cgi->param('page') || 1;
393 my $offset = ($page-1)*$results_per_page;
395 my $expanded_facet = $params->{'expand'};
397 # Define some global variables
398 my $error; # used for error handling
399 my $search_desc; # the query expressed in terms that humans understand
400 my $koha_query; # the query expressed in terms that zoom understands with field weighting and stemming
402 my $query_type; # usually not needed, but can be used to trigger ccl, cql, or pqf queries if set
404 ## I. BUILD THE QUERY
405 ($error,$search_desc,$koha_query,$federated_query,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
407 ## II. DO THE SEARCH AND GET THE RESULTS
408 my $total; # the total results for the whole set
409 my $facets; # this object stores the faceted results that display on the left-hand of the results page
413 if (C4::Context->preference('NoZebra')) {
415 ($error, $results_hashref, $facets) = NZgetRecords($koha_query,$federated_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
419 ($error, $results_hashref, $facets) = getRecords($koha_query,$federated_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
423 $template->param(query_error => $error.$@);
425 output_html_with_http_headers $cgi, $cookie, $template->output;
429 # FIXME: This belongs in tools/ not in the primary search results page
430 my $op=$cgi->param("operation");
431 if ($op eq "bulkedit"){
432 my ($countchanged,$listunchanged)=
433 ModBiblios($results_hashref->{'biblioserver'}->{"RECORDS"},
434 $params->{"tagsubfield"},
435 $params->{"inputvalue"},
436 $params->{"targetvalue"},
439 $template->param(bulkeditresults=>1,
440 tagsubfield=>$params->{"tagsubfield"},
441 inputvalue=>$params->{"inputvalue"},
442 targetvalue=>$params->{"targetvalue"},
443 countchanged=>$countchanged,
444 countunchanged=>scalar(@$listunchanged),
445 listunchanged=>$listunchanged);
447 if (C4::Context->userenv->{'flags'}==1 ||(C4::Context->userenv->{'flags'} & ( 2**9 ) )){
448 #Edit Catalogue Permissions
449 $template->param(bulkedit => 1);
450 $template->param(tagsubfields=>GetManagedTagSubfields());
453 # At this point, each server has given us a result set
454 # now we build that set for template display
455 my @sup_results_array;
456 for (my $i=0;$i<=@servers;$i++) {
457 my $server = $servers[$i];
458 if ($server =~/biblioserver/) { # this is the local bibliographic server
459 $hits = $results_hashref->{$server}->{"hits"};
460 my $page = $cgi->param('page') || 0;
461 my @newresults = searchResults( $search_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
462 $total = $total + $results_hashref->{$server}->{"hits"};
464 $template->param(total => $hits);
465 $template->param(searchdesc => ($query_type?"$query_type=":"")."$search_desc" );
466 $template->param(results_per_page => $results_per_page);
467 $template->param(SEARCH_RESULTS => \@newresults);
470 # my $pages = ceil($hits / $results_per_page);
471 # my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
472 # my $next_page_offset = $offset + $results_per_page;
473 # for (my $j=1; $j<=$pages;$j++) {
474 # my $this_offset = (($j*$results_per_page)-$results_per_page);
475 # my $this_page_number = $j;
476 # my $highlight = 1 if ($this_page_number == $current_page_number);
477 # if ($this_page_number <= $pages) {
478 # push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
481 # $template->param(PAGE_NUMBERS => \@page_numbers,
482 # previous_page_offset => $previous_page_offset,
483 # next_page_offset => $next_page_offset) unless $pages < 2;
484 my $link="/cgi-bin/koha/catalogue/search.pl?q=$search_desc&";
485 foreach my $sort (@sort_by){
486 $link.="&sort_by=".$sort."&";
489 pagination_bar => pagination_bar(
491 getnbpages($hits, $results_per_page),
497 } # end of the if local
499 # check if it's a z3950 or opensearch source
500 my $zed3950 = 0; # FIXME :: Hardcoded value.
502 my @inner_sup_results_array;
503 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
504 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
505 my $control_number = $marc_record_object->field('010')->subfield('a') if $marc_record_object->field('010');
506 $control_number =~ s/^ //g;
507 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";
508 my $title = $marc_record_object->title();
509 push @inner_sup_results_array, {
514 my $servername = $server;
515 push @sup_results_array, { servername => $servername, inner_sup_results_loop => \@inner_sup_results_array};
516 $template->param(outer_sup_results_loop => \@sup_results_array);
520 } #/end of the for loop
521 #$template->param(FEDERATED_RESULTS => \@results_array);
525 #classlist => $classlist,
527 searchdesc => ($query_type?"$query_type=":"")."$search_desc",
529 facets_loop => $facets,
531 search_error => $error,
533 ## Now let's find out if we have any supplemental data to show the user
534 # and in the meantime, save the current query for statistical purposes, etc.
535 my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
536 my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
537 my $phrases = $search_desc;
540 if ( C4::Context->preference("kohaspsuggest") ) {
541 my ($suggest_host, $suggest_dbname, $suggest_user, $suggest_pwd) = split(':', C4::Context->preference("kohaspsuggest"));
543 my $koha_spsuggest_dbh;
544 # FIXME: this needs to be moved to Context.pm
546 $koha_spsuggest_dbh=DBI->connect("DBI:mysql:$suggest_dbname:$suggest_host","$suggest_user","$suggest_pwd");
549 warn "can't connect to spsuggest db";
552 my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
553 my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
554 my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
555 $koha_spsuggest_sth->execute($phrases);
556 while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
557 $spsuggestion =~ s/(:|\/)//g;
559 $line{spsuggestion} = $spsuggestion;
560 push @koha_spsuggest,\%line;
564 # Now save the current query
565 $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
566 #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
567 $koha_spsuggest_sth->finish;
569 $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
570 $template->param( SPELL_SUGGEST => \@koha_spsuggest,
575 warn "Kohaspsuggest failure:".$@;
579 # VI. BUILD THE TEMPLATE
580 output_html_with_http_headers $cgi, $cookie, $template->output;