catalogue/search.pl

   1 #!/usr/bin/perl
   2 # Script to perform searching
   3 # For documentation try 'perldoc /path/to/search'
   4 #
   5 # Copyright 2006 LibLime
   6 # Copyright 2010 BibLibre
   7 #
   8 # This file is part of Koha
   9 #
  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.
  14 #
  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.
  19 #
  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>.
  22
  23 =head1 NAME
  24
  25 search - a search script for finding records in a Koha system (Version 3)
  26
  27 =head1 OVERVIEW
  28
  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.
  35
  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
  38 free to disagree :-)
  39
  40 I will attempt to describe what is happening at each part of this script.
  41 -- Joshua Ferraro <jmf AT liblime DOT com>
  42
  43 =head2 INTRO
  44
  45 This script performs two functions:
  46
  47 =over
  48
  49 =item 1. interacts with Koha to retrieve and display the results of a search
  50
  51 =item 2. loads the advanced search page
  52
  53 =back
  54
  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
  58 for that function.
  59
  60 =head2 LOADING ADVANCED SEARCH PAGE
  61
  62 This is fairly straightforward, and I won't go into detail ;-)
  63
  64 =head2 PERFORMING A SEARCH
  65
  66 If we're performing a search, this script  performs three primary
  67 operations:
  68
  69 =over
  70
  71 =item 1. builds query strings (yes, plural)
  72
  73 =item 2. perform the search and return the results array
  74
  75 =item 3. build the HTML for output to the template
  76
  77 =back
  78
  79 There are several additional secondary functions performed that I will
  80 not cover in detail.
  81
  82 =head3 1. Building Query Strings
  83
  84 There are several types of queries needed in the process of search and retrieve:
  85
  86 =over
  87
  88 =item 1 $query - the fully-built query passed to zebra
  89
  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.
  95
  96 This query incorporates query profiles that aren't compatible with most non-Zebra
  97 Z39.50 targets to acomplish the field weighting and relevance ranking.
  98
  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
 101
 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).
 104
 105 =item 3 $query_cgi - passed to the template / saved for future refinements of
 106 the query (by user)
 107
 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.
 110
 111 =item 4 $query_desc - Human search description - what the user sees in search
 112 feedback area
 113
 114 This is a simple string that is human readable. It will contain '=', ',', etc.
 115
 116 =back
 117
 118 =head3 2. Perform the Search
 119
 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.
 123
 124 =head3 3. Build HTML
 125
 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.
 128
 129 =head3 Additional Notes
 130
 131 Not yet completed...
 132
 133 =cut
 134
 135 use Modern::Perl;
 136
 137 ## STEP 1. Load things that are used in both search page and
 138 # results page and decide which template to load, operations
 139 # to perform, etc.
 140
 141 ## load Koha modules
 142 use C4::Context;
 143 use C4::Output;
 144 use C4::Auth qw(:DEFAULT get_session);
 145 use C4::Search;
 146 use C4::Languages qw(getLanguages);
 147 use C4::Koha;
 148 use URI::Escape;
 149 use POSIX qw(ceil floor);
 150 use C4::Search::History;
 151
 152 use Koha::ItemTypes;
 153 use Koha::LibraryCategories;
 154 use Koha::Patrons;
 155 use Koha::SearchEngine::Search;
 156 use Koha::SearchEngine::QueryBuilder;
 157 use Koha::Virtualshelves;
 158
 159 use URI::Escape;
 160
 161 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
 162 # create a new CGI object
 163 # FIXME: no_undef_params needs to be tested
 164 use CGI qw('-no_undef_params' -utf8 );
 165 my $cgi = new CGI;
 166
 167 # decide which template to use
 168 my $template_name;
 169 my $template_type;
 170 my @params = $cgi->multi_param("limit");
 171 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
 172     $template_name = 'catalogue/results.tt';
 173 }
 174 else {
 175     $template_name = 'catalogue/advsearch.tt';
 176     $template_type = 'advsearch';
 177 }
 178 # load the template
 179 my ($template, $borrowernumber, $cookie) = get_template_and_user({
 180     template_name => $template_name,
 181     query => $cgi,
 182     type => "intranet",
 183     authnotrequired => 0,
 184     flagsrequired   => { catalogue => 1 },
 185     }
 186 );
 187
 188 my $lang = C4::Languages::getlanguage($cgi);
 189
 190 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 191     $template->param('UNIMARC' => 1);
 192 }
 193
 194 if($cgi->cookie("holdfor")){
 195     my $holdfor_patron = Koha::Patrons->find( $cgi->cookie("holdfor") );
 196     $template->param(
 197         holdfor => $cgi->cookie("holdfor"),
 198         holdfor_surname => $holdfor_patron->surname,
 199         holdfor_firstname => $holdfor_patron->firstname,
 200         holdfor_cardnumber => $holdfor_patron->cardnumber,
 201     );
 202 }
 203
 204 # get biblionumbers stored in the cart
 205 my @cart_list;
 206
 207 if($cgi->cookie("intranet_bib_list")){
 208     my $cart_list = $cgi->cookie("intranet_bib_list");
 209     @cart_list = split(/\//, $cart_list);
 210 }
 211
 212 # load the branches
 213 my $categories = Koha::LibraryCategories->search( { categorytype => 'searchdomain' }, { order_by => [ 'categorytype', 'categorycode' ] } );
 214
 215 $template->param(
 216     selected_branchcode => ( C4::Context->IsSuperLibrarian ? C4::Context->userenv : '' ),
 217     searchdomainloop => $categories
 218 );
 219
 220 # load the Type stuff
 221 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 222 # the index parameter is different for item-level itemtypes
 223 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 224 my @advancedsearchesloop;
 225 my $cnt;
 226 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 227 my @advanced_search_types = split(/\|/, $advanced_search_types);
 228
 229 foreach my $advanced_srch_type (@advanced_search_types) {
 230     $advanced_srch_type =~ s/^\s*//;
 231     $advanced_srch_type =~ s/\s*$//;
 232    if ($advanced_srch_type eq 'itemtypes') {
 233    # itemtype is a special case, since it's not defined in authorized values
 234         my @itypesloop;
 235         foreach my $thisitemtype ( sort {$itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes ) {
 236             my %row =(  number=>$cnt++,
 237                 ccl => "$itype_or_itemtype,phr",
 238                 code => $thisitemtype,
 239                 description => $itemtypes->{$thisitemtype}->{translated_description},
 240                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 241             );
 242             push @itypesloop, \%row;
 243         }
 244         my %search_code = (  advanced_search_type => $advanced_srch_type,
 245                              code_loop => \@itypesloop );
 246         push @advancedsearchesloop, \%search_code;
 247     } else {
 248     # covers all the other cases: non-itemtype authorized values
 249        my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 250         my @authvalueloop;
 251         for my $thisitemtype (@$advsearchtypes) {
 252                 my %row =(
 253                                 number=>$cnt++,
 254                                 ccl => $advanced_srch_type,
 255                 code => $thisitemtype->{authorised_value},
 256                 description => $thisitemtype->{'lib'},
 257                 imageurl => getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
 258                 );
 259                 push @authvalueloop, \%row;
 260         }
 261         my %search_code = (  advanced_search_type => $advanced_srch_type,
 262                              code_loop => \@authvalueloop );
 263         push @advancedsearchesloop, \%search_code;
 264     }
 265 }
 266 $template->param(advancedsearchesloop => \@advancedsearchesloop);
 267 my $types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 268 my $advancedsearchesloop = prepare_adv_search_types($types);
 269 $template->param(advancedsearchesloop => $advancedsearchesloop);
 270
 271 # The following should only be loaded if we're bringing up the advanced search template
 272 if ( $template_type eq 'advsearch' ) {
 273
 274     # load the servers (used for searching -- to do federated searching, etc.)
 275     my $primary_servers_loop;# = displayPrimaryServers();
 276     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 277
 278     my $secondary_servers_loop;
 279     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 280
 281     # set the default sorting
 282     if (   C4::Context->preference('OPACdefaultSortField')
 283         && C4::Context->preference('OPACdefaultSortOrder') ) {
 284         my $default_sort_by =
 285             C4::Context->preference('defaultSortField') . '_'
 286           . C4::Context->preference('defaultSortOrder');
 287         $template->param( sort_by => $default_sort_by  );
 288     }
 289
 290     # determine what to display next to the search boxes (ie, boolean option
 291     # shouldn't appear on the first one, scan indexes should, adding a new
 292     # box should only appear on the last, etc.
 293     my @search_boxes_array;
 294     my $search_boxes_count = 3; # begin whith 3 boxes
 295     # FIXME: all this junk can be done in TMPL using __first__ and __last__
 296     for (my $i=1;$i<=$search_boxes_count;$i++) {
 297         # if it's the first one, don't display boolean option, but show scan indexes
 298         if ($i==1) {
 299             push @search_boxes_array, {scan_index => 1};
 300         }
 301         # if it's the last one, show the 'add field' box
 302         elsif ($i==$search_boxes_count) {
 303             push @search_boxes_array,
 304                 {
 305                 boolean => 1,
 306                 add_field => 1,
 307                 };
 308         }
 309         else {
 310             push @search_boxes_array,
 311                 {
 312                 boolean => 1,
 313                 };
 314         }
 315
 316     }
 317     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 318                       search_boxes_loop => \@search_boxes_array);
 319
 320     # load the language limits (for search)
 321     my $languages_limit_loop = getLanguages($lang, 1);
 322     $template->param(search_languages_loop => $languages_limit_loop,);
 323
 324     # Expanded search options in advanced search:
 325     # use the global setting by default, but let the user override it
 326     {
 327         my $expanded = $cgi->param('expanded_options');
 328         $expanded = C4::Context->preference("expandedSearchOption") || 0
 329             if !defined($expanded) || $expanded !~ /^0|1$/;
 330         $template->param( expanded_options => $expanded );
 331     }
 332
 333     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 334
 335     output_html_with_http_headers $cgi, $cookie, $template->output;
 336     exit;
 337 }
 338
 339 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 340
 341 # Fetch the paramater list as a hash in scalar context:
 342 #  * returns paramater list as tied hash ref
 343 #  * we can edit the values by changing the key
 344 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 345 my $params = $cgi->Vars;
 346
 347 # Params that can have more than one value
 348 # sort by is used to sort the query
 349 # in theory can have more than one but generally there's just one
 350 my @sort_by;
 351 my $default_sort_by;
 352 if (   C4::Context->preference('defaultSortField')
 353     && C4::Context->preference('defaultSortOrder') ) {
 354     $default_sort_by =
 355         C4::Context->preference('defaultSortField') . '_'
 356       . C4::Context->preference('defaultSortOrder');
 357 }
 358
 359 @sort_by = $cgi->multi_param('sort_by');
 360 $sort_by[0] = $default_sort_by unless $sort_by[0];
 361 foreach my $sort (@sort_by) {
 362     $template->param($sort => 1) if $sort;
 363 }
 364 $template->param('sort_by' => $sort_by[0]);
 365
 366 # Use the servers defined, or just search our local catalog(default)
 367 my @servers = $cgi->multi_param('server');
 368 unless (@servers) {
 369     #FIXME: this should be handled using Context.pm
 370     @servers = ("biblioserver");
 371     # @servers = C4::Context->config("biblioserver");
 372 }
 373 # operators include boolean and proximity operators and are used
 374 # to evaluate multiple operands
 375 my @operators = map uri_unescape($_), $cgi->multi_param('op');
 376
 377 # indexes are query qualifiers, like 'title', 'author', etc. They
 378 # can be single or multiple parameters separated by comma: kw,right-Truncation
 379 my @indexes = map uri_unescape($_), $cgi->multi_param('idx');
 380
 381 # if a simple index (only one)  display the index used in the top search box
 382 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
 383     my $idx = "ms_".$indexes[0];
 384     $idx =~ s/\,/comma/g;  # template toolkit doesnt like variables with a , in it
 385     $template->param($idx => 1);
 386 }
 387
 388 # an operand can be a single term, a phrase, or a complete ccl query
 389 my @operands = map uri_unescape($_), $cgi->multi_param('q');
 390
 391 # limits are use to limit to results to a pre-defined category such as branch or language
 392 my @limits = map uri_unescape($_), $cgi->multi_param('limit');
 393 my @nolimits = map uri_unescape($_), $cgi->multi_param('nolimit');
 394 my %is_nolimit = map { $_ => 1 } @nolimits;
 395 @limits = grep { not $is_nolimit{$_} } @limits;
 396
 397 if($params->{'multibranchlimit'}) {
 398     my $library_category = Koha::LibraryCategories->find( $params->{multibranchlimit} );
 399     my @libraries = $library_category->libraries;
 400     my $multibranch = '('.join( " or ", map { 'branch: ' . $_->id } @libraries ) .')';
 401     push @limits, $multibranch if ($multibranch ne  '()');
 402 }
 403
 404 my $available;
 405 foreach my $limit(@limits) {
 406     if ($limit =~/available/) {
 407         $available = 1;
 408     }
 409 }
 410 $template->param(available => $available);
 411
 412 # append year limits if they exist
 413 my $limit_yr;
 414 my $limit_yr_value;
 415 if ($params->{'limit-yr'}) {
 416     if ($params->{'limit-yr'} =~ /\d{4}/) {
 417         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 418         $limit_yr_value = $params->{'limit-yr'};
 419     }
 420     push @limits,$limit_yr;
 421     #FIXME: Should return a error to the user, incorect date format specified
 422 }
 423
 424 # convert indexes and operands to corresponding parameter names for the z3950 search
 425 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 426 my $z3950par;
 427 my $indexes2z3950 = {
 428     kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 429     'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 430     ti=>'title', 'ti,phr'=>'title', se=>'title'
 431 };
 432 for (my $ii = 0; $ii < @operands; ++$ii)
 433 {
 434     my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
 435     if (defined $name && defined $operands[$ii])
 436     {
 437         $z3950par ||= {};
 438         $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 439     }
 440 }
 441
 442
 443 # Params that can only have one value
 444 my $scan = $params->{'scan'};
 445 my $count = C4::Context->preference('numSearchResults') || 20;
 446 my $results_per_page = $params->{'count'} || $count;
 447 my $offset = $params->{'offset'} || 0;
 448 $offset = 0 if $offset < 0;
 449 my $page = $cgi->param('page') || 1;
 450 #my $offset = ($page-1)*$results_per_page;
 451 my $hits;
 452 my $expanded_facet = $params->{'expand'};
 453
 454 # Define some global variables
 455 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
 456
 457 my $builder = Koha::SearchEngine::QueryBuilder->new(
 458     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 459 my $searcher = Koha::SearchEngine::Search->new(
 460     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 461
 462 ## I. BUILD THE QUERY
 463 (
 464     $error,             $query, $simple_query, $query_cgi,
 465     $query_desc,        $limit, $limit_cgi,    $limit_desc,
 466     $query_type
 467   )
 468   = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
 469     \@sort_by, $scan, $lang );
 470
 471 ## parse the query_cgi string and put it into a form suitable for <input>s
 472 my @query_inputs;
 473 my $scan_index_to_use;
 474 my $scan_search_term_to_use;
 475
 476 for my $this_cgi ( split('&',$query_cgi) ) {
 477     next unless $this_cgi;
 478     $this_cgi =~ m/(.*?)=(.*)/;
 479     my $input_name = $1;
 480     my $input_value = $2;
 481     push @query_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape( $input_value ) ) };
 482     if ($input_name eq 'idx') {
 483         $scan_index_to_use = $input_value; # unless $scan_index_to_use;
 484     }
 485     if ($input_name eq 'q') {
 486         $scan_search_term_to_use = Encode::decode_utf8( uri_unescape( $input_value ));
 487     }
 488 }
 489 $template->param ( QUERY_INPUTS => \@query_inputs,
 490                    scan_index_to_use => $scan_index_to_use,
 491                    scan_search_term_to_use => $scan_search_term_to_use );
 492
 493 ## parse the limit_cgi string and put it into a form suitable for <input>s
 494 my @limit_inputs;
 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 };
 500         next;
 501     }
 502     $this_cgi =~ m/(.*=)(.*)/;
 503     my $input_name = $1;
 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) ) };
 507 }
 508 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 509
 510 ## II. DO THE SEARCH AND GET THE RESULTS
 511 my $total; # the total results for the whole set
 512 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 513 my $results_hashref;
 514
 515 eval {
 516     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 517     ( $error, $results_hashref, $facets ) = $searcher->search_compat(
 518         $query,            $simple_query, \@sort_by,       \@servers,
 519         $results_per_page, $offset,       $expanded_facet, undef,
 520         $itemtypes,        $query_type,   $scan
 521     );
 522 };
 523
 524 if ($@ || $error) {
 525     $template->param(query_error => $error.$@);
 526     output_html_with_http_headers $cgi, $cookie, $template->output;
 527     exit;
 528 }
 529
 530 # At this point, each server has given us a result set
 531 # now we build that set for template display
 532 my @sup_results_array;
 533 for (my $i=0;$i<@servers;$i++) {
 534     my $server = $servers[$i];
 535     if ($server =~/biblioserver/) { # this is the local bibliographic server
 536         $hits = $results_hashref->{$server}->{"hits"};
 537         my $page = $cgi->param('page') || 0;
 538         my @newresults = searchResults('intranet', $query_desc, $hits, $results_per_page, $offset, $scan,
 539                                        $results_hashref->{$server}->{"RECORDS"});
 540         $total = $total + $results_hashref->{$server}->{"hits"};
 541
 542         # Search history
 543         if (C4::Context->preference('EnableSearchHistory')) {
 544             unless ( $offset ) {
 545                 my $path_info = $cgi->url(-path_info=>1);
 546                 my $query_cgi_history = $cgi->url(-query=>1);
 547                 $query_cgi_history =~ s/^$path_info\?//;
 548                 $query_cgi_history =~ s/;/&/g;
 549                 my $query_desc_history = $query_desc;
 550                 $query_desc_history .= ", $limit_desc"
 551                     if $limit_desc;
 552
 553                 C4::Search::History::add({
 554                     userid => $borrowernumber,
 555                     sessionid => $cgi->cookie("CGISESSID"),
 556                     query_desc => $query_desc_history,
 557                     query_cgi => $query_cgi_history,
 558                     total => $total,
 559                     type => "biblio",
 560                 });
 561             }
 562             $template->param( EnableSearchHistory => 1 );
 563         }
 564
 565         ## If there's just one result, redirect to the detail page
 566         if ($total == 1) {
 567             my $biblionumber = $newresults[0]->{biblionumber};
 568             my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 569             my $views = { C4::Search::enabled_staff_search_views };
 570             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 571                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
 572             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 573                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
 574             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 575                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
 576             } else {
 577                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 578             }
 579             exit;
 580         }
 581
 582         # set up parameters if user wishes to re-run the search
 583         # as a Z39.50 search
 584         $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 585
 586         if ($hits) {
 587             $template->param(total => $hits);
 588             my $limit_cgi_not_availablity = $limit_cgi;
 589             $limit_cgi_not_availablity =~ s/&limit=available//g;
 590             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 591             $template->param(limit_cgi => $limit_cgi);
 592             $template->param(query_cgi => $query_cgi);
 593             $template->param(query_desc => $query_desc);
 594             $template->param(limit_desc => $limit_desc);
 595             $template->param(offset     => $offset);
 596             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 597             if ($query_desc || $limit_desc) {
 598                 $template->param(searchdesc => 1);
 599             }
 600             $template->param(results_per_page =>  $results_per_page);
 601             # must define a value for size if not present in DB
 602             # in order to avoid problems generated by the default size value in TT
 603             foreach my $line (@newresults) {
 604                 if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
 605                 # while we're checking each line, see if item is in the cart
 606                 if ( grep {$_ eq $line->{'biblionumber'}} @cart_list) {
 607                     $line->{'incart'} = 1;
 608                 }
 609             }
 610             $template->param(SEARCH_RESULTS => \@newresults);
 611             ## FIXME: add a global function for this, it's better than the current global one
 612             ## Build the page numbers on the bottom of the page
 613             my @page_numbers;
 614             # total number of pages there will be
 615             my $pages = ceil($hits / $results_per_page);
 616             my $last_page_offset = ( $pages -1 ) * $results_per_page;
 617             # default page number
 618             my $current_page_number = 1;
 619             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 620             my $previous_page_offset;
 621             if ( $offset >= $results_per_page ) {
 622                 $previous_page_offset = $offset - $results_per_page;
 623             }
 624             my $next_page_offset = $offset + $results_per_page;
 625             # If we're within the first 10 pages, keep it simple
 626             #warn "current page:".$current_page_number;
 627             if ($current_page_number < 10) {
 628                 # just show the first 10 pages
 629                 # Loop through the pages
 630                 my $pages_to_show = 10;
 631                 $pages_to_show = $pages if $pages<10;
 632                 for (my $i=1; $i<=$pages_to_show;$i++) {
 633                     # the offset for this page
 634                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 635                     # the page number for this page
 636                     my $this_page_number = $i;
 637                     # put it in the array
 638                     push @page_numbers,
 639                       { offset    => $this_offset,
 640                         pg        => $this_page_number,
 641                         # it should only be highlighted if it's the current page
 642                         highlight => $this_page_number == $current_page_number,
 643                         sort_by   => join ' ', @sort_by
 644                       };
 645
 646                 }
 647
 648             }
 649
 650             # now, show twenty pages, with the current one smack in the middle
 651             else {
 652                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 653                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 654                     my $this_page_number = $i-9;
 655                     if ( $this_page_number <= $pages ) {
 656                         push @page_numbers,
 657                           { offset    => $this_offset,
 658                             pg        => $this_page_number,
 659                             highlight => $this_page_number == $current_page_number,
 660                             sort_by   => join ' ', @sort_by
 661                           };
 662                     }
 663                 }
 664             }
 665             # FIXME: no previous_page_offset when pages < 2
 666             $template->param(   PAGE_NUMBERS => \@page_numbers,
 667                                 last_page_offset => $last_page_offset,
 668                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 669             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 670         }
 671
 672
 673         # no hits
 674         else {
 675             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 676         }
 677
 678     } # end of the if local
 679
 680     # asynchronously search the authority server
 681     elsif ($server =~/authorityserver/) { # this is the local authority server
 682         my @inner_sup_results_array;
 683         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 684             my $marc_record_object = C4::Search::new_record_from_zebra(
 685                 'authorityserver',
 686                 $sup_record
 687             );
 688             # warn "Authority Found: ".$marc_record_object->as_formatted();
 689             push @inner_sup_results_array, {
 690                 'title' => $marc_record_object->field(100)->subfield('a'),
 691                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 692             };
 693         }
 694         push @sup_results_array, {  servername => $server,
 695                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 696     }
 697     # FIXME: can add support for other targets as needed here
 698     $template->param(           outer_sup_results_loop => \@sup_results_array);
 699 } #/end of the for loop
 700 #$template->param(FEDERATED_RESULTS => \@results_array);
 701
 702 $template->{'VARS'}->{'searchid'} = $cgi->param('searchid');
 703
 704 my $gotonumber = $cgi->param('gotoNumber');
 705 if ($gotonumber eq 'last' || $gotonumber eq 'first') {
 706     $template->{'VARS'}->{'gotoNumber'} = $gotonumber;
 707 }
 708 $template->{'VARS'}->{'gotoPage'}   = 'detail.pl';
 709 my $gotopage = $cgi->param('gotoPage');
 710 $template->{'VARS'}->{'gotoPage'} = $gotopage
 711   if $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
 712
 713 for my $facet ( @$facets ) {
 714     for my $entry ( @{ $facet->{facets} } ) {
 715         my $index = $entry->{type_link_value};
 716         my $value = $entry->{facet_link_value};
 717         $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
 718     }
 719 }
 720
 721 $template->param(
 722             #classlist => $classlist,
 723             total => $total,
 724             opacfacets => 1,
 725             facets_loop => $facets,
 726             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 727             scan => $scan,
 728             search_error => $error,
 729 );
 730
 731 if ($query_desc || $limit_desc) {
 732     $template->param(searchdesc => 1);
 733 }
 734
 735 # VI. BUILD THE TEMPLATE
 736
 737 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 738     {
 739         borrowernumber => $borrowernumber,
 740         add_allowed    => 1,
 741         category       => 1,
 742     }
 743 );
 744 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 745     {
 746         borrowernumber => $borrowernumber,
 747         add_allowed    => 1,
 748         category       => 2,
 749     }
 750 );
 751
 752
 753 $template->param(
 754     add_to_some_private_shelves => $some_private_shelves,
 755     add_to_some_public_shelves  => $some_public_shelves,
 756 );
 757
 758 output_html_with_http_headers $cgi, $cookie, $template->output;
 759
 760
 761 =head2 prepare_adv_search_types
 762
 763     my $type = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 764     my @advanced_search_types = prepare_adv_search_types($type);
 765
 766 Different types can be searched for in the advanced search. This takes the
 767 system preference that defines these types and parses it into an arrayref for
 768 the template.
 769
 770 "itemtypes" is handled specially, as itemtypes aren't an authorised value.
 771 It also accounts for the "item-level_itypes" system preference.
 772
 773 =cut
 774
 775 sub prepare_adv_search_types {
 776     my ($types) = @_;
 777
 778     my @advanced_search_types = split( /\|/, $types );
 779
 780     # the index parameter is different for item-level itemtypes
 781     my $itype_or_itemtype =
 782       ( C4::Context->preference("item-level_itypes") ) ? 'itype' : 'itemtype';
 783     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 784
 785     my ( $cnt, @result );
 786     foreach my $advanced_srch_type (@advanced_search_types) {
 787         $advanced_srch_type =~ s/^\s*//;
 788         $advanced_srch_type =~ s/\s*$//;
 789         if ( $advanced_srch_type eq 'itemtypes' ) {
 790
 791        # itemtype is a special case, since it's not defined in authorized values
 792             my @itypesloop;
 793             foreach my $thisitemtype (
 794                 sort {
 795                     $itemtypes->{$a}->{'translated_description'}
 796                       cmp $itemtypes->{$b}->{'translated_description'}
 797                 } keys %$itemtypes
 798               )
 799             {
 800                 my %row = (
 801                     number      => $cnt++,
 802                     ccl         => "$itype_or_itemtype,phr",
 803                     code        => $thisitemtype,
 804                     description => $itemtypes->{$thisitemtype}->{'translated_description'},
 805                     imageurl    => getitemtypeimagelocation(
 806                         'intranet', $itemtypes->{$thisitemtype}->{'imageurl'}
 807                     ),
 808                 );
 809                 push @itypesloop, \%row;
 810             }
 811             my %search_code = (
 812                 advanced_search_type => $advanced_srch_type,
 813                 code_loop            => \@itypesloop
 814             );
 815             push @result, \%search_code;
 816         }
 817         else {
 818             # covers all the other cases: non-itemtype authorized values
 819             my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 820             my @authvalueloop;
 821             for my $thisitemtype (@$advsearchtypes) {
 822                 my %row = (
 823                     number      => $cnt++,
 824                     ccl         => $advanced_srch_type,
 825                     code        => $thisitemtype->{authorised_value},
 826                     description => $thisitemtype->{'lib'},
 827                     imageurl    => getitemtypeimagelocation(
 828                         'intranet', $thisitemtype->{'imageurl'}
 829                     ),
 830                 );
 831                 push @authvalueloop, \%row;
 832             }
 833             my %search_code = (
 834                 advanced_search_type => $advanced_srch_type,
 835                 code_loop            => \@authvalueloop
 836             );
 837             push @result, \%search_code;
 838         }
 839     }
 840     return \@result;
 841 }