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