C4/Search.pm

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