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             $f->{facets} = [ sort { uc($a->{facet_label_value}) cmp uc($b->{facet_label_value}) } @{ $f->{facets} } ];
 590         }
 591     }
 592
 593     return ( undef, $results_hashref, \@facets_loop );
 594 }
 595
 596 sub GetFacets {
 597
 598     my $rs = shift;
 599     my $facets;
 600
 601     my $use_zebra_facets = C4::Context->config('use_zebra_facets') // 0;
 602
 603     if ( $use_zebra_facets ) {
 604         $facets = _get_facets_from_zebra( $rs );
 605     } else {
 606         $facets = _get_facets_from_records( $rs );
 607     }
 608
 609     return $facets;
 610 }
 611
 612 sub _get_facets_from_records {
 613
 614     my $rs = shift;
 615
 616     my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets') // 20;
 617     my $facets_config  = getFacets();
 618     my $facets         = {};
 619     my $size           = $rs->size();
 620     my $jmax           = $size > $facets_maxrecs
 621                             ? $facets_maxrecs
 622                             : $size;
 623
 624     for ( my $j = 0 ; $j < $jmax ; $j++ ) {
 625
 626         my $marc_record = new_record_from_zebra (
 627                 'biblioserver',
 628                 $rs->record( $j )->raw()
 629         );
 630
 631         if ( ! defined $marc_record ) {
 632             warn "ERROR DECODING RECORD - $@: " .
 633                 $rs->record( $j )->raw();
 634             next;
 635         }
 636
 637         _get_facets_data_from_record( $marc_record, $facets_config, $facets );
 638     }
 639
 640     return $facets;
 641 }
 642
 643 =head2 _get_facets_data_from_record
 644
 645     C4::Search::_get_facets_data_from_record( $marc_record, $facets, $facets_counter );
 646
 647 Internal function that extracts facets information from a MARC::Record object
 648 and populates $facets_counter for using in getRecords.
 649
 650 $facets is expected to be filled with C4::Koha::getFacets output (i.e. the configured
 651 facets for Zebra).
 652
 653 =cut
 654
 655 sub _get_facets_data_from_record {
 656
 657     my ( $marc_record, $facets, $facets_counter ) = @_;
 658
 659     for my $facet (@$facets) {
 660
 661         my @used_datas = ();
 662
 663         foreach my $tag ( @{ $facet->{ tags } } ) {
 664
 665             # tag number is the first three digits
 666             my $tag_num          = substr( $tag, 0, 3 );
 667             # subfields are the remainder
 668             my $subfield_letters = substr( $tag, 3 );
 669
 670             my @fields = $marc_record->field( $tag_num );
 671             foreach my $field (@fields) {
 672                 # If $field->indicator(1) eq 'z', it means it is a 'see from'
 673                 # field introduced because of IncludeSeeFromInSearches, so skip it
 674                 next if $field->indicator(1) eq 'z';
 675
 676                 my $data = $field->as_string( $subfield_letters, $facet->{ sep } );
 677                 $data =~ s/\s*(?<!\p{Uppercase})[.\-,;]*\s*$//;
 678
 679                 unless ( grep { $_ eq $data } @used_datas ) {
 680                     push @used_datas, $data;
 681                     $facets_counter->{ $facet->{ idx } }->{ $data }++;
 682                 }
 683             }
 684         }
 685     }
 686 }
 687
 688 =head2 _get_facets_from_zebra
 689
 690     my $facets = _get_facets_from_zebra( $result_set )
 691
 692 Retrieves facets for a specified result set. It loops through the facets defined
 693 in C4::Koha::getFacets and returns a hash with the following structure:
 694
 695    {  facet_idx => {
 696             facet_value => count
 697       },
 698       ...
 699    }
 700
 701 =cut
 702
 703 sub _get_facets_from_zebra {
 704
 705     my $rs = shift;
 706
 707     # save current elementSetName
 708     my $elementSetName = $rs->option( 'elementSetName' );
 709
 710     my $facets_loop = getFacets();
 711     my $facets_data  = {};
 712     # loop through defined facets and fill the facets hashref
 713     foreach my $facet ( @$facets_loop ) {
 714
 715         my $idx = $facet->{ idx };
 716         my $sep = $facet->{ sep };
 717         my $facet_values = _get_facet_from_result_set( $idx, $rs, $sep );
 718         if ( $facet_values ) {
 719             # we've actually got a result
 720             $facets_data->{ $idx } = $facet_values;
 721         }
 722     }
 723     # set elementSetName to its previous value to avoid side effects
 724     $rs->option( elementSetName => $elementSetName );
 725
 726     return $facets_data;
 727 }
 728
 729 =head2 _get_facet_from_result_set
 730
 731     my $facet_values =
 732         C4::Search::_get_facet_from_result_set( $facet_idx, $result_set, $sep )
 733
 734 Internal function that extracts facet information for a specific index ($facet_idx) and
 735 returns a hash containing facet values and count:
 736
 737     {
 738         $facet_value => $count ,
 739         ...
 740     }
 741
 742 Warning: this function has the side effect of changing the elementSetName for the result
 743 set. It is a helper function for the main loop, which takes care of backing it up for
 744 restoring.
 745
 746 =cut
 747
 748 sub _get_facet_from_result_set {
 749
 750     my $facet_idx = shift;
 751     my $rs        = shift;
 752     my $sep       = shift;
 753
 754     my $internal_sep  = '<*>';
 755     my $facetMaxCount = C4::Context->preference('FacetMaxCount') // 20;
 756
 757     return if ( ! defined $facet_idx || ! defined $rs );
 758     # zebra's facet element, untokenized index
 759     my $facet_element = 'zebra::facet::' . $facet_idx . ':0:' . $facetMaxCount;
 760     # configure zebra results for retrieving the desired facet
 761     $rs->option( elementSetName => $facet_element );
 762     # get the facet record from result set
 763     my $facet = $rs->record( 0 )->raw;
 764     # if the facet has no restuls...
 765     return if !defined $facet;
 766     # TODO: benchmark DOM vs. SAX performance
 767     my $facet_dom = XML::LibXML->load_xml(
 768       string => ($facet)
 769     );
 770     my @terms = $facet_dom->getElementsByTagName('term');
 771     return if ! @terms;
 772
 773     my $facets = {};
 774     foreach my $term ( @terms ) {
 775         my $facet_value = $term->textContent;
 776         $facet_value =~ s/\s*(?<!\p{Uppercase})[.\-,;]*\s*$//;
 777         $facet_value =~ s/\Q$internal_sep\E/$sep/ if defined $sep;
 778         $facets->{ $facet_value } += $term->getAttribute( 'occur' );
 779     }
 780
 781     return $facets;
 782 }
 783
 784 =head2 _get_facets_info
 785
 786     my $facets_info = C4::Search::_get_facets_info( $facets )
 787
 788 Internal function that extracts facets information and properly builds
 789 the data structure needed to render facet labels.
 790
 791 =cut
 792
 793 sub _get_facets_info {
 794
 795     my $facets = shift;
 796
 797     my $facets_info = {};
 798
 799     for my $facet ( @$facets ) {
 800         $facets_info->{ $facet->{ idx } }->{ label_value } = $facet->{ label };
 801     }
 802
 803     return $facets_info;
 804 }
 805
 806 # TRUNCATION
 807 sub _detect_truncation {
 808     my ( $operand, $index ) = @_;
 809     my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
 810         @regexpr );
 811     $operand =~ s/^ //g;
 812     my @wordlist = split( /\s/, $operand );
 813     foreach my $word (@wordlist) {
 814         if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
 815             push @rightlefttruncated, $word;
 816         }
 817         elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
 818             push @lefttruncated, $word;
 819         }
 820         elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
 821             push @righttruncated, $word;
 822         }
 823         elsif ( index( $word, "*" ) < 0 ) {
 824             push @nontruncated, $word;
 825         }
 826         else {
 827             push @regexpr, $word;
 828         }
 829     }
 830     return (
 831         \@nontruncated,       \@righttruncated, \@lefttruncated,
 832         \@rightlefttruncated, \@regexpr
 833     );
 834 }
 835
 836 # STEMMING
 837 sub _build_stemmed_operand {
 838     my ($operand,$lang) = @_;
 839     require Lingua::Stem::Snowball ;
 840     my $stemmed_operand=q{};
 841
 842     # Stemmer needs language
 843     return $operand unless $lang;
 844
 845     # If operand contains a digit, it is almost certainly an identifier, and should
 846     # not be stemmed.  This is particularly relevant for ISBNs and ISSNs, which
 847     # can contain the letter "X" - for example, _build_stemmend_operand would reduce
 848     # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
 849     # results (e.g., "23 x 29 cm." from the 300$c).  Bug 2098.
 850     return $operand if $operand =~ /\d/;
 851
 852 # FIXME: the locale should be set based on the user's language and/or search choice
 853     #warn "$lang";
 854     # Make sure we only use the first two letters from the language code
 855     $lang = lc(substr($lang, 0, 2));
 856     # The language codes for the two variants of Norwegian will now be "nb" and "nn",
 857     # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
 858     if ($lang eq 'nb' || $lang eq 'nn') {
 859       $lang = 'no';
 860     }
 861     my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
 862                                                encoding => "UTF-8" );
 863
 864     my @words = split( / /, $operand );
 865     my @stems = $stemmer->stem(\@words);
 866     for my $stem (@stems) {
 867         $stemmed_operand .= "$stem";
 868         $stemmed_operand .= "?"
 869           unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 870         $stemmed_operand .= " ";
 871     }
 872
 873     Koha::Logger->get->debug("STEMMED OPERAND: $stemmed_operand");
 874     return $stemmed_operand;
 875 }
 876
 877 # FIELD WEIGHTING
 878 sub _build_weighted_query {
 879
 880 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
 881 # pretty well but could work much better if we had a smarter query parser
 882     my ( $operand, $stemmed_operand, $index ) = @_;
 883     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 884     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 885     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy")        || 0;
 886     $operand =~ s/"/ /g;    # Bug 7518: searches with quotation marks don't work
 887
 888     my $weighted_query .= "(rk=(";    # Specifies that we're applying rank
 889
 890     # Keyword, or, no index specified
 891     if ( ( $index eq 'kw' ) || ( !$index ) ) {
 892         $weighted_query .=
 893           "Title-cover,ext,r1=\"$operand\"";    # exact title-cover
 894         $weighted_query .= " or ti,ext,r2=\"$operand\"";    # exact title
 895         $weighted_query .= " or Title-cover,phr,r3=\"$operand\"";    # phrase title
 896         $weighted_query .= " or ti,wrdl,r4=\"$operand\"";    # words in title
 897           #$weighted_query .= " or any,ext,r4=$operand";               # exact any
 898           #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
 899         $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
 900           if $fuzzy_enabled;    # add fuzzy, word list
 901         $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
 902           if ( $stemming and $stemmed_operand )
 903           ;                     # add stemming, right truncation
 904         $weighted_query .= " or wrdl,r9=\"$operand\"";
 905
 906         # embedded sorting: 0 a-z; 1 z-a
 907         # $weighted_query .= ") or (sort1,aut=1";
 908     }
 909
 910     # Barcode searches should skip this process
 911     elsif ( $index eq 'bc' ) {
 912         $weighted_query .= "bc=\"$operand\"";
 913     }
 914
 915     # Authority-number searches should skip this process
 916     elsif ( $index eq 'an' ) {
 917         $weighted_query .= "an=\"$operand\"";
 918     }
 919
 920     # If the index is numeric, don't autoquote it.
 921     elsif ( $index =~ /,st-numeric$/ ) {
 922         $weighted_query .= " $index=$operand";
 923     }
 924
 925     # If the index already has more than one qualifier, wrap the operand
 926     # in quotes and pass it back (assumption is that the user knows what they
 927     # are doing and won't appreciate us mucking up their query
 928     elsif ( $index =~ ',' ) {
 929         $weighted_query .= " $index=\"$operand\"";
 930     }
 931
 932     #TODO: build better cases based on specific search indexes
 933     else {
 934         $weighted_query .= " $index,ext,r1=\"$operand\"";    # exact index
 935           #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
 936         $weighted_query .= " or $index,phr,r3=\"$operand\"";    # phrase index
 937         $weighted_query .= " or $index,wrdl,r6=\"$operand\"";    # word list index
 938         $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
 939           if $fuzzy_enabled;    # add fuzzy, word list
 940         $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
 941           if ( $stemming and $stemmed_operand );    # add stemming, right truncation
 942     }
 943
 944     $weighted_query .= "))";                       # close rank specification
 945     return $weighted_query;
 946 }
 947
 948 =head2 getIndexes
 949
 950 Return an array with available indexes.
 951
 952 =cut
 953
 954 sub getIndexes{
 955     my @indexes = (
 956                     # biblio indexes
 957                     'ab',
 958                     'Abstract',
 959                     'acqdate',
 960                     'allrecords',
 961                     'an',
 962                     'Any',
 963                     'at',
 964                     'arl',
 965                     'arp',
 966                     'au',
 967                     'aub',
 968                     'aud',
 969                     'audience',
 970                     'auo',
 971                     'aut',
 972                     'Author',
 973                     'Author-in-order ',
 974                     'Author-personal-bibliography',
 975                     'Authority-Number',
 976                     'authtype',
 977                     'bc',
 978                     'Bib-level',
 979                     'biblionumber',
 980                     'bio',
 981                     'biography',
 982                     'callnum',
 983                     'cfn',
 984                     'Chronological-subdivision',
 985                     'cn-bib-source',
 986                     'cn-bib-sort',
 987                     'cn-class',
 988                     'cn-item',
 989                     'cn-prefix',
 990                     'cn-suffix',
 991                     'cpn',
 992                     'Code-institution',
 993                     'Conference-name',
 994                     'Conference-name-heading',
 995                     'Conference-name-see',
 996                     'Conference-name-seealso',
 997                     'Content-type',
 998                     'Control-number',
 999                     'copydate',
1000                     'Corporate-name',
1001                     'Corporate-name-heading',
1002                     'Corporate-name-see',
1003                     'Corporate-name-seealso',
1004                     'Country-publication',
1005                     'ctype',
1006                     'curriculum',
1007                     'date-entered-on-file',
1008                     'Date-of-acquisition',
1009                     'Date-of-publication',
1010                     'Date-time-last-modified',
1011                     'Dewey-classification',
1012                     'Dissertation-information',
1013                     'diss',
1014                     'dtlm',
1015                     'EAN',
1016                     'extent',
1017                     'fic',
1018                     'fiction',
1019                     'Form-subdivision',
1020                     'format',
1021                     'Geographic-subdivision',
1022                     'he',
1023                     'Heading',
1024                     'Heading-use-main-or-added-entry',
1025                     'Heading-use-series-added-entry ',
1026                     'Heading-use-subject-added-entry',
1027                     'Host-item',
1028                     'id-other',
1029                     'ident',
1030                     'Identifier-standard',
1031                     'Illustration-code',
1032                     'Index-term-genre',
1033                     'Index-term-uncontrolled',
1034                     'Interest-age-level',
1035                     'Interest-grade-level',
1036                     'ISBN',
1037                     'isbn',
1038                     'ISSN',
1039                     'issn',
1040                     'itemtype',
1041                     'kw',
1042                     'Koha-Auth-Number',
1043                     'l-format',
1044                     'language',
1045                     'language-original',
1046                     'lc-card',
1047                     'LC-card-number',
1048                     'lcn',
1049                     'lex',
1050                     'lexile-number',
1051                     'llength',
1052                     'ln',
1053                     'ln-audio',
1054                     'ln-subtitle',
1055                     'Local-classification',
1056                     'Local-number',
1057                     'Match-heading',
1058                     'Match-heading-see-from',
1059                     'Material-type',
1060                     'mc-itemtype',
1061                     'mc-rtype',
1062                     'mus',
1063                     'name',
1064                     'Music-number',
1065                     'Name-geographic',
1066                     'Name-geographic-heading',
1067                     'Name-geographic-see',
1068                     'Name-geographic-seealso',
1069                     'nb',
1070                     'Note',
1071                     'notes',
1072                     'ns',
1073                     'nt',
1074                     'Other-control-number',
1075                     'pb',
1076                     'Personal-name',
1077                     'Personal-name-heading',
1078                     'Personal-name-see',
1079                     'Personal-name-seealso',
1080                     'pl',
1081                     'Place-publication',
1082                     'pn',
1083                     'popularity',
1084                     'pubdate',
1085                     'Publisher',
1086                     'Provider',
1087                     'pv',
1088                     'Reading-grade-level',
1089                     'Record-control-number',
1090                     'rcn',
1091                     'Record-type',
1092                     'rtype',
1093                     'se',
1094                     'See',
1095                     'See-also',
1096                     'sn',
1097                     'Stock-number',
1098                     'su',
1099                     'Subject',
1100                     'Subject-heading-thesaurus',
1101                     'Subject-name-personal',
1102                     'Subject-subdivision',
1103                     'Summary',
1104                     'Suppress',
1105                     'su-geo',
1106                     'su-na',
1107                     'su-to',
1108                     'su-ut',
1109                     'ut',
1110                     'Term-genre-form',
1111                     'Term-genre-form-heading',
1112                     'Term-genre-form-see',
1113                     'Term-genre-form-seealso',
1114                     'ti',
1115                     'Title',
1116                     'Title-cover',
1117                     'Title-series',
1118                     'Title-uniform',
1119                     'Title-uniform-heading',
1120                     'Title-uniform-see',
1121                     'Title-uniform-seealso',
1122                     'totalissues',
1123                     'yr',
1124
1125                     # items indexes
1126                     'acqsource',
1127                     'barcode',
1128                     'bc',
1129                     'branch',
1130                     'ccode',
1131                     'classification-source',
1132                     'cn-sort',
1133                     'coded-location-qualifier',
1134                     'copynumber',
1135                     'damaged',
1136                     'datelastborrowed',
1137                     'datelastseen',
1138                     'holdingbranch',
1139                     'homebranch',
1140                     'issues',
1141                     'item',
1142                     'itemnumber',
1143                     'itype',
1144                     'Local-classification',
1145                     'location',
1146                     'lost',
1147                     'materials-specified',
1148                     'mc-ccode',
1149                     'mc-itype',
1150                     'mc-loc',
1151                     'notforloan',
1152                     'Number-local-acquisition',
1153                     'onloan',
1154                     'price',
1155                     'renewals',
1156                     'replacementprice',
1157                     'replacementpricedate',
1158                     'reserves',
1159                     'restricted',
1160                     'stack',
1161                     'stocknumber',
1162                     'inv',
1163                     'uri',
1164                     'withdrawn',
1165
1166                     # subject related
1167                   );
1168
1169     return \@indexes;
1170 }
1171
1172 =head2 buildQuery
1173
1174 ( $error, $query,
1175 $simple_query, $query_cgi,
1176 $query_desc, $limit,
1177 $limit_cgi, $limit_desc,
1178 $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1179
1180 Build queries and limits in CCL, CGI, Human,
1181 handle truncation, stemming, field weighting, fuzziness, etc.
1182
1183 See verbose embedded documentation.
1184
1185
1186 =cut
1187
1188 sub buildQuery {
1189     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1190
1191     my $query_desc;
1192
1193     # dereference
1194     my @operators = $operators ? @$operators : ();
1195     my @indexes   = $indexes   ? @$indexes   : ();
1196     my @operands  = $operands  ? @$operands  : ();
1197     my @limits    = $limits    ? @$limits    : ();
1198     my @sort_by   = $sort_by   ? @$sort_by   : ();
1199
1200     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
1201     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
1202     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
1203     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
1204
1205     my $query        = $operands[0] // "";
1206     my $simple_query = $operands[0];
1207
1208     # initialize the variables we're passing back
1209     my $query_cgi;
1210     my $query_type;
1211
1212     my $limit;
1213     my $limit_cgi;
1214     my $limit_desc;
1215
1216     my $cclq       = 0;
1217     my $cclindexes = getIndexes();
1218     if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1219         while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1220             my $dx = lc($1);
1221             $cclq = grep { lc($_) eq $dx } @$cclindexes;
1222         }
1223         $query = "ccl=$query" if $cclq;
1224     }
1225
1226 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1227 # DIAGNOSTIC ONLY!!
1228     if ( $query =~ /^ccl=/ ) {
1229         my $q=$';
1230         # This is needed otherwise ccl= and &limit won't work together, and
1231         # this happens when selecting a subject on the opac-detail page
1232         @limits = grep {!/^$/} @limits;
1233         my $original_q = $q; # without available part
1234         unless ( grep { $_ eq 'available' } @limits ) {
1235             $q =~ s| and \( \(allrecords,AlwaysMatches=''\) and \(not-onloan-count,st-numeric >= 1\) and \(lost,st-numeric=0\) \)||;
1236             $original_q = $q;
1237         }
1238         if ( @limits ) {
1239             if ( grep { $_ eq 'available' } @limits ) {
1240                 $q .= q| and ( (allrecords,AlwaysMatches='') and (not-onloan-count,st-numeric >= 1) and (lost,st-numeric=0) )|;
1241                 @limits = grep {!/^available$/} @limits;
1242             }
1243             $q .= ' and '.join(' and ', @limits) if @limits;
1244         }
1245         return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $original_q, '', '', '', 'ccl' );
1246     }
1247     if ( $query =~ /^cql=/ ) {
1248         return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', 'cql' );
1249     }
1250     if ( $query =~ /^pqf=/ ) {
1251         $query_desc = $';
1252         $query_cgi = "q=pqf=".uri_escape_utf8($');
1253         return ( undef, $', $', $query_cgi, $query_desc, '', '', '', 'pqf' );
1254     }
1255
1256     # pass nested queries directly
1257     # FIXME: need better handling of some of these variables in this case
1258     # Nested queries aren't handled well and this implementation is flawed and causes users to be
1259     # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1260 #    if ( $query =~ /(\(|\))/ ) {
1261 #        return (
1262 #            undef,              $query, $simple_query, $query_cgi,
1263 #            $query,             $limit, $limit_cgi,    $limit_desc,
1264 #            'ccl'
1265 #        );
1266 #    }
1267
1268 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1269 # query operands and indexes and add stemming, truncation, field weighting, etc.
1270 # Once we do so, we'll end up with a value in $query, just like if we had an
1271 # incoming $query from the user
1272     else {
1273         $query = ""
1274           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1275         my $previous_operand
1276           ;    # a flag used to keep track if there was a previous query
1277                # if there was, we can apply the current operator
1278                # for every operand
1279         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1280
1281             # COMBINE OPERANDS, INDEXES AND OPERATORS
1282             if ( ($operands[$i] // '') ne '' ) {
1283                 $operands[$i]=~s/^\s+//;
1284
1285               # A flag to determine whether or not to add the index to the query
1286                 my $indexes_set;
1287
1288 # If the user is sophisticated enough to specify an index, turn off field weighting, and stemming handling
1289                 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1290                     $weight_fields    = 0;
1291                     $stemming         = 0;
1292                 } else {
1293                     $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1294                 }
1295                 my $operand = $operands[$i];
1296                 my $index   = $indexes[$i] || 'kw';
1297
1298                 # Add index-specific attributes
1299
1300                 #Afaik, this 'yr' condition will only ever be met in the staff interface advanced search
1301                 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1302                 #which is processed higher up in this sub. Other than that, year searches are typically
1303                 #handled as limits which are not processed her either.
1304
1305                 # Search ranges: Date of Publication, st-numeric
1306                 if ( $index =~ /(yr|st-numeric)/ ) {
1307                     #weight_fields/relevance search causes errors with date ranges
1308                     #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1309                     #In the case of YYYY-YYYY, it will return no results
1310                     $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1311                 }
1312
1313                 # Date of Acquisition
1314                 elsif ( $index =~ /acqdate/ ) {
1315                     #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1316                     #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1317                       #top of the results just because they have lots of item records matching that date.
1318                     #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1319                       #irrelevant here
1320                     $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1321                 }
1322                 # ISBN,ISSN,Standard Number, don't need special treatment
1323                 elsif ( $index eq 'nb' || $index eq 'ns' || $index eq 'hi' ) {
1324                     (
1325                         $stemming,      $auto_truncation,
1326                         $weight_fields, $fuzzy_enabled
1327                     ) = ( 0, 0, 0, 0 );
1328
1329                     if ( $index eq 'nb' ) {
1330                         if ( C4::Context->preference("SearchWithISBNVariations") ) {
1331                             my @isbns = C4::Koha::GetVariationsOfISBN( $operand );
1332                             $operands[$i] = $operand =  '(nb=' . join(' OR nb=', @isbns) . ')';
1333                             $indexes[$i] = $index = 'kw';
1334                         }
1335                     }
1336                 }
1337
1338                 # Set default structure attribute (word list)
1339                 my $struct_attr = q{};
1340                 unless ( $indexes_set || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1341                     $struct_attr = ",wrdl";
1342                 }
1343
1344                 # Some helpful index variants
1345                 my $index_plus       = $index . $struct_attr . ':';
1346                 my $index_plus_comma = $index . $struct_attr . ',';
1347
1348                 if ($auto_truncation){
1349                         unless ( $index =~ /,(st-|phr|ext)/ ) {
1350                                                 #FIXME only valid with LTR scripts
1351                                                 $operand=join(" ",map{
1352                                                                                         (index($_,"*")>0?"$_":"$_*")
1353                                                                                          }split (/\s+/,$operand));
1354                                         }
1355                                 }
1356
1357                 # Detect Truncation
1358                 my $truncated_operand = q{};
1359                 my( $nontruncated, $righttruncated, $lefttruncated,
1360                     $rightlefttruncated, $regexpr
1361                 ) = _detect_truncation( $operand, $index );
1362
1363                 Koha::Logger->get->debug(
1364                     "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<");
1365
1366                 # Apply Truncation
1367                 if (
1368                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
1369                     scalar(@$rightlefttruncated) > 0 )
1370                 {
1371
1372                # Don't field weight or add the index to the query, we do it here
1373                     $indexes_set = 1;
1374                     undef $weight_fields;
1375                     my $previous_truncation_operand;
1376                     if (scalar @$nontruncated) {
1377                         $truncated_operand .= "$index_plus @$nontruncated ";
1378                         $previous_truncation_operand = 1;
1379                     }
1380                     if (scalar @$righttruncated) {
1381                         $truncated_operand .= "and " if $previous_truncation_operand;
1382                         $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1383                         $previous_truncation_operand = 1;
1384                     }
1385                     if (scalar @$lefttruncated) {
1386                         $truncated_operand .= "and " if $previous_truncation_operand;
1387                         $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1388                         $previous_truncation_operand = 1;
1389                     }
1390                     if (scalar @$rightlefttruncated) {
1391                         $truncated_operand .= "and " if $previous_truncation_operand;
1392                         $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1393                         $previous_truncation_operand = 1;
1394                     }
1395                 }
1396                 $operand = $truncated_operand if $truncated_operand;
1397                 Koha::Logger->get->debug("TRUNCATED OPERAND: >$truncated_operand<");
1398
1399                 # Handle Stemming
1400                 my $stemmed_operand = q{};
1401                 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1402                                                                                 if $stemming;
1403
1404                 Koha::Logger->get->debug("STEMMED OPERAND: >$stemmed_operand<");
1405
1406                 # Handle Field Weighting
1407                 my $weighted_operand = q{};
1408                 if ($weight_fields) {
1409                     $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1410                     $operand = $weighted_operand;
1411                     $indexes_set = 1;
1412                 }
1413
1414                 Koha::Logger->get->debug("FIELD WEIGHTED OPERAND: >$weighted_operand<");
1415
1416                 #Use relevance ranking when not using a weighted query (which adds relevance ranking of its own)
1417
1418                 #N.B. Truncation is mutually exclusive with Weighted Queries,
1419                 #so even if QueryWeightFields is turned on, QueryAutoTruncate will turn it off, thus
1420                 #the need for this relevance wrapper.
1421                 $operand = "(rk=($operand))" unless $weight_fields;
1422
1423                 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1424                     query => $query,
1425                     query_cgi => $query_cgi,
1426                     query_desc => $query_desc,
1427                     operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1428                     parsed_operand => $operand,
1429                     original_operand => $operands[$i] // '',
1430                     index => $index,
1431                     index_plus => $index_plus,
1432                     indexes_set => $indexes_set,
1433                     previous_operand => $previous_operand,
1434                 });
1435
1436             }    #/if $operands
1437         }    # /for
1438     }
1439     Koha::Logger->get->debug("QUERY BEFORE LIMITS: >$query<");
1440
1441     # add limits
1442     my %group_OR_limits;
1443     my $availability_limit;
1444     foreach my $this_limit (@limits) {
1445         next unless $this_limit;
1446         if ( $this_limit =~ /available/ ) {
1447 #
1448 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1449 ## In English:
1450 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1451             $availability_limit .=
1452 "( (allrecords,AlwaysMatches='') and (not-onloan-count,st-numeric >= 1) and (lost,st-numeric=0) )";
1453             $limit_cgi  .= "&limit=available";
1454             $limit_desc .= "";
1455         }
1456
1457         # group_OR_limits, prefixed by mc-
1458         # OR every member of the group
1459         elsif ( $this_limit =~ /mc/ ) {
1460             my ($k,$v) = split(/:/, $this_limit,2);
1461             if ( $k !~ /mc-i(tem)?type/ ) {
1462                 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1463                 $this_limit =~ tr/"//d;
1464                 $this_limit = $k.':"'.$v.'"';
1465             }
1466
1467             $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1468             $limit_desc      .= " or " if $group_OR_limits{$k};
1469             $group_OR_limits{$k} .= "$this_limit";
1470             $limit_cgi       .= "&limit=" . uri_escape_utf8($this_limit);
1471             $limit_desc      .= " $this_limit";
1472         }
1473
1474         # Regular old limits
1475         else {
1476             $limit .= " and " if $limit || $query;
1477             $limit      .= "$this_limit";
1478             $limit_cgi  .= "&limit=" . uri_escape_utf8($this_limit);
1479             if ($this_limit =~ /^branch:(.+)/) {
1480                 my $branchcode = $1;
1481                 my $library = Koha::Libraries->find( $branchcode );
1482                 if (defined $library) {
1483                     $limit_desc .= " branch:" . $library->branchname;
1484                 } else {
1485                     $limit_desc .= " $this_limit";
1486                 }
1487             } else {
1488                 $limit_desc .= " $this_limit";
1489             }
1490         }
1491     }
1492     foreach my $k (keys (%group_OR_limits)) {
1493         $limit .= " and " if ( $query || $limit );
1494         $limit .= "($group_OR_limits{$k})";
1495     }
1496     if ($availability_limit) {
1497         $limit .= " and " if ( $query || $limit );
1498         $limit .= "($availability_limit)";
1499     }
1500
1501     # Normalize the query and limit strings
1502     # This is flawed , means we can't search anything with : in it
1503     # if user wants to do ccl or cql, start the query with that
1504 #    $query =~ s/:/=/g;
1505     #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1506     $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1507     $query =~ s/(?<=(wrdl)):/=/g;
1508     $query =~ s/(?<=(trn|phr)):/=/g;
1509     $query =~ s/(?<=(st-numeric)):/=/g;
1510     $query =~ s/(?<=(st-year)):/=/g;
1511     $query =~ s/(?<=(st-date-normalized)):/=/g;
1512
1513     # Removing warnings for later substitutions
1514     $query        //= q{};
1515     $query_desc   //= q{};
1516     $query_cgi    //= q{};
1517     $limit        //= q{};
1518     $limit_desc   //= q{};
1519     $limit_cgi    //= q{};
1520     $simple_query //= q{};
1521     $limit =~ s/:/=/g;
1522     for ( $query, $query_desc, $limit, $limit_desc ) {
1523         s/  +/ /g;    # remove extra spaces
1524         s/^ //g;     # remove any beginning spaces
1525         s/ $//g;     # remove any ending spaces
1526         s/==/=/g;    # remove double == from query
1527     }
1528     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1529
1530     for ($query_cgi,$simple_query) {
1531         s/"//g;
1532     }
1533     # append the limit to the query
1534     $query .= " " . $limit;
1535
1536     Koha::Logger->get->debug(
1537         sprintf "buildQuery returns\nQUERY:%s\nQUERY CGI:%s\nQUERY DESC:%s\nLIMIT:%s\nLIMIT CGI:%s\nLIMIT DESC:%s",
1538         $query, $query_cgi, $query_desc, $limit, $limit_cgi, $limit_desc );
1539
1540     return (
1541         undef,              $query, $simple_query, $query_cgi,
1542         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1543         $query_type
1544     );
1545 }
1546
1547 =head2 _build_initial_query
1548
1549   ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1550
1551   Build a section of the initial query containing indexes, operators, and operands.
1552
1553 =cut
1554
1555 sub _build_initial_query {
1556     my ($params) = @_;
1557
1558     my $operator = "";
1559     if ($params->{previous_operand}){
1560         #If there is a previous operand, add a supplied operator or the default 'and'
1561         $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1562     }
1563
1564     #NOTE: indexes_set is typically set when doing truncation or field weighting
1565     my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1566
1567     #e.g. "kw,wrdl:test"
1568     #e.g. " and kw,wrdl:test"
1569     $params->{query} .= $operator . $operand;
1570
1571     $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1572     $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1573     $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1574
1575     #e.g. " and kw,wrdl: test"
1576     $params->{query_desc} .= $operator . ( $params->{index_plus} // q{} ) . " " . ( $params->{original_operand} // q{} );
1577
1578     $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1579
1580     return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1581 }
1582
1583 =head2 searchResults
1584
1585   my @search_results = searchResults($search_context, $searchdesc, $hits,
1586                                      $results_per_page, $offset, $scan,
1587                                      @marcresults);
1588
1589 Format results in a form suitable for passing to the template
1590
1591 =cut
1592
1593 # IMO this subroutine is pretty messy still -- it's responsible for
1594 # building the HTML output for the template
1595 sub searchResults {
1596     my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults, $xslt_variables ) = @_;
1597     my $dbh = C4::Context->dbh;
1598     my @newresults;
1599
1600     require C4::Items;
1601
1602     $search_context->{'interface'} = 'opac' if !$search_context->{'interface'} || $search_context->{'interface'} ne 'intranet';
1603     my ($is_opac, $hidelostitems);
1604     if ($search_context->{'interface'} eq 'opac') {
1605         $hidelostitems = C4::Context->preference('hidelostitems');
1606         $is_opac       = 1;
1607     }
1608
1609     my $record_processor = Koha::RecordProcessor->new({
1610         filters => 'ViewPolicy'
1611     });
1612
1613     #Build branchnames hash
1614     my %branches = map { $_->branchcode => $_->branchname } Koha::Libraries->search({}, { order_by => 'branchname' });
1615
1616 # FIXME - We build an authorised values hash here, using the default framework
1617 # though it is possible to have different authvals for different fws.
1618
1619     my $shelflocations =
1620       { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
1621
1622     # get notforloan authorised value list (see $shelflocations  FIXME)
1623     my $av = Koha::MarcSubfieldStructures->search({ frameworkcode => '', kohafield => 'items.notforloan', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
1624     my $notforloan_authorised_value = $av->count ? $av->next->authorised_value : undef;
1625
1626     #Get itemtype hash
1627     my $itemtypes = Koha::ItemTypes->search_with_localization;
1628     my %itemtypes = map { $_->{itemtype} => $_ } @{ $itemtypes->unblessed };
1629
1630     #search item field code
1631     my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber" );
1632
1633     ## find column names of items related to MARC
1634     my %subfieldstosearch;
1635     my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
1636     for my $column ( @columns ) {
1637         my ( $tagfield, $tagsubfield ) =
1638           &GetMarcFromKohaField( "items." . $column );
1639         if ( defined $tagsubfield ) {
1640             $subfieldstosearch{$column} = $tagsubfield;
1641         }
1642     }
1643
1644     # handle which records to actually retrieve
1645     my $times; # Times is which record to process up to
1646     if ( $hits && $offset + $results_per_page <= $hits ) {
1647         $times = $offset + $results_per_page;
1648     }
1649     else {
1650         $times = $hits; # If less hits than results_per_page+offset we go to the end
1651     }
1652
1653     my $marcflavour = C4::Context->preference("marcflavour");
1654     # We get the biblionumber position in MARC
1655     my ($bibliotag,$bibliosubf)=GetMarcFromKohaField( 'biblio.biblionumber' );
1656
1657     # set stuff for XSLT processing here once, not later again for every record we retrieved
1658     my $xslfile;
1659     my $xslsyspref;
1660     if( $is_opac ){
1661         $xslsyspref = "OPACXSLTResultsDisplay";
1662         $xslfile = C4::Context->preference( $xslsyspref );
1663     } else {
1664         $xslsyspref = "XSLTResultsDisplay";
1665         $xslfile = C4::Context->preference( $xslsyspref ) || "default";
1666     }
1667     my $lang   = $xslfile ? C4::Languages::getlanguage()  : undef;
1668     my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
1669
1670     my $userenv = C4::Context->userenv;
1671     my $logged_in_user
1672         = ( defined $userenv and $userenv->{number} )
1673         ? Koha::Patrons->find( $userenv->{number} )
1674         : undef;
1675     my $patron_category_hide_lost_items = ($logged_in_user) ? $logged_in_user->category->hidelostitems : 0;
1676
1677     # loop through all of the records we've retrieved
1678     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1679
1680         my $marcrecord;
1681         if ($scan) {
1682             # For Scan searches we built USMARC data
1683             $marcrecord = MARC::Record->new_from_usmarc( $marcresults->[$i]);
1684         } else {
1685             # Normal search, render from Zebra's output
1686             $marcrecord = new_record_from_zebra(
1687                 'biblioserver',
1688                 $marcresults->[$i]
1689             );
1690
1691             if ( ! defined $marcrecord ) {
1692                 warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1693                 next;
1694             }
1695         }
1696
1697         my $fw = $scan
1698              ? undef
1699              : $bibliotag < 10
1700                ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1701                : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1702
1703         SetUTF8Flag($marcrecord);
1704         my $oldbiblio = TransformMarcToKoha( $marcrecord, $fw, 'no_items' );
1705         $oldbiblio->{result_number} = $i + 1;
1706
1707                 $oldbiblio->{normalized_upc}  = GetNormalizedUPC(       $marcrecord,$marcflavour);
1708                 $oldbiblio->{normalized_ean}  = GetNormalizedEAN(       $marcrecord,$marcflavour);
1709                 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1710         $oldbiblio->{normalized_isbn} = GetNormalizedISBN($oldbiblio->{isbn},$marcrecord,$marcflavour); # Use existing ISBN from record if we got one
1711                 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1712
1713                 # edition information, if any
1714         $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1715
1716         my $itemtype = $oldbiblio->{itemtype} ? $itemtypes{$oldbiblio->{itemtype}} : undef;
1717         # add imageurl to itemtype if there is one
1718         $oldbiblio->{imageurl} = $itemtype ? getitemtypeimagelocation( $search_context->{'interface'}, $itemtype->{imageurl} ) : q{};
1719         # Build summary if there is one (the summary is defined in the itemtypes table)
1720         $oldbiblio->{description} = $itemtype ? $itemtype->{translated_description} : q{};
1721
1722         # FIXME: this is only used in the deprecated non-XLST opac results
1723         if ( !$xslfile && $is_opac && $itemtype && $itemtype->{summary} ) {
1724             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1725             my @fields  = $marcrecord->fields();
1726
1727             my $newsummary;
1728             foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1729                 my $tags = {};
1730                 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1731                     $tag =~ /(.{3})(.)/;
1732                     if($marcrecord->field($1)){
1733                         my @abc = $marcrecord->field($1)->subfield($2);
1734                         $tags->{$tag} = $#abc + 1 ;
1735                     }
1736                 }
1737
1738                 # We catch how many times to repeat this line
1739                 my $max = 0;
1740                 foreach my $tag (keys(%$tags)){
1741                     $max = $tags->{$tag} if($tags->{$tag} > $max);
1742                  }
1743
1744                 # we replace, and repeat each line
1745                 for (my $i = 0 ; $i < $max ; $i++){
1746                     my $newline = $line;
1747
1748                     foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1749                         $tag =~ /(.{3})(.)/;
1750
1751                         if($marcrecord->field($1)){
1752                             my @repl = $marcrecord->field($1)->subfield($2);
1753                             my $subfieldvalue = $repl[$i];
1754                             $newline =~ s/\[$tag\]/$subfieldvalue/g;
1755                         }
1756                     }
1757                     $newsummary .= "$newline\n";
1758                 }
1759             }
1760
1761             $newsummary =~ s/\[(.*?)]//g;
1762             $newsummary =~ s/\n/<br\/>/g;
1763             $oldbiblio->{summary} = $newsummary;
1764         }
1765
1766         # Pull out the items fields
1767         my @fields = $marcrecord->field($itemtag);
1768         my $marcflavor = C4::Context->preference("marcflavour");
1769
1770         # adding linked items that belong to host records
1771         if ( C4::Context->preference('EasyAnalyticalRecords') ) {
1772             my $analyticsfield = '773';
1773             if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1774                 $analyticsfield = '773';
1775             } elsif ($marcflavor eq 'UNIMARC') {
1776                 $analyticsfield = '461';
1777             }
1778             foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1779                 my $hostbiblionumber = $hostfield->subfield("0");
1780                 my $linkeditemnumber = $hostfield->subfield("9");
1781                 if( $hostbiblionumber ) {
1782                     my $linkeditemmarc = C4::Items::GetMarcItem( $hostbiblionumber, $linkeditemnumber );
1783                     if ($linkeditemmarc) {
1784                         my $linkeditemfield = $linkeditemmarc->field($itemtag);
1785                         if ($linkeditemfield) {
1786                             push( @fields, $linkeditemfield );
1787                         }
1788                     }
1789                 }
1790             }
1791         }
1792
1793         # Setting item statuses for display
1794         my @available_items_loop;
1795         my @onloan_items_loop;
1796         my @other_items_loop;
1797
1798         my $available_items;
1799         my $onloan_items;
1800         my $other_items;
1801
1802         my $ordered_count         = 0;
1803         my $available_count       = 0;
1804         my $onloan_count          = 0;
1805         my $longoverdue_count     = 0;
1806         my $other_count           = 0;
1807         my $withdrawn_count        = 0;
1808         my $itemlost_count        = 0;
1809         my $hideatopac_count      = 0;
1810         my $itembinding_count     = 0;
1811         my $itemdamaged_count     = 0;
1812         my $item_in_transit_count = 0;
1813         my $can_place_holds       = 0;
1814         my $item_onhold_count     = 0;
1815         my $notforloan_count      = 0;
1816         my $items_count           = scalar(@fields);
1817         my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
1818         my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
1819         my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
1820
1821         # loop through every item
1822         foreach my $field (@fields) {
1823             my $item;
1824
1825             # populate the items hash
1826             foreach my $code ( keys %subfieldstosearch ) {
1827                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1828             }
1829             $item->{description} = $itemtypes{ $item->{itype} }{translated_description} if $item->{itype};
1830
1831                 # OPAC hidden items
1832             if ($is_opac) {
1833                 # hidden because lost
1834                 if ($hidelostitems && $item->{itemlost}) {
1835                     $hideatopac_count++;
1836                     next;
1837                 }
1838                 # hidden based on OpacHiddenItems syspref
1839                 my @hi = C4::Items::GetHiddenItemnumbers({ items=> [ $item ], borcat => $search_context->{category} });
1840                 if (scalar @hi) {
1841                     push @hiddenitems, @hi;
1842                     $hideatopac_count++;
1843                     next;
1844                 }
1845             }
1846
1847             my $hbranch     = C4::Context->preference('StaffSearchResultsDisplayBranch');
1848             my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1849
1850             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1851             if ($item->{$hbranch}) {
1852                 $item->{'branchname'} = $branches{$item->{$hbranch}};
1853             }
1854             elsif ($item->{$otherbranch}) {     # Last resort
1855                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1856             }
1857
1858             my $prefix =
1859                 ( $item->{$hbranch} ? $item->{$hbranch} . '--' : q{} )
1860               . ( $item->{location} ? $item->{location} : q{} )
1861               . ( $item->{itype}    ? $item->{itype}    : q{} )
1862               . ( $item->{itemcallnumber} ? $item->{itemcallnumber} : q{} );
1863 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1864             if ( $item->{onloan}
1865                 and $logged_in_user
1866                 and !( $patron_category_hide_lost_items and $item->{itemlost} ) )
1867             {
1868                 $onloan_count++;
1869                 my $key = $prefix . $item->{onloan} . $item->{barcode};
1870                 $onloan_items->{$key}->{due_date} = $item->{onloan};
1871                 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1872                 $onloan_items->{$key}->{branchname}     = $item->{branchname};
1873                 $onloan_items->{$key}->{location}       = $shelflocations->{ $item->{location} } if $item->{location};
1874                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1875                 $onloan_items->{$key}->{description}    = $item->{description};
1876                 $onloan_items->{$key}->{imageurl} =
1877                   getitemtypeimagelocation( $search_context->{'interface'}, $itemtypes{ $item->{itype} }->{imageurl} );
1878
1879                 # if something's checked out and lost, mark it as 'long overdue'
1880                 if ( $item->{itemlost} ) {
1881                     $onloan_items->{$key}->{longoverdue}++;
1882                     $longoverdue_count++;
1883                 }
1884                 else {    # can place holds as long as item isn't lost
1885                     $can_place_holds = 1;
1886                 }
1887             }
1888
1889          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1890             else {
1891
1892                 my $itemtype = C4::Context->preference("item-level_itypes")? $item->{itype}: $oldbiblio->{itemtype};
1893                 $item->{notforloan} = 1 if !$item->{notforloan} &&
1894                     $itemtype && $itemtypes{ $itemtype }->{notforloan};
1895
1896                 # item is on order
1897                 if ( $item->{notforloan} < 0 ) {
1898                     $ordered_count++;
1899                 } elsif ( $item->{notforloan} > 0 ) {
1900                     $notforloan_count++;
1901                 }
1902
1903                 # is item in transit?
1904                 my $transfertwhen = '';
1905                 my ($transfertfrom, $transfertto);
1906
1907                 # is item on the reserve shelf?
1908                 my $reservestatus = '';
1909
1910                 unless ($item->{withdrawn}
1911                         || $item->{itemlost}
1912                         || $item->{damaged}
1913                         || $item->{notforloan}
1914                         || ( C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck')
1915                         && $items_count > C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') ) ) {
1916
1917                     # A couple heuristics to limit how many times
1918                     # we query the database for item transfer information, sacrificing
1919                     # accuracy in some cases for speed;
1920                     #
1921                     # 1. don't query if item has one of the other statuses
1922                     # 2. don't check transit status if the bib has
1923                     #    more than 20 items
1924                     #
1925                     # FIXME: to avoid having the query the database like this, and to make
1926                     #        the in transit status count as unavailable for search limiting,
1927                     #        should map transit status to record indexed in Zebra.
1928                     #
1929                     ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1930                     $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
1931                 }
1932
1933                 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
1934                 if (   $item->{withdrawn}
1935                     || $item->{itemlost}
1936                     || $item->{damaged}
1937                     || $item->{notforloan}
1938                     || $reservestatus eq 'Waiting'
1939                     || ($transfertwhen && $transfertwhen ne ''))
1940                 {
1941                     $withdrawn_count++        if $item->{withdrawn};
1942                     $itemlost_count++        if $item->{itemlost};
1943                     $itemdamaged_count++     if $item->{damaged};
1944                     $item_in_transit_count++ if $transfertwhen && $transfertwhen ne '';
1945                     $item_onhold_count++     if $reservestatus eq 'Waiting';
1946                     $item->{status} = ($item->{withdrawn}//q{}) . "-" . ($item->{itemlost}//q{}) . "-" . ($item->{damaged}//q{}) . "-" . ($item->{notforloan}//q{});
1947
1948                     # can place a hold on a item if
1949                     # not lost nor withdrawn
1950                     # not damaged unless AllowHoldsOnDamagedItems is true
1951                     # item is either for loan or on order (notforloan < 0)
1952                     $can_place_holds = 1
1953                       if (
1954                            !$item->{itemlost}
1955                         && !$item->{withdrawn}
1956                         && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
1957                         && ( !$item->{notforloan} || $item->{notforloan} < 0 )
1958                       );
1959
1960                     $other_count++;
1961
1962                     my $key = $prefix . $item->{status};
1963                     foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
1964                         $other_items->{$key}->{$_} = $item->{$_};
1965                     }
1966                     $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
1967                     $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
1968                     $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
1969                     $other_items->{$key}->{count}++ if $item->{$hbranch};
1970                     $other_items->{$key}->{location} = $shelflocations->{ $item->{location} } if $item->{location};
1971                     $other_items->{$key}->{description} = $item->{description};
1972                     $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context->{'interface'}, $itemtypes{ $item->{itype}//q{} }->{imageurl} );
1973                 }
1974                 # item is available
1975                 else {
1976                     $can_place_holds = 1;
1977                     $available_count++;
1978                     $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1979                     foreach (qw(branchname itemcallnumber description)) {
1980                         $available_items->{$prefix}->{$_} = $item->{$_};
1981                     }
1982                     $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} } if $item->{location};
1983                     $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context->{'interface'}, $itemtypes{ $item->{itype}//q{} }->{imageurl} );
1984                 }
1985             }
1986         }    # notforloan, item level and biblioitem level
1987
1988         # if all items are hidden, do not show the record
1989         if ( C4::Context->preference('OpacHiddenItemsHidesRecord') && $items_count > 0 && $hideatopac_count == $items_count) {
1990             next;
1991         }
1992
1993         my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1994         for my $key ( sort keys %$onloan_items ) {
1995             (++$onloanitemscount > $maxitems) and last;
1996             push @onloan_items_loop, $onloan_items->{$key};
1997         }
1998         for my $key ( sort keys %$other_items ) {
1999             (++$otheritemscount > $maxitems) and last;
2000             push @other_items_loop, $other_items->{$key};
2001         }
2002         for my $key ( sort keys %$available_items ) {
2003             (++$availableitemscount > $maxitems) and last;
2004             push @available_items_loop, $available_items->{$key}
2005         }
2006
2007         # XSLT processing of some stuff
2008         # we fetched the sysprefs already before the loop through all retrieved record!
2009         if (!$scan && $xslfile) {
2010             $record_processor->options({
2011                 frameworkcode => $fw,
2012                 interface     => $search_context->{'interface'}
2013             });
2014
2015             $record_processor->process($marcrecord);
2016             $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $xslsyspref, 1, \@hiddenitems, $sysxml, $xslfile, $lang, $xslt_variables);
2017         }
2018
2019         # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2020         if (!C4::Context->preference("item-level_itypes")) {
2021             if ($itemtype && $itemtype->{notforloan}) {
2022                 $can_place_holds = 0;
2023             }
2024         }
2025         $oldbiblio->{norequests} = 1 unless $can_place_holds;
2026         $oldbiblio->{items_count}          = $items_count;
2027         $oldbiblio->{available_items_loop} = \@available_items_loop;
2028         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
2029         $oldbiblio->{other_items_loop}     = \@other_items_loop;
2030         $oldbiblio->{availablecount}       = $available_count;
2031         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
2032         $oldbiblio->{onloancount}          = $onloan_count;
2033         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
2034         $oldbiblio->{othercount}           = $other_count;
2035         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
2036         $oldbiblio->{withdrawncount}        = $withdrawn_count;
2037         $oldbiblio->{itemlostcount}        = $itemlost_count;
2038         $oldbiblio->{damagedcount}         = $itemdamaged_count;
2039         $oldbiblio->{intransitcount}       = $item_in_transit_count;
2040         $oldbiblio->{onholdcount}          = $item_onhold_count;
2041         $oldbiblio->{orderedcount}         = $ordered_count;
2042         $oldbiblio->{notforloancount}      = $notforloan_count;
2043
2044         if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2045             my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2046             my $subfields = substr $fieldspec, 3;
2047             my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2048             my @alternateholdingsinfo = ();
2049             my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2050             my $alternateholdingscount = 0;
2051
2052             for my $field (@holdingsfields) {
2053                 my %holding = ( holding => '' );
2054                 my $havesubfield = 0;
2055                 for my $subfield ($field->subfields()) {
2056                     if ((index $subfields, $$subfield[0]) >= 0) {
2057                         $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2058                         $holding{'holding'} .= $$subfield[1];
2059                         $havesubfield++;
2060                     }
2061                 }
2062                 if ($havesubfield) {
2063                     push(@alternateholdingsinfo, \%holding);
2064                     $alternateholdingscount++;
2065                 }
2066             }
2067
2068             $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2069             $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2070         }
2071
2072         $oldbiblio->{biblio_object} = Koha::Biblios->find( $oldbiblio->{biblionumber} );
2073
2074         push( @newresults, $oldbiblio );
2075     }
2076
2077     return @newresults;
2078 }
2079
2080 =head2 enabled_staff_search_views
2081
2082 %hash = enabled_staff_search_views()
2083
2084 This function returns a hash that contains three flags obtained from the system
2085 preferences, used to determine whether a particular staff search results view
2086 is enabled.
2087
2088 =over 2
2089
2090 =item C<Output arg:>
2091
2092     * $hash{can_view_MARC} is true only if the MARC view is enabled
2093     * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2094     * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2095
2096 =item C<usage in the script:>
2097
2098 =back
2099
2100 $template->param ( C4::Search::enabled_staff_search_views );
2101
2102 =cut
2103
2104 sub enabled_staff_search_views
2105 {
2106         return (
2107                 can_view_MARC                   => C4::Context->preference('viewMARC'),                 # 1 if the staff search allows the MARC view
2108                 can_view_ISBD                   => C4::Context->preference('viewISBD'),                 # 1 if the staff search allows the ISBD view
2109                 can_view_labeledMARC    => C4::Context->preference('viewLabeledMARC'),  # 1 if the staff search allows the Labeled MARC view
2110         );
2111 }
2112
2113 =head2 z3950_search_args
2114
2115 $arrayref = z3950_search_args($matchpoints)
2116
2117 This function returns an array reference that contains the search parameters to be
2118 passed to the Z39.50 search script (z3950_search.pl). The array elements
2119 are hash refs whose keys are name and value, and whose values are the
2120 name of a search parameter, the value of that search parameter and the URL encoded
2121 value of that parameter.
2122
2123 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2124
2125 The search parameter values are obtained from the bibliographic record whose
2126 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2127
2128 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2129 a general purpose search argument. In this case, the returned array contains only
2130 entry: the key is 'title' and the value is derived from $matchpoints.
2131
2132 If a search parameter value is undefined or empty, it is not included in the returned
2133 array.
2134
2135 The returned array reference may be passed directly to the template parameters.
2136
2137 =over 2
2138
2139 =item C<Output arg:>
2140
2141     * $array containing hash refs as described above
2142
2143 =item C<usage in the script:>
2144
2145 =back
2146
2147 $data = Biblio::GetBiblioData($bibno);
2148 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2149
2150 *OR*
2151
2152 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2153
2154 =cut
2155
2156 sub z3950_search_args {
2157     my $bibrec = shift;
2158
2159     my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2160     my $isbn = Business::ISBN->new( $isbn_string );
2161
2162     if (defined $isbn && $isbn->is_valid)
2163     {
2164         if ( ref($bibrec) ) {
2165             $bibrec->{isbn} = $isbn_string;
2166             $bibrec->{title} = undef;
2167         } else {
2168             $bibrec = { isbn => $isbn_string };
2169         }
2170     }
2171     else {
2172         $bibrec = { title => $bibrec } if !ref $bibrec;
2173     }
2174     my $array = [];
2175     for my $field (qw/ lccn isbn issn title author dewey subject /)
2176     {
2177         push @$array, { name => $field, value => $bibrec->{$field} }
2178           if defined $bibrec->{$field};
2179     }
2180     return $array;
2181 }
2182
2183 =head2 GetDistinctValues($field);
2184
2185 C<$field> is a reference to the fields array
2186
2187 =cut
2188
2189 sub GetDistinctValues {
2190     my ($fieldname,$string)=@_;
2191     # returns a reference to a hash of references to branches...
2192     if ($fieldname=~/\./){
2193                         my ($table,$column)=split /\./, $fieldname;
2194                         my $dbh = C4::Context->dbh;
2195                         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 ");
2196                         $sth->execute;
2197                         my $elements=$sth->fetchall_arrayref({});
2198                         return $elements;
2199    }
2200    else {
2201                 $string||= qq("");
2202                 my @servers=qw<biblioserver authorityserver>;
2203                 my (@zconns,@results);
2204         for ( my $i = 0 ; $i < @servers ; $i++ ) {
2205                 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2206                         $results[$i] =
2207                       $zconns[$i]->scan(
2208                         ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2209                       );
2210                 }
2211                 # The big moment: asynchronously retrieve results from all servers
2212                 my @elements;
2213         _ZOOM_event_loop(
2214             \@zconns,
2215             \@results,
2216             sub {
2217                 my ( $i, $size ) = @_;
2218                 for ( my $j = 0 ; $j < $size ; $j++ ) {
2219                     my %hashscan;
2220                     @hashscan{qw(value cnt)} =
2221                       $results[ $i - 1 ]->display_term($j);
2222                     push @elements, \%hashscan;
2223                 }
2224             }
2225         );
2226                 return \@elements;
2227    }
2228 }
2229
2230 =head2 _ZOOM_event_loop
2231
2232     _ZOOM_event_loop(\@zconns, \@results, sub {
2233         my ( $i, $size ) = @_;
2234         ....
2235     } );
2236
2237 Processes a ZOOM event loop and passes control to a closure for
2238 processing the results, and destroying the resultsets.
2239
2240 =cut
2241
2242 sub _ZOOM_event_loop {
2243     my ($zconns, $results, $callback) = @_;
2244     while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2245         my $ev = $zconns->[ $i - 1 ]->last_event();
2246         if ( $ev == ZOOM::Event::ZEND ) {
2247             next unless $results->[ $i - 1 ];
2248             my $size = $results->[ $i - 1 ]->size();
2249             if ( $size > 0 ) {
2250                 $callback->($i, $size);
2251             }
2252         }
2253     }
2254
2255     foreach my $result (@$results) {
2256         $result->destroy();
2257     }
2258 }
2259
2260 =head2 new_record_from_zebra
2261
2262 Given raw data from a searchengine result set, return a MARC::Record object
2263
2264 This helper function is needed to take into account all the involved
2265 system preferences and configuration variables to properly create the
2266 MARC::Record object.
2267
2268 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2269 data. If we are using DOM, then it has to be MARCXML.
2270
2271 If we are using elasticsearch, it'll already be a MARC::Record and this
2272 function needs a new name.
2273
2274 =cut
2275
2276 sub new_record_from_zebra {
2277
2278     my $server   = shift;
2279     my $raw_data = shift;
2280     # Set the default indexing modes
2281     my $search_engine = C4::Context->preference("SearchEngine");
2282     if ($search_engine eq 'Elasticsearch') {
2283         return ref $raw_data eq 'MARC::Record' ? $raw_data : MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2284     }
2285     my $index_mode = ( $server eq 'biblioserver' )
2286                         ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2287                         : C4::Context->config('zebra_auth_index_mode') // 'dom';
2288
2289     my $marc_record =  eval {
2290         if ( $index_mode eq 'dom' ) {
2291             MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2292         } else {
2293             MARC::Record->new_from_usmarc( $raw_data );
2294         }
2295     };
2296
2297     if ($@) {
2298         return;
2299     } else {
2300         return $marc_record;
2301     }
2302
2303 }
2304
2305 END { }    # module clean-up code here (global destructor)
2306
2307 1;
2308 __END__
2309
2310 =head1 AUTHOR
2311
2312 Koha Development Team <http://koha-community.org/>
2313
2314 =cut