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