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