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