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