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