C4/Search.pm

   1 package C4::Search;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use strict;
  19 #use warnings; FIXME - Bug 2505
  20 require Exporter;
  21 use C4::Context;
  22 use C4::Biblio;    # GetMarcFromKohaField, GetBiblioData
  23 use C4::Koha;      # getFacets
  24 use Koha::DateUtils;
  25 use Koha::Libraries;
  26 use Lingua::Stem;
  27 use C4::Search::PazPar2;
  28 use XML::Simple;
  29 use C4::XSLT;
  30 use C4::Reserves;    # GetReserveStatus
  31 use C4::Debug;
  32 use C4::Charset;
  33 use Koha::AuthorisedValues;
  34 use Koha::ItemTypes;
  35 use Koha::Libraries;
  36 use Koha::Patrons;
  37 use YAML;
  38 use URI::Escape;
  39 use Business::ISBN;
  40 use MARC::Record;
  41 use MARC::Field;
  42 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
  43
  44 BEGIN {
  45     $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
  46 }
  47
  48 =head1 NAME
  49
  50 C4::Search - Functions for searching the Koha catalog.
  51
  52 =head1 SYNOPSIS
  53
  54 See opac/opac-search.pl or catalogue/search.pl for example of usage
  55
  56 =head1 DESCRIPTION
  57
  58 This module provides searching functions for Koha's bibliographic databases
  59
  60 =head1 FUNCTIONS
  61
  62 =cut
  63
  64 @ISA    = qw(Exporter);
  65 @EXPORT = qw(
  66   &FindDuplicate
  67   &SimpleSearch
  68   &searchResults
  69   &getRecords
  70   &buildQuery
  71   &GetDistinctValues
  72   &enabled_staff_search_views
  73 );
  74
  75 # make all your functions, whether exported or not;
  76
  77 =head2 FindDuplicate
  78
  79 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
  80
  81 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
  82
  83 =cut
  84
  85 sub FindDuplicate {
  86     my ($record) = @_;
  87     my $dbh = C4::Context->dbh;
  88     my $result = TransformMarcToKoha( $record, '' );
  89     my $sth;
  90     my $query;
  91     my $search;
  92     my $type;
  93     my ( $biblionumber, $title );
  94
  95     # search duplicate on ISBN, easy and fast..
  96     # ... normalize first
  97     if ( $result->{isbn} ) {
  98         $result->{isbn} =~ s/\(.*$//;
  99         $result->{isbn} =~ s/\s+$//;
 100         $query = "isbn:$result->{isbn}";
 101     }
 102     else {
 103         my $QParser;
 104         $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
 105         my $titleindex;
 106         my $authorindex;
 107         my $op;
 108
 109         if ($QParser) {
 110             $titleindex = 'title|exact';
 111             $authorindex = 'author|exact';
 112             $op = '&&';
 113             $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
 114         } else {
 115             $titleindex = 'ti,ext';
 116             $authorindex = 'au,ext';
 117             $op = 'and';
 118         }
 119
 120         $result->{title} =~ s /\\//g;
 121         $result->{title} =~ s /\"//g;
 122         $result->{title} =~ s /\(//g;
 123         $result->{title} =~ s /\)//g;
 124
 125         # FIXME: instead of removing operators, could just do
 126         # quotes around the value
 127         $result->{title} =~ s/(and|or|not)//g;
 128         $query = "$titleindex:\"$result->{title}\"";
 129         if   ( $result->{author} ) {
 130             $result->{author} =~ s /\\//g;
 131             $result->{author} =~ s /\"//g;
 132             $result->{author} =~ s /\(//g;
 133             $result->{author} =~ s /\)//g;
 134
 135             # remove valid operators
 136             $result->{author} =~ s/(and|or|not)//g;
 137             $query .= " $op $authorindex:\"$result->{author}\"";
 138         }
 139     }
 140
 141     my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
 142     my @results;
 143     if (!defined $error) {
 144         foreach my $possible_duplicate_record (@{$searchresults}) {
 145             my $marcrecord = new_record_from_zebra(
 146                 'biblioserver',
 147                 $possible_duplicate_record
 148             );
 149
 150             my $result = TransformMarcToKoha( $marcrecord, '' );
 151
 152             # FIXME :: why 2 $biblionumber ?
 153             if ($result) {
 154                 push @results, $result->{'biblionumber'};
 155                 push @results, $result->{'title'};
 156             }
 157         }
 158     }
 159     return @results;
 160 }
 161
 162 =head2 SimpleSearch
 163
 164 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers], [%options] );
 165
 166 This function provides a simple search API on the bibliographic catalog
 167
 168 =over 2
 169
 170 =item C<input arg:>
 171
 172     * $query can be a simple keyword or a complete CCL query
 173     * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
 174     * $offset - If present, represents the number of records at the beginning to omit. Defaults to 0
 175     * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
 176     * %options is optional. (e.g. "skip_normalize" allows you to skip changing : to = )
 177
 178
 179 =item C<Return:>
 180
 181     Returns an array consisting of three elements
 182     * $error is undefined unless an error is detected
 183     * $results is a reference to an array of records.
 184     * $total_hits is the number of hits that would have been returned with no limit
 185
 186     If an error is returned the two other return elements are undefined. If error itself is undefined
 187     the other two elements are always defined
 188
 189 =item C<usage in the script:>
 190
 191 =back
 192
 193 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
 194
 195 if (defined $error) {
 196     $template->param(query_error => $error);
 197     warn "error: ".$error;
 198     output_html_with_http_headers $input, $cookie, $template->output;
 199     exit;
 200 }
 201
 202 my $hits = @{$marcresults};
 203 my @results;
 204
 205 for my $r ( @{$marcresults} ) {
 206     my $marcrecord = MARC::File::USMARC::decode($r);
 207     my $biblio = TransformMarcToKoha($marcrecord,q{});
 208
 209     #build the iarray of hashs for the template.
 210     push @results, {
 211         title           => $biblio->{'title'},
 212         subtitle        => $biblio->{'subtitle'},
 213         biblionumber    => $biblio->{'biblionumber'},
 214         author          => $biblio->{'author'},
 215         publishercode   => $biblio->{'publishercode'},
 216         publicationyear => $biblio->{'publicationyear'},
 217         };
 218
 219 }
 220
 221 $template->param(result=>\@results);
 222
 223 =cut
 224
 225 sub SimpleSearch {
 226     my ( $query, $offset, $max_results, $servers, %options )  = @_;
 227
 228     return ( 'No query entered', undef, undef ) unless $query;
 229     # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
 230     my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
 231     my @zoom_queries;
 232     my @tmpresults;
 233     my @zconns;
 234     my $results = [];
 235     my $total_hits = 0;
 236
 237     my $QParser;
 238     $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') && ! ($query =~ m/\w,\w|\w=\w/));
 239     if ($QParser) {
 240         $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
 241     }
 242
 243     # Initialize & Search Zebra
 244     for ( my $i = 0 ; $i < @servers ; $i++ ) {
 245         eval {
 246             $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 247             if ($QParser) {
 248                 $query =~ s/=/:/g unless $options{skip_normalize};
 249                 $QParser->parse( $query );
 250                 $query = $QParser->target_syntax($servers[$i]);
 251                 $zoom_queries[$i] = new ZOOM::Query::PQF( $query, $zconns[$i]);
 252             } else {
 253                 $query =~ s/:/=/g unless $options{skip_normalize};
 254                 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
 255             }
 256             $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
 257
 258             # error handling
 259             my $error =
 260                 $zconns[$i]->errmsg() . " ("
 261               . $zconns[$i]->errcode() . ") "
 262               . $zconns[$i]->addinfo() . " "
 263               . $zconns[$i]->diagset();
 264
 265             return ( $error, undef, undef ) if $zconns[$i]->errcode();
 266         };
 267         if ($@) {
 268
 269             # caught a ZOOM::Exception
 270             my $error =
 271                 $@->message() . " ("
 272               . $@->code() . ") "
 273               . $@->addinfo() . " "
 274               . $@->diagset();
 275             warn $error." for query: $query";
 276             return ( $error, undef, undef );
 277         }
 278     }
 279
 280     _ZOOM_event_loop(
 281         \@zconns,
 282         \@tmpresults,
 283         sub {
 284             my ($i, $size) = @_;
 285             my $first_record = defined($offset) ? $offset + 1 : 1;
 286             my $hits = $tmpresults[ $i - 1 ]->size();
 287             $total_hits += $hits;
 288             my $last_record = $hits;
 289             if ( defined $max_results && $offset + $max_results < $hits ) {
 290                 $last_record = $offset + $max_results;
 291             }
 292
 293             for my $j ( $first_record .. $last_record ) {
 294                 my $record = eval {
 295                   $tmpresults[ $i - 1 ]->record( $j - 1 )->raw()
 296                   ;    # 0 indexed
 297                 };
 298                 push @{$results}, $record if defined $record;
 299             }
 300         }
 301     );
 302
 303     foreach my $zoom_query (@zoom_queries) {
 304         $zoom_query->destroy();
 305     }
 306
 307     return ( undef, $results, $total_hits );
 308 }
 309
 310 =head2 getRecords
 311
 312 ( undef, $results_hashref, \@facets_loop ) = getRecords (
 313
 314         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 315         $results_per_page, $offset,       $expanded_facet, $branches,$itemtypes,
 316         $query_type,       $scan
 317     );
 318
 319 The all singing, all dancing, multi-server, asynchronous, scanning,
 320 searching, record nabbing, facet-building
 321
 322 See verbse embedded documentation.
 323
 324 =cut
 325
 326 sub getRecords {
 327     my (
 328         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 329         $results_per_page, $offset,       $expanded_facet, $branches,
 330         $itemtypes,        $query_type,   $scan,           $opac
 331     ) = @_;
 332
 333     my @servers = @$servers_ref;
 334     my @sort_by = @$sort_by_ref;
 335     $offset = 0 if $offset < 0;
 336
 337     # Initialize variables for the ZOOM connection and results object
 338     my $zconn;
 339     my @zconns;
 340     my @results;
 341     my $results_hashref = ();
 342
 343     # TODO simplify this structure ( { branchcode => $branchname } is enought) and remove this parameter
 344     $branches ||= { map { $_->branchcode => { branchname => $_->branchname } } Koha::Libraries->search };
 345
 346     # Initialize variables for the faceted results objects
 347     my $facets_counter = {};
 348     my $facets_info    = {};
 349     my $facets         = getFacets();
 350
 351     my @facets_loop;    # stores the ref to array of hashes for template facets loop
 352
 353     ### LOOP THROUGH THE SERVERS
 354     for ( my $i = 0 ; $i < @servers ; $i++ ) {
 355         $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 356
 357 # perform the search, create the results objects
 358 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
 359         my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
 360
 361         #$query_to_use = $simple_query if $scan;
 362         warn $simple_query if ( $scan and $DEBUG );
 363
 364         # Check if we've got a query_type defined, if so, use it
 365         eval {
 366             if ($query_type) {
 367                 if ($query_type =~ /^ccl/) {
 368                     $query_to_use =~ s/\:/\=/g;    # change : to = last minute (FIXME)
 369                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
 370                 } elsif ($query_type =~ /^cql/) {
 371                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
 372                 } elsif ($query_type =~ /^pqf/) {
 373                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
 374                 } else {
 375                     warn "Unknown query_type '$query_type'.  Results undetermined.";
 376                 }
 377             } elsif ($scan) {
 378                     $results[$i] = $zconns[$i]->scan(  new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
 379             } else {
 380                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
 381             }
 382         };
 383         if ($@) {
 384             warn "WARNING: query problem with $query_to_use " . $@;
 385         }
 386
 387         # Concatenate the sort_by limits and pass them to the results object
 388         # Note: sort will override rank
 389         my $sort_by;
 390         foreach my $sort (@sort_by) {
 391             if ( $sort eq "author_az" || $sort eq "author_asc" ) {
 392                 $sort_by .= "1=1003 <i ";
 393             }
 394             elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
 395                 $sort_by .= "1=1003 >i ";
 396             }
 397             elsif ( $sort eq "popularity_asc" ) {
 398                 $sort_by .= "1=9003 <i ";
 399             }
 400             elsif ( $sort eq "popularity_dsc" ) {
 401                 $sort_by .= "1=9003 >i ";
 402             }
 403             elsif ( $sort eq "call_number_asc" ) {
 404                 $sort_by .= "1=8007  <i ";
 405             }
 406             elsif ( $sort eq "call_number_dsc" ) {
 407                 $sort_by .= "1=8007 >i ";
 408             }
 409             elsif ( $sort eq "pubdate_asc" ) {
 410                 $sort_by .= "1=31 <i ";
 411             }
 412             elsif ( $sort eq "pubdate_dsc" ) {
 413                 $sort_by .= "1=31 >i ";
 414             }
 415             elsif ( $sort eq "acqdate_asc" ) {
 416                 $sort_by .= "1=32 <i ";
 417             }
 418             elsif ( $sort eq "acqdate_dsc" ) {
 419                 $sort_by .= "1=32 >i ";
 420             }
 421             elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
 422                 $sort_by .= "1=4 <i ";
 423             }
 424             elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
 425                 $sort_by .= "1=4 >i ";
 426             }
 427             else {
 428                 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
 429             }
 430         }
 431         if ( $sort_by && !$scan && $results[$i] ) {
 432             if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
 433                 warn "WARNING sort $sort_by failed";
 434             }
 435         }
 436     }    # finished looping through servers
 437
 438     # The big moment: asynchronously retrieve results from all servers
 439         _ZOOM_event_loop(
 440             \@zconns,
 441             \@results,
 442             sub {
 443                 my ( $i, $size ) = @_;
 444                 my $results_hash;
 445
 446                 # loop through the results
 447                 $results_hash->{'hits'} = $size;
 448                 my $times;
 449                 if ( $offset + $results_per_page <= $size ) {
 450                     $times = $offset + $results_per_page;
 451                 }
 452                 else {
 453                     $times = $size;
 454                 }
 455
 456                 for ( my $j = $offset ; $j < $times ; $j++ ) {
 457                     my $records_hash;
 458                     my $record;
 459
 460                     ## Check if it's an index scan
 461                     if ($scan) {
 462                         my ( $term, $occ ) = $results[ $i - 1 ]->display_term($j);
 463
 464                  # here we create a minimal MARC record and hand it off to the
 465                  # template just like a normal result ... perhaps not ideal, but
 466                  # it works for now
 467                         my $tmprecord = MARC::Record->new();
 468                         $tmprecord->encoding('UTF-8');
 469                         my $tmptitle;
 470                         my $tmpauthor;
 471
 472                 # the minimal record in author/title (depending on MARC flavour)
 473                         if ( C4::Context->preference("marcflavour") eq
 474                             "UNIMARC" )
 475                         {
 476                             $tmptitle = MARC::Field->new(
 477                                 '200', ' ', ' ',
 478                                 a => $term,
 479                                 f => $occ
 480                             );
 481                             $tmprecord->append_fields($tmptitle);
 482                         }
 483                         else {
 484                             $tmptitle =
 485                               MARC::Field->new( '245', ' ', ' ', a => $term, );
 486                             $tmpauthor =
 487                               MARC::Field->new( '100', ' ', ' ', a => $occ, );
 488                             $tmprecord->append_fields($tmptitle);
 489                             $tmprecord->append_fields($tmpauthor);
 490                         }
 491                         $results_hash->{'RECORDS'}[$j] =
 492                           $tmprecord->as_usmarc();
 493                     }
 494
 495                     # not an index scan
 496                     else {
 497                         $record = $results[ $i - 1 ]->record($j)->raw();
 498                         # warn "RECORD $j:".$record;
 499                         $results_hash->{'RECORDS'}[$j] = $record;
 500                     }
 501
 502                 }
 503                 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
 504
 505                 # Fill the facets while we're looping, but only for the
 506                 # biblioserver and not for a scan
 507                 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
 508                     $facets_counter = GetFacets( $results[ $i - 1 ] );
 509                     $facets_info    = _get_facets_info( $facets );
 510                 }
 511
 512                 # BUILD FACETS
 513                 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
 514                     for my $link_value (
 515                         sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
 516                         keys %$facets_counter
 517                       )
 518                     {
 519                         my $expandable;
 520                         my $number_of_facets;
 521                         my @this_facets_array;
 522                         for my $one_facet (
 523                             sort {
 524                                 $facets_counter->{$link_value}
 525                                   ->{$b} <=> $facets_counter->{$link_value}
 526                                   ->{$a}
 527                             } keys %{ $facets_counter->{$link_value} }
 528                           )
 529                         {
 530                             $number_of_facets++;
 531                             if (   ( $number_of_facets <= 5 )
 532                                 || ( $expanded_facet eq $link_value )
 533                                 || ( $facets_info->{$link_value}->{'expanded'} )
 534                               )
 535                             {
 536
 537 # Sanitize the link value : parenthesis, question and exclamation mark will cause errors with CCL
 538                                 my $facet_link_value = $one_facet;
 539                                 $facet_link_value =~ s/[()!?¡¿؟]/ /g;
 540
 541                                 # fix the length that will display in the label,
 542                                 my $facet_label_value = $one_facet;
 543                                 my $facet_max_length  = C4::Context->preference(
 544                                     'FacetLabelTruncationLength')
 545                                   || 20;
 546                                 $facet_label_value =
 547                                   substr( $one_facet, 0, $facet_max_length )
 548                                   . "..."
 549                                   if length($facet_label_value) >
 550                                       $facet_max_length;
 551
 552                             # if it's a branch, label by the name, not the code,
 553                                 if ( $link_value =~ /branch/ ) {
 554                                     if (   defined $branches
 555                                         && ref($branches) eq "HASH"
 556                                         && defined $branches->{$one_facet}
 557                                         && ref( $branches->{$one_facet} ) eq
 558                                         "HASH" )
 559                                     {
 560                                         $facet_label_value =
 561                                           $branches->{$one_facet}
 562                                           ->{'branchname'};
 563                                     }
 564                                     else {
 565                                         $facet_label_value = "*";
 566                                     }
 567                                 }
 568
 569                           # if it's a itemtype, label by the name, not the code,
 570                                 if ( $link_value =~ /itype/ ) {
 571                                     if (   defined $itemtypes
 572                                         && ref($itemtypes) eq "HASH"
 573                                         && defined $itemtypes->{$one_facet}
 574                                         && ref( $itemtypes->{$one_facet} ) eq
 575                                         "HASH" )
 576                                     {
 577                                         $facet_label_value =
 578                                           $itemtypes->{$one_facet}
 579                                           ->{translated_description};
 580                                     }
 581                                 }
 582
 583                # also, if it's a location code, use the name instead of the code
 584                                 if ( $link_value =~ /location/ ) {
 585                                     # TODO Retrieve all authorised values at once, instead of 1 query per entry
 586                                     my $av = Koha::AuthorisedValues->search({ category => 'LOC', authorised_value => $one_facet });
 587                                     $facet_label_value = $av->count ? $av->next->opac_description : '';
 588                                 }
 589
 590                 # but we're down with the whole label being in the link's title.
 591                                 push @this_facets_array,
 592                                   {
 593                                     facet_count =>
 594                                       $facets_counter->{$link_value}
 595                                       ->{$one_facet},
 596                                     facet_label_value => $facet_label_value,
 597                                     facet_title_value => $one_facet,
 598                                     facet_link_value  => $facet_link_value,
 599                                     type_link_value   => $link_value,
 600                                   }
 601                                   if ($facet_label_value);
 602                             }
 603                         }
 604
 605                         # handle expanded option
 606                         unless ( $facets_info->{$link_value}->{'expanded'} ) {
 607                             $expandable = 1
 608                               if ( ( $number_of_facets > 5 )
 609                                 && ( $expanded_facet ne $link_value ) );
 610                         }
 611                         push @facets_loop,
 612                           {
 613                             type_link_value => $link_value,
 614                             type_id         => $link_value . "_id",
 615                             "type_label_"
 616                               . $facets_info->{$link_value}->{'label_value'} =>
 617                               1,
 618                             facets     => \@this_facets_array,
 619                             expandable => $expandable,
 620                             expand     => $link_value,
 621                           }
 622                           unless (
 623                             (
 624                                 $facets_info->{$link_value}->{'label_value'} =~
 625                                 /Libraries/
 626                             )
 627                             and ( Koha::Libraries->search->count == 1 )
 628                           );
 629                     }
 630                 }
 631             }
 632         );
 633
 634     # This sorts the facets into alphabetical order
 635     if (@facets_loop) {
 636         foreach my $f (@facets_loop) {
 637             $f->{facets} = [ sort { uc($a->{facet_label_value}) cmp uc($b->{facet_label_value}) } @{ $f->{facets} } ];
 638         }
 639         @facets_loop = sort {$a->{expand} cmp $b->{expand}} @facets_loop;
 640     }
 641
 642     return ( undef, $results_hashref, \@facets_loop );
 643 }
 644
 645 sub GetFacets {
 646
 647     my $rs = shift;
 648     my $facets;
 649
 650     my $indexing_mode    = C4::Context->config('zebra_bib_index_mode') // 'dom';
 651     my $use_zebra_facets = C4::Context->config('use_zebra_facets') // 0;
 652
 653     if ( $indexing_mode eq 'dom' &&
 654          $use_zebra_facets ) {
 655         $facets = _get_facets_from_zebra( $rs );
 656     } else {
 657         $facets = _get_facets_from_records( $rs );
 658     }
 659
 660     return $facets;
 661 }
 662
 663 sub _get_facets_from_records {
 664
 665     my $rs = shift;
 666
 667     my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets') // 20;
 668     my $facets_config  = getFacets();
 669     my $facets         = {};
 670     my $size           = $rs->size();
 671     my $jmax           = $size > $facets_maxrecs
 672                             ? $facets_maxrecs
 673                             : $size;
 674
 675     for ( my $j = 0 ; $j < $jmax ; $j++ ) {
 676
 677         my $marc_record = new_record_from_zebra (
 678                 'biblioserver',
 679                 $rs->record( $j )->raw()
 680         );
 681
 682         if ( ! defined $marc_record ) {
 683             warn "ERROR DECODING RECORD - $@: " .
 684                 $rs->record( $j )->raw();
 685             next;
 686         }
 687
 688         _get_facets_data_from_record( $marc_record, $facets_config, $facets );
 689     }
 690
 691     return $facets;
 692 }
 693
 694 =head2 _get_facets_data_from_record
 695
 696     C4::Search::_get_facets_data_from_record( $marc_record, $facets, $facets_counter );
 697
 698 Internal function that extracts facets information from a MARC::Record object
 699 and populates $facets_counter for using in getRecords.
 700
 701 $facets is expected to be filled with C4::Koha::getFacets output (i.e. the configured
 702 facets for Zebra).
 703
 704 =cut
 705
 706 sub _get_facets_data_from_record {
 707
 708     my ( $marc_record, $facets, $facets_counter ) = @_;
 709
 710     for my $facet (@$facets) {
 711
 712         my @used_datas = ();
 713
 714         foreach my $tag ( @{ $facet->{ tags } } ) {
 715
 716             # tag number is the first three digits
 717             my $tag_num          = substr( $tag, 0, 3 );
 718             # subfields are the remainder
 719             my $subfield_letters = substr( $tag, 3 );
 720
 721             my @fields = $marc_record->field( $tag_num );
 722             foreach my $field (@fields) {
 723                 # If $field->indicator(1) eq 'z', it means it is a 'see from'
 724                 # field introduced because of IncludeSeeFromInSearches, so skip it
 725                 next if $field->indicator(1) eq 'z';
 726
 727                 my $data = $field->as_string( $subfield_letters, $facet->{ sep } );
 728
 729                 unless ( grep { /^\Q$data\E$/ } @used_datas ) {
 730                     push @used_datas, $data;
 731                     $facets_counter->{ $facet->{ idx } }->{ $data }++;
 732                 }
 733             }
 734         }
 735     }
 736 }
 737
 738 =head2 _get_facets_from_zebra
 739
 740     my $facets = _get_facets_from_zebra( $result_set )
 741
 742 Retrieves facets for a specified result set. It loops through the facets defined
 743 in C4::Koha::getFacets and returns a hash with the following structure:
 744
 745    {  facet_idx => {
 746             facet_value => count
 747       },
 748       ...
 749    }
 750
 751 =cut
 752
 753 sub _get_facets_from_zebra {
 754
 755     my $rs = shift;
 756
 757     # save current elementSetName
 758     my $elementSetName = $rs->option( 'elementSetName' );
 759
 760     my $facets_loop = getFacets();
 761     my $facets_data  = {};
 762     # loop through defined facets and fill the facets hashref
 763     foreach my $facet ( @$facets_loop ) {
 764
 765         my $idx = $facet->{ idx };
 766         my $sep = $facet->{ sep };
 767         my $facet_values = _get_facet_from_result_set( $idx, $rs, $sep );
 768         if ( $facet_values ) {
 769             # we've actually got a result
 770             $facets_data->{ $idx } = $facet_values;
 771         }
 772     }
 773     # set elementSetName to its previous value to avoid side effects
 774     $rs->option( elementSetName => $elementSetName );
 775
 776     return $facets_data;
 777 }
 778
 779 =head2 _get_facet_from_result_set
 780
 781     my $facet_values =
 782         C4::Search::_get_facet_from_result_set( $facet_idx, $result_set, $sep )
 783
 784 Internal function that extracts facet information for a specific index ($facet_idx) and
 785 returns a hash containing facet values and count:
 786
 787     {
 788         $facet_value => $count ,
 789         ...
 790     }
 791
 792 Warning: this function has the side effect of changing the elementSetName for the result
 793 set. It is a helper function for the main loop, which takes care of backing it up for
 794 restoring.
 795
 796 =cut
 797
 798 sub _get_facet_from_result_set {
 799
 800     my $facet_idx = shift;
 801     my $rs        = shift;
 802     my $sep       = shift;
 803
 804     my $internal_sep  = '<*>';
 805     my $facetMaxCount = C4::Context->preference('FacetMaxCount') // 20;
 806
 807     return if ( ! defined $facet_idx || ! defined $rs );
 808     # zebra's facet element, untokenized index
 809     my $facet_element = 'zebra::facet::' . $facet_idx . ':0:' . $facetMaxCount;
 810     # configure zebra results for retrieving the desired facet
 811     $rs->option( elementSetName => $facet_element );
 812     # get the facet record from result set
 813     my $facet = $rs->record( 0 )->raw;
 814     # if the facet has no restuls...
 815     return if !defined $facet;
 816     # TODO: benchmark DOM vs. SAX performance
 817     my $facet_dom = XML::LibXML->load_xml(
 818       string => ($facet)
 819     );
 820     my @terms = $facet_dom->getElementsByTagName('term');
 821     return if ! @terms;
 822
 823     my $facets = {};
 824     foreach my $term ( @terms ) {
 825         my $facet_value = $term->textContent;
 826         $facet_value =~ s/\Q$internal_sep\E/$sep/ if defined $sep;
 827         $facets->{ $facet_value } = $term->getAttribute( 'occur' );
 828     }
 829
 830     return $facets;
 831 }
 832
 833 =head2 _get_facets_info
 834
 835     my $facets_info = C4::Search::_get_facets_info( $facets )
 836
 837 Internal function that extracts facets information and properly builds
 838 the data structure needed to render facet labels.
 839
 840 =cut
 841
 842 sub _get_facets_info {
 843
 844     my $facets = shift;
 845
 846     my $facets_info = {};
 847
 848     for my $facet ( @$facets ) {
 849         $facets_info->{ $facet->{ idx } }->{ label_value } = $facet->{ label };
 850         $facets_info->{ $facet->{ idx } }->{ expanded }    = $facet->{ expanded };
 851     }
 852
 853     return $facets_info;
 854 }
 855
 856 sub pazGetRecords {
 857     my (
 858         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 859         $results_per_page, $offset,       $expanded_facet, $branches,
 860         $query_type,       $scan
 861     ) = @_;
 862     #NOTE: Parameter $branches is not used here !
 863
 864     my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
 865     $paz->init();
 866     $paz->search($simple_query);
 867     sleep 1;   # FIXME: WHY?
 868
 869     # do results
 870     my $results_hashref = {};
 871     my $stats = XMLin($paz->stat);
 872     my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
 873
 874     # for a grouped search result, the number of hits
 875     # is the number of groups returned; 'bib_hits' will have
 876     # the total number of bibs.
 877     $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
 878     $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
 879
 880     HIT: foreach my $hit (@{ $results->{'hit'} }) {
 881         my $recid = $hit->{recid}->[0];
 882
 883         my $work_title = $hit->{'md-work-title'}->[0];
 884         my $work_author;
 885         if (exists $hit->{'md-work-author'}) {
 886             $work_author = $hit->{'md-work-author'}->[0];
 887         }
 888         my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
 889
 890         my $result_group = {};
 891         $result_group->{'group_label'} = $group_label;
 892         $result_group->{'group_merge_key'} = $recid;
 893
 894         my $count = 1;
 895         if (exists $hit->{count}) {
 896             $count = $hit->{count}->[0];
 897         }
 898         $result_group->{'group_count'} = $count;
 899
 900         for (my $i = 0; $i < $count; $i++) {
 901             # FIXME -- may need to worry about diacritics here
 902             my $rec = $paz->record($recid, $i);
 903             push @{ $result_group->{'RECORDS'} }, $rec;
 904         }
 905
 906         push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
 907     }
 908
 909     # pass through facets
 910     my $termlist_xml = $paz->termlist('author,subject');
 911     my $terms = XMLin($termlist_xml, forcearray => 1);
 912     my @facets_loop = ();
 913     #die Dumper($results);
 914 #    foreach my $list (sort keys %{ $terms->{'list'} }) {
 915 #        my @facets = ();
 916 #        foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
 917 #            push @facets, {
 918 #                facet_label_value => $facet->{'name'}->[0],
 919 #            };
 920 #        }
 921 #        push @facets_loop, ( {
 922 #            type_label => $list,
 923 #            facets => \@facets,
 924 #        } );
 925 #    }
 926
 927     return ( undef, $results_hashref, \@facets_loop );
 928 }
 929
 930 # TRUNCATION
 931 sub _detect_truncation {
 932     my ( $operand, $index ) = @_;
 933     my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
 934         @regexpr );
 935     $operand =~ s/^ //g;
 936     my @wordlist = split( /\s/, $operand );
 937     foreach my $word (@wordlist) {
 938         if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
 939             push @rightlefttruncated, $word;
 940         }
 941         elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
 942             push @lefttruncated, $word;
 943         }
 944         elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
 945             push @righttruncated, $word;
 946         }
 947         elsif ( index( $word, "*" ) < 0 ) {
 948             push @nontruncated, $word;
 949         }
 950         else {
 951             push @regexpr, $word;
 952         }
 953     }
 954     return (
 955         \@nontruncated,       \@righttruncated, \@lefttruncated,
 956         \@rightlefttruncated, \@regexpr
 957     );
 958 }
 959
 960 # STEMMING
 961 sub _build_stemmed_operand {
 962     my ($operand,$lang) = @_;
 963     require Lingua::Stem::Snowball ;
 964     my $stemmed_operand=q{};
 965
 966     # Stemmer needs language
 967     return $operand unless $lang;
 968
 969     # If operand contains a digit, it is almost certainly an identifier, and should
 970     # not be stemmed.  This is particularly relevant for ISBNs and ISSNs, which
 971     # can contain the letter "X" - for example, _build_stemmend_operand would reduce
 972     # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
 973     # results (e.g., "23 x 29 cm." from the 300$c).  Bug 2098.
 974     return $operand if $operand =~ /\d/;
 975
 976 # FIXME: the locale should be set based on the user's language and/or search choice
 977     #warn "$lang";
 978     # Make sure we only use the first two letters from the language code
 979     $lang = lc(substr($lang, 0, 2));
 980     # The language codes for the two variants of Norwegian will now be "nb" and "nn",
 981     # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
 982     if ($lang eq 'nb' || $lang eq 'nn') {
 983       $lang = 'no';
 984     }
 985     my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
 986                                                encoding => "UTF-8" );
 987
 988     my @words = split( / /, $operand );
 989     my @stems = $stemmer->stem(\@words);
 990     for my $stem (@stems) {
 991         $stemmed_operand .= "$stem";
 992         $stemmed_operand .= "?"
 993           unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 994         $stemmed_operand .= " ";
 995     }
 996     warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
 997     return $stemmed_operand;
 998 }
 999
1000 # FIELD WEIGHTING
1001 sub _build_weighted_query {
1002
1003 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
1004 # pretty well but could work much better if we had a smarter query parser
1005     my ( $operand, $stemmed_operand, $index ) = @_;
1006     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
1007     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1008     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy")        || 0;
1009     $operand =~ s/"/ /g;    # Bug 7518: searches with quotation marks don't work
1010
1011     my $weighted_query .= "(rk=(";    # Specifies that we're applying rank
1012
1013     # Keyword, or, no index specified
1014     if ( ( $index eq 'kw' ) || ( !$index ) ) {
1015         $weighted_query .=
1016           "Title-cover,ext,r1=\"$operand\"";    # exact title-cover
1017         $weighted_query .= " or ti,ext,r2=\"$operand\"";    # exact title
1018         $weighted_query .= " or Title-cover,phr,r3=\"$operand\"";    # phrase title
1019         $weighted_query .= " or ti,wrdl,r4=\"$operand\"";    # words in title
1020           #$weighted_query .= " or any,ext,r4=$operand";               # exact any
1021           #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
1022         $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
1023           if $fuzzy_enabled;    # add fuzzy, word list
1024         $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
1025           if ( $stemming and $stemmed_operand )
1026           ;                     # add stemming, right truncation
1027         $weighted_query .= " or wrdl,r9=\"$operand\"";
1028
1029         # embedded sorting: 0 a-z; 1 z-a
1030         # $weighted_query .= ") or (sort1,aut=1";
1031     }
1032
1033     # Barcode searches should skip this process
1034     elsif ( $index eq 'bc' ) {
1035         $weighted_query .= "bc=\"$operand\"";
1036     }
1037
1038     # Authority-number searches should skip this process
1039     elsif ( $index eq 'an' ) {
1040         $weighted_query .= "an=\"$operand\"";
1041     }
1042
1043     # If the index is numeric, don't autoquote it.
1044     elsif ( $index =~ /,st-numeric$/ ) {
1045         $weighted_query .= " $index=$operand";
1046     }
1047
1048     # If the index already has more than one qualifier, wrap the operand
1049     # in quotes and pass it back (assumption is that the user knows what they
1050     # are doing and won't appreciate us mucking up their query
1051     elsif ( $index =~ ',' ) {
1052         $weighted_query .= " $index=\"$operand\"";
1053     }
1054
1055     #TODO: build better cases based on specific search indexes
1056     else {
1057         $weighted_query .= " $index,ext,r1=\"$operand\"";    # exact index
1058           #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
1059         $weighted_query .= " or $index,phr,r3=\"$operand\"";    # phrase index
1060         $weighted_query .= " or $index,wrdl,r6=\"$operand\"";    # word list index
1061         $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
1062           if $fuzzy_enabled;    # add fuzzy, word list
1063         $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
1064           if ( $stemming and $stemmed_operand );    # add stemming, right truncation
1065     }
1066
1067     $weighted_query .= "))";                       # close rank specification
1068     return $weighted_query;
1069 }
1070
1071 =head2 getIndexes
1072
1073 Return an array with available indexes.
1074
1075 =cut
1076
1077 sub getIndexes{
1078     my @indexes = (
1079                     # biblio indexes
1080                     'ab',
1081                     'Abstract',
1082                     'acqdate',
1083                     'allrecords',
1084                     'an',
1085                     'Any',
1086                     'at',
1087                     'au',
1088                     'aub',
1089                     'aud',
1090                     'audience',
1091                     'auo',
1092                     'aut',
1093                     'Author',
1094                     'Author-in-order ',
1095                     'Author-personal-bibliography',
1096                     'Authority-Number',
1097                     'authtype',
1098                     'bc',
1099                     'Bib-level',
1100                     'biblionumber',
1101                     'bio',
1102                     'biography',
1103                     'callnum',
1104                     'cfn',
1105                     'Chronological-subdivision',
1106                     'cn-bib-source',
1107                     'cn-bib-sort',
1108                     'cn-class',
1109                     'cn-item',
1110                     'cn-prefix',
1111                     'cn-suffix',
1112                     'cpn',
1113                     'Code-institution',
1114                     'Conference-name',
1115                     'Conference-name-heading',
1116                     'Conference-name-see',
1117                     'Conference-name-seealso',
1118                     'Content-type',
1119                     'Control-number',
1120                     'copydate',
1121                     'Corporate-name',
1122                     'Corporate-name-heading',
1123                     'Corporate-name-see',
1124                     'Corporate-name-seealso',
1125                     'Country-publication',
1126                     'ctype',
1127                     'curriculum',
1128                     'date-entered-on-file',
1129                     'Date-of-acquisition',
1130                     'Date-of-publication',
1131                     'Date-time-last-modified',
1132                     'Dewey-classification',
1133                     'Dissertation-information',
1134                     'diss',
1135                     'dtlm',
1136                     'EAN',
1137                     'extent',
1138                     'fic',
1139                     'fiction',
1140                     'Form-subdivision',
1141                     'format',
1142                     'Geographic-subdivision',
1143                     'he',
1144                     'Heading',
1145                     'Heading-use-main-or-added-entry',
1146                     'Heading-use-series-added-entry ',
1147                     'Heading-use-subject-added-entry',
1148                     'Host-item',
1149                     'id-other',
1150                     'ident',
1151                     'Identifier-standard',
1152                     'Illustration-code',
1153                     'Index-term-genre',
1154                     'Index-term-uncontrolled',
1155                     'Interest-age-level',
1156                     'Interest-grade-level',
1157                     'ISBN',
1158                     'isbn',
1159                     'ISSN',
1160                     'issn',
1161                     'itemtype',
1162                     'kw',
1163                     'Koha-Auth-Number',
1164                     'l-format',
1165                     'language',
1166                     'language-original',
1167                     'lc-card',
1168                     'LC-card-number',
1169                     'lcn',
1170                     'lex',
1171                     'lexile-number',
1172                     'llength',
1173                     'ln',
1174                     'ln-audio',
1175                     'ln-subtitle',
1176                     'Local-classification',
1177                     'Local-number',
1178                     'Match-heading',
1179                     'Match-heading-see-from',
1180                     'Material-type',
1181                     'mc-itemtype',
1182                     'mc-rtype',
1183                     'mus',
1184                     'name',
1185                     'Music-number',
1186                     'Name-geographic',
1187                     'Name-geographic-heading',
1188                     'Name-geographic-see',
1189                     'Name-geographic-seealso',
1190                     'nb',
1191                     'Note',
1192                     'notes',
1193                     'ns',
1194                     'nt',
1195                     'Other-control-number',
1196                     'pb',
1197                     'Personal-name',
1198                     'Personal-name-heading',
1199                     'Personal-name-see',
1200                     'Personal-name-seealso',
1201                     'pl',
1202                     'Place-publication',
1203                     'pn',
1204                     'popularity',
1205                     'pubdate',
1206                     'Publisher',
1207                     'Provider',
1208                     'pv',
1209                     'Reading-grade-level',
1210                     'Record-control-number',
1211                     'rcn',
1212                     'Record-type',
1213                     'rtype',
1214                     'se',
1215                     'See',
1216                     'See-also',
1217                     'sn',
1218                     'Stock-number',
1219                     'su',
1220                     'Subject',
1221                     'Subject-heading-thesaurus',
1222                     'Subject-name-personal',
1223                     'Subject-subdivision',
1224                     'Summary',
1225                     'Suppress',
1226                     'su-geo',
1227                     'su-na',
1228                     'su-to',
1229                     'su-ut',
1230                     'ut',
1231                     'Term-genre-form',
1232                     'Term-genre-form-heading',
1233                     'Term-genre-form-see',
1234                     'Term-genre-form-seealso',
1235                     'ti',
1236                     'Title',
1237                     'Title-cover',
1238                     'Title-series',
1239                     'Title-uniform',
1240                     'Title-uniform-heading',
1241                     'Title-uniform-see',
1242                     'Title-uniform-seealso',
1243                     'totalissues',
1244                     'yr',
1245
1246                     # items indexes
1247                     'acqsource',
1248                     'barcode',
1249                     'bc',
1250                     'branch',
1251                     'ccode',
1252                     'classification-source',
1253                     'cn-sort',
1254                     'coded-location-qualifier',
1255                     'copynumber',
1256                     'damaged',
1257                     'datelastborrowed',
1258                     'datelastseen',
1259                     'holdingbranch',
1260                     'homebranch',
1261                     'issues',
1262                     'item',
1263                     'itemnumber',
1264                     'itype',
1265                     'Local-classification',
1266                     'location',
1267                     'lost',
1268                     'materials-specified',
1269                     'mc-ccode',
1270                     'mc-itype',
1271                     'mc-loc',
1272                     'notforloan',
1273                     'Number-local-acquisition',
1274                     'onloan',
1275                     'price',
1276                     'renewals',
1277                     'replacementprice',
1278                     'replacementpricedate',
1279                     'reserves',
1280                     'restricted',
1281                     'stack',
1282                     'stocknumber',
1283                     'inv',
1284                     'uri',
1285                     'withdrawn',
1286
1287                     # subject related
1288                   );
1289
1290     return \@indexes;
1291 }
1292
1293 =head2 _handle_exploding_index
1294
1295     my $query = _handle_exploding_index($index, $term)
1296
1297 Callback routine to generate the search for "exploding" indexes (i.e.
1298 those indexes which are turned into multiple or-connected searches based
1299 on authority data).
1300
1301 =cut
1302
1303 sub _handle_exploding_index {
1304     my ($QParser, $filter, $params, $negate, $server) = @_;
1305     my $index = $filter;
1306     my $term = join(' ', @$params);
1307
1308     return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1309
1310     my $marcflavour = C4::Context->preference('marcflavour');
1311
1312     my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1313     my $wantedcodes = '';
1314     my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1315     my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1316     foreach my $auth (@$results) {
1317         my $record = MARC::Record->new_from_usmarc($auth);
1318         my @references = $record->field('5..');
1319         if (@references) {
1320             if ($index eq 'su-br') {
1321                 $wantedcodes = 'g';
1322             } elsif ($index eq 'su-na') {
1323                 $wantedcodes = 'h';
1324             } elsif ($index eq 'su-rl') {
1325                 $wantedcodes = '';
1326             }
1327             foreach my $reference (@references) {
1328                 my $codes = $reference->subfield($codesubfield);
1329                 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1330             }
1331         }
1332     }
1333     my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1334     return $query;
1335 }
1336
1337 =head2 parseQuery
1338
1339     ( $operators, $operands, $indexes, $limits,
1340       $sort_by, $scan, $lang ) =
1341             parseQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1342
1343 Shim function to ease the transition from buildQuery to a new QueryParser.
1344 This function is called at the beginning of buildQuery, and modifies
1345 buildQuery's input. If it can handle the input, it returns a query that
1346 buildQuery will not try to parse.
1347
1348 =cut
1349
1350 sub parseQuery {
1351     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1352
1353     my @operators = $operators ? @$operators : ();
1354     my @indexes   = $indexes   ? @$indexes   : ();
1355     my @operands  = $operands  ? @$operands  : ();
1356     my @limits    = $limits    ? @$limits    : ();
1357     my @sort_by   = $sort_by   ? @$sort_by   : ();
1358
1359     my $query = $operands[0];
1360     my $index;
1361     my $term;
1362     my $query_desc;
1363
1364     my $QParser;
1365     $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1366     undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1367     undef $QParser if (scalar @limits > 0);
1368
1369     if ($QParser)
1370     {
1371         $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1372         $query = '';
1373         for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1374             next unless $operands[$ii];
1375             $query .= $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1376               if ($query);
1377             if ( $operands[$ii] =~ /^[^"]\W*[-|_\w]*:\w.*[^"]$/ ) {
1378                 $query .= $operands[$ii];
1379             }
1380             elsif ( $indexes[$ii] =~ m/su-/ ) {
1381                 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1382             }
1383             else {
1384                 $query .=
1385                   ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1386             }
1387         }
1388         foreach my $limit (@limits) {
1389         }
1390         if ( scalar(@sort_by) > 0 ) {
1391             my $modifier_re =
1392               '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1393             $query =~ s/$modifier_re//g;
1394             foreach my $modifier (@sort_by) {
1395                 $query .= " #$modifier";
1396             }
1397         }
1398
1399         $query_desc = $query;
1400         $query_desc =~ s/\s+/ /g;
1401         if ( C4::Context->preference("QueryWeightFields") ) {
1402         }
1403         $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1404               { 'target_syntax_callback' => \&_handle_exploding_index } );
1405         $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1406               { 'target_syntax_callback' => \&_handle_exploding_index } );
1407         $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1408               { 'target_syntax_callback' => \&_handle_exploding_index } );
1409         $QParser->parse($query);
1410         $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1411     }
1412     else {
1413         require Koha::QueryParser::Driver::PQF;
1414         my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1415         s/$modifier_re//g for @operands;
1416     }
1417
1418     return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1419 }
1420
1421 =head2 buildQuery
1422
1423 ( $error, $query,
1424 $simple_query, $query_cgi,
1425 $query_desc, $limit,
1426 $limit_cgi, $limit_desc,
1427 $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1428
1429 Build queries and limits in CCL, CGI, Human,
1430 handle truncation, stemming, field weighting, fuzziness, etc.
1431
1432 See verbose embedded documentation.
1433
1434
1435 =cut
1436
1437 sub buildQuery {
1438     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1439
1440     warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1441
1442     my $query_desc;
1443     ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1444
1445     # dereference
1446     my @operators = $operators ? @$operators : ();
1447     my @indexes   = $indexes   ? @$indexes   : ();
1448     my @operands  = $operands  ? @$operands  : ();
1449     my @limits    = $limits    ? @$limits    : ();
1450     my @sort_by   = $sort_by   ? @$sort_by   : ();
1451
1452     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
1453     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
1454     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
1455     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
1456
1457     my $query        = $operands[0];
1458     my $simple_query = $operands[0];
1459
1460     # initialize the variables we're passing back
1461     my $query_cgi;
1462     my $query_type;
1463
1464     my $limit;
1465     my $limit_cgi;
1466     my $limit_desc;
1467
1468     my $cclq       = 0;
1469     my $cclindexes = getIndexes();
1470     if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1471         while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1472             my $dx = lc($1);
1473             $cclq = grep { lc($_) eq $dx } @$cclindexes;
1474         }
1475         $query = "ccl=$query" if $cclq;
1476     }
1477
1478 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1479 # DIAGNOSTIC ONLY!!
1480     if ( $query =~ /^ccl=/ ) {
1481         my $q=$';
1482         # This is needed otherwise ccl= and &limit won't work together, and
1483         # this happens when selecting a subject on the opac-detail page
1484         @limits = grep {!/^$/} @limits;
1485         my $original_q = $q; # without available part
1486         unless ( grep { /^available$/ } @limits ) {
1487             $q =~ s| and \( \( allrecords,AlwaysMatches:'' not onloan,AlwaysMatches:''\) and \(lost,st-numeric=0\) \)||;
1488             $original_q = $q;
1489         }
1490         if ( @limits ) {
1491             if ( grep { /^available$/ } @limits ) {
1492                 $q .= q| and ( ( allrecords,AlwaysMatches:'' not onloan,AlwaysMatches:'') and (lost,st-numeric=0) )|;
1493                 delete $limits['available'];
1494             }
1495             $q .= ' and '.join(' and ', @limits) if @limits;
1496         }
1497         return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $original_q, '', '', '', 'ccl' );
1498     }
1499     if ( $query =~ /^cql=/ ) {
1500         return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', 'cql' );
1501     }
1502     if ( $query =~ /^pqf=/ ) {
1503         if ($query_desc) {
1504             $query_cgi = "q=".uri_escape_utf8($query_desc);
1505         } else {
1506             $query_desc = $';
1507             $query_cgi = "q=pqf=".uri_escape_utf8($');
1508         }
1509         return ( undef, $', $', $query_cgi, $query_desc, '', '', '', 'pqf' );
1510     }
1511
1512     # pass nested queries directly
1513     # FIXME: need better handling of some of these variables in this case
1514     # Nested queries aren't handled well and this implementation is flawed and causes users to be
1515     # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1516 #    if ( $query =~ /(\(|\))/ ) {
1517 #        return (
1518 #            undef,              $query, $simple_query, $query_cgi,
1519 #            $query,             $limit, $limit_cgi,    $limit_desc,
1520 #            'ccl'
1521 #        );
1522 #    }
1523
1524 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1525 # query operands and indexes and add stemming, truncation, field weighting, etc.
1526 # Once we do so, we'll end up with a value in $query, just like if we had an
1527 # incoming $query from the user
1528     else {
1529         $query = ""
1530           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1531         my $previous_operand
1532           ;    # a flag used to keep track if there was a previous query
1533                # if there was, we can apply the current operator
1534                # for every operand
1535         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1536
1537             # COMBINE OPERANDS, INDEXES AND OPERATORS
1538             if ( ($operands[$i] // '') ne '' ) {
1539                 $operands[$i]=~s/^\s+//;
1540
1541               # A flag to determine whether or not to add the index to the query
1542                 my $indexes_set;
1543
1544 # If the user is sophisticated enough to specify an index, turn off field weighting, and stemming handling
1545                 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1546                     $weight_fields    = 0;
1547                     $stemming         = 0;
1548                 } else {
1549                     $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1550                 }
1551                 my $operand = $operands[$i];
1552                 my $index   = $indexes[$i];
1553
1554                 # Add index-specific attributes
1555
1556                 #Afaik, this 'yr' condition will only ever be met in the staff client advanced search
1557                 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1558                 #which is processed higher up in this sub. Other than that, year searches are typically
1559                 #handled as limits which are not processed her either.
1560
1561                 # Search ranges: Date of Publication, st-numeric
1562                 if ( $index =~ /(yr|st-numeric)/ ) {
1563                     #weight_fields/relevance search causes errors with date ranges
1564                     #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1565                     #In the case of YYYY-YYYY, it will return no results
1566                     $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1567                 }
1568
1569                 # Date of Acquisition
1570                 elsif ( $index =~ /acqdate/ ) {
1571                     #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1572                     #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1573                       #top of the results just because they have lots of item records matching that date.
1574                     #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1575                       #irrelevant here
1576                     $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1577                 }
1578                 # ISBN,ISSN,Standard Number, don't need special treatment
1579                 elsif ( $index eq 'nb' || $index eq 'ns' || $index eq 'hi' ) {
1580                     (
1581                         $stemming,      $auto_truncation,
1582                         $weight_fields, $fuzzy_enabled
1583                     ) = ( 0, 0, 0, 0 );
1584
1585                     if ( $index eq 'nb' ) {
1586                         if ( C4::Context->preference("SearchWithISBNVariations") ) {
1587                             my @isbns = C4::Koha::GetVariationsOfISBN( $operand );
1588                             $operands[$i] = $operand =  '(nb=' . join(' OR nb=', @isbns) . ')';
1589                             $indexes[$i] = $index = '';
1590                         }
1591                     }
1592                 }
1593
1594                 if(not $index){
1595                     $index = 'kw';
1596                 }
1597
1598                 # Set default structure attribute (word list)
1599                 my $struct_attr = q{};
1600                 unless ( $indexes_set || !$index || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1601                     $struct_attr = ",wrdl";
1602                 }
1603
1604                 # Some helpful index variants
1605                 my $index_plus       = $index . $struct_attr . ':';
1606                 my $index_plus_comma = $index . $struct_attr . ',';
1607
1608                 if ($auto_truncation){
1609                         unless ( $index =~ /,(st-|phr|ext)/ ) {
1610                                                 #FIXME only valid with LTR scripts
1611                                                 $operand=join(" ",map{
1612                                                                                         (index($_,"*")>0?"$_":"$_*")
1613                                                                                          }split (/\s+/,$operand));
1614                                                 warn $operand if $DEBUG;
1615                                         }
1616                                 }
1617
1618                 # Detect Truncation
1619                 my $truncated_operand;
1620                 my( $nontruncated, $righttruncated, $lefttruncated,
1621                     $rightlefttruncated, $regexpr
1622                 ) = _detect_truncation( $operand, $index );
1623                 warn
1624 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1625                   if $DEBUG;
1626
1627                 # Apply Truncation
1628                 if (
1629                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
1630                     scalar(@$rightlefttruncated) > 0 )
1631                 {
1632
1633                # Don't field weight or add the index to the query, we do it here
1634                     $indexes_set = 1;
1635                     undef $weight_fields;
1636                     my $previous_truncation_operand;
1637                     if (scalar @$nontruncated) {
1638                         $truncated_operand .= "$index_plus @$nontruncated ";
1639                         $previous_truncation_operand = 1;
1640                     }
1641                     if (scalar @$righttruncated) {
1642                         $truncated_operand .= "and " if $previous_truncation_operand;
1643                         $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1644                         $previous_truncation_operand = 1;
1645                     }
1646                     if (scalar @$lefttruncated) {
1647                         $truncated_operand .= "and " if $previous_truncation_operand;
1648                         $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1649                         $previous_truncation_operand = 1;
1650                     }
1651                     if (scalar @$rightlefttruncated) {
1652                         $truncated_operand .= "and " if $previous_truncation_operand;
1653                         $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1654                         $previous_truncation_operand = 1;
1655                     }
1656                 }
1657                 $operand = $truncated_operand if $truncated_operand;
1658                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1659
1660                 # Handle Stemming
1661                 my $stemmed_operand;
1662                 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1663                                                                                 if $stemming;
1664
1665                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1666
1667                 # Handle Field Weighting
1668                 my $weighted_operand;
1669                 if ($weight_fields) {
1670                     $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1671                     $operand = $weighted_operand;
1672                     $indexes_set = 1;
1673                 }
1674
1675                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1676
1677                 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1678                     query => $query,
1679                     query_cgi => $query_cgi,
1680                     query_desc => $query_desc,
1681                     operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1682                     parsed_operand => $operand,
1683                     original_operand => $operands[$i] // '',
1684                     index => $index,
1685                     index_plus => $index_plus,
1686                     indexes_set => $indexes_set,
1687                     previous_operand => $previous_operand,
1688                 });
1689
1690             }    #/if $operands
1691         }    # /for
1692     }
1693     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1694
1695     # add limits
1696     my %group_OR_limits;
1697     my $availability_limit;
1698     foreach my $this_limit (@limits) {
1699         next unless $this_limit;
1700         if ( $this_limit =~ /available/ ) {
1701 #
1702 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1703 ## In English:
1704 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1705             $availability_limit .=
1706 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1707             $limit_cgi  .= "&limit=available";
1708             $limit_desc .= "";
1709         }
1710
1711         # group_OR_limits, prefixed by mc-
1712         # OR every member of the group
1713         elsif ( $this_limit =~ /mc/ ) {
1714             my ($k,$v) = split(/:/, $this_limit,2);
1715             if ( $k !~ /mc-i(tem)?type/ ) {
1716                 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1717                 $this_limit =~ tr/"//d;
1718                 $this_limit = $k.":'".$v."'";
1719             }
1720
1721             $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1722             $limit_desc      .= " or " if $group_OR_limits{$k};
1723             $group_OR_limits{$k} .= "$this_limit";
1724             $limit_cgi       .= "&limit=" . uri_escape_utf8($this_limit);
1725             $limit_desc      .= " $this_limit";
1726         }
1727
1728         # Regular old limits
1729         else {
1730             $limit .= " and " if $limit || $query;
1731             $limit      .= "$this_limit";
1732             $limit_cgi  .= "&limit=" . uri_escape_utf8($this_limit);
1733             if ($this_limit =~ /^branch:(.+)/) {
1734                 my $branchcode = $1;
1735                 my $library = Koha::Libraries->find( $branchcode );
1736                 if (defined $library) {
1737                     $limit_desc .= " branch:" . $library->branchname;
1738                 } else {
1739                     $limit_desc .= " $this_limit";
1740                 }
1741             } else {
1742                 $limit_desc .= " $this_limit";
1743             }
1744         }
1745     }
1746     foreach my $k (keys (%group_OR_limits)) {
1747         $limit .= " and " if ( $query || $limit );
1748         $limit .= "($group_OR_limits{$k})";
1749     }
1750     if ($availability_limit) {
1751         $limit .= " and " if ( $query || $limit );
1752         $limit .= "($availability_limit)";
1753     }
1754
1755     # Normalize the query and limit strings
1756     # This is flawed , means we can't search anything with : in it
1757     # if user wants to do ccl or cql, start the query with that
1758 #    $query =~ s/:/=/g;
1759     #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1760     $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1761     $query =~ s/(?<=(wrdl)):/=/g;
1762     $query =~ s/(?<=(trn|phr)):/=/g;
1763     $query =~ s/(?<=(st-numeric)):/=/g;
1764     $query =~ s/(?<=(st-year)):/=/g;
1765     $query =~ s/(?<=(st-date-normalized)):/=/g;
1766     $limit =~ s/:/=/g;
1767     for ( $query, $query_desc, $limit, $limit_desc ) {
1768         s/  +/ /g;    # remove extra spaces
1769         s/^ //g;     # remove any beginning spaces
1770         s/ $//g;     # remove any ending spaces
1771         s/==/=/g;    # remove double == from query
1772     }
1773     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1774
1775     for ($query_cgi,$simple_query) {
1776         s/"//g;
1777     }
1778     # append the limit to the query
1779     $query .= " " . $limit;
1780
1781     # Warnings if DEBUG
1782     if ($DEBUG) {
1783         warn "QUERY:" . $query;
1784         warn "QUERY CGI:" . $query_cgi;
1785         warn "QUERY DESC:" . $query_desc;
1786         warn "LIMIT:" . $limit;
1787         warn "LIMIT CGI:" . $limit_cgi;
1788         warn "LIMIT DESC:" . $limit_desc;
1789         warn "---------\nLeave buildQuery\n---------";
1790     }
1791
1792     return (
1793         undef,              $query, $simple_query, $query_cgi,
1794         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1795         $query_type
1796     );
1797 }
1798
1799 =head2 _build_initial_query
1800
1801   ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1802
1803   Build a section of the initial query containing indexes, operators, and operands.
1804
1805 =cut
1806
1807 sub _build_initial_query {
1808     my ($params) = @_;
1809
1810     my $operator = "";
1811     if ($params->{previous_operand}){
1812         #If there is a previous operand, add a supplied operator or the default 'and'
1813         $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1814     }
1815
1816     #NOTE: indexes_set is typically set when doing truncation or field weighting
1817     my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1818
1819     #e.g. "kw,wrdl:test"
1820     #e.g. " and kw,wrdl:test"
1821     $params->{query} .= $operator . $operand;
1822
1823     $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1824     $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1825     $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1826
1827     #e.g. " and kw,wrdl: test"
1828     $params->{query_desc} .= $operator . $params->{index_plus} . " " . $params->{original_operand};
1829
1830     $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1831
1832     return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1833 }
1834
1835 =head2 searchResults
1836
1837   my @search_results = searchResults($search_context, $searchdesc, $hits,
1838                                      $results_per_page, $offset, $scan,
1839                                      @marcresults);
1840
1841 Format results in a form suitable for passing to the template
1842
1843 =cut
1844
1845 # IMO this subroutine is pretty messy still -- it's responsible for
1846 # building the HTML output for the template
1847 sub searchResults {
1848     my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1849     my $dbh = C4::Context->dbh;
1850     my @newresults;
1851
1852     require C4::Items;
1853
1854     $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1855     my ($is_opac, $hidelostitems);
1856     if ($search_context eq 'opac') {
1857         $hidelostitems = C4::Context->preference('hidelostitems');
1858         $is_opac       = 1;
1859     }
1860
1861     #Build branchnames hash
1862     my %branches = map { $_->branchcode => $_->branchname } Koha::Libraries->search({}, { order_by => 'branchname' });
1863
1864 # FIXME - We build an authorised values hash here, using the default framework
1865 # though it is possible to have different authvals for different fws.
1866
1867     my $shelflocations =
1868       { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
1869
1870     # get notforloan authorised value list (see $shelflocations  FIXME)
1871     my $av = Koha::MarcSubfieldStructures->search({ frameworkcode => '', kohafield => 'items.notforloan', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
1872     my $notforloan_authorised_value = $av->count ? $av->next->authorised_value : undef;
1873
1874     #Get itemtype hash
1875     my $itemtypes = Koha::ItemTypes->search_with_localization;
1876     my %itemtypes = map { $_->{itemtype} => $_ } @{ $itemtypes->unblessed };
1877
1878     #search item field code
1879     my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1880
1881     ## find column names of items related to MARC
1882     my %subfieldstosearch;
1883     my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
1884     for my $column ( @columns ) {
1885         my ( $tagfield, $tagsubfield ) =
1886           &GetMarcFromKohaField( "items." . $column, "" );
1887         if ( defined $tagsubfield ) {
1888             $subfieldstosearch{$column} = $tagsubfield;
1889         }
1890     }
1891
1892     # handle which records to actually retrieve
1893     my $times;
1894     if ( $hits && $offset + $results_per_page <= $hits ) {
1895         $times = $offset + $results_per_page;
1896     }
1897     else {
1898         $times = $hits;  # FIXME: if $hits is undefined, why do we want to equal it?
1899     }
1900
1901     my $marcflavour = C4::Context->preference("marcflavour");
1902     # We get the biblionumber position in MARC
1903     my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1904
1905     # set stuff for XSLT processing here once, not later again for every record we retrieved
1906     my $interface = $search_context eq 'opac' ? 'OPAC' : '';
1907     my $xslsyspref = $interface . "XSLTResultsDisplay";
1908     my $xslfile = C4::Context->preference($xslsyspref);
1909     my $lang   = $xslfile ? C4::Languages::getlanguage()  : undef;
1910     my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
1911
1912     # loop through all of the records we've retrieved
1913     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1914
1915         my $marcrecord;
1916         if ($scan) {
1917             # For Scan searches we built USMARC data
1918             $marcrecord = MARC::Record->new_from_usmarc( $marcresults->[$i]);
1919         } else {
1920             # Normal search, render from Zebra's output
1921             $marcrecord = new_record_from_zebra(
1922                 'biblioserver',
1923                 $marcresults->[$i]
1924             );
1925
1926             if ( ! defined $marcrecord ) {
1927                 warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1928                 next;
1929             }
1930         }
1931
1932         my $fw = $scan
1933              ? undef
1934              : $bibliotag < 10
1935                ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1936                : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1937
1938         SetUTF8Flag($marcrecord);
1939         my $oldbiblio = TransformMarcToKoha( $marcrecord, $fw );
1940         $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1941         $oldbiblio->{result_number} = $i + 1;
1942
1943         # add imageurl to itemtype if there is one
1944         $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1945
1946                 $oldbiblio->{normalized_upc}  = GetNormalizedUPC(       $marcrecord,$marcflavour);
1947                 $oldbiblio->{normalized_ean}  = GetNormalizedEAN(       $marcrecord,$marcflavour);
1948                 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1949                 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1950                 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1951
1952                 # edition information, if any
1953         $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1954         $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{translated_description};
1955  # Build summary if there is one (the summary is defined in the itemtypes table)
1956  # FIXME: is this used anywhere, I think it can be commented out? -- JF
1957         if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1958             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1959             my @fields  = $marcrecord->fields();
1960
1961             my $newsummary;
1962             foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1963                 my $tags = {};
1964                 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1965                     $tag =~ /(.{3})(.)/;
1966                     if($marcrecord->field($1)){
1967                         my @abc = $marcrecord->field($1)->subfield($2);
1968                         $tags->{$tag} = $#abc + 1 ;
1969                     }
1970                 }
1971
1972                 # We catch how many times to repeat this line
1973                 my $max = 0;
1974                 foreach my $tag (keys(%$tags)){
1975                     $max = $tags->{$tag} if($tags->{$tag} > $max);
1976                  }
1977
1978                 # we replace, and repeat each line
1979                 for (my $i = 0 ; $i < $max ; $i++){
1980                     my $newline = $line;
1981
1982                     foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1983                         $tag =~ /(.{3})(.)/;
1984
1985                         if($marcrecord->field($1)){
1986                             my @repl = $marcrecord->field($1)->subfield($2);
1987                             my $subfieldvalue = $repl[$i];
1988                             $newline =~ s/\[$tag\]/$subfieldvalue/g;
1989                         }
1990                     }
1991                     $newsummary .= "$newline\n";
1992                 }
1993             }
1994
1995             $newsummary =~ s/\[(.*?)]//g;
1996             $newsummary =~ s/\n/<br\/>/g;
1997             $oldbiblio->{summary} = $newsummary;
1998         }
1999
2000         # Pull out the items fields
2001         my @fields = $marcrecord->field($itemtag);
2002         my $marcflavor = C4::Context->preference("marcflavour");
2003         # adding linked items that belong to host records
2004         my $analyticsfield = '773';
2005         if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
2006             $analyticsfield = '773';
2007         } elsif ($marcflavor eq 'UNIMARC') {
2008             $analyticsfield = '461';
2009         }
2010         foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
2011             my $hostbiblionumber = $hostfield->subfield("0");
2012             my $linkeditemnumber = $hostfield->subfield("9");
2013             if( $hostbiblionumber ) {
2014                 my $hostbiblio = GetMarcBiblio({
2015                     biblionumber => $hostbiblionumber,
2016                     embed_items  => 1 });
2017                 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
2018                 if( $hostbiblio ) {
2019                     my @hostitems = $hostbiblio->field($itemfield);
2020                     foreach my $hostitem (@hostitems){
2021                         if ($hostitem->subfield("9") eq $linkeditemnumber){
2022                             my $linkeditem =$hostitem;
2023                             # append linked items if they exist
2024                             push @fields, $linkeditem if $linkeditem;
2025                         }
2026                     }
2027                 }
2028             }
2029         }
2030
2031         # Setting item statuses for display
2032         my @available_items_loop;
2033         my @onloan_items_loop;
2034         my @other_items_loop;
2035
2036         my $available_items;
2037         my $onloan_items;
2038         my $other_items;
2039
2040         my $ordered_count         = 0;
2041         my $available_count       = 0;
2042         my $onloan_count          = 0;
2043         my $longoverdue_count     = 0;
2044         my $other_count           = 0;
2045         my $withdrawn_count        = 0;
2046         my $itemlost_count        = 0;
2047         my $hideatopac_count      = 0;
2048         my $itembinding_count     = 0;
2049         my $itemdamaged_count     = 0;
2050         my $item_in_transit_count = 0;
2051         my $can_place_holds       = 0;
2052         my $item_onhold_count     = 0;
2053         my $notforloan_count      = 0;
2054         my $items_count           = scalar(@fields);
2055         my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
2056         my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
2057         my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
2058
2059         # loop through every item
2060         foreach my $field (@fields) {
2061             my $item;
2062
2063             # populate the items hash
2064             foreach my $code ( keys %subfieldstosearch ) {
2065                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
2066             }
2067             $item->{description} = $itemtypes{ $item->{itype} }{translated_description};
2068
2069                 # OPAC hidden items
2070             if ($is_opac) {
2071                 # hidden because lost
2072                 if ($hidelostitems && $item->{itemlost}) {
2073                     $hideatopac_count++;
2074                     next;
2075                 }
2076                 # hidden based on OpacHiddenItems syspref
2077                 my @hi = C4::Items::GetHiddenItemnumbers($item);
2078                 if (scalar @hi) {
2079                     push @hiddenitems, @hi;
2080                     $hideatopac_count++;
2081                     next;
2082                 }
2083             }
2084
2085             my $hbranch     = C4::Context->preference('StaffSearchResultsDisplayBranch');
2086             my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
2087
2088             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
2089             if ($item->{$hbranch}) {
2090                 $item->{'branchname'} = $branches{$item->{$hbranch}};
2091             }
2092             elsif ($item->{$otherbranch}) {     # Last resort
2093                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
2094             }
2095
2096                         my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
2097 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
2098             my $userenv = C4::Context->userenv;
2099             if ( $item->{onloan}
2100                 && $userenv
2101                 && $userenv->{number}
2102                 && !( Koha::Patrons->find($userenv->{number})->category->hidelostitems && $item->{itemlost} ) )
2103             {
2104                 $onloan_count++;
2105                 my $key = $prefix . $item->{onloan} . $item->{barcode};
2106                 $onloan_items->{$key}->{due_date} = $item->{onloan};
2107                 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
2108                 $onloan_items->{$key}->{branchname}     = $item->{branchname};
2109                 $onloan_items->{$key}->{location}       = $shelflocations->{ $item->{location} };
2110                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
2111                 $onloan_items->{$key}->{description}    = $item->{description};
2112                 $onloan_items->{$key}->{imageurl} =
2113                   getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2114
2115                 # if something's checked out and lost, mark it as 'long overdue'
2116                 if ( $item->{itemlost} ) {
2117                     $onloan_items->{$key}->{longoverdue}++;
2118                     $longoverdue_count++;
2119                 }
2120                 else {    # can place holds as long as item isn't lost
2121                     $can_place_holds = 1;
2122                 }
2123             }
2124
2125          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
2126             else {
2127
2128                 $item->{notforloan}=1 if !$item->{notforloan}  && $itemtypes{ C4::Context->preference("item-level_itypes")? $item->{itype}: $oldbiblio->{itemtype} }->{notforloan};
2129
2130                 # item is on order
2131                 if ( $item->{notforloan} < 0 ) {
2132                     $ordered_count++;
2133                 } elsif ( $item->{notforloan} > 0 ) {
2134                     $notforloan_count++;
2135                 }
2136
2137                 # is item in transit?
2138                 my $transfertwhen = '';
2139                 my ($transfertfrom, $transfertto);
2140
2141                 # is item on the reserve shelf?
2142                 my $reservestatus = '';
2143
2144                 unless ($item->{withdrawn}
2145                         || $item->{itemlost}
2146                         || $item->{damaged}
2147                         || $item->{notforloan}
2148                         || ( C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck')
2149                         && $items_count > C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') ) ) {
2150
2151                     # A couple heuristics to limit how many times
2152                     # we query the database for item transfer information, sacrificing
2153                     # accuracy in some cases for speed;
2154                     #
2155                     # 1. don't query if item has one of the other statuses
2156                     # 2. don't check transit status if the bib has
2157                     #    more than 20 items
2158                     #
2159                     # FIXME: to avoid having the query the database like this, and to make
2160                     #        the in transit status count as unavailable for search limiting,
2161                     #        should map transit status to record indexed in Zebra.
2162                     #
2163                     ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
2164                     $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
2165                 }
2166
2167                 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
2168                 if (   $item->{withdrawn}
2169                     || $item->{itemlost}
2170                     || $item->{damaged}
2171                     || $item->{notforloan}
2172                     || $reservestatus eq 'Waiting'
2173                     || ($transfertwhen ne ''))
2174                 {
2175                     $withdrawn_count++        if $item->{withdrawn};
2176                     $itemlost_count++        if $item->{itemlost};
2177                     $itemdamaged_count++     if $item->{damaged};
2178                     $item_in_transit_count++ if $transfertwhen ne '';
2179                     $item_onhold_count++     if $reservestatus eq 'Waiting';
2180                     $item->{status} = $item->{withdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
2181
2182                     # can place a hold on a item if
2183                     # not lost nor withdrawn
2184                     # not damaged unless AllowHoldsOnDamagedItems is true
2185                     # item is either for loan or on order (notforloan < 0)
2186                     $can_place_holds = 1
2187                       if (
2188                            !$item->{itemlost}
2189                         && !$item->{withdrawn}
2190                         && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
2191                         && ( !$item->{notforloan} || $item->{notforloan} < 0 )
2192                       );
2193
2194                     $other_count++;
2195
2196                     my $key = $prefix . $item->{status};
2197                     foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
2198                         $other_items->{$key}->{$_} = $item->{$_};
2199                     }
2200                     $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
2201                     $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
2202                     $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
2203                                         $other_items->{$key}->{count}++ if $item->{$hbranch};
2204                                         $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2205                                         $other_items->{$key}->{description} = $item->{description};
2206                                         $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2207                 }
2208                 # item is available
2209                 else {
2210                     $can_place_holds = 1;
2211                     $available_count++;
2212                                         $available_items->{$prefix}->{count}++ if $item->{$hbranch};
2213                                         foreach (qw(branchname itemcallnumber description)) {
2214                         $available_items->{$prefix}->{$_} = $item->{$_};
2215                                         }
2216                                         $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
2217                                         $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2218                 }
2219             }
2220         }    # notforloan, item level and biblioitem level
2221
2222         # if all items are hidden, do not show the record
2223         if ($items_count > 0 && $hideatopac_count == $items_count) {
2224             next;
2225         }
2226
2227         my ( $availableitemscount, $onloanitemscount, $otheritemscount );
2228         for my $key ( sort keys %$onloan_items ) {
2229             (++$onloanitemscount > $maxitems) and last;
2230             push @onloan_items_loop, $onloan_items->{$key};
2231         }
2232         for my $key ( sort keys %$other_items ) {
2233             (++$otheritemscount > $maxitems) and last;
2234             push @other_items_loop, $other_items->{$key};
2235         }
2236         for my $key ( sort keys %$available_items ) {
2237             (++$availableitemscount > $maxitems) and last;
2238             push @available_items_loop, $available_items->{$key}
2239         }
2240
2241         # XSLT processing of some stuff
2242         # we fetched the sysprefs already before the loop through all retrieved record!
2243         if (!$scan && $xslfile) {
2244             $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $xslsyspref, 1, \@hiddenitems, $sysxml, $xslfile, $lang);
2245         # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2246         }
2247
2248         # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2249         if (!C4::Context->preference("item-level_itypes")) {
2250             if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2251                 $can_place_holds = 0;
2252             }
2253         }
2254         $oldbiblio->{norequests} = 1 unless $can_place_holds;
2255         $oldbiblio->{itemsplural}          = 1 if $items_count > 1;
2256         $oldbiblio->{items_count}          = $items_count;
2257         $oldbiblio->{available_items_loop} = \@available_items_loop;
2258         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
2259         $oldbiblio->{other_items_loop}     = \@other_items_loop;
2260         $oldbiblio->{availablecount}       = $available_count;
2261         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
2262         $oldbiblio->{onloancount}          = $onloan_count;
2263         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
2264         $oldbiblio->{othercount}           = $other_count;
2265         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
2266         $oldbiblio->{withdrawncount}        = $withdrawn_count;
2267         $oldbiblio->{itemlostcount}        = $itemlost_count;
2268         $oldbiblio->{damagedcount}         = $itemdamaged_count;
2269         $oldbiblio->{intransitcount}       = $item_in_transit_count;
2270         $oldbiblio->{onholdcount}          = $item_onhold_count;
2271         $oldbiblio->{orderedcount}         = $ordered_count;
2272         $oldbiblio->{notforloancount}      = $notforloan_count;
2273
2274         if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2275             my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2276             my $subfields = substr $fieldspec, 3;
2277             my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2278             my @alternateholdingsinfo = ();
2279             my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2280             my $alternateholdingscount = 0;
2281
2282             for my $field (@holdingsfields) {
2283                 my %holding = ( holding => '' );
2284                 my $havesubfield = 0;
2285                 for my $subfield ($field->subfields()) {
2286                     if ((index $subfields, $$subfield[0]) >= 0) {
2287                         $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2288                         $holding{'holding'} .= $$subfield[1];
2289                         $havesubfield++;
2290                     }
2291                 }
2292                 if ($havesubfield) {
2293                     push(@alternateholdingsinfo, \%holding);
2294                     $alternateholdingscount++;
2295                 }
2296             }
2297
2298             $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2299             $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2300         }
2301
2302         push( @newresults, $oldbiblio );
2303     }
2304
2305     return @newresults;
2306 }
2307
2308 =head2 enabled_staff_search_views
2309
2310 %hash = enabled_staff_search_views()
2311
2312 This function returns a hash that contains three flags obtained from the system
2313 preferences, used to determine whether a particular staff search results view
2314 is enabled.
2315
2316 =over 2
2317
2318 =item C<Output arg:>
2319
2320     * $hash{can_view_MARC} is true only if the MARC view is enabled
2321     * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2322     * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2323
2324 =item C<usage in the script:>
2325
2326 =back
2327
2328 $template->param ( C4::Search::enabled_staff_search_views );
2329
2330 =cut
2331
2332 sub enabled_staff_search_views
2333 {
2334         return (
2335                 can_view_MARC                   => C4::Context->preference('viewMARC'),                 # 1 if the staff search allows the MARC view
2336                 can_view_ISBD                   => C4::Context->preference('viewISBD'),                 # 1 if the staff search allows the ISBD view
2337                 can_view_labeledMARC    => C4::Context->preference('viewLabeledMARC'),  # 1 if the staff search allows the Labeled MARC view
2338         );
2339 }
2340
2341 =head2 z3950_search_args
2342
2343 $arrayref = z3950_search_args($matchpoints)
2344
2345 This function returns an array reference that contains the search parameters to be
2346 passed to the Z39.50 search script (z3950_search.pl). The array elements
2347 are hash refs whose keys are name and value, and whose values are the
2348 name of a search parameter, the value of that search parameter and the URL encoded
2349 value of that parameter.
2350
2351 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2352
2353 The search parameter values are obtained from the bibliographic record whose
2354 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2355
2356 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2357 a general purpose search argument. In this case, the returned array contains only
2358 entry: the key is 'title' and the value is derived from $matchpoints.
2359
2360 If a search parameter value is undefined or empty, it is not included in the returned
2361 array.
2362
2363 The returned array reference may be passed directly to the template parameters.
2364
2365 =over 2
2366
2367 =item C<Output arg:>
2368
2369     * $array containing hash refs as described above
2370
2371 =item C<usage in the script:>
2372
2373 =back
2374
2375 $data = Biblio::GetBiblioData($bibno);
2376 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2377
2378 *OR*
2379
2380 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2381
2382 =cut
2383
2384 sub z3950_search_args {
2385     my $bibrec = shift;
2386
2387     my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2388     my $isbn = Business::ISBN->new( $isbn_string );
2389
2390     if (defined $isbn && $isbn->is_valid)
2391     {
2392         if ( ref($bibrec) ) {
2393             $bibrec->{isbn} = $isbn_string;
2394             $bibrec->{title} = undef;
2395         } else {
2396             $bibrec = { isbn => $isbn_string };
2397         }
2398     }
2399     else {
2400         $bibrec = { title => $bibrec } if !ref $bibrec;
2401     }
2402     my $array = [];
2403     for my $field (qw/ lccn isbn issn title author dewey subject /)
2404     {
2405         push @$array, { name => $field, value => $bibrec->{$field} }
2406           if defined $bibrec->{$field};
2407     }
2408     return $array;
2409 }
2410
2411 =head2 GetDistinctValues($field);
2412
2413 C<$field> is a reference to the fields array
2414
2415 =cut
2416
2417 sub GetDistinctValues {
2418     my ($fieldname,$string)=@_;
2419     # returns a reference to a hash of references to branches...
2420     if ($fieldname=~/\./){
2421                         my ($table,$column)=split /\./, $fieldname;
2422                         my $dbh = C4::Context->dbh;
2423                         warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2424                         my $sth = $dbh->prepare("select DISTINCT($column) as value, count(*) as cnt from $table ".($string?" where $column like \"$string%\"":"")."group by value order by $column ");
2425                         $sth->execute;
2426                         my $elements=$sth->fetchall_arrayref({});
2427                         return $elements;
2428    }
2429    else {
2430                 $string||= qq("");
2431                 my @servers=qw<biblioserver authorityserver>;
2432                 my (@zconns,@results);
2433         for ( my $i = 0 ; $i < @servers ; $i++ ) {
2434                 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2435                         $results[$i] =
2436                       $zconns[$i]->scan(
2437                         ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2438                       );
2439                 }
2440                 # The big moment: asynchronously retrieve results from all servers
2441                 my @elements;
2442         _ZOOM_event_loop(
2443             \@zconns,
2444             \@results,
2445             sub {
2446                 my ( $i, $size ) = @_;
2447                 for ( my $j = 0 ; $j < $size ; $j++ ) {
2448                     my %hashscan;
2449                     @hashscan{qw(value cnt)} =
2450                       $results[ $i - 1 ]->display_term($j);
2451                     push @elements, \%hashscan;
2452                 }
2453             }
2454         );
2455                 return \@elements;
2456    }
2457 }
2458
2459 =head2 _ZOOM_event_loop
2460
2461     _ZOOM_event_loop(\@zconns, \@results, sub {
2462         my ( $i, $size ) = @_;
2463         ....
2464     } );
2465
2466 Processes a ZOOM event loop and passes control to a closure for
2467 processing the results, and destroying the resultsets.
2468
2469 =cut
2470
2471 sub _ZOOM_event_loop {
2472     my ($zconns, $results, $callback) = @_;
2473     while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2474         my $ev = $zconns->[ $i - 1 ]->last_event();
2475         if ( $ev == ZOOM::Event::ZEND ) {
2476             next unless $results->[ $i - 1 ];
2477             my $size = $results->[ $i - 1 ]->size();
2478             if ( $size > 0 ) {
2479                 $callback->($i, $size);
2480             }
2481         }
2482     }
2483
2484     foreach my $result (@$results) {
2485         $result->destroy();
2486     }
2487 }
2488
2489 =head2 new_record_from_zebra
2490
2491 Given raw data from a searchengine result set, return a MARC::Record object
2492
2493 This helper function is needed to take into account all the involved
2494 system preferences and configuration variables to properly create the
2495 MARC::Record object.
2496
2497 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2498 data. If we are using DOM, then it has to be MARCXML.
2499
2500 If we are using elasticsearch, it'll already be a MARC::Record and this
2501 function needs a new name.
2502
2503 =cut
2504
2505 sub new_record_from_zebra {
2506
2507     my $server   = shift;
2508     my $raw_data = shift;
2509     # Set the default indexing modes
2510     my $search_engine = C4::Context->preference("SearchEngine");
2511     if ($search_engine eq 'Elasticsearch') {
2512         return ref $raw_data eq 'MARC::Record' ? $raw_data : MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2513     }
2514     my $index_mode = ( $server eq 'biblioserver' )
2515                         ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2516                         : C4::Context->config('zebra_auth_index_mode') // 'dom';
2517
2518     my $marc_record =  eval {
2519         if ( $index_mode eq 'dom' ) {
2520             MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2521         } else {
2522             MARC::Record->new_from_usmarc( $raw_data );
2523         }
2524     };
2525
2526     if ($@) {
2527         return;
2528     } else {
2529         return $marc_record;
2530     }
2531
2532 }
2533
2534 END { }    # module clean-up code here (global destructor)
2535
2536 1;
2537 __END__
2538
2539 =head1 AUTHOR
2540
2541 Koha Development Team <http://koha-community.org/>
2542
2543 =cut