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 ( $indexes[$ii] =~ m/su-/ ) {
1192                 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1193             }
1194             else {
1195                 $query .=
1196                   ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1197             }
1198         }
1199         foreach my $limit (@limits) {
1200         }
1201         if ( scalar(@sort_by) > 0 ) {
1202             my $modifier_re =
1203               '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1204             $query =~ s/$modifier_re//g;
1205             foreach my $modifier (@sort_by) {
1206                 $query .= " #$modifier";
1207             }
1208         }
1209
1210         $query_desc = $query;
1211         $query_desc =~ s/\s+/ /g;
1212         if ( C4::Context->preference("QueryWeightFields") ) {
1213         }
1214         $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1215               { 'target_syntax_callback' => \&_handle_exploding_index } );
1216         $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1217               { 'target_syntax_callback' => \&_handle_exploding_index } );
1218         $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1219               { 'target_syntax_callback' => \&_handle_exploding_index } );
1220         $QParser->parse($query);
1221         $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1222     }
1223     else {
1224         require Koha::QueryParser::Driver::PQF;
1225         my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1226         s/$modifier_re//g for @operands;
1227     }
1228
1229     return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1230 }
1231
1232 =head2 buildQuery
1233
1234 ( $error, $query,
1235 $simple_query, $query_cgi,
1236 $query_desc, $limit,
1237 $limit_cgi, $limit_desc,
1238 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1239
1240 Build queries and limits in CCL, CGI, Human,
1241 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
1242
1243 See verbose embedded documentation.
1244
1245
1246 =cut
1247
1248 sub buildQuery {
1249     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1250
1251     warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1252
1253     my $query_desc;
1254     ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1255
1256     # dereference
1257     my @operators = $operators ? @$operators : ();
1258     my @indexes   = $indexes   ? @$indexes   : ();
1259     my @operands  = $operands  ? @$operands  : ();
1260     my @limits    = $limits    ? @$limits    : ();
1261     my @sort_by   = $sort_by   ? @$sort_by   : ();
1262
1263     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
1264     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
1265     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
1266     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
1267     my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
1268
1269     my $query        = $operands[0];
1270     my $simple_query = $operands[0];
1271
1272     # initialize the variables we're passing back
1273     my $query_cgi;
1274     my $query_type;
1275
1276     my $limit;
1277     my $limit_cgi;
1278     my $limit_desc;
1279
1280     my $stopwords_removed;    # flag to determine if stopwords have been removed
1281
1282     my $cclq       = 0;
1283     my $cclindexes = getIndexes();
1284     if ( $query !~ /\s*ccl=/ ) {
1285         while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1286             my $dx = lc($1);
1287             $cclq = grep { lc($_) eq $dx } @$cclindexes;
1288         }
1289         $query = "ccl=$query" if $cclq;
1290     }
1291
1292 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1293 # DIAGNOSTIC ONLY!!
1294     if ( $query =~ /^ccl=/ ) {
1295         my $q=$';
1296         # This is needed otherwise ccl= and &limit won't work together, and
1297         # this happens when selecting a subject on the opac-detail page
1298         @limits = grep {!/^$/} @limits;
1299         if ( @limits ) {
1300             $q .= ' and '.join(' and ', @limits);
1301         }
1302         return ( undef, $q, $q, "q=ccl=".uri_escape($q), $q, '', '', '', '', 'ccl' );
1303     }
1304     if ( $query =~ /^cql=/ ) {
1305         return ( undef, $', $', "q=cql=".uri_escape($'), $', '', '', '', '', 'cql' );
1306     }
1307     if ( $query =~ /^pqf=/ ) {
1308         if ($query_desc) {
1309             $query_cgi = "q=".uri_escape($query_desc);
1310         } else {
1311             $query_desc = $';
1312             $query_cgi = "q=pqf=".uri_escape($');
1313         }
1314         return ( undef, $', $', $query_cgi, $query_desc, '', '', '', '', 'pqf' );
1315     }
1316
1317     # pass nested queries directly
1318     # FIXME: need better handling of some of these variables in this case
1319     # Nested queries aren't handled well and this implementation is flawed and causes users to be
1320     # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1321 #    if ( $query =~ /(\(|\))/ ) {
1322 #        return (
1323 #            undef,              $query, $simple_query, $query_cgi,
1324 #            $query,             $limit, $limit_cgi,    $limit_desc,
1325 #            $stopwords_removed, 'ccl'
1326 #        );
1327 #    }
1328
1329 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1330 # query operands and indexes and add stemming, truncation, field weighting, etc.
1331 # Once we do so, we'll end up with a value in $query, just like if we had an
1332 # incoming $query from the user
1333     else {
1334         $query = ""
1335           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1336         my $previous_operand
1337           ;    # a flag used to keep track if there was a previous query
1338                # if there was, we can apply the current operator
1339                # for every operand
1340         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1341
1342             # COMBINE OPERANDS, INDEXES AND OPERATORS
1343             if ( $operands[$i] ) {
1344                 $operands[$i]=~s/^\s+//;
1345
1346               # A flag to determine whether or not to add the index to the query
1347                 my $indexes_set;
1348
1349 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
1350                 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1351                     $weight_fields    = 0;
1352                     $stemming         = 0;
1353                     $remove_stopwords = 0;
1354                 } else {
1355                     $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1356                 }
1357                 my $operand = $operands[$i];
1358                 my $index   = $indexes[$i];
1359
1360                 # Add index-specific attributes
1361                 # Date of Publication
1362                 if ( $index eq 'yr' ) {
1363                     $index .= ",st-numeric";
1364                     $indexes_set++;
1365                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1366                 }
1367
1368                 # Date of Acquisition
1369                 elsif ( $index eq 'acqdate' ) {
1370                     $index .= ",st-date-normalized";
1371                     $indexes_set++;
1372                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1373                 }
1374                 # ISBN,ISSN,Standard Number, don't need special treatment
1375                 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1376                     (
1377                         $stemming,      $auto_truncation,
1378                         $weight_fields, $fuzzy_enabled,
1379                         $remove_stopwords
1380                     ) = ( 0, 0, 0, 0, 0 );
1381
1382                 }
1383
1384                 if(not $index){
1385                     $index = 'kw';
1386                 }
1387
1388                 # Set default structure attribute (word list)
1389                 my $struct_attr = q{};
1390                 unless ( $indexes_set || !$index || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1391                     $struct_attr = ",wrdl";
1392                 }
1393
1394                 # Some helpful index variants
1395                 my $index_plus       = $index . $struct_attr . ':';
1396                 my $index_plus_comma = $index . $struct_attr . ',';
1397
1398                 # Remove Stopwords
1399                 if ($remove_stopwords) {
1400                     ( $operand, $stopwords_removed ) =
1401                       _remove_stopwords( $operand, $index );
1402                     warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
1403                     warn "REMOVED STOPWORDS: @$stopwords_removed"
1404                       if ( $stopwords_removed && $DEBUG );
1405                 }
1406
1407                 if ($auto_truncation){
1408                         unless ( $index =~ /,(st-|phr|ext)/ ) {
1409                                                 #FIXME only valid with LTR scripts
1410                                                 $operand=join(" ",map{
1411                                                                                         (index($_,"*")>0?"$_":"$_*")
1412                                                                                          }split (/\s+/,$operand));
1413                                                 warn $operand if $DEBUG;
1414                                         }
1415                                 }
1416
1417                 # Detect Truncation
1418                 my $truncated_operand;
1419                 my( $nontruncated, $righttruncated, $lefttruncated,
1420                     $rightlefttruncated, $regexpr
1421                 ) = _detect_truncation( $operand, $index );
1422                 warn
1423 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1424                   if $DEBUG;
1425
1426                 # Apply Truncation
1427                 if (
1428                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
1429                     scalar(@$rightlefttruncated) > 0 )
1430                 {
1431
1432                # Don't field weight or add the index to the query, we do it here
1433                     $indexes_set = 1;
1434                     undef $weight_fields;
1435                     my $previous_truncation_operand;
1436                     if (scalar @$nontruncated) {
1437                         $truncated_operand .= "$index_plus @$nontruncated ";
1438                         $previous_truncation_operand = 1;
1439                     }
1440                     if (scalar @$righttruncated) {
1441                         $truncated_operand .= "and " if $previous_truncation_operand;
1442                         $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1443                         $previous_truncation_operand = 1;
1444                     }
1445                     if (scalar @$lefttruncated) {
1446                         $truncated_operand .= "and " if $previous_truncation_operand;
1447                         $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1448                         $previous_truncation_operand = 1;
1449                     }
1450                     if (scalar @$rightlefttruncated) {
1451                         $truncated_operand .= "and " if $previous_truncation_operand;
1452                         $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1453                         $previous_truncation_operand = 1;
1454                     }
1455                 }
1456                 $operand = $truncated_operand if $truncated_operand;
1457                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1458
1459                 # Handle Stemming
1460                 my $stemmed_operand;
1461                 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1462                                                                                 if $stemming;
1463
1464                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1465
1466                 # Handle Field Weighting
1467                 my $weighted_operand;
1468                 if ($weight_fields) {
1469                     $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1470                     $operand = $weighted_operand;
1471                     $indexes_set = 1;
1472                 }
1473
1474                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1475
1476                 # If there's a previous operand, we need to add an operator
1477                 if ($previous_operand) {
1478
1479                     # User-specified operator
1480                     if ( $operators[ $i - 1 ] ) {
1481                         $query     .= " $operators[$i-1] ";
1482                         $query     .= " $index_plus " unless $indexes_set;
1483                         $query     .= " $operand";
1484                         $query_cgi .= "&op=".uri_escape($operators[$i-1]);
1485                         $query_cgi .= "&idx=".uri_escape($index) if $index;
1486                         $query_cgi .= "&q=".uri_escape($operands[$i]) if $operands[$i];
1487                         $query_desc .=
1488                           " $operators[$i-1] $index_plus $operands[$i]";
1489                     }
1490
1491                     # Default operator is and
1492                     else {
1493                         $query      .= " and ";
1494                         $query      .= "$index_plus " unless $indexes_set;
1495                         $query      .= "$operand";
1496                         $query_cgi  .= "&op=and&idx=".uri_escape($index) if $index;
1497                         $query_cgi  .= "&q=".uri_escape($operands[$i]) if $operands[$i];
1498                         $query_desc .= " and $index_plus $operands[$i]";
1499                     }
1500                 }
1501
1502                 # There isn't a pervious operand, don't need an operator
1503                 else {
1504
1505                     # Field-weighted queries already have indexes set
1506                     $query .= " $index_plus " unless $indexes_set;
1507                     $query .= $operand;
1508                     $query_desc .= " $index_plus $operands[$i]";
1509                     $query_cgi  .= "&idx=".uri_escape($index) if $index;
1510                     $query_cgi  .= "&q=".uri_escape($operands[$i]) if $operands[$i];
1511                     $previous_operand = 1;
1512                 }
1513             }    #/if $operands
1514         }    # /for
1515     }
1516     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1517
1518     # add limits
1519     my %group_OR_limits;
1520     my $availability_limit;
1521     foreach my $this_limit (@limits) {
1522         next unless $this_limit;
1523         if ( $this_limit =~ /available/ ) {
1524 #
1525 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1526 ## In English:
1527 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1528             $availability_limit .=
1529 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1530             $limit_cgi  .= "&limit=available";
1531             $limit_desc .= "";
1532         }
1533
1534         # group_OR_limits, prefixed by mc-
1535         # OR every member of the group
1536         elsif ( $this_limit =~ /mc/ ) {
1537             my ($k,$v) = split(/:/, $this_limit,2);
1538             if ( $k !~ /mc-i(tem)?type/ ) {
1539                 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1540                 $this_limit =~ tr/"//d;
1541                 $this_limit = $k.":\"".$v."\"";
1542             }
1543
1544             $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1545             $limit_desc      .= " or " if $group_OR_limits{$k};
1546             $group_OR_limits{$k} .= "$this_limit";
1547             $limit_cgi       .= "&limit=$this_limit";
1548             $limit_desc      .= " $this_limit";
1549         }
1550
1551         # Regular old limits
1552         else {
1553             $limit .= " and " if $limit || $query;
1554             $limit      .= "$this_limit";
1555             $limit_cgi  .= "&limit=$this_limit";
1556             if ($this_limit =~ /^branch:(.+)/) {
1557                 my $branchcode = $1;
1558                 my $branchname = GetBranchName($branchcode);
1559                 if (defined $branchname) {
1560                     $limit_desc .= " branch:$branchname";
1561                 } else {
1562                     $limit_desc .= " $this_limit";
1563                 }
1564             } else {
1565                 $limit_desc .= " $this_limit";
1566             }
1567         }
1568     }
1569     foreach my $k (keys (%group_OR_limits)) {
1570         $limit .= " and " if ( $query || $limit );
1571         $limit .= "($group_OR_limits{$k})";
1572     }
1573     if ($availability_limit) {
1574         $limit .= " and " if ( $query || $limit );
1575         $limit .= "($availability_limit)";
1576     }
1577
1578     # Normalize the query and limit strings
1579     # This is flawed , means we can't search anything with : in it
1580     # if user wants to do ccl or cql, start the query with that
1581 #    $query =~ s/:/=/g;
1582     $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1583     $query =~ s/(?<=(wrdl)):/=/g;
1584     $query =~ s/(?<=(trn|phr)):/=/g;
1585     $limit =~ s/:/=/g;
1586     for ( $query, $query_desc, $limit, $limit_desc ) {
1587         s/  +/ /g;    # remove extra spaces
1588         s/^ //g;     # remove any beginning spaces
1589         s/ $//g;     # remove any ending spaces
1590         s/==/=/g;    # remove double == from query
1591     }
1592     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1593
1594     for ($query_cgi,$simple_query) {
1595         s/"//g;
1596     }
1597     # append the limit to the query
1598     $query .= " " . $limit;
1599
1600     # Warnings if DEBUG
1601     if ($DEBUG) {
1602         warn "QUERY:" . $query;
1603         warn "QUERY CGI:" . $query_cgi;
1604         warn "QUERY DESC:" . $query_desc;
1605         warn "LIMIT:" . $limit;
1606         warn "LIMIT CGI:" . $limit_cgi;
1607         warn "LIMIT DESC:" . $limit_desc;
1608         warn "---------\nLeave buildQuery\n---------";
1609     }
1610     return (
1611         undef,              $query, $simple_query, $query_cgi,
1612         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1613         $stopwords_removed, $query_type
1614     );
1615 }
1616
1617 =head2 searchResults
1618
1619   my @search_results = searchResults($search_context, $searchdesc, $hits,
1620                                      $results_per_page, $offset, $scan,
1621                                      @marcresults);
1622
1623 Format results in a form suitable for passing to the template
1624
1625 =cut
1626
1627 # IMO this subroutine is pretty messy still -- it's responsible for
1628 # building the HTML output for the template
1629 sub searchResults {
1630     my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1631     my $dbh = C4::Context->dbh;
1632     my @newresults;
1633
1634     require C4::Items;
1635
1636     $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1637     my ($is_opac, $hidelostitems);
1638     if ($search_context eq 'opac') {
1639         $hidelostitems = C4::Context->preference('hidelostitems');
1640         $is_opac       = 1;
1641     }
1642
1643     #Build branchnames hash
1644     #find branchname
1645     #get branch information.....
1646     my %branches;
1647     my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1648     $bsth->execute();
1649     while ( my $bdata = $bsth->fetchrow_hashref ) {
1650         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1651     }
1652 # FIXME - We build an authorised values hash here, using the default framework
1653 # though it is possible to have different authvals for different fws.
1654
1655     my $shelflocations =GetKohaAuthorisedValues('items.location','');
1656
1657     # get notforloan authorised value list (see $shelflocations  FIXME)
1658     my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1659
1660     #Build itemtype hash
1661     #find itemtype & itemtype image
1662     my %itemtypes;
1663     $bsth =
1664       $dbh->prepare(
1665         "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1666       );
1667     $bsth->execute();
1668     while ( my $bdata = $bsth->fetchrow_hashref ) {
1669                 foreach (qw(description imageurl summary notforloan)) {
1670                 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1671                 }
1672     }
1673
1674     #search item field code
1675     my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1676
1677     ## find column names of items related to MARC
1678     my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1679     $sth2->execute;
1680     my %subfieldstosearch;
1681     while ( ( my $column ) = $sth2->fetchrow ) {
1682         my ( $tagfield, $tagsubfield ) =
1683           &GetMarcFromKohaField( "items." . $column, "" );
1684         $subfieldstosearch{$column} = $tagsubfield;
1685     }
1686
1687     # handle which records to actually retrieve
1688     my $times;
1689     if ( $hits && $offset + $results_per_page <= $hits ) {
1690         $times = $offset + $results_per_page;
1691     }
1692     else {
1693         $times = $hits;  # FIXME: if $hits is undefined, why do we want to equal it?
1694     }
1695
1696         my $marcflavour = C4::Context->preference("marcflavour");
1697     # We get the biblionumber position in MARC
1698     my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1699
1700     # loop through all of the records we've retrieved
1701     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1702         my $marcrecord = eval { MARC::File::USMARC::decode( $marcresults->[$i] ); };
1703         if ( $@ ) {
1704             warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1705             next;
1706         }
1707
1708         my $fw = $scan
1709              ? undef
1710              : $bibliotag < 10
1711                ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1712                : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1713         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1714         $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1715         $oldbiblio->{result_number} = $i + 1;
1716
1717         # add imageurl to itemtype if there is one
1718         $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1719
1720         $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 ) ) : [];
1721                 $oldbiblio->{normalized_upc}  = GetNormalizedUPC(       $marcrecord,$marcflavour);
1722                 $oldbiblio->{normalized_ean}  = GetNormalizedEAN(       $marcrecord,$marcflavour);
1723                 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1724                 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1725                 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1726
1727                 # edition information, if any
1728         $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1729                 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1730  # Build summary if there is one (the summary is defined in the itemtypes table)
1731  # FIXME: is this used anywhere, I think it can be commented out? -- JF
1732         if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1733             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1734             my @fields  = $marcrecord->fields();
1735
1736             my $newsummary;
1737             foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1738                 my $tags = {};
1739                 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1740                     $tag =~ /(.{3})(.)/;
1741                     if($marcrecord->field($1)){
1742                         my @abc = $marcrecord->field($1)->subfield($2);
1743                         $tags->{$tag} = $#abc + 1 ;
1744                     }
1745                 }
1746
1747                 # We catch how many times to repeat this line
1748                 my $max = 0;
1749                 foreach my $tag (keys(%$tags)){
1750                     $max = $tags->{$tag} if($tags->{$tag} > $max);
1751                  }
1752
1753                 # we replace, and repeat each line
1754                 for (my $i = 0 ; $i < $max ; $i++){
1755                     my $newline = $line;
1756
1757                     foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1758                         $tag =~ /(.{3})(.)/;
1759
1760                         if($marcrecord->field($1)){
1761                             my @repl = $marcrecord->field($1)->subfield($2);
1762                             my $subfieldvalue = $repl[$i];
1763
1764                             if (! utf8::is_utf8($subfieldvalue)) {
1765                                 utf8::decode($subfieldvalue);
1766                             }
1767
1768                              $newline =~ s/\[$tag\]/$subfieldvalue/g;
1769                         }
1770                     }
1771                     $newsummary .= "$newline\n";
1772                 }
1773             }
1774
1775             $newsummary =~ s/\[(.*?)]//g;
1776             $newsummary =~ s/\n/<br\/>/g;
1777             $oldbiblio->{summary} = $newsummary;
1778         }
1779
1780         # Pull out the items fields
1781         my @fields = $marcrecord->field($itemtag);
1782         my $marcflavor = C4::Context->preference("marcflavour");
1783         # adding linked items that belong to host records
1784         my $analyticsfield = '773';
1785         if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1786             $analyticsfield = '773';
1787         } elsif ($marcflavor eq 'UNIMARC') {
1788             $analyticsfield = '461';
1789         }
1790         foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1791             my $hostbiblionumber = $hostfield->subfield("0");
1792             my $linkeditemnumber = $hostfield->subfield("9");
1793             if(!$hostbiblionumber eq undef){
1794                 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
1795                 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
1796                 if(!$hostbiblio eq undef){
1797                     my @hostitems = $hostbiblio->field($itemfield);
1798                     foreach my $hostitem (@hostitems){
1799                         if ($hostitem->subfield("9") eq $linkeditemnumber){
1800                             my $linkeditem =$hostitem;
1801                             # append linked items if they exist
1802                             if (!$linkeditem eq undef){
1803                                 push (@fields, $linkeditem);}
1804                         }
1805                     }
1806                 }
1807             }
1808         }
1809
1810         # Setting item statuses for display
1811         my @available_items_loop;
1812         my @onloan_items_loop;
1813         my @other_items_loop;
1814
1815         my $available_items;
1816         my $onloan_items;
1817         my $other_items;
1818
1819         my $ordered_count         = 0;
1820         my $available_count       = 0;
1821         my $onloan_count          = 0;
1822         my $longoverdue_count     = 0;
1823         my $other_count           = 0;
1824         my $withdrawn_count        = 0;
1825         my $itemlost_count        = 0;
1826         my $hideatopac_count      = 0;
1827         my $itembinding_count     = 0;
1828         my $itemdamaged_count     = 0;
1829         my $item_in_transit_count = 0;
1830         my $can_place_holds       = 0;
1831         my $item_onhold_count     = 0;
1832         my $items_count           = scalar(@fields);
1833         my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
1834         my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
1835         my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
1836
1837         # loop through every item
1838         foreach my $field (@fields) {
1839             my $item;
1840
1841             # populate the items hash
1842             foreach my $code ( keys %subfieldstosearch ) {
1843                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1844             }
1845             $item->{description} = $itemtypes{ $item->{itype} }{description};
1846
1847                 # OPAC hidden items
1848             if ($is_opac) {
1849                 # hidden because lost
1850                 if ($hidelostitems && $item->{itemlost}) {
1851                     $hideatopac_count++;
1852                     next;
1853                 }
1854                 # hidden based on OpacHiddenItems syspref
1855                 my @hi = C4::Items::GetHiddenItemnumbers($item);
1856                 if (scalar @hi) {
1857                     push @hiddenitems, @hi;
1858                     $hideatopac_count++;
1859                     next;
1860                 }
1861             }
1862
1863             my $hbranch     = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch'    : 'holdingbranch';
1864             my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1865
1866             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1867             if ($item->{$hbranch}) {
1868                 $item->{'branchname'} = $branches{$item->{$hbranch}};
1869             }
1870             elsif ($item->{$otherbranch}) {     # Last resort
1871                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1872             }
1873
1874                         my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1875 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1876             my $userenv = C4::Context->userenv;
1877             if ( $item->{onloan} && !(C4::Members::GetHideLostItemsPreference($userenv->{'number'}) && $item->{itemlost}) ) {
1878                 $onloan_count++;
1879                                 my $key = $prefix . $item->{onloan} . $item->{barcode};
1880                                 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1881                                 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1882                                 $onloan_items->{$key}->{branchname} = $item->{branchname};
1883                                 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1884                                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1885                                 $onloan_items->{$key}->{description} = $item->{description};
1886                                 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1887                 # if something's checked out and lost, mark it as 'long overdue'
1888                 if ( $item->{itemlost} ) {
1889                     $onloan_items->{$prefix}->{longoverdue}++;
1890                     $longoverdue_count++;
1891                 } else {        # can place holds as long as item isn't lost
1892                     $can_place_holds = 1;
1893                 }
1894             }
1895
1896          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1897             else {
1898
1899                 # item is on order
1900                 if ( $item->{notforloan} < 0 ) {
1901                     $ordered_count++;
1902                 }
1903
1904                 # is item in transit?
1905                 my $transfertwhen = '';
1906                 my ($transfertfrom, $transfertto);
1907
1908                 # is item on the reserve shelf?
1909                 my $reservestatus = '';
1910
1911                 unless ($item->{withdrawn}
1912                         || $item->{itemlost}
1913                         || $item->{damaged}
1914                         || $item->{notforloan}
1915                         || $items_count > 20) {
1916
1917                     # A couple heuristics to limit how many times
1918                     # we query the database for item transfer information, sacrificing
1919                     # accuracy in some cases for speed;
1920                     #
1921                     # 1. don't query if item has one of the other statuses
1922                     # 2. don't check transit status if the bib has
1923                     #    more than 20 items
1924                     #
1925                     # FIXME: to avoid having the query the database like this, and to make
1926                     #        the in transit status count as unavailable for search limiting,
1927                     #        should map transit status to record indexed in Zebra.
1928                     #
1929                     ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1930                     $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber}, $oldbiblio->{biblionumber} );
1931                 }
1932
1933                 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
1934                 if (   $item->{withdrawn}
1935                     || $item->{itemlost}
1936                     || $item->{damaged}
1937                     || $item->{notforloan}
1938                     || $reservestatus eq 'Waiting'
1939                     || ($transfertwhen ne ''))
1940                 {
1941                     $withdrawn_count++        if $item->{withdrawn};
1942                     $itemlost_count++        if $item->{itemlost};
1943                     $itemdamaged_count++     if $item->{damaged};
1944                     $item_in_transit_count++ if $transfertwhen ne '';
1945                     $item_onhold_count++     if $reservestatus eq 'Waiting';
1946                     $item->{status} = $item->{withdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1947
1948                     # can place a hold on a item if
1949                     # not lost nor withdrawn
1950                     # not damaged unless AllowHoldsOnDamagedItems is true
1951                     # item is either for loan or on order (notforloan < 0)
1952                     $can_place_holds = 1
1953                       if (
1954                            !$item->{itemlost}
1955                         && !$item->{withdrawn}
1956                         && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
1957                         && ( !$item->{notforloan} || $item->{notforloan} < 0 )
1958                       );
1959
1960                     $other_count++;
1961
1962                     my $key = $prefix . $item->{status};
1963                     foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
1964                         $other_items->{$key}->{$_} = $item->{$_};
1965                     }
1966                     $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
1967                     $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
1968                     $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
1969                                         $other_items->{$key}->{count}++ if $item->{$hbranch};
1970                                         $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1971                                         $other_items->{$key}->{description} = $item->{description};
1972                                         $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1973                 }
1974                 # item is available
1975                 else {
1976                     $can_place_holds = 1;
1977                     $available_count++;
1978                                         $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1979                                         foreach (qw(branchname itemcallnumber description)) {
1980                         $available_items->{$prefix}->{$_} = $item->{$_};
1981                                         }
1982                                         $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1983                                         $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1984                 }
1985             }
1986         }    # notforloan, item level and biblioitem level
1987
1988         # if all items are hidden, do not show the record
1989         if ($items_count > 0 && $hideatopac_count == $items_count) {
1990             next;
1991         }
1992
1993         my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1994         for my $key ( sort keys %$onloan_items ) {
1995             (++$onloanitemscount > $maxitems) and last;
1996             push @onloan_items_loop, $onloan_items->{$key};
1997         }
1998         for my $key ( sort keys %$other_items ) {
1999             (++$otheritemscount > $maxitems) and last;
2000             push @other_items_loop, $other_items->{$key};
2001         }
2002         for my $key ( sort keys %$available_items ) {
2003             (++$availableitemscount > $maxitems) and last;
2004             push @available_items_loop, $available_items->{$key}
2005         }
2006
2007         # XSLT processing of some stuff
2008         use C4::Charset;
2009         SetUTF8Flag($marcrecord);
2010         warn $marcrecord->as_formatted if $DEBUG;
2011         my $interface = $search_context eq 'opac' ? 'OPAC' : '';
2012         if (!$scan && C4::Context->preference($interface . "XSLTResultsDisplay")) {
2013             $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $interface."XSLTResultsDisplay", 1, \@hiddenitems);
2014             # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2015         }
2016
2017         # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2018         if (!C4::Context->preference("item-level_itypes")) {
2019             if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2020                 $can_place_holds = 0;
2021             }
2022         }
2023         $oldbiblio->{norequests} = 1 unless $can_place_holds;
2024         $oldbiblio->{itemsplural}          = 1 if $items_count > 1;
2025         $oldbiblio->{items_count}          = $items_count;
2026         $oldbiblio->{available_items_loop} = \@available_items_loop;
2027         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
2028         $oldbiblio->{other_items_loop}     = \@other_items_loop;
2029         $oldbiblio->{availablecount}       = $available_count;
2030         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
2031         $oldbiblio->{onloancount}          = $onloan_count;
2032         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
2033         $oldbiblio->{othercount}           = $other_count;
2034         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
2035         $oldbiblio->{withdrawncount}        = $withdrawn_count;
2036         $oldbiblio->{itemlostcount}        = $itemlost_count;
2037         $oldbiblio->{damagedcount}         = $itemdamaged_count;
2038         $oldbiblio->{intransitcount}       = $item_in_transit_count;
2039         $oldbiblio->{onholdcount}          = $item_onhold_count;
2040         $oldbiblio->{orderedcount}         = $ordered_count;
2041
2042         if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2043             my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2044             my $subfields = substr $fieldspec, 3;
2045             my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2046             my @alternateholdingsinfo = ();
2047             my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2048             my $alternateholdingscount = 0;
2049
2050             for my $field (@holdingsfields) {
2051                 my %holding = ( holding => '' );
2052                 my $havesubfield = 0;
2053                 for my $subfield ($field->subfields()) {
2054                     if ((index $subfields, $$subfield[0]) >= 0) {
2055                         $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2056                         $holding{'holding'} .= $$subfield[1];
2057                         $havesubfield++;
2058                     }
2059                 }
2060                 if ($havesubfield) {
2061                     push(@alternateholdingsinfo, \%holding);
2062                     $alternateholdingscount++;
2063                 }
2064             }
2065
2066             $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2067             $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2068         }
2069
2070         push( @newresults, $oldbiblio );
2071     }
2072
2073     return @newresults;
2074 }
2075
2076 =head2 SearchAcquisitions
2077     Search for acquisitions
2078 =cut
2079
2080 sub SearchAcquisitions{
2081     my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
2082
2083     my $dbh=C4::Context->dbh;
2084     # Variable initialization
2085     my $str=qq|
2086     SELECT marcxml
2087     FROM biblio
2088     LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
2089     LEFT JOIN items ON items.biblionumber=biblio.biblionumber
2090     WHERE dateaccessioned BETWEEN ? AND ?
2091     |;
2092
2093     my (@params,@loopcriteria);
2094
2095     push @params, $datebegin->output("iso");
2096     push @params, $dateend->output("iso");
2097
2098     if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
2099         if(C4::Context->preference("item-level_itypes")){
2100             $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2101         }else{
2102             $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2103         }
2104         push @params, @$itemtypes;
2105     }
2106
2107     if ($criteria =~/itemtype/){
2108         if(C4::Context->preference("item-level_itypes")){
2109             $str .= "AND items.itype=? ";
2110         }else{
2111             $str .= "AND biblioitems.itemtype=? ";
2112         }
2113
2114         if(scalar(@$itemtypes) == 0){
2115             my $itypes = GetItemTypes();
2116             for my $key (keys %$itypes){
2117                 push @$itemtypes, $key;
2118             }
2119         }
2120
2121         @loopcriteria= @$itemtypes;
2122     }elsif ($criteria=~/itemcallnumber/){
2123         $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
2124                  OR items.itemcallnumber is NULL
2125                  OR items.itemcallnumber = '')";
2126
2127         @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
2128     }else {
2129         $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
2130         @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
2131     }
2132
2133     if ($orderby =~ /date_desc/){
2134         $str.=" ORDER BY dateaccessioned DESC";
2135     } else {
2136         $str.=" ORDER BY title";
2137     }
2138
2139     my $qdataacquisitions=$dbh->prepare($str);
2140
2141     my @loopacquisitions;
2142     foreach my $value(@loopcriteria){
2143         push @params,$value;
2144         my %cell;
2145         $cell{"title"}=$value;
2146         $cell{"titlecode"}=$value;
2147
2148         eval{$qdataacquisitions->execute(@params);};
2149
2150         if ($@){ warn "recentacquisitions Error :$@";}
2151         else {
2152             my @loopdata;
2153             while (my $data=$qdataacquisitions->fetchrow_hashref){
2154                 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
2155             }
2156             $cell{"loopdata"}=\@loopdata;
2157         }
2158         push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
2159         pop @params;
2160     }
2161     $qdataacquisitions->finish;
2162     return \@loopacquisitions;
2163 }
2164
2165 =head2 enabled_staff_search_views
2166
2167 %hash = enabled_staff_search_views()
2168
2169 This function returns a hash that contains three flags obtained from the system
2170 preferences, used to determine whether a particular staff search results view
2171 is enabled.
2172
2173 =over 2
2174
2175 =item C<Output arg:>
2176
2177     * $hash{can_view_MARC} is true only if the MARC view is enabled
2178     * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2179     * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2180
2181 =item C<usage in the script:>
2182
2183 =back
2184
2185 $template->param ( C4::Search::enabled_staff_search_views );
2186
2187 =cut
2188
2189 sub enabled_staff_search_views
2190 {
2191         return (
2192                 can_view_MARC                   => C4::Context->preference('viewMARC'),                 # 1 if the staff search allows the MARC view
2193                 can_view_ISBD                   => C4::Context->preference('viewISBD'),                 # 1 if the staff search allows the ISBD view
2194                 can_view_labeledMARC    => C4::Context->preference('viewLabeledMARC'),  # 1 if the staff search allows the Labeled MARC view
2195         );
2196 }
2197
2198 sub AddSearchHistory{
2199         my ($borrowernumber,$session,$query_desc,$query_cgi, $total)=@_;
2200     my $dbh = C4::Context->dbh;
2201
2202     # Add the request the user just made
2203     my $sql = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES(?, ?, ?, ?, ?, NOW())";
2204     my $sth   = $dbh->prepare($sql);
2205     $sth->execute($borrowernumber, $session, $query_desc, $query_cgi, $total);
2206         return $dbh->last_insert_id(undef, 'search_history', undef,undef,undef);
2207 }
2208
2209 sub GetSearchHistory{
2210         my ($borrowernumber,$session)=@_;
2211     my $dbh = C4::Context->dbh;
2212
2213     # Add the request the user just made
2214     my $query = "SELECT FROM search_history WHERE (userid=? OR sessionid=?)";
2215     my $sth   = $dbh->prepare($query);
2216         $sth->execute($borrowernumber, $session);
2217     return  $sth->fetchall_hashref({});
2218 }
2219
2220 sub PurgeSearchHistory{
2221     my ($pSearchhistory)=@_;
2222     my $dbh = C4::Context->dbh;
2223     my $sth = $dbh->prepare("DELETE FROM search_history WHERE time < DATE_SUB( NOW(), INTERVAL ? DAY )");
2224     $sth->execute($pSearchhistory) or die $dbh->errstr;
2225 }
2226
2227 =head2 z3950_search_args
2228
2229 $arrayref = z3950_search_args($matchpoints)
2230
2231 This function returns an array reference that contains the search parameters to be
2232 passed to the Z39.50 search script (z3950_search.pl). The array elements
2233 are hash refs whose keys are name, value and encvalue, and whose values are the
2234 name of a search parameter, the value of that search parameter and the URL encoded
2235 value of that parameter.
2236
2237 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2238
2239 The search parameter values are obtained from the bibliographic record whose
2240 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2241
2242 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2243 a general purpose search argument. In this case, the returned array contains only
2244 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2245
2246 If a search parameter value is undefined or empty, it is not included in the returned
2247 array.
2248
2249 The returned array reference may be passed directly to the template parameters.
2250
2251 =over 2
2252
2253 =item C<Output arg:>
2254
2255     * $array containing hash refs as described above
2256
2257 =item C<usage in the script:>
2258
2259 =back
2260
2261 $data = Biblio::GetBiblioData($bibno);
2262 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2263
2264 *OR*
2265
2266 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2267
2268 =cut
2269
2270 sub z3950_search_args {
2271     my $bibrec = shift;
2272     my $isbn = Business::ISBN->new($bibrec);
2273
2274     if (defined $isbn && $isbn->is_valid)
2275     {
2276         $bibrec = { isbn => $bibrec } if !ref $bibrec;
2277     }
2278     else {
2279         $bibrec = { title => $bibrec } if !ref $bibrec;
2280     }
2281     my $array = [];
2282     for my $field (qw/ lccn isbn issn title author dewey subject /)
2283     {
2284         my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2285         push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2286     }
2287     return $array;
2288 }
2289
2290 =head2 GetDistinctValues($field);
2291
2292 C<$field> is a reference to the fields array
2293
2294 =cut
2295
2296 sub GetDistinctValues {
2297     my ($fieldname,$string)=@_;
2298     # returns a reference to a hash of references to branches...
2299     if ($fieldname=~/\./){
2300                         my ($table,$column)=split /\./, $fieldname;
2301                         my $dbh = C4::Context->dbh;
2302                         warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2303                         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 ");
2304                         $sth->execute;
2305                         my $elements=$sth->fetchall_arrayref({});
2306                         return $elements;
2307    }
2308    else {
2309                 $string||= qq("");
2310                 my @servers=qw<biblioserver authorityserver>;
2311                 my (@zconns,@results);
2312         for ( my $i = 0 ; $i < @servers ; $i++ ) {
2313                 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2314                         $results[$i] =
2315                       $zconns[$i]->scan(
2316                         ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2317                       );
2318                 }
2319                 # The big moment: asynchronously retrieve results from all servers
2320                 my @elements;
2321         _ZOOM_event_loop(
2322             \@zconns,
2323             \@results,
2324             sub {
2325                 my ( $i, $size ) = @_;
2326                 for ( my $j = 0 ; $j < $size ; $j++ ) {
2327                     my %hashscan;
2328                     @hashscan{qw(value cnt)} =
2329                       $results[ $i - 1 ]->display_term($j);
2330                     push @elements, \%hashscan;
2331                 }
2332             }
2333         );
2334                 return \@elements;
2335    }
2336 }
2337
2338 =head2 _ZOOM_event_loop
2339
2340     _ZOOM_event_loop(\@zconns, \@results, sub {
2341         my ( $i, $size ) = @_;
2342         ....
2343     } );
2344
2345 Processes a ZOOM event loop and passes control to a closure for
2346 processing the results, and destroying the resultsets.
2347
2348 =cut
2349
2350 sub _ZOOM_event_loop {
2351     my ($zconns, $results, $callback) = @_;
2352     while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2353         my $ev = $zconns->[ $i - 1 ]->last_event();
2354         if ( $ev == ZOOM::Event::ZEND ) {
2355             next unless $results->[ $i - 1 ];
2356             my $size = $results->[ $i - 1 ]->size();
2357             if ( $size > 0 ) {
2358                 $callback->($i, $size);
2359             }
2360         }
2361     }
2362
2363     foreach my $result (@$results) {
2364         $result->destroy();
2365     }
2366 }
2367
2368
2369 END { }    # module clean-up code here (global destructor)
2370
2371 1;
2372 __END__
2373
2374 =head1 AUTHOR
2375
2376 Koha Development Team <http://koha-community.org/>
2377
2378 =cut