C4/Search.pm

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