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 2.4)
30 This script contains a demonstration of a new search API for Koha 2.4. It is
31 designed to be simple to use and configure, yet capable of performing feats
32 like stemming, field weighting, relevance ranking, support for multiple
33 query language 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, 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)
73 =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).
77 However, they create one problem : the strings aren't translated. I have an idea
78 for how to do this that I will purusue soon.
80 =head2 PERFORMING A SEARCH
82 If we're performing a search, this script performs three primary
87 =item 1. builds query strings (yes, plural)
89 =item 2. perform the search and return the results array
91 =item 3. build the HTML for output to the template
95 There are several additional secondary functions performed that I will
98 =head3 1. Building Query Strings
100 There are several types of queries needed in the process of search and retrieve:
104 =item 1 Koha query - the query that is passed to Zebra
106 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.
108 This query incorporates query profiles that aren't compatible with non-Zebra Z39.50 targets to acomplish the field weighting and relevance ranking.
110 =item 2 Federated query - the query that is passed to other Z39.50 targets
112 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).
114 =item 3 Search description - passed to the template / saved for future refinements of the query (by user)
116 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:
118 1. it does not contain commas or = signs
121 =item 4 Human search description - what the user sees in the search_desc area
123 This is a simple string nearly identical to the Search description, but more human readable. It will contain = signs or commas, etc.
127 =head3 2. Perform the Search
129 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.
133 The final major section of this script takes the objects collected thusfar and builds the HTML for output to the template and user.
135 =head3 Additional Notes
141 use strict; # always use
143 ## STEP 1. Load things that are used in both search page and
144 # results page and decide which template to load, operations
151 use C4::Languages; # getAllLanguages
153 use POSIX qw(ceil floor);
154 use C4::Branch; # GetBranches
155 # create a new CGI object
156 # not sure undef_params option is working, need to test
157 use CGI qw('-no_undef_params');
160 my ($template,$borrowernumber,$cookie);
162 # decide which template to use
164 my @params = $cgi->param("limit");
165 if ((@params>1) || ($cgi->param("q")) ) {
166 $template_name = 'catalogue/results.tmpl';
169 $template_name = 'catalogue/advsearch.tmpl';
173 ($template, $borrowernumber, $cookie) = get_template_and_user({
174 template_name => $template_name,
177 authnotrequired => 0,
178 flagsrequired => { catalogue => 1 },
182 =head1 BUGS and FIXMEs
184 There are many, most are documented in the code. The one that
185 isn't fully documented, but referred to is the need for a full
191 # FIXME: URI re-writing should be tested more carefully and may better
192 # handled by mod_rewrite or something else. The code below almost works,
193 # but doesn't quite handle limits correctly when they are the only
194 # param passed -- I'll work on this soon -- JF
196 #my $uri = $cgi->url(-base => 1);
197 #my $relative_url = $cgi->url(-relative=>1);
198 #$uri.="/".$relative_url."?";
200 #my @cgi_params_list = $cgi->param();
201 #my $url_params = $cgi->Vars;
203 #for my $each_param_set (@cgi_params_list) {
204 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
206 #warn "New URI:$uri";
207 # Only re-write a URI if there are params or if it already hasn't been re-written
208 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
209 # print $cgi->redirect( -uri=>$uri."&r=1",
210 # -cookie => $cookie);
215 my $branches = GetBranches();
217 push @branch_loop, {value => "", branchname => "All Branches", };
218 for my $branch_hash (keys %$branches) {
219 push @branch_loop, {value => "branch: $branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
221 $template->param(branchloop => \@branch_loop,);
223 # load the itemtypes (Called Collection Codes in the template -- used for circ rules )
224 my $itemtypes = GetItemTypes;
228 my $imgdir = getitemtypeimagesrc();
229 foreach my $thisitemtype (sort keys %$itemtypes) {
230 my %row =( number=>$cnt++,
231 imageurl=>$imgdir."/".$itemtypes->{$thisitemtype}->{'imageurl'},
232 code => $thisitemtype,
233 selected => $selected,
234 description => $itemtypes->{$thisitemtype}->{'description'},
237 $selected = 0 if ($selected) ;
238 push @itemtypesloop, \%row;
240 $template->param(itemtypeloop => \@itemtypesloop);
242 # # load the itypes (Called item types in the template -- just authorized values for searching)
243 # my ($itypecount,@itype_loop) = GetCcodes();
244 # $template->param(itypeloop=>\@itype_loop,);
246 # load the languages ( for switching from one template to another )
247 # my @languages_options = displayLanguages($cgi);
248 # my $languages_count = @languages_options;
249 # if($languages_count > 1){
250 # $template->param(languages => \@languages_options);
253 # The following should only be loaded if we're bringing up the advanced search template
254 if ( $template_name eq "catalogue/advsearch.tmpl" ) {
255 # load the servers (used for searching -- to do federated searching, etc.)
256 my $primary_servers_loop;# = displayPrimaryServers();
257 $template->param(outer_servers_loop => $primary_servers_loop,);
259 my $secondary_servers_loop;# = displaySecondaryServers();
260 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
262 # load the limit types (icon-based limits in advanced search page)
263 my $outer_limit_types_loop = displayLimitTypes();
264 $template->param(outer_limit_types_loop => $outer_limit_types_loop,);
266 # load the search indexes (what a user can choose to search by)
267 my $indexes = displayIndexes();
269 # determine what to display next to the search boxes (ie, boolean option
270 # shouldn't appear on the first one, scan indexes should, adding a new
271 # box should only appear on the last, etc.
272 # FIXME: this stuff should be cleaned up a bit and the html should be turned
273 # into flags for the template -- I'll work on that soon -- JF
274 my @search_boxes_array;
275 my $search_boxes_count = 1; # should be a syspref
276 for (my $i=0;$i<=$search_boxes_count;$i++) {
277 my $this_index =[@$indexes]; # clone the data, not just the reference
278 #@$this_index[$i]->{selected} = "selected";
280 push @search_boxes_array,
281 {indexes => $this_index,
282 search_boxes_label => 1,
287 elsif ($i==$search_boxes_count) {
288 push @search_boxes_array,
289 {indexes => $indexes,
293 push @search_boxes_array,
294 {indexes => $indexes,};
297 $template->param(uc(C4::Context->preference("marcflavour")) => 1,
298 search_boxes_loop => \@search_boxes_array);
300 # load the language limits (for search)
301 my $languages_limit_loop = getAllLanguages();
302 $template->param(search_languages_loop => $languages_limit_loop,);
304 # load the subtype limits
305 my $outer_subtype_limits_loop = displaySubtypesLimit();
306 $template->param(outer_subtype_limits_loop => $outer_subtype_limits_loop,);
308 my $expanded_options;
309 if (not defined $cgi->param('expanded_options')){
310 $expanded_options = C4::Context->preference("expandedSearchOption");
313 $expanded_options = $cgi->param('expanded_options');
315 $template->param(expanded_options => $expanded_options);
317 # load the sort_by options for the template
318 my $sort_by = $cgi->param('sort_by');
319 my $sort_by_loop = displaySortby($sort_by);
320 $template->param(sort_by_loop => $sort_by_loop);
322 output_html_with_http_headers $cgi, $cookie, $template->output;
326 ### OK, if we're this far, we're performing an actual search
328 # Fetch the paramater list as a hash in scalar context:
329 # * returns paramater list as tied hash ref
330 # * we can edit the values by changing the key
331 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
332 my $params = $cgi->Vars;
334 # Params that can have more than one value
335 # sort by is used to sort the query
337 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
338 # load the sort_by options for the template
339 my $sort_by = $params->{'sort_by'};
340 my $sort_by_loop = displaySortby($sort_by);
341 $template->param(sort_by_loop => $sort_by_loop);
343 # Use the servers defined, or just search our local catalog(default)
345 @servers = split("\0",$params->{'server'}) if $params->{'server'};
347 #FIXME: this should be handled using Context.pm
348 @servers = ("biblioserver");
349 # @servers = C4::Context->config("biblioserver");
352 # operators include boolean and proximity operators and are used
353 # to evaluate multiple operands
355 @operators = split("\0",$params->{'op'}) if $params->{'op'};
357 # indexes are query qualifiers, like 'title', 'author', etc. They
358 # can be simple or complex
360 @indexes = split("\0",$params->{'idx'}) if $params->{'idx'};
362 # an operand can be a single term, a phrase, or a complete ccl query
364 @operands = split("\0",$params->{'q'}) if $params->{'q'};
366 # limits are use to limit to results to a pre-defined category such as branch or language
368 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
371 foreach my $limit(@limits) {
372 if ($limit =~/available/) {
376 $template->param(available => $available);
377 push @limits, map "yr:".$_, split("\0",$params->{'limit-yr'}) if $params->{'limit-yr'};
379 # Params that can only have one value
380 my $query = $params->{'q'};
381 my $scan = $params->{'scan'};
382 my $results_per_page = $params->{'count'} || 20;
383 my $offset = $params->{'offset'} || 0;
385 my $expanded_facet = $params->{'expand'};
387 # Define some global variables
388 my $error; # used for error handling
389 my $search_desc; # the query expressed in terms that humans understand
390 my $koha_query; # the query expressed in terms that zoom understands with field weighting and stemming
392 my $query_type; # usually not needed, but can be used to trigger ccl, cql, or pqf queries if set
394 ## I. BUILD THE QUERY
395 ($error,$search_desc,$koha_query,$federated_query,$query_type) = buildQuery($query,\@operators,\@operands,\@indexes,\@limits);
397 ## II. DO THE SEARCH AND GET THE RESULTS
398 my $total; # the total results for the whole set
399 my $facets; # this object stores the faceted results that display on the left-hand of the results page
405 ($error, $results_hashref, $facets) = getRecords($koha_query,$federated_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
409 $template->param(query_error => $error.$@);
411 output_html_with_http_headers $cgi, $cookie, $template->output;
415 # At this point, each server has given us a result set
416 # now we build that set for template display
417 my @sup_results_array;
418 for (my $i=0;$i<=@servers;$i++) {
419 my $server = $servers[$i];
420 if ($server =~/biblioserver/) { # this is the local bibliographic server
421 $hits = $results_hashref->{$server}->{"hits"};
422 my @newresults = searchResults( $search_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
423 $total = $total + $results_hashref->{$server}->{"hits"};
425 $template->param(total => $hits);
426 $template->param(searchdesc => ($query_type?"$query_type=":"")."$search_desc" );
427 $template->param(results_per_page => $results_per_page);
428 $template->param(SEARCH_RESULTS => \@newresults);
431 my $pages = ceil($hits / $results_per_page);
432 my $current_page_number = 1;
433 $current_page_number = ($offset / $results_per_page + 1) if $offset;
434 my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
435 my $next_page_offset = $offset + $results_per_page;
436 for (my $j=1; $j<=$pages;$j++) {
437 my $this_offset = (($j*$results_per_page)-$results_per_page);
438 my $this_page_number = $j;
439 my $highlight = 1 if ($this_page_number == $current_page_number);
440 if ($this_page_number <= $pages) {
441 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
444 $template->param(PAGE_NUMBERS => \@page_numbers,
445 previous_page_offset => $previous_page_offset,
446 next_page_offset => $next_page_offset) unless $pages < 2;
448 } # end of the if local
450 # check if it's a z3950 or opensearch source
451 my $zed3950 = 0; # FIXME :: Hardcoded value.
453 my @inner_sup_results_array;
454 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
455 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
456 my $control_number = $marc_record_object->field('010')->subfield('a') if $marc_record_object->field('010');
457 $control_number =~ s/^ //g;
458 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";
459 my $title = $marc_record_object->title();
460 push @inner_sup_results_array, {
465 my $servername = $server;
466 push @sup_results_array, { servername => $servername, inner_sup_results_loop => \@inner_sup_results_array};
467 $template->param(outer_sup_results_loop => \@sup_results_array);
471 } #/end of the for loop
472 #$template->param(FEDERATED_RESULTS => \@results_array);
476 #classlist => $classlist,
478 searchdesc => ($query_type?"$query_type=":"")."$search_desc",
480 facets_loop => $facets,
481 suggestion => C4::Context->preference("suggestion"),
482 virtualshelves => C4::Context->preference("virtualshelves"),
483 LibraryName => C4::Context->preference("LibraryName"),
484 OpacNav => C4::Context->preference("OpacNav"),
485 opaccredits => C4::Context->preference("opaccredits"),
486 AmazonContent => C4::Context->preference("AmazonContent"),
487 opacsmallimage => C4::Context->preference("opacsmallimage"),
488 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
489 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
490 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
492 search_error => $error,
494 ## Now let's find out if we have any supplemental data to show the user
495 # and in the meantime, save the current query for statistical purposes, etc.
496 my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
497 my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
498 my $phrases = $search_desc;
501 if ( C4::Context->preference("kohaspsuggest") ) {
503 my $koha_spsuggest_dbh;
504 # FIXME: this needs to be moved to Context.pm
506 $koha_spsuggest_dbh=DBI->connect("DBI:mysql:suggest:66.213.78.76","auth","Free2cirC");
509 warn "can't connect to spsuggest db";
512 my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
513 my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
514 my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
515 $koha_spsuggest_sth->execute($phrases);
516 while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
517 $spsuggestion =~ s/(:|\/)//g;
519 $line{spsuggestion} = $spsuggestion;
520 push @koha_spsuggest,\%line;
524 # Now save the current query
525 $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
526 #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
527 $koha_spsuggest_sth->finish;
529 $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
530 $template->param( SPELL_SUGGEST => \@koha_spsuggest,
535 warn "Kohaspsuggest failure:".$@;
539 # VI. BUILD THE TEMPLATE
540 output_html_with_http_headers $cgi, $cookie, $template->output;