C4/Search.pm

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