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