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