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