C4/Search.pm

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