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::Library::Groups;
 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 my @search_groups =
 213   Koha::Library::Groups->get_search_groups( { interface => 'staff' } );
 214 @search_groups = sort { $a->title cmp $b->title } @search_groups;
 215
 216 $template->param(
 217     selected_branchcode => ( C4::Context->IsSuperLibrarian ? C4::Context->userenv : '' ),
 218     search_groups    => \@search_groups,
 219 );
 220
 221 # load the Type stuff
 222 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 223 # the index parameter is different for item-level itemtypes
 224 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 225 my @advancedsearchesloop;
 226 my $cnt;
 227 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 228 my @advanced_search_types = split(/\|/, $advanced_search_types);
 229
 230 foreach my $advanced_srch_type (@advanced_search_types) {
 231     $advanced_srch_type =~ s/^\s*//;
 232     $advanced_srch_type =~ s/\s*$//;
 233    if ($advanced_srch_type eq 'itemtypes') {
 234    # itemtype is a special case, since it's not defined in authorized values
 235         my @itypesloop;
 236         foreach my $thisitemtype ( sort {$itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes ) {
 237             my %row =(  number=>$cnt++,
 238                 ccl => "$itype_or_itemtype,phr",
 239                 code => $thisitemtype,
 240                 description => $itemtypes->{$thisitemtype}->{translated_description},
 241                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 242             );
 243             push @itypesloop, \%row;
 244         }
 245         my %search_code = (  advanced_search_type => $advanced_srch_type,
 246                              code_loop => \@itypesloop );
 247         push @advancedsearchesloop, \%search_code;
 248     } else {
 249     # covers all the other cases: non-itemtype authorized values
 250        my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 251         my @authvalueloop;
 252         for my $thisitemtype (@$advsearchtypes) {
 253                 my %row =(
 254                                 number=>$cnt++,
 255                                 ccl => $advanced_srch_type,
 256                 code => $thisitemtype->{authorised_value},
 257                 description => $thisitemtype->{'lib'},
 258                 imageurl => getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
 259                 );
 260                 push @authvalueloop, \%row;
 261         }
 262         my %search_code = (  advanced_search_type => $advanced_srch_type,
 263                              code_loop => \@authvalueloop );
 264         push @advancedsearchesloop, \%search_code;
 265     }
 266 }
 267 $template->param(advancedsearchesloop => \@advancedsearchesloop);
 268 my $types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 269 my $advancedsearchesloop = prepare_adv_search_types($types);
 270 $template->param(advancedsearchesloop => $advancedsearchesloop);
 271
 272 # The following should only be loaded if we're bringing up the advanced search template
 273 if ( $template_type eq 'advsearch' ) {
 274
 275     # load the servers (used for searching -- to do federated searching, etc.)
 276     my $primary_servers_loop;# = displayPrimaryServers();
 277     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 278
 279     my $secondary_servers_loop;
 280     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 281
 282     # set the default sorting
 283     if (   C4::Context->preference('OPACdefaultSortField')
 284         && C4::Context->preference('OPACdefaultSortOrder') ) {
 285         my $default_sort_by =
 286             C4::Context->preference('defaultSortField') . '_'
 287           . C4::Context->preference('defaultSortOrder');
 288         $template->param( sort_by => $default_sort_by  );
 289     }
 290
 291     # determine what to display next to the search boxes (ie, boolean option
 292     # shouldn't appear on the first one, scan indexes should, adding a new
 293     # box should only appear on the last, etc.
 294     my @search_boxes_array;
 295     my $search_boxes_count = 3; # begin whith 3 boxes
 296     # FIXME: all this junk can be done in TMPL using __first__ and __last__
 297     for (my $i=1;$i<=$search_boxes_count;$i++) {
 298         # if it's the first one, don't display boolean option, but show scan indexes
 299         if ($i==1) {
 300             push @search_boxes_array, {scan_index => 1};
 301         }
 302         # if it's the last one, show the 'add field' box
 303         elsif ($i==$search_boxes_count) {
 304             push @search_boxes_array,
 305                 {
 306                 boolean => 1,
 307                 add_field => 1,
 308                 };
 309         }
 310         else {
 311             push @search_boxes_array,
 312                 {
 313                 boolean => 1,
 314                 };
 315         }
 316
 317     }
 318     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 319                       search_boxes_loop => \@search_boxes_array);
 320
 321     # load the language limits (for search)
 322     my $languages_limit_loop = getLanguages($lang, 1);
 323     $template->param(search_languages_loop => $languages_limit_loop,);
 324
 325     # Expanded search options in advanced search:
 326     # use the global setting by default, but let the user override it
 327     {
 328         my $expanded = $cgi->param('expanded_options');
 329         $expanded = C4::Context->preference("expandedSearchOption") || 0
 330             if !defined($expanded) || $expanded !~ /^0|1$/;
 331         $template->param( expanded_options => $expanded );
 332     }
 333
 334     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 335
 336     output_html_with_http_headers $cgi, $cookie, $template->output;
 337     exit;
 338 }
 339
 340 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 341
 342 # Fetch the paramater list as a hash in scalar context:
 343 #  * returns paramater list as tied hash ref
 344 #  * we can edit the values by changing the key
 345 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 346 my $params = $cgi->Vars;
 347
 348 # Params that can have more than one value
 349 # sort by is used to sort the query
 350 # in theory can have more than one but generally there's just one
 351 my @sort_by;
 352 my $default_sort_by;
 353 if (   C4::Context->preference('defaultSortField')
 354     && C4::Context->preference('defaultSortOrder') ) {
 355     $default_sort_by =
 356         C4::Context->preference('defaultSortField') . '_'
 357       . C4::Context->preference('defaultSortOrder');
 358 }
 359
 360 @sort_by = $cgi->multi_param('sort_by');
 361 $sort_by[0] = $default_sort_by unless $sort_by[0];
 362 foreach my $sort (@sort_by) {
 363     $template->param($sort => 1) if $sort;
 364 }
 365 $template->param('sort_by' => $sort_by[0]);
 366
 367 # Use the servers defined, or just search our local catalog(default)
 368 my @servers = $cgi->multi_param('server');
 369 unless (@servers) {
 370     #FIXME: this should be handled using Context.pm
 371     @servers = ("biblioserver");
 372     # @servers = C4::Context->config("biblioserver");
 373 }
 374 # operators include boolean and proximity operators and are used
 375 # to evaluate multiple operands
 376 my @operators = map uri_unescape($_), $cgi->multi_param('op');
 377
 378 # indexes are query qualifiers, like 'title', 'author', etc. They
 379 # can be single or multiple parameters separated by comma: kw,right-Truncation
 380 my @indexes = map uri_unescape($_), $cgi->multi_param('idx');
 381
 382 # if a simple index (only one)  display the index used in the top search box
 383 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
 384     my $idx = "ms_".$indexes[0];
 385     $idx =~ s/\,/comma/g;  # template toolkit doesnt like variables with a , in it
 386     $template->param($idx => 1);
 387 }
 388
 389 # an operand can be a single term, a phrase, or a complete ccl query
 390 my @operands = map uri_unescape($_), $cgi->multi_param('q');
 391
 392 # limits are use to limit to results to a pre-defined category such as branch or language
 393 my @limits = map uri_unescape($_), $cgi->multi_param('limit');
 394 my @nolimits = map uri_unescape($_), $cgi->multi_param('nolimit');
 395 my %is_nolimit = map { $_ => 1 } @nolimits;
 396 @limits = grep { not $is_nolimit{$_} } @limits;
 397
 398 if($params->{'multibranchlimit'}) {
 399     my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
 400     my @libraries = $search_group->all_libraries;
 401     my $multibranch = '('.join( " or ", map { 'branch: ' . $_->id } @libraries ) .')';
 402     push @limits, $multibranch if ($multibranch ne  '()');
 403 }
 404
 405 my $available;
 406 foreach my $limit(@limits) {
 407     if ($limit =~/available/) {
 408         $available = 1;
 409     }
 410 }
 411 $template->param(available => $available);
 412
 413 # append year limits if they exist
 414 my $limit_yr;
 415 my $limit_yr_value;
 416 if ($params->{'limit-yr'}) {
 417     if ($params->{'limit-yr'} =~ /\d{4}/) {
 418         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 419         $limit_yr_value = $params->{'limit-yr'};
 420     }
 421     push @limits,$limit_yr;
 422     #FIXME: Should return a error to the user, incorect date format specified
 423 }
 424
 425 # convert indexes and operands to corresponding parameter names for the z3950 search
 426 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 427 my $z3950par;
 428 my $indexes2z3950 = {
 429     kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 430     'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 431     ti=>'title', 'ti,phr'=>'title', se=>'title'
 432 };
 433 for (my $ii = 0; $ii < @operands; ++$ii)
 434 {
 435     my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
 436     if (defined $name && defined $operands[$ii])
 437     {
 438         $z3950par ||= {};
 439         $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 440     }
 441 }
 442
 443
 444 # Params that can only have one value
 445 my $scan = $params->{'scan'};
 446 my $count = C4::Context->preference('numSearchResults') || 20;
 447 my $results_per_page = $params->{'count'} || $count;
 448 my $offset = $params->{'offset'} || 0;
 449 $offset = 0 if $offset < 0;
 450 my $page = $cgi->param('page') || 1;
 451 #my $offset = ($page-1)*$results_per_page;
 452 my $hits;
 453 my $expanded_facet = $params->{'expand'};
 454
 455 # Define some global variables
 456 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
 457
 458 my $builder = Koha::SearchEngine::QueryBuilder->new(
 459     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 460 my $searcher = Koha::SearchEngine::Search->new(
 461     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 462
 463 ## I. BUILD THE QUERY
 464 (
 465     $error,             $query, $simple_query, $query_cgi,
 466     $query_desc,        $limit, $limit_cgi,    $limit_desc,
 467     $query_type
 468   )
 469   = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
 470     \@sort_by, $scan, $lang );
 471
 472 ## parse the query_cgi string and put it into a form suitable for <input>s
 473 my @query_inputs;
 474 my $scan_index_to_use;
 475 my $scan_search_term_to_use;
 476
 477 for my $this_cgi ( split('&',$query_cgi) ) {
 478     next unless $this_cgi;
 479     $this_cgi =~ m/(.*?)=(.*)/;
 480     my $input_name = $1;
 481     my $input_value = $2;
 482     push @query_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape( $input_value ) ) };
 483     if ($input_name eq 'idx') {
 484         $scan_index_to_use = $input_value; # unless $scan_index_to_use;
 485     }
 486     if ($input_name eq 'q') {
 487         $scan_search_term_to_use = Encode::decode_utf8( uri_unescape( $input_value ));
 488     }
 489 }
 490 $template->param ( QUERY_INPUTS => \@query_inputs,
 491                    scan_index_to_use => $scan_index_to_use,
 492                    scan_search_term_to_use => $scan_search_term_to_use );
 493
 494 ## parse the limit_cgi string and put it into a form suitable for <input>s
 495 my @limit_inputs;
 496 for my $this_cgi ( split('&',$limit_cgi) ) {
 497     next unless $this_cgi;
 498     # handle special case limit-yr
 499     if ($this_cgi =~ /yr,st-numeric/) {
 500         push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 501         next;
 502     }
 503     $this_cgi =~ m/(.*=)(.*)/;
 504     my $input_name = $1;
 505     my $input_value = $2;
 506     $input_name =~ s/=$//;
 507     push @limit_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape($input_value) ) };
 508 }
 509 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 510
 511 ## II. DO THE SEARCH AND GET THE RESULTS
 512 my $total; # 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
 514 my $results_hashref;
 515
 516 eval {
 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,       $expanded_facet, undef,
 521         $itemtypes,        $query_type,   $scan
 522     );
 523 };
 524
 525 if ($@ || $error) {
 526     $template->param(query_error => $error.$@);
 527     output_html_with_http_headers $cgi, $cookie, $template->output;
 528     exit;
 529 }
 530
 531 # At this point, each server has given us a result set
 532 # now we build that set for template display
 533 my @sup_results_array;
 534 for (my $i=0;$i<@servers;$i++) {
 535     my $server = $servers[$i];
 536     if ($server =~/biblioserver/) { # this is the local bibliographic server
 537         $hits = $results_hashref->{$server}->{"hits"};
 538         my $page = $cgi->param('page') || 0;
 539         my @newresults = searchResults('intranet', $query_desc, $hits, $results_per_page, $offset, $scan,
 540                                        $results_hashref->{$server}->{"RECORDS"});
 541         $total = $total + $results_hashref->{$server}->{"hits"};
 542
 543         # Search history
 544         if (C4::Context->preference('EnableSearchHistory')) {
 545             unless ( $offset ) {
 546                 my $path_info = $cgi->url(-path_info=>1);
 547                 my $query_cgi_history = $cgi->url(-query=>1);
 548                 $query_cgi_history =~ s/^$path_info\?//;
 549                 $query_cgi_history =~ s/;/&/g;
 550                 my $query_desc_history = $query_desc;
 551                 $query_desc_history .= ", $limit_desc"
 552                     if $limit_desc;
 553
 554                 C4::Search::History::add({
 555                     userid => $borrowernumber,
 556                     sessionid => $cgi->cookie("CGISESSID"),
 557                     query_desc => $query_desc_history,
 558                     query_cgi => $query_cgi_history,
 559                     total => $total,
 560                     type => "biblio",
 561                 });
 562             }
 563             $template->param( EnableSearchHistory => 1 );
 564         }
 565
 566         ## If there's just one result, redirect to the detail page
 567         if ($total == 1) {
 568             my $biblionumber = $newresults[0]->{biblionumber};
 569             my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 570             my $views = { C4::Search::enabled_staff_search_views };
 571             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 572                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
 573             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 574                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
 575             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 576                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
 577             } else {
 578                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 579             }
 580             exit;
 581         }
 582
 583         # set up parameters if user wishes to re-run the search
 584         # as a Z39.50 search
 585         $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 586
 587         if ($hits) {
 588             $template->param(total => $hits);
 589             my $limit_cgi_not_availablity = $limit_cgi;
 590             $limit_cgi_not_availablity =~ s/&limit=available//g;
 591             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 592             $template->param(limit_cgi => $limit_cgi);
 593             $template->param(query_cgi => $query_cgi);
 594             $template->param(query_desc => $query_desc);
 595             $template->param(limit_desc => $limit_desc);
 596             $template->param(offset     => $offset);
 597             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 598             if ($query_desc || $limit_desc) {
 599                 $template->param(searchdesc => 1);
 600             }
 601             $template->param(results_per_page =>  $results_per_page);
 602             # must define a value for size if not present in DB
 603             # in order to avoid problems generated by the default size value in TT
 604             foreach my $line (@newresults) {
 605                 if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
 606                 # while we're checking each line, see if item is in the cart
 607                 if ( grep {$_ eq $line->{'biblionumber'}} @cart_list) {
 608                     $line->{'incart'} = 1;
 609                 }
 610             }
 611             $template->param(SEARCH_RESULTS => \@newresults);
 612             ## FIXME: add a global function for this, it's better than the current global one
 613             ## Build the page numbers on the bottom of the page
 614             my @page_numbers;
 615             # total number of pages there will be
 616             my $pages = ceil($hits / $results_per_page);
 617             my $last_page_offset = ( $pages -1 ) * $results_per_page;
 618             # default page number
 619             my $current_page_number = 1;
 620             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 621             my $previous_page_offset;
 622             if ( $offset >= $results_per_page ) {
 623                 $previous_page_offset = $offset - $results_per_page;
 624             }
 625             my $next_page_offset = $offset + $results_per_page;
 626             # If we're within the first 10 pages, keep it simple
 627             #warn "current page:".$current_page_number;
 628             if ($current_page_number < 10) {
 629                 # just show the first 10 pages
 630                 # Loop through the pages
 631                 my $pages_to_show = 10;
 632                 $pages_to_show = $pages if $pages<10;
 633                 for (my $i=1; $i<=$pages_to_show;$i++) {
 634                     # the offset for this page
 635                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 636                     # the page number for this page
 637                     my $this_page_number = $i;
 638                     # put it in the array
 639                     push @page_numbers,
 640                       { offset    => $this_offset,
 641                         pg        => $this_page_number,
 642                         # it should only be highlighted if it's the current page
 643                         highlight => $this_page_number == $current_page_number,
 644                         sort_by   => join ' ', @sort_by
 645                       };
 646
 647                 }
 648
 649             }
 650
 651             # now, show twenty pages, with the current one smack in the middle
 652             else {
 653                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 654                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 655                     my $this_page_number = $i-9;
 656                     if ( $this_page_number <= $pages ) {
 657                         push @page_numbers,
 658                           { offset    => $this_offset,
 659                             pg        => $this_page_number,
 660                             highlight => $this_page_number == $current_page_number,
 661                             sort_by   => join ' ', @sort_by
 662                           };
 663                     }
 664                 }
 665             }
 666             # FIXME: no previous_page_offset when pages < 2
 667             $template->param(   PAGE_NUMBERS => \@page_numbers,
 668                                 last_page_offset => $last_page_offset,
 669                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 670             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 671         }
 672
 673
 674         # no hits
 675         else {
 676             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 677         }
 678
 679     } # end of the if local
 680
 681     # asynchronously search the authority server
 682     elsif ($server =~/authorityserver/) { # this is the local authority server
 683         my @inner_sup_results_array;
 684         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 685             my $marc_record_object = C4::Search::new_record_from_zebra(
 686                 'authorityserver',
 687                 $sup_record
 688             );
 689             # warn "Authority Found: ".$marc_record_object->as_formatted();
 690             push @inner_sup_results_array, {
 691                 'title' => $marc_record_object->field(100)->subfield('a'),
 692                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 693             };
 694         }
 695         push @sup_results_array, {  servername => $server,
 696                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 697     }
 698     # FIXME: can add support for other targets as needed here
 699     $template->param(           outer_sup_results_loop => \@sup_results_array);
 700 } #/end of the for loop
 701 #$template->param(FEDERATED_RESULTS => \@results_array);
 702
 703 $template->{'VARS'}->{'searchid'} = $cgi->param('searchid');
 704
 705 my $gotonumber = $cgi->param('gotoNumber');
 706 if ($gotonumber eq 'last' || $gotonumber eq 'first') {
 707     $template->{'VARS'}->{'gotoNumber'} = $gotonumber;
 708 }
 709 $template->{'VARS'}->{'gotoPage'}   = 'detail.pl';
 710 my $gotopage = $cgi->param('gotoPage');
 711 $template->{'VARS'}->{'gotoPage'} = $gotopage
 712   if $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
 713
 714 for my $facet ( @$facets ) {
 715     for my $entry ( @{ $facet->{facets} } ) {
 716         my $index = $entry->{type_link_value};
 717         my $value = $entry->{facet_link_value};
 718         $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
 719     }
 720 }
 721
 722 $template->param(
 723             #classlist => $classlist,
 724             total => $total,
 725             opacfacets => 1,
 726             facets_loop => $facets,
 727             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 728             scan => $scan,
 729             search_error => $error,
 730 );
 731
 732 if ($query_desc || $limit_desc) {
 733     $template->param(searchdesc => 1);
 734 }
 735
 736 # VI. BUILD THE TEMPLATE
 737
 738 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 739     {
 740         borrowernumber => $borrowernumber,
 741         add_allowed    => 1,
 742         category       => 1,
 743     }
 744 );
 745 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 746     {
 747         borrowernumber => $borrowernumber,
 748         add_allowed    => 1,
 749         category       => 2,
 750     }
 751 );
 752
 753
 754 $template->param(
 755     add_to_some_private_shelves => $some_private_shelves,
 756     add_to_some_public_shelves  => $some_public_shelves,
 757 );
 758
 759 output_html_with_http_headers $cgi, $cookie, $template->output;
 760
 761
 762 =head2 prepare_adv_search_types
 763
 764     my $type = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 765     my @advanced_search_types = prepare_adv_search_types($type);
 766
 767 Different types can be searched for in the advanced search. This takes the
 768 system preference that defines these types and parses it into an arrayref for
 769 the template.
 770
 771 "itemtypes" is handled specially, as itemtypes aren't an authorised value.
 772 It also accounts for the "item-level_itypes" system preference.
 773
 774 =cut
 775
 776 sub prepare_adv_search_types {
 777     my ($types) = @_;
 778
 779     my @advanced_search_types = split( /\|/, $types );
 780
 781     # the index parameter is different for item-level itemtypes
 782     my $itype_or_itemtype =
 783       ( C4::Context->preference("item-level_itypes") ) ? 'itype' : 'itemtype';
 784     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 785
 786     my ( $cnt, @result );
 787     foreach my $advanced_srch_type (@advanced_search_types) {
 788         $advanced_srch_type =~ s/^\s*//;
 789         $advanced_srch_type =~ s/\s*$//;
 790         if ( $advanced_srch_type eq 'itemtypes' ) {
 791
 792        # itemtype is a special case, since it's not defined in authorized values
 793             my @itypesloop;
 794             foreach my $thisitemtype (
 795                 sort {
 796                     $itemtypes->{$a}->{'translated_description'}
 797                       cmp $itemtypes->{$b}->{'translated_description'}
 798                 } keys %$itemtypes
 799               )
 800             {
 801                 my %row = (
 802                     number      => $cnt++,
 803                     ccl         => "$itype_or_itemtype,phr",
 804                     code        => $thisitemtype,
 805                     description => $itemtypes->{$thisitemtype}->{'translated_description'},
 806                     imageurl    => getitemtypeimagelocation(
 807                         'intranet', $itemtypes->{$thisitemtype}->{'imageurl'}
 808                     ),
 809                 );
 810                 push @itypesloop, \%row;
 811             }
 812             my %search_code = (
 813                 advanced_search_type => $advanced_srch_type,
 814                 code_loop            => \@itypesloop
 815             );
 816             push @result, \%search_code;
 817         }
 818         else {
 819             # covers all the other cases: non-itemtype authorized values
 820             my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 821             my @authvalueloop;
 822             for my $thisitemtype (@$advsearchtypes) {
 823                 my %row = (
 824                     number      => $cnt++,
 825                     ccl         => $advanced_srch_type,
 826                     code        => $thisitemtype->{authorised_value},
 827                     description => $thisitemtype->{'lib'},
 828                     imageurl    => getitemtypeimagelocation(
 829                         'intranet', $thisitemtype->{'imageurl'}
 830                     ),
 831                 );
 832                 push @authvalueloop, \%row;
 833             }
 834             my %search_code = (
 835                 advanced_search_type => $advanced_srch_type,
 836                 code_loop            => \@authvalueloop
 837             );
 838             push @result, \%search_code;
 839         }
 840     }
 841     return \@result;
 842 }