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