2 # Script to perform searching
3 # For documentation try 'perldoc /path/to/search'
5 # Copyright 2006 LibLime
6 # Copyright 2010 BibLibre
8 # This file is part of Koha
10 # Koha is free software; you can redistribute it and/or modify it
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 search - a search script for finding records in a Koha system (Version 3)
29 This script utilizes a new search API for Koha 3. It is designed to be
30 simple to use and configure, yet capable of performing feats like stemming,
31 field weighting, relevance ranking, support for multiple query language
32 formats (CCL, CQL, PQF), full support for the bib1 attribute set, extended
33 attribute sets defined in Zebra profiles, access to the full range of Z39.50
34 and SRU query options, federated searches on Z39.50/SRU targets, etc.
36 The API as represented in this script is mostly sound, even if the individual
37 functions in Search.pm and Koha.pm need to be cleaned up. Of course, you are
40 I will attempt to describe what is happening at each part of this script.
41 -- Joshua Ferraro <jmf AT liblime DOT com>
45 This script performs two functions:
49 =item 1. interacts with Koha to retrieve and display the results of a search
51 =item 2. loads the advanced search page
55 These two functions share many of the same variables and modules, so the first
56 task is to load what they have in common and determine which template to use.
57 Once determined, proceed to only load the variables and procedures necessary
60 =head2 LOADING ADVANCED SEARCH PAGE
62 This is fairly straightforward, and I won't go into detail ;-)
64 =head2 PERFORMING A SEARCH
66 If we're performing a search, this script performs three primary
71 =item 1. builds query strings (yes, plural)
73 =item 2. perform the search and return the results array
75 =item 3. build the HTML for output to the template
79 There are several additional secondary functions performed that I will
82 =head3 1. Building Query Strings
84 There are several types of queries needed in the process of search and retrieve:
88 =item 1 $query - the fully-built query passed to zebra
90 This is the most complex query that needs to be built. The original design goal
91 was to use a custom CCL2PQF query parser to translate an incoming CCL query into
92 a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field
93 weighting, koha-specific relevance ranking, and stemming. When I have a chance
94 I'll try to flesh out this section to better explain.
96 This query incorporates query profiles that aren't compatible with most non-Zebra
97 Z39.50 targets to accomplish the field weighting and relevance ranking.
99 =item 2 $simple_query - a simple query that doesn't contain the field weighting,
100 stemming, etc., suitable to pass off to other search targets
102 This query is just the user's query expressed in CCL CQL, or PQF for passing to a
103 non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
105 =item 3 $query_cgi - passed to the template / saved for future refinements of
108 This is a simple string that completely expresses the query as a CGI string that
109 can be used for future refinements of the query or as a part of a history feature.
111 =item 4 $query_desc - Human search description - what the user sees in search
114 This is a simple string that is human readable. It will contain '=', ',', etc.
118 =head3 2. Perform the Search
120 This section takes the query strings and performs searches on the named servers,
121 including the Koha Zebra server, stores the results in a deeply nested object,
122 builds 'faceted results', and returns these objects.
126 The final major section of this script takes the objects collected thusfar and
127 builds the HTML for output to the template and user.
129 =head3 Additional Notes
137 ## STEP 1. Load things that are used in both search page and
138 # results page and decide which template to load, operations
143 use C4::Output qw( output_html_with_http_headers pagination_bar );
144 use C4::Circulation qw( barcodedecode );
145 use C4::Auth qw( get_template_and_user );
146 use C4::Search qw( searchResults enabled_staff_search_views z3950_search_args new_record_from_zebra );
147 use C4::Languages qw( getlanguage getLanguages );
148 use C4::Koha qw( getitemtypeimagelocation GetAuthorisedValues );
150 use POSIX qw(ceil floor);
151 use C4::Search qw( searchResults enabled_staff_search_views z3950_search_args new_record_from_zebra );
154 use Koha::Library::Groups;
156 use Koha::SearchEngine::Search;
157 use Koha::SearchEngine::QueryBuilder;
158 use Koha::Virtualshelves;
159 use Koha::SearchFields;
163 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
164 # create a new CGI object
165 # FIXME: no_undef_params needs to be tested
166 use CGI qw('-no_undef_params' -utf8 );
169 # decide which template to use
172 # limits are used to limit to results to a pre-defined category such as branch or language
173 my @limits = map uri_unescape($_), $cgi->multi_param("limit");
174 my @nolimits = map uri_unescape($_), $cgi->multi_param('nolimit');
175 my %is_nolimit = map { $_ => 1 } @nolimits;
176 @limits = grep { not $is_nolimit{$_} } @limits;
178 !$cgi->param('edit_search') &&
179 ( (@limits>=1) || (defined $cgi->param("q") && $cgi->param("q") ne "" ) || ($cgi->param('limit-yr')) )
181 $template_name = 'catalogue/results.tt';
182 $template_type = 'results';
185 $template_name = 'catalogue/advsearch.tt';
186 $template_type = 'advsearch';
189 my ($template, $borrowernumber, $cookie) = get_template_and_user({
190 template_name => $template_name,
193 flagsrequired => { catalogue => 1 },
197 my $lang = C4::Languages::getlanguage($cgi);
199 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
200 $template->param('UNIMARC' => 1);
203 if($cgi->cookie("holdfor")){
204 my $holdfor_patron = Koha::Patrons->find( $cgi->cookie("holdfor") );
205 if ( $holdfor_patron ) { # may have been deleted in the meanwhile
207 holdfor => $cgi->cookie("holdfor"),
208 holdfor_patron => $holdfor_patron,
213 if($cgi->cookie("holdforclub")){
214 my $holdfor_club = Koha::Clubs->find( $cgi->cookie("holdforclub") );
215 if ( $holdfor_club ) { # May have been deleted in the meanwhile
217 holdforclub => $cgi->cookie("holdforclub"),
218 holdforclub_name => $holdfor_club->name,
223 if($cgi->cookie("searchToOrder")){
224 my ( $basketno, $vendorid ) = split( /\//, $cgi->cookie("searchToOrder") );
226 searchtoorder_basketno => $basketno,
227 searchtoorder_vendorid => $vendorid
231 # get biblionumbers stored in the cart
234 if($cgi->cookie("intranet_bib_list")){
235 my $cart_list = $cgi->cookie("intranet_bib_list");
236 @cart_list = split(/\//, $cart_list);
240 Koha::Library::Groups->get_search_groups( { interface => 'staff' } )->as_list;
242 my $branch_limit = '';
243 my $limit_param = $cgi->param('limit');
244 if ( $limit_param and $limit_param =~ /branch:([\w-]+)/ ) {
249 search_groups => \@search_groups,
250 branch_limit => $branch_limit
253 # load the Type stuff
254 my $types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
255 my $advancedsearchesloop = prepare_adv_search_types($types);
256 $template->param(advancedsearchesloop => $advancedsearchesloop);
258 $template->param( searchid => scalar $cgi->param('searchid'), );
260 # The following should only be loaded if we're bringing up the advanced search template
261 if ( $template_type eq 'advsearch' ) {
263 my $expanded = $cgi->param('expanded_options');
264 if( $cgi->param('edit_search') ){
265 my @operators = $cgi->multi_param('op');
266 my @indexes = $cgi->multi_param('idx');
268 foreach my $limit (@limits){
269 if ( $limit eq 'available' ){
270 $template->param( limit_available => 1 );
272 my ($index,$value) = split(':',$limit);
274 if ( $index =~ /mc-/ ){
275 $limit_hash{$index . "_" . $value} = 1;
277 push @{$limit_hash{$index}}, $value;
281 $expanded = 1 if scalar @operators || scalar @limits;
282 $template->param( operators => \@operators );
283 $template->param( limits => \%limit_hash );
285 indexes => \@indexes,
286 sort => $cgi->param('sort_by'),
289 # load the servers (used for searching -- to do federated searching, etc.)
290 my $primary_servers_loop;# = displayPrimaryServers();
291 $template->param(outer_servers_loop => $primary_servers_loop,);
293 my $secondary_servers_loop;
294 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
296 # set the default sorting
297 if ( C4::Context->preference('defaultSortField')
298 && C4::Context->preference('defaultSortOrder') ) {
299 my $default_sort_by =
300 C4::Context->preference('defaultSortField') . '_'
301 . C4::Context->preference('defaultSortOrder');
302 $template->param( sort_by => $default_sort_by );
305 # determine what to display next to the search boxes
306 my @queries = $cgi->multi_param('q');
307 while( scalar @queries < 3 ){
310 $template->param(uc(C4::Context->preference("marcflavour")) =>1 );
312 # load the language limits (for search)
313 my $languages_limit_loop = getLanguages($lang, 1);
314 $template->param(search_languages_loop => $languages_limit_loop,);
315 $template->param( queries => \@queries );
317 # Expanded search options in advanced search:
318 # use the global setting by default, but let the user override it
320 $expanded = C4::Context->preference("expandedSearchOption") || 0
321 if !defined($expanded) || $expanded !~ /^0|1$/;
322 $template->param( expanded_options => $expanded );
325 $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
327 output_html_with_http_headers $cgi, $cookie, $template->output;
331 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
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;
338 # Params that can have more than one value
339 # sort by is used to sort the query
340 # in theory can have more than one but generally there's just one
343 if ( C4::Context->preference('defaultSortField')
344 && C4::Context->preference('defaultSortOrder') ) {
346 C4::Context->preference('defaultSortField') . '_'
347 . C4::Context->preference('defaultSortOrder');
350 @sort_by = $cgi->multi_param('sort_by');
351 $sort_by[0] = $default_sort_by unless $sort_by[0];
352 foreach my $sort (@sort_by) {
353 $template->param($sort => 1) if $sort;
355 $template->param('sort_by' => $sort_by[0]);
357 # Use the servers defined, or just search our local catalog(default)
358 my @servers = $cgi->multi_param('server');
360 #FIXME: this should be handled using Context.pm
361 @servers = ("biblioserver");
362 # @servers = C4::Context->config("biblioserver");
364 # operators include boolean and proximity operators and are used
365 # to evaluate multiple operands
366 my @operators = map uri_unescape($_), $cgi->multi_param('op');
368 # indexes are query qualifiers, like 'title', 'author', etc. They
369 # can be single or multiple parameters separated by comma: kw,right-Truncation
370 my @indexes = map uri_unescape($_), $cgi->multi_param('idx');
372 # if a simple index (only one) display the index used in the top search box
373 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
374 my $idx = "ms_".$indexes[0];
375 $idx =~ s/\,/comma/g; # template toolkit doesn't like variables with a , in it
376 $idx =~ s/-/dash/g; # template toolkit doesn't like variables with a dash in it
377 $template->param(header_pulldown => $idx);
380 # an operand can be a single term, a phrase, or a complete ccl query
381 my @operands = map uri_unescape($_), $cgi->multi_param('q');
383 # if a simple search, display the value in the search box
384 my $basic_search = 0;
385 if ($operands[0] && !$operands[1]) {
386 my $ms_query = $operands[0];
387 $ms_query =~ s/ #\S+//;
388 $template->param(ms_value => $ms_query);
393 foreach my $limit(@limits) {
394 if ($limit =~/available/) {
398 $template->param(available => $available);
400 # append year limits if they exist
403 if ($params->{'limit-yr'}) {
404 if ($params->{'limit-yr'} =~ /\d{4}/) {
405 $limit_yr = "yr,st-numeric:$params->{'limit-yr'}";
406 $limit_yr_value = $params->{'limit-yr'};
408 push @limits,$limit_yr;
409 #FIXME: Should return a error to the user, incorect date format specified
412 # convert indexes and operands to corresponding parameter names for the z3950 search
413 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
415 my $indexes2z3950 = {
416 kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
417 'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
418 ti=>'title', 'ti,phr'=>'title', se=>'title'
420 for (my $ii = 0; $ii < @operands; ++$ii)
422 my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
423 if (defined $name && defined $operands[$ii])
426 $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
431 # Params that can only have one value
432 my $scan = $params->{'scan'};
433 my $count = C4::Context->preference('numSearchResults') || 20;
434 my $results_per_page = $params->{'count'} || $count;
435 my $offset = $params->{'offset'} || 0;
436 my $whole_record = $params->{'whole_record'} || 0;
437 my $weight_search = $params->{'advsearch'} ? $params->{'weight_search'} || 0 : 1;
438 $offset = 0 if $offset < 0;
439 my $page = $cgi->param('page') || 1;
440 #my $offset = ($page-1)*$results_per_page;
442 # Define some global variables
443 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
445 my $builder = Koha::SearchEngine::QueryBuilder->new(
446 { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
447 my $searcher = Koha::SearchEngine::Search->new(
448 { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
450 # If index indicates the value is a barocode, we need to preproccess it before searching
451 for ( my $i = 0; $i < @operands; $i++ ) {
452 $operands[$i] = barcodedecode($operands[$i]) if $indexes[$i] eq 'bc';
455 ## I. BUILD THE QUERY
457 $error, $query, $simple_query, $query_cgi,
458 $query_desc, $limit, $limit_cgi, $limit_desc,
461 = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
462 \@sort_by, $scan, $lang, { weighted_fields => $weight_search, whole_record => $whole_record });
464 $template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
466 ## parse the query_cgi string and put it into a form suitable for <input>s
468 my $scan_index_to_use;
469 my $scan_search_term_to_use;
472 for my $this_cgi ( split('&', $query_cgi) ) {
473 next unless $this_cgi;
474 $this_cgi =~ m/(.*?)=(.*)/;
476 my $input_value = $2;
477 push @query_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape( $input_value ) ) };
478 if ($input_name eq 'idx') {
479 # The form contains multiple fields, so take the first value as the scan index
480 $scan_index_to_use = $input_value unless $scan_index_to_use;
482 if (!defined $scan_search_term_to_use && $input_name eq 'q') {
483 $scan_search_term_to_use = Encode::decode_utf8( uri_unescape( $input_value ));
488 $template->param ( QUERY_INPUTS => \@query_inputs,
489 scan_index_to_use => $scan_index_to_use,
490 scan_search_term_to_use => $scan_search_term_to_use );
492 ## parse the limit_cgi string and put it into a form suitable for <input>s
495 for my $this_cgi ( split('&', $limit_cgi) ) {
496 next unless $this_cgi;
497 # handle special case limit-yr
498 if ($this_cgi =~ /yr,st-numeric/) {
499 push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
502 $this_cgi =~ m/(.*=)(.*)/;
504 my $input_value = $2;
505 $input_name =~ s/=$//;
506 push @limit_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape($input_value) ) };
509 $template->param ( LIMIT_INPUTS => \@limit_inputs );
511 ## II. DO THE SEARCH AND GET THE RESULTS
512 my $total = 0; # the total results for the whole set
513 my $facets; # this object stores the faceted results that display on the left-hand of the results page
517 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
518 ( $error, $results_hashref, $facets ) = $searcher->search_compat(
519 $query, $simple_query, \@sort_by, \@servers,
520 $results_per_page, $offset, undef, $itemtypes,
526 my $query_error = q{};
527 $query_error .= $error if $error;
528 $query_error .= $@ if $@;
529 $template->param(query_error => $query_error);
530 output_html_with_http_headers $cgi, $cookie, $template->output;
534 # At this point, each server has given us a result set
535 # now we build that set for template display
536 my @sup_results_array;
537 for (my $i=0;$i<@servers;$i++) {
538 my $server = $servers[$i];
539 if ($server =~/biblioserver/) { # this is the local bibliographic server
540 my $hits = $results_hashref->{$server}->{"hits"} // 0;
541 if ( $hits == 0 && $basic_search ){
542 $operands[0] = '"'.$operands[0].'"'; #quote it
543 ## I. BUILD THE QUERY
545 $error, $query, $simple_query, $query_cgi,
546 $query_desc, $limit, $limit_cgi, $limit_desc,
549 = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
550 \@sort_by, $scan, $lang, { weighted_fields => $weight_search, whole_record => $whole_record });
551 my $quoted_results_hashref;
553 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
554 ( $error, $quoted_results_hashref, $facets ) = $searcher->search_compat(
555 $query, $simple_query, \@sort_by, ['biblioserver'],
556 $results_per_page, $offset, undef, $itemtypes,
560 my $quoted_hits = $quoted_results_hashref->{$server}->{"hits"} // 0;
562 $results_hashref->{'biblioserver'} = $quoted_results_hashref->{'biblioserver'};
563 $hits = $quoted_hits;
566 my $page = $cgi->param('page') || 0;
567 my @newresults = searchResults({ 'interface' => 'intranet' }, $query_desc, $hits, $results_per_page, $offset, $scan,
568 $results_hashref->{$server}->{"RECORDS"});
569 $total = $total + $hits;
572 if (C4::Context->preference('EnableSearchHistory')) {
574 my $path_info = $cgi->url(-path_info=>1);
575 my $query_cgi_history = $cgi->url(-query=>1);
576 $query_cgi_history =~ s/^$path_info\?//;
577 $query_cgi_history =~ s/;/&/g;
578 my $query_desc_history = $query_desc;
579 $query_desc_history .= ", $limit_desc"
582 C4::Search::History::add({
583 userid => $borrowernumber,
584 sessionid => $cgi->cookie("CGISESSID"),
585 query_desc => $query_desc_history,
586 query_cgi => $query_cgi_history,
591 $template->param( EnableSearchHistory => 1 );
594 ## If there's just one result, redirect to the detail page unless doing an index scan
595 if ($total == 1 && !$scan) {
596 my $biblionumber = $newresults[0]->{biblionumber};
597 my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
598 my $views = { C4::Search::enabled_staff_search_views };
599 if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
600 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber&found1=1");
601 } elsif ($defaultview eq 'marc' && $views->{can_view_MARC}) {
602 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber&found1=1");
603 } elsif ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
604 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber&found1=1");
606 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber&found1=1");
611 # set up parameters if user wishes to re-run the search
613 $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
614 $template->param(limit_cgi => $limit_cgi);
615 $template->param(query_cgi => $query_cgi);
616 $template->param(query_desc => $query_desc);
617 $template->param(limit_desc => $limit_desc);
618 $template->param(offset => $offset);
621 $template->param(total => $hits);
623 my $limit_cgi_not_availablity = $limit_cgi;
624 $limit_cgi_not_availablity =~ s/&limit=available//g;
625 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
627 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
628 if ($query_desc || $limit_desc) {
629 $template->param(searchdesc => 1);
631 $template->param(results_per_page => $results_per_page);
632 # must define a value for size if not present in DB
633 # in order to avoid problems generated by the default size value in TT
634 foreach my $line (@newresults) {
635 if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
636 # while we're checking each line, see if item is in the cart
637 if ( grep {$_ eq $line->{'biblionumber'}} @cart_list) {
638 $line->{'incart'} = 1;
641 my( $page_numbers, $hits_to_paginate, $pages, $current_page_number, $previous_page_offset, $next_page_offset, $last_page_offset ) =
642 Koha::SearchEngine::Search->pagination_bar(
645 max_result_window => $searcher->max_result_window,
646 results_per_page => $results_per_page,
651 $template->param( hits_to_paginate => $hits_to_paginate );
652 $template->param(SEARCH_RESULTS => \@newresults);
653 # FIXME: no previous_page_offset when pages < 2
654 $template->param( PAGE_NUMBERS => $page_numbers,
655 last_page_offset => $last_page_offset,
656 previous_page_offset => $previous_page_offset) unless $pages < 2;
657 $template->param( next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
663 $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
666 } # end of the if local
668 # asynchronously search the authority server
669 elsif ($server =~/authorityserver/) { # this is the local authority server
670 my @inner_sup_results_array;
671 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
672 my $marc_record_object = C4::Search::new_record_from_zebra(
676 # warn "Authority Found: ".$marc_record_object->as_formatted();
677 push @inner_sup_results_array, {
678 'title' => $marc_record_object->field(100)->subfield('a'),
679 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
682 push @sup_results_array, { servername => $server,
683 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
685 # FIXME: can add support for other targets as needed here
686 $template->param( outer_sup_results_loop => \@sup_results_array);
687 } #/end of the for loop
688 #$template->param(FEDERATED_RESULTS => \@results_array);
690 my $gotonumber = $cgi->param('gotoNumber');
691 if ( $gotonumber && ( $gotonumber eq 'last' || $gotonumber eq 'first' ) ) {
692 $template->{'VARS'}->{'gotoNumber'} = $gotonumber;
694 $template->{'VARS'}->{'gotoPage'} = 'detail.pl';
695 my $gotopage = $cgi->param('gotoPage');
696 $template->{'VARS'}->{'gotoPage'} = $gotopage
697 if $gotopage && $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
699 for my $facet ( @$facets ) {
700 for my $entry ( @{ $facet->{facets} } ) {
701 my $index = $entry->{type_link_value};
702 my $value = $entry->{facet_link_value};
703 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
708 #classlist => $classlist,
711 facets_loop => $facets,
712 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
714 search_error => $error,
717 if ($query_desc || $limit_desc) {
718 $template->param(searchdesc => 1);
721 # VI. BUILD THE TEMPLATE
723 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
725 borrowernumber => $borrowernumber,
730 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
732 borrowernumber => $borrowernumber,
740 add_to_some_private_shelves => $some_private_shelves,
741 add_to_some_public_shelves => $some_public_shelves,
744 output_html_with_http_headers $cgi, $cookie, $template->output;
747 =head2 prepare_adv_search_types
749 my $type = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
750 my @advanced_search_types = prepare_adv_search_types($type);
752 Different types can be searched for in the advanced search. This takes the
753 system preference that defines these types and parses it into an arrayref for
756 "itemtypes" is handled specially, as itemtypes aren't an authorised value.
757 It also accounts for the "item-level_itypes" system preference.
761 sub prepare_adv_search_types {
764 my @advanced_search_types = split( /\|/, $types );
766 # the index parameter is different for item-level itemtypes
767 my $itype_or_itemtype =
768 ( C4::Context->preference("item-level_itypes") ) ? 'itype' : 'itemtype';
769 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
771 my ( $cnt, @result );
772 foreach my $advanced_srch_type (@advanced_search_types) {
773 $advanced_srch_type =~ s/^\s*//;
774 $advanced_srch_type =~ s/\s*$//;
775 if ( $advanced_srch_type eq 'itemtypes' ) {
777 # itemtype is a special case, since it's not defined in authorized values
779 foreach my $thisitemtype (
781 $itemtypes->{$a}->{'translated_description'}
782 cmp $itemtypes->{$b}->{'translated_description'}
788 ccl => "$itype_or_itemtype,phr",
789 code => $thisitemtype,
790 description => $itemtypes->{$thisitemtype}->{'translated_description'},
791 imageurl => getitemtypeimagelocation(
792 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'}
795 push @itypesloop, \%row;
798 advanced_search_type => $advanced_srch_type,
799 code_loop => \@itypesloop
801 push @result, \%search_code;
804 # covers all the other cases: non-itemtype authorized values
805 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
807 for my $thisitemtype (@$advsearchtypes) {
810 ccl => $advanced_srch_type,
811 code => $thisitemtype->{authorised_value},
812 description => $thisitemtype->{'lib'},
813 imageurl => getitemtypeimagelocation(
814 'intranet', $thisitemtype->{'imageurl'}
817 push @authvalueloop, \%row;
820 advanced_search_type => $advanced_srch_type,
821 code_loop => \@authvalueloop
823 push @result, \%search_code;