C4/Search.pm

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