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
  20 require Exporter;
  21 use C4::Context;
  22 use C4::Biblio;    # GetMarcFromKohaField
  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::XSLT;
  29 use C4::Branch;
  30
  31 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
  32
  33 # set the version for version checking
  34 BEGIN {
  35     $VERSION = 3.01;
  36     $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
  37 }
  38
  39 =head1 NAME
  40
  41 C4::Search - Functions for searching the Koha catalog.
  42
  43 =head1 SYNOPSIS
  44
  45 See opac/opac-search.pl or catalogue/search.pl for example of usage
  46
  47 =head1 DESCRIPTION
  48
  49 This module provides searching functions for Koha's bibliographic databases
  50
  51 =head1 FUNCTIONS
  52
  53 =cut
  54
  55 @ISA    = qw(Exporter);
  56 @EXPORT = qw(
  57   &findseealso
  58   &FindDuplicate
  59   &SimpleSearch
  60   &searchResults
  61   &getRecords
  62   &buildQuery
  63   &NZgetRecords
  64 );
  65
  66 # make all your functions, whether exported or not;
  67
  68 =head2 findseealso($dbh,$fields);
  69
  70 C<$dbh> is a link to the DB handler.
  71
  72 use C4::Context;
  73 my $dbh =C4::Context->dbh;
  74
  75 C<$fields> is a reference to the fields array
  76
  77 This function modifies the @$fields array and adds related fields to search on.
  78
  79 FIXME: this function is probably deprecated in Koha 3
  80
  81 =cut
  82
  83 sub findseealso {
  84     my ( $dbh, $fields ) = @_;
  85     my $tagslib = GetMarcStructure(1);
  86     for ( my $i = 0 ; $i <= $#{$fields} ; $i++ ) {
  87         my ($tag)      = substr( @$fields[$i], 1, 3 );
  88         my ($subfield) = substr( @$fields[$i], 4, 1 );
  89         @$fields[$i] .= ',' . $tagslib->{$tag}->{$subfield}->{seealso}
  90           if ( $tagslib->{$tag}->{$subfield}->{seealso} );
  91     }
  92 }
  93
  94 =head2 FindDuplicate
  95
  96 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
  97
  98 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
  99
 100 =cut
 101
 102 sub FindDuplicate {
 103     my ($record) = @_;
 104     my $dbh = C4::Context->dbh;
 105     my $result = TransformMarcToKoha( $dbh, $record, '' );
 106     my $sth;
 107     my $query;
 108     my $search;
 109     my $type;
 110     my ( $biblionumber, $title );
 111
 112     # search duplicate on ISBN, easy and fast..
 113     # ... normalize first
 114     if ( $result->{isbn} ) {
 115         $result->{isbn} =~ s/\(.*$//;
 116         $result->{isbn} =~ s/\s+$//;
 117         $query = "isbn=$result->{isbn}";
 118     }
 119     else {
 120         $result->{title} =~ s /\\//g;
 121         $result->{title} =~ s /\"//g;
 122         $result->{title} =~ s /\(//g;
 123         $result->{title} =~ s /\)//g;
 124
 125         # FIXME: instead of removing operators, could just do
 126         # quotes around the value
 127         $result->{title} =~ s/(and|or|not)//g;
 128         $query = "ti,ext=$result->{title}";
 129         $query .= " and itemtype=$result->{itemtype}"
 130           if ( $result->{itemtype} );
 131         if   ( $result->{author} ) {
 132             $result->{author} =~ s /\\//g;
 133             $result->{author} =~ s /\"//g;
 134             $result->{author} =~ s /\(//g;
 135             $result->{author} =~ s /\)//g;
 136
 137             # remove valid operators
 138             $result->{author} =~ s/(and|or|not)//g;
 139             $query .= " and au,ext=$result->{author}";
 140         }
 141     }
 142
 143     # FIXME: add error handling
 144     my ( $error, $searchresults ) = SimpleSearch($query); # FIXME :: hardcoded !
 145     my @results;
 146     foreach my $possible_duplicate_record (@$searchresults) {
 147         my $marcrecord =
 148           MARC::Record->new_from_usmarc($possible_duplicate_record);
 149         my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
 150
 151         # FIXME :: why 2 $biblionumber ?
 152         if ($result) {
 153             push @results, $result->{'biblionumber'};
 154             push @results, $result->{'title'};
 155         }
 156     }
 157     return @results;
 158 }
 159
 160 =head2 SimpleSearch
 161
 162 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
 163
 164 This function provides a simple search API on the bibliographic catalog
 165
 166 =over 2
 167
 168 =item C<input arg:>
 169
 170     * $query can be a simple keyword or a complete CCL query
 171     * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
 172     * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
 173     * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
 174
 175
 176 =item C<Output:>
 177
 178     * $error is a empty unless an error is detected
 179     * \@results is an array of records.
 180     * $total_hits is the number of hits that would have been returned with no limit
 181
 182 =item C<usage in the script:>
 183
 184 =back
 185
 186 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
 187
 188 if (defined $error) {
 189     $template->param(query_error => $error);
 190     warn "error: ".$error;
 191     output_html_with_http_headers $input, $cookie, $template->output;
 192     exit;
 193 }
 194
 195 my $hits = scalar @$marcresults;
 196 my @results;
 197
 198 for my $i (0..$hits) {
 199     my %resultsloop;
 200     my $marcrecord = MARC::File::USMARC::decode($marcresults->[$i]);
 201     my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,'');
 202
 203     #build the hash for the template.
 204     $resultsloop{highlight}       = ($i % 2)?(1):(0);
 205     $resultsloop{title}           = $biblio->{'title'};
 206     $resultsloop{subtitle}        = $biblio->{'subtitle'};
 207     $resultsloop{biblionumber}    = $biblio->{'biblionumber'};
 208     $resultsloop{author}          = $biblio->{'author'};
 209     $resultsloop{publishercode}   = $biblio->{'publishercode'};
 210     $resultsloop{publicationyear} = $biblio->{'publicationyear'};
 211
 212     push @results, \%resultsloop;
 213 }
 214
 215 $template->param(result=>\@results);
 216
 217 =cut
 218
 219 sub SimpleSearch {
 220     my ( $query, $offset, $max_results, $servers )  = @_;
 221
 222     if ( C4::Context->preference('NoZebra') ) {
 223         my $result = NZorder( NZanalyse($query) )->{'biblioserver'};
 224         my $search_result =
 225           (      $result->{hits}
 226               && $result->{hits} > 0 ? $result->{'RECORDS'} : [] );
 227         return ( undef, $search_result, scalar($result->{hits}) );
 228     }
 229     else {
 230         # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
 231         my @servers = defined ( $servers ) ? @$servers : ( "biblioserver" );
 232         my @results;
 233         my @zoom_queries;
 234         my @tmpresults;
 235         my @zconns;
 236         my $total_hits;
 237         return ( "No query entered", undef, undef ) unless $query;
 238
 239         # Initialize & Search Zebra
 240         for ( my $i = 0 ; $i < @servers ; $i++ ) {
 241             eval {
 242                 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 243                 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
 244                 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
 245
 246                 # error handling
 247                 my $error =
 248                     $zconns[$i]->errmsg() . " ("
 249                   . $zconns[$i]->errcode() . ") "
 250                   . $zconns[$i]->addinfo() . " "
 251                   . $zconns[$i]->diagset();
 252
 253                 return ( $error, undef, undef ) if $zconns[$i]->errcode();
 254             };
 255             if ($@) {
 256
 257                 # caught a ZOOM::Exception
 258                 my $error =
 259                     $@->message() . " ("
 260                   . $@->code() . ") "
 261                   . $@->addinfo() . " "
 262                   . $@->diagset();
 263                 warn $error;
 264                 return ( $error, undef, undef );
 265             }
 266         }
 267         while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
 268             my $event = $zconns[ $i - 1 ]->last_event();
 269             if ( $event == ZOOM::Event::ZEND ) {
 270
 271                 my $first_record = defined( $offset ) ? $offset+1 : 1;
 272                 my $hits = $tmpresults[ $i - 1 ]->size();
 273                 $total_hits += $hits;
 274                 my $last_record = $hits;
 275                 if ( defined $max_results && $offset + $max_results < $hits ) {
 276                     $last_record  = $offset + $max_results;
 277                 }
 278
 279                 for my $j ( $first_record..$last_record ) {
 280                     my $record = $tmpresults[ $i - 1 ]->record( $j-1 )->raw(); # 0 indexed
 281                     push @results, $record;
 282                 }
 283             }
 284         }
 285
 286         foreach my $result (@tmpresults) {
 287             $result->destroy();
 288         }
 289         foreach my $zoom_query (@zoom_queries) {
 290             $zoom_query->destroy();
 291         }
 292
 293         return ( undef, \@results, $total_hits );
 294     }
 295 }
 296
 297 =head2 getRecords
 298
 299 ( undef, $results_hashref, \@facets_loop ) = getRecords (
 300
 301         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 302         $results_per_page, $offset,       $expanded_facet, $branches,
 303         $query_type,       $scan
 304     );
 305
 306 The all singing, all dancing, multi-server, asynchronous, scanning,
 307 searching, record nabbing, facet-building
 308
 309 See verbse embedded documentation.
 310
 311 =cut
 312
 313 sub getRecords {
 314     my (
 315         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 316         $results_per_page, $offset,       $expanded_facet, $branches,
 317         $query_type,       $scan
 318     ) = @_;
 319
 320     my @servers = @$servers_ref;
 321     my @sort_by = @$sort_by_ref;
 322
 323     # Initialize variables for the ZOOM connection and results object
 324     my $zconn;
 325     my @zconns;
 326     my @results;
 327     my $results_hashref = ();
 328
 329     # Initialize variables for the faceted results objects
 330     my $facets_counter = ();
 331     my $facets_info    = ();
 332     my $facets         = getFacets();
 333
 334     my @facets_loop;    # stores the ref to array of hashes for template facets loop
 335
 336     ### LOOP THROUGH THE SERVERS
 337     for ( my $i = 0 ; $i < @servers ; $i++ ) {
 338         $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 339
 340 # perform the search, create the results objects
 341 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
 342         my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
 343
 344         #$query_to_use = $simple_query if $scan;
 345         warn $simple_query if ( $scan and $DEBUG );
 346
 347         # Check if we've got a query_type defined, if so, use it
 348         eval {
 349             if ($query_type)
 350             {
 351                 if ( $query_type =~ /^ccl/ ) {
 352                     $query_to_use =~
 353                       s/\:/\=/g;    # change : to = last minute (FIXME)
 354                     $results[$i] =
 355                       $zconns[$i]->search(
 356                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 357                       );
 358                 }
 359                 elsif ( $query_type =~ /^cql/ ) {
 360                     $results[$i] =
 361                       $zconns[$i]->search(
 362                         new ZOOM::Query::CQL( $query_to_use, $zconns[$i] ) );
 363                 }
 364                 elsif ( $query_type =~ /^pqf/ ) {
 365                     $results[$i] =
 366                       $zconns[$i]->search(
 367                         new ZOOM::Query::PQF( $query_to_use, $zconns[$i] ) );
 368                 }
 369             }
 370             else {
 371                 if ($scan) {
 372                     $results[$i] =
 373                       $zconns[$i]->scan(
 374                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 375                       );
 376                 }
 377                 else {
 378                     $results[$i] =
 379                       $zconns[$i]->search(
 380                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 381                       );
 382                 }
 383             }
 384         };
 385         if ($@) {
 386             warn "WARNING: query problem with $query_to_use " . $@;
 387         }
 388
 389         # Concatenate the sort_by limits and pass them to the results object
 390         # Note: sort will override rank
 391         my $sort_by;
 392         foreach my $sort (@sort_by) {
 393             if ( $sort eq "author_az" ) {
 394                 $sort_by .= "1=1003 <i ";
 395             }
 396             elsif ( $sort eq "author_za" ) {
 397                 $sort_by .= "1=1003 >i ";
 398             }
 399             elsif ( $sort eq "popularity_asc" ) {
 400                 $sort_by .= "1=9003 <i ";
 401             }
 402             elsif ( $sort eq "popularity_dsc" ) {
 403                 $sort_by .= "1=9003 >i ";
 404             }
 405             elsif ( $sort eq "call_number_asc" ) {
 406                 $sort_by .= "1=20  <i ";
 407             }
 408             elsif ( $sort eq "call_number_dsc" ) {
 409                 $sort_by .= "1=20 >i ";
 410             }
 411             elsif ( $sort eq "pubdate_asc" ) {
 412                 $sort_by .= "1=31 <i ";
 413             }
 414             elsif ( $sort eq "pubdate_dsc" ) {
 415                 $sort_by .= "1=31 >i ";
 416             }
 417             elsif ( $sort eq "acqdate_asc" ) {
 418                 $sort_by .= "1=32 <i ";
 419             }
 420             elsif ( $sort eq "acqdate_dsc" ) {
 421                 $sort_by .= "1=32 >i ";
 422             }
 423             elsif ( $sort eq "title_az" ) {
 424                 $sort_by .= "1=4 <i ";
 425             }
 426             elsif ( $sort eq "title_za" ) {
 427                 $sort_by .= "1=4 >i ";
 428             }
 429             else {
 430                 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
 431             }
 432         }
 433         if ($sort_by) {
 434             if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
 435                 warn "WARNING sort $sort_by failed";
 436             }
 437         }
 438     }    # finished looping through servers
 439
 440     # The big moment: asynchronously retrieve results from all servers
 441     while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
 442         my $ev = $zconns[ $i - 1 ]->last_event();
 443         if ( $ev == ZOOM::Event::ZEND ) {
 444             next unless $results[ $i - 1 ];
 445             my $size = $results[ $i - 1 ]->size();
 446             if ( $size > 0 ) {
 447                 my $results_hash;
 448
 449                 # loop through the results
 450                 $results_hash->{'hits'} = $size;
 451                 my $times;
 452                 if ( $offset + $results_per_page <= $size ) {
 453                     $times = $offset + $results_per_page;
 454                 }
 455                 else {
 456                     $times = $size;
 457                 }
 458                 for ( my $j = $offset ; $j < $times ; $j++ ) {
 459                     my $records_hash;
 460                     my $record;
 461                     my $facet_record;
 462
 463                     ## Check if it's an index scan
 464                     if ($scan) {
 465                         my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
 466
 467                  # here we create a minimal MARC record and hand it off to the
 468                  # template just like a normal result ... perhaps not ideal, but
 469                  # it works for now
 470                         my $tmprecord = MARC::Record->new();
 471                         $tmprecord->encoding('UTF-8');
 472                         my $tmptitle;
 473                         my $tmpauthor;
 474
 475                 # the minimal record in author/title (depending on MARC flavour)
 476                         if (C4::Context->preference("marcflavour") eq "UNIMARC") {
 477                             $tmptitle = MARC::Field->new('200',' ',' ', a => $term, f => $occ);
 478                             $tmprecord->append_fields($tmptitle);
 479                         } else {
 480                             $tmptitle  = MARC::Field->new('245',' ',' ', a => $term,);
 481                             $tmpauthor = MARC::Field->new('100',' ',' ', a => $occ,);
 482                             $tmprecord->append_fields($tmptitle);
 483                             $tmprecord->append_fields($tmpauthor);
 484                         }
 485                         $results_hash->{'RECORDS'}[$j] = $tmprecord->as_usmarc();
 486                     }
 487
 488                     # not an index scan
 489                     else {
 490                         $record = $results[ $i - 1 ]->record($j)->raw();
 491
 492                         # warn "RECORD $j:".$record;
 493                         $results_hash->{'RECORDS'}[$j] = $record;
 494
 495             # Fill the facets while we're looping, but only for the biblioserver
 496                         $facet_record = MARC::Record->new_from_usmarc($record)
 497                           if $servers[ $i - 1 ] =~ /biblioserver/;
 498
 499                     #warn $servers[$i-1]."\n".$record; #.$facet_record->title();
 500                         if ($facet_record) {
 501                             for ( my $k = 0 ; $k <= @$facets ; $k++ ) {
 502                                 ($facets->[$k]) or next;
 503                                 my @fields = map {$facet_record->field($_)} @{$facets->[$k]->{'tags'}} ;
 504                                 for my $field (@fields) {
 505                                     my @subfields = $field->subfields();
 506                                     for my $subfield (@subfields) {
 507                                         my ( $code, $data ) = @$subfield;
 508                                         ($code eq $facets->[$k]->{'subfield'}) or next;
 509                                         $facets_counter->{ $facets->[$k]->{'link_value'} }->{$data}++;
 510                                     }
 511                                 }
 512                                 $facets_info->{ $facets->[$k]->{'link_value'} }->{'label_value'} =
 513                                     $facets->[$k]->{'label_value'};
 514                                 $facets_info->{ $facets->[$k]->{'link_value'} }->{'expanded'} =
 515                                     $facets->[$k]->{'expanded'};
 516                             }
 517                         }
 518                     }
 519                 }
 520                 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
 521             }
 522
 523             # warn "connection ", $i-1, ": $size hits";
 524             # warn $results[$i-1]->record(0)->render() if $size > 0;
 525
 526             # BUILD FACETS
 527             if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
 528                 for my $link_value (
 529                     sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
 530                     keys %$facets_counter )
 531                 {
 532                     my $expandable;
 533                     my $number_of_facets;
 534                     my @this_facets_array;
 535                     for my $one_facet (
 536                         sort {
 537                             $facets_counter->{$link_value}
 538                               ->{$b} <=> $facets_counter->{$link_value}->{$a}
 539                         } keys %{ $facets_counter->{$link_value} }
 540                       )
 541                     {
 542                         $number_of_facets++;
 543                         if (   ( $number_of_facets < 6 )
 544                             || ( $expanded_facet eq $link_value )
 545                             || ( $facets_info->{$link_value}->{'expanded'} ) )
 546                         {
 547
 548                       # Sanitize the link value ), ( will cause errors with CCL,
 549                             my $facet_link_value = $one_facet;
 550                             $facet_link_value =~ s/(\(|\))/ /g;
 551
 552                             # fix the length that will display in the label,
 553                             my $facet_label_value = $one_facet;
 554                             $facet_label_value =
 555                               substr( $one_facet, 0, 20 ) . "..."
 556                               unless length($facet_label_value) <= 20;
 557
 558                             # if it's a branch, label by the name, not the code,
 559                             if ( $link_value =~ /branch/ ) {
 560                                 $facet_label_value =
 561                                   $branches->{$one_facet}->{'branchname'};
 562                             }
 563
 564                 # but we're down with the whole label being in the link's title.
 565                             my $facet_title_value = $one_facet;
 566
 567                             push @this_facets_array,
 568                               (
 569                                 {
 570                                     facet_count =>
 571                                       $facets_counter->{$link_value}
 572                                       ->{$one_facet},
 573                                     facet_label_value => $facet_label_value,
 574                                     facet_title_value => $facet_title_value,
 575                                     facet_link_value  => $facet_link_value,
 576                                     type_link_value   => $link_value,
 577                                 },
 578                               );
 579                         }
 580                     }
 581
 582                     # handle expanded option
 583                     unless ( $facets_info->{$link_value}->{'expanded'} ) {
 584                         $expandable = 1
 585                           if ( ( $number_of_facets > 6 )
 586                             && ( $expanded_facet ne $link_value ) );
 587                     }
 588                     push @facets_loop,
 589                       (
 590                         {
 591                             type_link_value => $link_value,
 592                             type_id         => $link_value . "_id",
 593                             "type_label_" . $facets_info->{$link_value}->{'label_value'} => 1,
 594                             facets     => \@this_facets_array,
 595                             expandable => $expandable,
 596                             expand     => $link_value,
 597                         }
 598                       ) unless ( ($facets_info->{$link_value}->{'label_value'} =~ /Libraries/) and (C4::Context->preference('singleBranchMode')) );
 599                 }
 600             }
 601         }
 602     }
 603     return ( undef, $results_hashref, \@facets_loop );
 604 }
 605
 606 sub pazGetRecords {
 607     my (
 608         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 609         $results_per_page, $offset,       $expanded_facet, $branches,
 610         $query_type,       $scan
 611     ) = @_;
 612
 613     my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
 614     $paz->init();
 615     $paz->search($simple_query);
 616     sleep 1;   # FIXME: WHY?
 617
 618     # do results
 619     my $results_hashref = {};
 620     my $stats = XMLin($paz->stat);
 621     my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
 622
 623     # for a grouped search result, the number of hits
 624     # is the number of groups returned; 'bib_hits' will have
 625     # the total number of bibs.
 626     $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
 627     $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
 628
 629     HIT: foreach my $hit (@{ $results->{'hit'} }) {
 630         my $recid = $hit->{recid}->[0];
 631
 632         my $work_title = $hit->{'md-work-title'}->[0];
 633         my $work_author;
 634         if (exists $hit->{'md-work-author'}) {
 635             $work_author = $hit->{'md-work-author'}->[0];
 636         }
 637         my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
 638
 639         my $result_group = {};
 640         $result_group->{'group_label'} = $group_label;
 641         $result_group->{'group_merge_key'} = $recid;
 642
 643         my $count = 1;
 644         if (exists $hit->{count}) {
 645             $count = $hit->{count}->[0];
 646         }
 647         $result_group->{'group_count'} = $count;
 648
 649         for (my $i = 0; $i < $count; $i++) {
 650             # FIXME -- may need to worry about diacritics here
 651             my $rec = $paz->record($recid, $i);
 652             push @{ $result_group->{'RECORDS'} }, $rec;
 653         }
 654
 655         push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
 656     }
 657
 658     # pass through facets
 659     my $termlist_xml = $paz->termlist('author,subject');
 660     my $terms = XMLin($termlist_xml, forcearray => 1);
 661     my @facets_loop = ();
 662     #die Dumper($results);
 663 #    foreach my $list (sort keys %{ $terms->{'list'} }) {
 664 #        my @facets = ();
 665 #        foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
 666 #            push @facets, {
 667 #                facet_label_value => $facet->{'name'}->[0],
 668 #            };
 669 #        }
 670 #        push @facets_loop, ( {
 671 #            type_label => $list,
 672 #            facets => \@facets,
 673 #        } );
 674 #    }
 675
 676     return ( undef, $results_hashref, \@facets_loop );
 677 }
 678
 679 # STOPWORDS
 680 sub _remove_stopwords {
 681     my ( $operand, $index ) = @_;
 682     my @stopwords_removed;
 683
 684     # phrase and exact-qualified indexes shouldn't have stopwords removed
 685     if ( $index !~ m/phr|ext/ ) {
 686
 687 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
 688 #       we use IsAlpha unicode definition, to deal correctly with diacritics.
 689 #       otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
 690 #       is a stopword, we'd get "çon" and wouldn't find anything...
 691         foreach ( keys %{ C4::Context->stopwords } ) {
 692             next if ( $_ =~ /(and|or|not)/ );    # don't remove operators
 693             if ( $operand =~
 694                 /(\P{IsAlpha}$_\P{IsAlpha}|^$_\P{IsAlpha}|\P{IsAlpha}$_$|^$_$)/ )
 695             {
 696                 $operand =~ s/\P{IsAlpha}$_\P{IsAlpha}/ /gi;
 697                 $operand =~ s/^$_\P{IsAlpha}/ /gi;
 698                 $operand =~ s/\P{IsAlpha}$_$/ /gi;
 699                                 $operand =~ s/$1//gi;
 700                 push @stopwords_removed, $_;
 701             }
 702         }
 703     }
 704     return ( $operand, \@stopwords_removed );
 705 }
 706
 707 # TRUNCATION
 708 sub _detect_truncation {
 709     my ( $operand, $index ) = @_;
 710     my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
 711         @regexpr );
 712     $operand =~ s/^ //g;
 713     my @wordlist = split( /\s/, $operand );
 714     foreach my $word (@wordlist) {
 715         if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
 716             push @rightlefttruncated, $word;
 717         }
 718         elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
 719             push @lefttruncated, $word;
 720         }
 721         elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
 722             push @righttruncated, $word;
 723         }
 724         elsif ( index( $word, "*" ) < 0 ) {
 725             push @nontruncated, $word;
 726         }
 727         else {
 728             push @regexpr, $word;
 729         }
 730     }
 731     return (
 732         \@nontruncated,       \@righttruncated, \@lefttruncated,
 733         \@rightlefttruncated, \@regexpr
 734     );
 735 }
 736
 737 # STEMMING
 738 sub _build_stemmed_operand {
 739     my ($operand) = @_;
 740     my $stemmed_operand;
 741
 742     # If operand contains a digit, it is almost certainly an identifier, and should
 743     # not be stemmed.  This is particularly relevant for ISBNs and ISSNs, which
 744     # can contain the letter "X" - for example, _build_stemmend_operand would reduce
 745     # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
 746     # results (e.g., "23 x 29 cm." from the 300$c).  Bug 2098.
 747     return $operand if $operand =~ /\d/;
 748
 749 # FIXME: the locale should be set based on the user's language and/or search choice
 750     my $stemmer = Lingua::Stem->new( -locale => 'EN-US' );
 751
 752 # FIXME: these should be stored in the db so the librarian can modify the behavior
 753     $stemmer->add_exceptions(
 754         {
 755             'and' => 'and',
 756             'or'  => 'or',
 757             'not' => 'not',
 758         }
 759     );
 760     my @words = split( / /, $operand );
 761     my $stems = $stemmer->stem(@words);
 762     for my $stem (@$stems) {
 763         $stemmed_operand .= "$stem";
 764         $stemmed_operand .= "?"
 765           unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 766         $stemmed_operand .= " ";
 767     }
 768     warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
 769     return $stemmed_operand;
 770 }
 771
 772 # FIELD WEIGHTING
 773 sub _build_weighted_query {
 774
 775 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
 776 # pretty well but could work much better if we had a smarter query parser
 777     my ( $operand, $stemmed_operand, $index ) = @_;
 778     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 779     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 780     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy")        || 0;
 781
 782     my $weighted_query .= "(rk=(";    # Specifies that we're applying rank
 783
 784     # Keyword, or, no index specified
 785     if ( ( $index eq 'kw' ) || ( !$index ) ) {
 786         $weighted_query .=
 787           "Title-cover,ext,r1=\"$operand\"";    # exact title-cover
 788         $weighted_query .= " or ti,ext,r2=\"$operand\"";    # exact title
 789         $weighted_query .= " or ti,phr,r3=\"$operand\"";    # phrase title
 790           #$weighted_query .= " or any,ext,r4=$operand";               # exact any
 791           #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
 792         $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
 793           if $fuzzy_enabled;    # add fuzzy, word list
 794         $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
 795           if ( $stemming and $stemmed_operand )
 796           ;                     # add stemming, right truncation
 797         $weighted_query .= " or wrdl,r9=\"$operand\"";
 798
 799         # embedded sorting: 0 a-z; 1 z-a
 800         # $weighted_query .= ") or (sort1,aut=1";
 801     }
 802
 803     # Barcode searches should skip this process
 804     elsif ( $index eq 'bc' ) {
 805         $weighted_query .= "bc=\"$operand\"";
 806     }
 807
 808     # Authority-number searches should skip this process
 809     elsif ( $index eq 'an' ) {
 810         $weighted_query .= "an=\"$operand\"";
 811     }
 812
 813     # If the index already has more than one qualifier, wrap the operand
 814     # in quotes and pass it back (assumption is that the user knows what they
 815     # are doing and won't appreciate us mucking up their query
 816     elsif ( $index =~ ',' ) {
 817         $weighted_query .= " $index=\"$operand\"";
 818     }
 819
 820     #TODO: build better cases based on specific search indexes
 821     else {
 822         $weighted_query .= " $index,ext,r1=\"$operand\"";    # exact index
 823           #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
 824         $weighted_query .= " or $index,phr,r3=\"$operand\"";    # phrase index
 825         $weighted_query .=
 826           " or $index,rt,wrdl,r3=\"$operand\"";    # word list index
 827     }
 828
 829     $weighted_query .= "))";                       # close rank specification
 830     return $weighted_query;
 831 }
 832
 833 =head2 buildQuery
 834
 835 ( $error, $query,
 836 $simple_query, $query_cgi,
 837 $query_desc, $limit,
 838 $limit_cgi, $limit_desc,
 839 $stopwords_removed, $query_type ) = getRecords ( $operators, $operands, $indexes, $limits, $sort_by, $scan);
 840
 841 Build queries and limits in CCL, CGI, Human,
 842 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
 843
 844 See verbose embedded documentation.
 845
 846
 847 =cut
 848
 849 sub buildQuery {
 850     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan ) = @_;
 851
 852     warn "---------\nEnter buildQuery\n---------" if $DEBUG;
 853
 854     # dereference
 855     my @operators = @$operators if $operators;
 856     my @indexes   = @$indexes   if $indexes;
 857     my @operands  = @$operands  if $operands;
 858     my @limits    = @$limits    if $limits;
 859     my @sort_by   = @$sort_by   if $sort_by;
 860
 861     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
 862     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
 863     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
 864     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
 865     my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
 866
 867     # no stemming/weight/fuzzy in NoZebra
 868     if ( C4::Context->preference("NoZebra") ) {
 869         $stemming      = 0;
 870         $weight_fields = 0;
 871         $fuzzy_enabled = 0;
 872     }
 873
 874     my $query        = $operands[0];
 875     my $simple_query = $operands[0];
 876
 877     # initialize the variables we're passing back
 878     my $query_cgi;
 879     my $query_desc;
 880     my $query_type;
 881
 882     my $limit;
 883     my $limit_cgi;
 884     my $limit_desc;
 885
 886     my $stopwords_removed;    # flag to determine if stopwords have been removed
 887
 888 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
 889 # DIAGNOSTIC ONLY!!
 890     if ( $query =~ /^ccl=/ ) {
 891         return ( undef, $', $', "q=ccl=$'", $', '', '', '', '', 'ccl' );
 892     }
 893     if ( $query =~ /^cql=/ ) {
 894         return ( undef, $', $', "q=cql=$'", $', '', '', '', '', 'cql' );
 895     }
 896     if ( $query =~ /^pqf=/ ) {
 897         return ( undef, $', $', "q=pqf=$'", $', '', '', '', '', 'pqf' );
 898     }
 899
 900     # pass nested queries directly
 901     # FIXME: need better handling of some of these variables in this case
 902     if ( $query =~ /(\(|\))/ ) {
 903         return (
 904             undef,              $query, $simple_query, $query_cgi,
 905             $query,             $limit, $limit_cgi,    $limit_desc,
 906             $stopwords_removed, 'ccl'
 907         );
 908     }
 909
 910 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
 911 # query operands and indexes and add stemming, truncation, field weighting, etc.
 912 # Once we do so, we'll end up with a value in $query, just like if we had an
 913 # incoming $query from the user
 914     else {
 915         $query = ""
 916           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
 917         my $previous_operand
 918           ;    # a flag used to keep track if there was a previous query
 919                # if there was, we can apply the current operator
 920                # for every operand
 921         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
 922
 923             # COMBINE OPERANDS, INDEXES AND OPERATORS
 924             if ( $operands[$i] ) {
 925
 926               # A flag to determine whether or not to add the index to the query
 927                 my $indexes_set;
 928
 929 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
 930                 if ( $operands[$i] =~ /(:|=)/ || $scan ) {
 931                     $weight_fields    = 0;
 932                     $stemming         = 0;
 933                     $remove_stopwords = 0;
 934                 }
 935                 my $operand = $operands[$i];
 936                 my $index   = $indexes[$i];
 937
 938                 # Add index-specific attributes
 939                 # Date of Publication
 940                 if ( $index eq 'yr' ) {
 941                     $index .= ",st-numeric";
 942                     $indexes_set++;
 943                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
 944                 }
 945
 946                 # Date of Acquisition
 947                 elsif ( $index eq 'acqdate' ) {
 948                     $index .= ",st-date-normalized";
 949                     $indexes_set++;
 950                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
 951                 }
 952                 # ISBN,ISSN,Standard Number, don't need special treatment
 953                 elsif ( $index eq 'nb' || $index eq 'ns' ) {
 954                     $indexes_set++;
 955                     (
 956                         $stemming,      $auto_truncation,
 957                         $weight_fields, $fuzzy_enabled,
 958                         $remove_stopwords
 959                     ) = ( 0, 0, 0, 0, 0 );
 960
 961                 }
 962                 # Set default structure attribute (word list)
 963                 my $struct_attr;
 964                 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl)/ ) {
 965                     $struct_attr = ",wrdl";
 966                 }
 967
 968                 # Some helpful index variants
 969                 my $index_plus       = $index . $struct_attr . ":" if $index;
 970                 my $index_plus_comma = $index . $struct_attr . "," if $index;
 971                 if ($auto_truncation){
 972 #                                       FIXME Auto Truncation is only valid for LTR languages
 973 #                                       use C4::Output;
 974 #                                       use C4::Languages qw(regex_lang_subtags get_bidi);
 975 #                               $lang = $query->cookie('KohaOpacLanguage') if (defined $query && $query->cookie('KohaOpacLanguage'));
 976 #                                   my $current_lang = regex_lang_subtags($lang);
 977 #                                   my $bidi;
 978 #                                   $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
 979                                         $index_plus_comma .= "rtrn:";
 980                                 }
 981
 982                 # Remove Stopwords
 983                 if ($remove_stopwords) {
 984                     ( $operand, $stopwords_removed ) =
 985                       _remove_stopwords( $operand, $index );
 986                     warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
 987                     warn "REMOVED STOPWORDS: @$stopwords_removed"
 988                       if ( $stopwords_removed && $DEBUG );
 989                 }
 990
 991                 # Detect Truncation
 992                 my $truncated_operand;
 993                 my( $nontruncated, $righttruncated, $lefttruncated,
 994                     $rightlefttruncated, $regexpr
 995                 ) = _detect_truncation( $operand, $index );
 996                 warn
 997 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
 998                   if $DEBUG;
 999
1000                 # Apply Truncation
1001                 if (
1002                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
1003                     scalar(@$rightlefttruncated) > 0 )
1004                 {
1005
1006                # Don't field weight or add the index to the query, we do it here
1007                     $indexes_set = 1;
1008                     undef $weight_fields;
1009                     my $previous_truncation_operand;
1010                     if ( scalar(@$nontruncated) > 0 ) {
1011                         $truncated_operand .= "$index_plus @$nontruncated ";
1012                         $previous_truncation_operand = 1;
1013                     }
1014                     if ( scalar(@$righttruncated) > 0 ) {
1015                         $truncated_operand .= "and "
1016                           if $previous_truncation_operand;
1017                         $truncated_operand .=
1018                           "$index_plus_comma" . "rtrn:@$righttruncated ";
1019                         $previous_truncation_operand = 1;
1020                     }
1021                     if ( scalar(@$lefttruncated) > 0 ) {
1022                         $truncated_operand .= "and "
1023                           if $previous_truncation_operand;
1024                         $truncated_operand .=
1025                           "$index_plus_comma" . "ltrn:@$lefttruncated ";
1026                         $previous_truncation_operand = 1;
1027                     }
1028                     if ( scalar(@$rightlefttruncated) > 0 ) {
1029                         $truncated_operand .= "and "
1030                           if $previous_truncation_operand;
1031                         $truncated_operand .=
1032                           "$index_plus_comma" . "rltrn:@$rightlefttruncated ";
1033                         $previous_truncation_operand = 1;
1034                     }
1035                 }
1036                 $operand = $truncated_operand if $truncated_operand;
1037                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1038
1039                 # Handle Stemming
1040                 my $stemmed_operand;
1041                 $stemmed_operand = _build_stemmed_operand($operand)
1042                   if $stemming;
1043                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1044
1045                 # Handle Field Weighting
1046                 my $weighted_operand;
1047                 $weighted_operand =
1048                   _build_weighted_query( $operand, $stemmed_operand, $index )
1049                   if $weight_fields;
1050                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1051                 $operand = $weighted_operand if $weight_fields;
1052                 $indexes_set = 1 if $weight_fields;
1053
1054                 # If there's a previous operand, we need to add an operator
1055                 if ($previous_operand) {
1056
1057                     # User-specified operator
1058                     if ( $operators[ $i - 1 ] ) {
1059                         $query     .= " $operators[$i-1] ";
1060                         $query     .= " $index_plus " unless $indexes_set;
1061                         $query     .= " $operand";
1062                         $query_cgi .= "&op=$operators[$i-1]";
1063                         $query_cgi .= "&idx=$index" if $index;
1064                         $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1065                         $query_desc .=
1066                           " $operators[$i-1] $index_plus $operands[$i]";
1067                     }
1068
1069                     # Default operator is and
1070                     else {
1071                         $query      .= " and ";
1072                         $query      .= "$index_plus " unless $indexes_set;
1073                         $query      .= "$operand";
1074                         $query_cgi  .= "&op=and&idx=$index" if $index;
1075                         $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1076                         $query_desc .= " and $index_plus $operands[$i]";
1077                     }
1078                 }
1079
1080                 # There isn't a pervious operand, don't need an operator
1081                 else {
1082
1083                     # Field-weighted queries already have indexes set
1084                     $query .= " $index_plus " unless $indexes_set;
1085                     $query .= $operand;
1086                     $query_desc .= " $index_plus $operands[$i]";
1087                     $query_cgi  .= "&idx=$index" if $index;
1088                     $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1089                     $previous_operand = 1;
1090                 }
1091             }    #/if $operands
1092         }    # /for
1093     }
1094     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1095
1096     # add limits
1097     my $group_OR_limits;
1098     my $availability_limit;
1099     foreach my $this_limit (@limits) {
1100         if ( $this_limit =~ /available/ ) {
1101
1102 # 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1103 # In English:
1104 # all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1105             $availability_limit .=
1106 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1107             $limit_cgi  .= "&limit=available";
1108             $limit_desc .= "";
1109         }
1110
1111         # group_OR_limits, prefixed by mc-
1112         # OR every member of the group
1113         elsif ( $this_limit =~ /mc/ ) {
1114             $group_OR_limits .= " or " if $group_OR_limits;
1115             $limit_desc      .= " or " if $group_OR_limits;
1116             $group_OR_limits .= "$this_limit";
1117             $limit_cgi       .= "&limit=$this_limit";
1118             $limit_desc      .= " $this_limit";
1119         }
1120
1121         # Regular old limits
1122         else {
1123             $limit .= " and " if $limit || $query;
1124             $limit      .= "$this_limit";
1125             $limit_cgi  .= "&limit=$this_limit";
1126             if ($this_limit =~ /^branch:(.+)/) {
1127                 my $branchcode = $1;
1128                 my $branchname = GetBranchName($branchcode);
1129                 if (defined $branchname) {
1130                     $limit_desc .= " branch:$branchname";
1131                 } else {
1132                     $limit_desc .= " $this_limit";
1133                 }
1134             } else {
1135                 $limit_desc .= " $this_limit";
1136             }
1137         }
1138     }
1139     if ($group_OR_limits) {
1140         $limit .= " and " if ( $query || $limit );
1141         $limit .= "($group_OR_limits)";
1142     }
1143     if ($availability_limit) {
1144         $limit .= " and " if ( $query || $limit );
1145         $limit .= "($availability_limit)";
1146     }
1147
1148     # Normalize the query and limit strings
1149     $query =~ s/:/=/g;
1150     $limit =~ s/:/=/g;
1151     for ( $query, $query_desc, $limit, $limit_desc ) {
1152         $_ =~ s/  / /g;    # remove extra spaces
1153         $_ =~ s/^ //g;     # remove any beginning spaces
1154         $_ =~ s/ $//g;     # remove any ending spaces
1155         $_ =~ s/==/=/g;    # remove double == from query
1156     }
1157     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1158
1159     for ($query_cgi,$simple_query) {
1160         $_ =~ s/"//g;
1161     }
1162     # append the limit to the query
1163     $query .= " " . $limit;
1164
1165     # Warnings if DEBUG
1166     if ($DEBUG) {
1167         warn "QUERY:" . $query;
1168         warn "QUERY CGI:" . $query_cgi;
1169         warn "QUERY DESC:" . $query_desc;
1170         warn "LIMIT:" . $limit;
1171         warn "LIMIT CGI:" . $limit_cgi;
1172         warn "LIMIT DESC:" . $limit_desc;
1173         warn "---------\nLeave buildQuery\n---------";
1174     }
1175     return (
1176         undef,              $query, $simple_query, $query_cgi,
1177         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1178         $stopwords_removed, $query_type
1179     );
1180 }
1181
1182 =head2 searchResults
1183
1184 Format results in a form suitable for passing to the template
1185
1186 =cut
1187
1188 # IMO this subroutine is pretty messy still -- it's responsible for
1189 # building the HTML output for the template
1190 sub searchResults {
1191     my ( $searchdesc, $hits, $results_per_page, $offset, $scan, @marcresults ) = @_;
1192     my $dbh = C4::Context->dbh;
1193     my $even = 1;
1194     my @newresults;
1195
1196     # add search-term highlighting via <span>s on the search terms
1197     my $span_terms_hashref;
1198     for my $span_term ( split( / /, $searchdesc ) ) {
1199         $span_term =~ s/(.*=|\)|\(|\+|\.|\*)//g;
1200         $span_terms_hashref->{$span_term}++;
1201     }
1202
1203     #Build branchnames hash
1204     #find branchname
1205     #get branch information.....
1206     my %branches;
1207     my $bsth =
1208       $dbh->prepare("SELECT branchcode,branchname FROM branches")
1209       ;    # FIXME : use C4::Koha::GetBranches
1210     $bsth->execute();
1211     while ( my $bdata = $bsth->fetchrow_hashref ) {
1212         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1213     }
1214 # FIXME - We build an authorised values hash here, using the default framework
1215 # though it is possible to have different authvals for different fws.
1216
1217     my $shelflocations =GetKohaAuthorisedValues('items.location','');
1218
1219     # get notforloan authorised value list (see $shelflocations  FIXME)
1220     my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1221
1222     #Build itemtype hash
1223     #find itemtype & itemtype image
1224     my %itemtypes;
1225     $bsth =
1226       $dbh->prepare(
1227         "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1228       );
1229     $bsth->execute();
1230     while ( my $bdata = $bsth->fetchrow_hashref ) {
1231                 foreach (qw(description imageurl summary notforloan)) {
1232                 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1233                 }
1234     }
1235
1236     #search item field code
1237     my $sth =
1238       $dbh->prepare(
1239 "SELECT tagfield FROM marc_subfield_structure WHERE kohafield LIKE 'items.itemnumber'"
1240       );
1241     $sth->execute;
1242     my ($itemtag) = $sth->fetchrow;
1243
1244     ## find column names of items related to MARC
1245     my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1246     $sth2->execute;
1247     my %subfieldstosearch;
1248     while ( ( my $column ) = $sth2->fetchrow ) {
1249         my ( $tagfield, $tagsubfield ) =
1250           &GetMarcFromKohaField( "items." . $column, "" );
1251         $subfieldstosearch{$column} = $tagsubfield;
1252     }
1253
1254     # handle which records to actually retrieve
1255     my $times;
1256     if ( $hits && $offset + $results_per_page <= $hits ) {
1257         $times = $offset + $results_per_page;
1258     }
1259     else {
1260         $times = $hits;  # FIXME: if $hits is undefined, why do we want to equal it?
1261     }
1262
1263         my $marcflavour = C4::Context->preference("marcflavour");
1264     # loop through all of the records we've retrieved
1265     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1266         my $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
1267         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, '' );
1268         $oldbiblio->{subtitle} = C4::Biblio::get_koha_field_from_marc('bibliosubtitle', 'subtitle', $marcrecord, '');
1269         $oldbiblio->{result_number} = $i + 1;
1270
1271         # add imageurl to itemtype if there is one
1272         $oldbiblio->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1273
1274         $oldbiblio->{'authorised_value_images'}  = C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{'biblionumber'}, $marcrecord ) );
1275                 $oldbiblio->{normalized_upc} = GetNormalizedUPC($marcrecord,$marcflavour);
1276                 $oldbiblio->{normalized_ean} = GetNormalizedEAN($marcrecord,$marcflavour);
1277                 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1278                 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1279                 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1280                 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1281  # Build summary if there is one (the summary is defined in the itemtypes table)
1282  # FIXME: is this used anywhere, I think it can be commented out? -- JF
1283         if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1284             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1285             my @fields  = $marcrecord->fields();
1286             foreach my $field (@fields) {
1287                 my $tag      = $field->tag();
1288                 my $tagvalue = $field->as_string();
1289                 $summary =~
1290                   s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
1291                 unless ( $tag < 10 ) {
1292                     my @subf = $field->subfields;
1293                     for my $i ( 0 .. $#subf ) {
1294                         my $subfieldcode  = $subf[$i][0];
1295                         my $subfieldvalue = $subf[$i][1];
1296                         my $tagsubf       = $tag . $subfieldcode;
1297                         $summary =~
1298 s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
1299                     }
1300                 }
1301             }
1302             # FIXME: yuk
1303             $summary =~ s/\[(.*?)]//g;
1304             $summary =~ s/\n/<br\/>/g;
1305             $oldbiblio->{summary} = $summary;
1306         }
1307
1308         # save an author with no <span> tag, for the <a href=search.pl?q=<!--tmpl_var name="author"-->> link
1309         $oldbiblio->{'author_nospan'} = $oldbiblio->{'author'};
1310         $oldbiblio->{'title_nospan'} = $oldbiblio->{'title'};
1311         $oldbiblio->{'subtitle_nospan'} = $oldbiblio->{'subtitle'};
1312         # Add search-term highlighting to the whole record where they match using <span>s
1313         if (C4::Context->preference("OpacHighlightedWords")){
1314             my $searchhighlightblob;
1315             for my $highlight_field ( $marcrecord->fields ) {
1316
1317     # FIXME: need to skip title, subtitle, author, etc., as they are handled below
1318                 next if $highlight_field->tag() =~ /(^00)/;    # skip fixed fields
1319                 for my $subfield ($highlight_field->subfields()) {
1320                     my $match;
1321                     next if $subfield->[0] eq '9';
1322                     my $field = $subfield->[1];
1323                     for my $term ( keys %$span_terms_hashref ) {
1324                         if ( ( $field =~ /$term/i ) && (( length($term) > 3 ) || ($field =~ / $term /i)) ) {
1325                             $field =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1326                         $match++;
1327                         }
1328                     }
1329                     $searchhighlightblob .= $field . " ... " if $match;
1330                 }
1331
1332             }
1333             $searchhighlightblob = ' ... '.$searchhighlightblob if $searchhighlightblob;
1334             $oldbiblio->{'searchhighlightblob'} = $searchhighlightblob;
1335         }
1336
1337         # Add search-term highlighting to the title, subtitle, etc. fields
1338         for my $term ( keys %$span_terms_hashref ) {
1339             my $old_term = $term;
1340             if ( length($term) > 3 ) {
1341                 $term =~ s/(.*=|\)|\(|\+|\.|\?|\[|\]|\\|\*)//g;
1342                                 foreach(qw(title subtitle author publishercode place pages notes size)) {
1343                         $oldbiblio->{$_} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1344                                 }
1345             }
1346         }
1347
1348         ($i % 2) and $oldbiblio->{'toggle'} = 1;
1349
1350         # Pull out the items fields
1351         my @fields = $marcrecord->field($itemtag);
1352
1353         # Setting item statuses for display
1354         my @available_items_loop;
1355         my @onloan_items_loop;
1356         my @other_items_loop;
1357
1358         my $available_items;
1359         my $onloan_items;
1360         my $other_items;
1361
1362         my $ordered_count         = 0;
1363         my $available_count       = 0;
1364         my $onloan_count          = 0;
1365         my $longoverdue_count     = 0;
1366         my $other_count           = 0;
1367         my $wthdrawn_count        = 0;
1368         my $itemlost_count        = 0;
1369         my $itembinding_count     = 0;
1370         my $itemdamaged_count     = 0;
1371         my $item_in_transit_count = 0;
1372         my $can_place_holds       = 0;
1373         my $items_count           = scalar(@fields);
1374         my $maxitems =
1375           ( C4::Context->preference('maxItemsinSearchResults') )
1376           ? C4::Context->preference('maxItemsinSearchResults') - 1
1377           : 1;
1378
1379         # loop through every item
1380         foreach my $field (@fields) {
1381             my $item;
1382
1383             # populate the items hash
1384             foreach my $code ( keys %subfieldstosearch ) {
1385                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1386             }
1387                         my $hbranch     = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch'    : 'holdingbranch';
1388                         my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1389             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1390             if ($item->{$hbranch}) {
1391                 $item->{'branchname'} = $branches{$item->{$hbranch}};
1392             }
1393             elsif ($item->{$otherbranch}) {     # Last resort
1394                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1395             }
1396
1397                         my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1398 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1399             if ( $item->{onloan} ) {
1400                 $onloan_count++;
1401                                 my $key = $prefix . $item->{due_date};
1402                                 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1403                                 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1404                                 $onloan_items->{$key}->{branchname} = $item->{branchname};
1405                                 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1406                                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1407                                 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1408                 # if something's checked out and lost, mark it as 'long overdue'
1409                 if ( $item->{itemlost} ) {
1410                     $onloan_items->{$prefix}->{longoverdue}++;
1411                     $longoverdue_count++;
1412                 } else {        # can place holds as long as item isn't lost
1413                     $can_place_holds = 1;
1414                 }
1415             }
1416
1417          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1418             else {
1419
1420                 # item is on order
1421                 if ( $item->{notforloan} == -1 ) {
1422                     $ordered_count++;
1423                 }
1424
1425                 # is item in transit?
1426                 my $transfertwhen = '';
1427                 my ($transfertfrom, $transfertto);
1428
1429                 unless ($item->{wthdrawn}
1430                         || $item->{itemlost}
1431                         || $item->{damaged}
1432                         || $item->{notforloan}
1433                         || $items_count > 20) {
1434
1435                     # A couple heuristics to limit how many times
1436                     # we query the database for item transfer information, sacrificing
1437                     # accuracy in some cases for speed;
1438                     #
1439                     # 1. don't query if item has one of the other statuses
1440                     # 2. don't check transit status if the bib has
1441                     #    more than 20 items
1442                     #
1443                     # FIXME: to avoid having the query the database like this, and to make
1444                     #        the in transit status count as unavailable for search limiting,
1445                     #        should map transit status to record indexed in Zebra.
1446                     #
1447                     ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1448                 }
1449
1450                 # item is withdrawn, lost or damaged
1451                 if (   $item->{wthdrawn}
1452                     || $item->{itemlost}
1453                     || $item->{damaged}
1454                     || $item->{notforloan}
1455                     || ($transfertwhen ne ''))
1456                 {
1457                     $wthdrawn_count++        if $item->{wthdrawn};
1458                     $itemlost_count++        if $item->{itemlost};
1459                     $itemdamaged_count++     if $item->{damaged};
1460                     $item_in_transit_count++ if $transfertwhen ne '';
1461                     $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1462                     $other_count++;
1463
1464                                         my $key = $prefix . $item->{status};
1465                                         foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber)) {
1466                         $other_items->{$key}->{$_} = $item->{$_};
1467                                         }
1468                     $other_items->{$key}->{intransit} = ($transfertwhen ne '') ? 1 : 0;
1469                                         $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value;
1470                                         $other_items->{$key}->{count}++ if $item->{$hbranch};
1471                                         $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1472                                         $other_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1473                 }
1474                 # item is available
1475                 else {
1476                     $can_place_holds = 1;
1477                     $available_count++;
1478                                         $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1479                                         foreach (qw(branchname itemcallnumber)) {
1480                         $available_items->{$prefix}->{$_} = $item->{$_};
1481                                         }
1482                                         $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1483                                         $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1484                 }
1485             }
1486         }    # notforloan, item level and biblioitem level
1487         my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1488         $maxitems =
1489           ( C4::Context->preference('maxItemsinSearchResults') )
1490           ? C4::Context->preference('maxItemsinSearchResults') - 1
1491           : 1;
1492         for my $key ( sort keys %$onloan_items ) {
1493             (++$onloanitemscount > $maxitems) and last;
1494             push @onloan_items_loop, $onloan_items->{$key};
1495         }
1496         for my $key ( sort keys %$other_items ) {
1497             (++$otheritemscount > $maxitems) and last;
1498             push @other_items_loop, $other_items->{$key};
1499         }
1500         for my $key ( sort keys %$available_items ) {
1501             (++$availableitemscount > $maxitems) and last;
1502             push @available_items_loop, $available_items->{$key}
1503         }
1504
1505         # XSLT processing of some stuff
1506         if (C4::Context->preference("XSLTResultsDisplay") && !$scan) {
1507             $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display(
1508                 $oldbiblio->{biblionumber}, $marcrecord, 'Results' );
1509         }
1510
1511         # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1512         $can_place_holds = 0
1513           if $itemtypes{ $oldbiblio->{itemtype} }->{notforloan};
1514         $oldbiblio->{norequests} = 1 unless $can_place_holds;
1515         $oldbiblio->{itemsplural}          = 1 if $items_count > 1;
1516         $oldbiblio->{items_count}          = $items_count;
1517         $oldbiblio->{available_items_loop} = \@available_items_loop;
1518         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
1519         $oldbiblio->{other_items_loop}     = \@other_items_loop;
1520         $oldbiblio->{availablecount}       = $available_count;
1521         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
1522         $oldbiblio->{onloancount}          = $onloan_count;
1523         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
1524         $oldbiblio->{othercount}           = $other_count;
1525         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
1526         $oldbiblio->{wthdrawncount}        = $wthdrawn_count;
1527         $oldbiblio->{itemlostcount}        = $itemlost_count;
1528         $oldbiblio->{damagedcount}         = $itemdamaged_count;
1529         $oldbiblio->{intransitcount}       = $item_in_transit_count;
1530         $oldbiblio->{orderedcount}         = $ordered_count;
1531         push( @newresults, $oldbiblio );
1532     }
1533     return @newresults;
1534 }
1535
1536 #----------------------------------------------------------------------
1537 #
1538 # Non-Zebra GetRecords#
1539 #----------------------------------------------------------------------
1540
1541 =head2 NZgetRecords
1542
1543   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1544
1545 =cut
1546
1547 sub NZgetRecords {
1548     my (
1549         $query,            $simple_query, $sort_by_ref,    $servers_ref,
1550         $results_per_page, $offset,       $expanded_facet, $branches,
1551         $query_type,       $scan
1552     ) = @_;
1553     warn "query =$query" if $DEBUG;
1554     my $result = NZanalyse($query);
1555     warn "results =$result" if $DEBUG;
1556     return ( undef,
1557         NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1558         undef );
1559 }
1560
1561 =head2 NZanalyse
1562
1563   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1564   the list is built from an inverted index in the nozebra SQL table
1565   note that title is here only for convenience : the sorting will be very fast when requested on title
1566   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1567
1568 =cut
1569
1570 sub NZanalyse {
1571     my ( $string, $server ) = @_;
1572 #     warn "---------"       if $DEBUG;
1573     warn " NZanalyse" if $DEBUG;
1574 #     warn "---------"       if $DEBUG;
1575
1576  # $server contains biblioserver or authorities, depending on what we search on.
1577  #warn "querying : $string on $server";
1578     $server = 'biblioserver' unless $server;
1579
1580 # if we have a ", replace the content to discard temporarily any and/or/not inside
1581     my $commacontent;
1582     if ( $string =~ /"/ ) {
1583         $string =~ s/"(.*?)"/__X__/;
1584         $commacontent = $1;
1585         warn "commacontent : $commacontent" if $DEBUG;
1586     }
1587
1588 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1589 # then, call again NZanalyse with $left and $right
1590 # (recursive until we find a leaf (=> something without and/or/not)
1591 # delete repeated operator... Would then go in infinite loop
1592     while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
1593     }
1594
1595     #process parenthesis before.
1596     if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
1597         my $left     = $1;
1598         my $right    = $4;
1599         my $operator = lc($3);   # FIXME: and/or/not are operators, not operands
1600         warn
1601 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
1602           if $DEBUG;
1603         my $leftresult = NZanalyse( $left, $server );
1604         if ($operator) {
1605             my $rightresult = NZanalyse( $right, $server );
1606
1607             # OK, we have the results for right and left part of the query
1608             # depending of operand, intersect, union or exclude both lists
1609             # to get a result list
1610             if ( $operator eq ' and ' ) {
1611                 return NZoperatorAND($leftresult,$rightresult);
1612             }
1613             elsif ( $operator eq ' or ' ) {
1614
1615                 # just merge the 2 strings
1616                 return $leftresult . $rightresult;
1617             }
1618             elsif ( $operator eq ' not ' ) {
1619                 return NZoperatorNOT($leftresult,$rightresult);
1620             }
1621         }
1622         else {
1623 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1624             return $leftresult;
1625         }
1626     }
1627     warn "string :" . $string if $DEBUG;
1628     my $left = "";
1629     my $right = "";
1630     my $operator = "";
1631     if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
1632         $left     = $1;
1633         $right    = $3;
1634         $operator = lc($2);    # FIXME: and/or/not are operators, not operands
1635     }
1636     warn "no parenthesis. left : $left operator: $operator right: $right"
1637       if $DEBUG;
1638
1639     # it's not a leaf, we have a and/or/not
1640     if ($operator) {
1641
1642         # reintroduce comma content if needed
1643         $right =~ s/__X__/"$commacontent"/ if $commacontent;
1644         $left  =~ s/__X__/"$commacontent"/ if $commacontent;
1645         warn "node : $left / $operator / $right\n" if $DEBUG;
1646         my $leftresult  = NZanalyse( $left,  $server );
1647         my $rightresult = NZanalyse( $right, $server );
1648         warn " leftresult : $leftresult" if $DEBUG;
1649         warn " rightresult : $rightresult" if $DEBUG;
1650         # OK, we have the results for right and left part of the query
1651         # depending of operand, intersect, union or exclude both lists
1652         # to get a result list
1653         if ( $operator eq ' and ' ) {
1654             warn "NZAND";
1655             return NZoperatorAND($leftresult,$rightresult);
1656         }
1657         elsif ( $operator eq ' or ' ) {
1658
1659             # just merge the 2 strings
1660             return $leftresult . $rightresult;
1661         }
1662         elsif ( $operator eq ' not ' ) {
1663             return NZoperatorNOT($leftresult,$rightresult);
1664         }
1665         else {
1666
1667 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1668             die "error : operand unknown : $operator for $string";
1669         }
1670
1671         # it's a leaf, do the real SQL query and return the result
1672     }
1673     else {
1674         $string =~ s/__X__/"$commacontent"/ if $commacontent;
1675         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1676         #remove trailing blank at the beginning
1677         $string =~ s/^ //g;
1678         warn "leaf:$string" if $DEBUG;
1679
1680         # parse the string in in operator/operand/value again
1681         my $left = "";
1682         my $operator = "";
1683         my $right = "";
1684         if ($string =~ /(.*)(>=|<=)(.*)/) {
1685             $left     = $1;
1686             $operator = $2;
1687             $right    = $3;
1688         } else {
1689             $left = $string;
1690         }
1691 #         warn "handling leaf... left:$left operator:$operator right:$right"
1692 #           if $DEBUG;
1693         unless ($operator) {
1694             if ($string =~ /(.*)(>|<|=)(.*)/) {
1695                 $left     = $1;
1696                 $operator = $2;
1697                 $right    = $3;
1698                 warn
1699     "handling unless (operator)... left:$left operator:$operator right:$right"
1700                 if $DEBUG;
1701             } else {
1702                 $left = $string;
1703             }
1704         }
1705         my $results;
1706
1707 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
1708         $left =~ s/ .*$//;
1709
1710         # automatic replace for short operators
1711         $left = 'title'            if $left =~ '^ti$';
1712         $left = 'author'           if $left =~ '^au$';
1713         $left = 'publisher'        if $left =~ '^pb$';
1714         $left = 'subject'          if $left =~ '^su$';
1715         $left = 'koha-Auth-Number' if $left =~ '^an$';
1716         $left = 'keyword'          if $left =~ '^kw$';
1717         warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
1718         if ( $operator && $left ne 'keyword' ) {
1719
1720             #do a specific search
1721             my $dbh = C4::Context->dbh;
1722             $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
1723             my $sth =
1724               $dbh->prepare(
1725 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
1726               );
1727             warn "$left / $operator / $right\n" if $DEBUG;
1728
1729             # split each word, query the DB and build the biblionumbers result
1730             #sanitizing leftpart
1731             $left =~ s/^\s+|\s+$//;
1732             foreach ( split / /, $right ) {
1733                 my $biblionumbers;
1734                 $_ =~ s/^\s+|\s+$//;
1735                 next unless $_;
1736                 warn "EXECUTE : $server, $left, $_" if $DEBUG;
1737                 $sth->execute( $server, $left, $_ )
1738                   or warn "execute failed: $!";
1739                 while ( my ( $line, $value ) = $sth->fetchrow ) {
1740
1741 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1742 # otherwise, fill the result
1743                     $biblionumbers .= $line
1744                       unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
1745                     warn "result : $value "
1746                       . ( $right  =~ /\d/ ) . "=="
1747                       . ( $value =~ /\D/?$line:"" ) if $DEBUG;         #= $line";
1748                 }
1749
1750 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1751                 if ($results) {
1752                     warn "NZAND" if $DEBUG;
1753                     $results = NZoperatorAND($biblionumbers,$results);
1754                 }
1755                 else {
1756                     $results = $biblionumbers;
1757                 }
1758             }
1759         }
1760         else {
1761
1762       #do a complete search (all indexes), if index='kw' do complete search too.
1763             my $dbh = C4::Context->dbh;
1764             my $sth =
1765               $dbh->prepare(
1766 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
1767               );
1768
1769             # split each word, query the DB and build the biblionumbers result
1770             foreach ( split / /, $string ) {
1771                 next if C4::Context->stopwords->{ uc($_) };   # skip if stopword
1772                 warn "search on all indexes on $_" if $DEBUG;
1773                 my $biblionumbers;
1774                 next unless $_;
1775                 $sth->execute( $server, $_ );
1776                 while ( my $line = $sth->fetchrow ) {
1777                     $biblionumbers .= $line;
1778                 }
1779
1780 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1781                 if ($results) {
1782                     $results = NZoperatorAND($biblionumbers,$results);
1783                 }
1784                 else {
1785                     warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
1786                     $results = $biblionumbers;
1787                 }
1788             }
1789         }
1790         warn "return : $results for LEAF : $string" if $DEBUG;
1791         return $results;
1792     }
1793     warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
1794 }
1795
1796 sub NZoperatorAND{
1797     my ($rightresult, $leftresult)=@_;
1798
1799     my @leftresult = split /;/, $leftresult;
1800     warn " @leftresult / $rightresult \n" if $DEBUG;
1801
1802     #             my @rightresult = split /;/,$leftresult;
1803     my $finalresult;
1804
1805 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1806 # the result is stored twice, to have the same weight for AND than OR.
1807 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1808 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1809     foreach (@leftresult) {
1810         my $value = $_;
1811         my $countvalue;
1812         ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
1813         if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
1814             $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
1815             $finalresult .=
1816                 "$value-$countvalue;$value-$countvalue;";
1817         }
1818     }
1819     warn "NZAND DONE : $finalresult \n" if $DEBUG;
1820     return $finalresult;
1821 }
1822
1823 sub NZoperatorOR{
1824     my ($rightresult, $leftresult)=@_;
1825     return $rightresult.$leftresult;
1826 }
1827
1828 sub NZoperatorNOT{
1829     my ($leftresult, $rightresult)=@_;
1830
1831     my @leftresult = split /;/, $leftresult;
1832
1833     #             my @rightresult = split /;/,$leftresult;
1834     my $finalresult;
1835     foreach (@leftresult) {
1836         my $value=$_;
1837         $value=$1 if $value=~m/(.*)-\d+$/;
1838         unless ($rightresult =~ "$value-") {
1839             $finalresult .= "$_;";
1840         }
1841     }
1842     return $finalresult;
1843 }
1844
1845 =head2 NZorder
1846
1847   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1848
1849   TODO :: Description
1850
1851 =cut
1852
1853 sub NZorder {
1854     my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
1855     warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
1856
1857     # order title asc by default
1858     #     $ordering = '1=36 <i' unless $ordering;
1859     $results_per_page = 20 unless $results_per_page;
1860     $offset           = 0  unless $offset;
1861     my $dbh = C4::Context->dbh;
1862
1863     #
1864     # order by POPULARITY
1865     #
1866     if ( $ordering =~ /popularity/ ) {
1867         my %result;
1868         my %popularity;
1869
1870         # popularity is not in MARC record, it's builded from a specific query
1871         my $sth =
1872           $dbh->prepare("select sum(issues) from items where biblionumber=?");
1873         foreach ( split /;/, $biblionumbers ) {
1874             my ( $biblionumber, $title ) = split /,/, $_;
1875             $result{$biblionumber} = GetMarcBiblio($biblionumber);
1876             $sth->execute($biblionumber);
1877             my $popularity = $sth->fetchrow || 0;
1878
1879 # hint : the key is popularity.title because we can have
1880 # many results with the same popularity. In this cas, sub-ordering is done by title
1881 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1882 # (un-frequent, I agree, but we won't forget anything that way ;-)
1883             $popularity{ sprintf( "%10d", $popularity ) . $title
1884                   . $biblionumber } = $biblionumber;
1885         }
1886
1887     # sort the hash and return the same structure as GetRecords (Zebra querying)
1888         my $result_hash;
1889         my $numbers = 0;
1890         if ( $ordering eq 'popularity_dsc' ) {    # sort popularity DESC
1891             foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
1892                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1893                   $result{ $popularity{$key} }->as_usmarc();
1894             }
1895         }
1896         else {                                    # sort popularity ASC
1897             foreach my $key ( sort ( keys %popularity ) ) {
1898                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1899                   $result{ $popularity{$key} }->as_usmarc();
1900             }
1901         }
1902         my $finalresult = ();
1903         $result_hash->{'hits'}         = $numbers;
1904         $finalresult->{'biblioserver'} = $result_hash;
1905         return $finalresult;
1906
1907         #
1908         # ORDER BY author
1909         #
1910     }
1911     elsif ( $ordering =~ /author/ ) {
1912         my %result;
1913         foreach ( split /;/, $biblionumbers ) {
1914             my ( $biblionumber, $title ) = split /,/, $_;
1915             my $record = GetMarcBiblio($biblionumber);
1916             my $author;
1917             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1918                 $author = $record->subfield( '200', 'f' );
1919                 $author = $record->subfield( '700', 'a' ) unless $author;
1920             }
1921             else {
1922                 $author = $record->subfield( '100', 'a' );
1923             }
1924
1925 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1926 # and we don't want to get only 1 result for each of them !!!
1927             $result{ $author . $biblionumber } = $record;
1928         }
1929
1930     # sort the hash and return the same structure as GetRecords (Zebra querying)
1931         my $result_hash;
1932         my $numbers = 0;
1933         if ( $ordering eq 'author_za' ) {    # sort by author desc
1934             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1935                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1936                   $result{$key}->as_usmarc();
1937             }
1938         }
1939         else {                               # sort by author ASC
1940             foreach my $key ( sort ( keys %result ) ) {
1941                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1942                   $result{$key}->as_usmarc();
1943             }
1944         }
1945         my $finalresult = ();
1946         $result_hash->{'hits'}         = $numbers;
1947         $finalresult->{'biblioserver'} = $result_hash;
1948         return $finalresult;
1949
1950         #
1951         # ORDER BY callnumber
1952         #
1953     }
1954     elsif ( $ordering =~ /callnumber/ ) {
1955         my %result;
1956         foreach ( split /;/, $biblionumbers ) {
1957             my ( $biblionumber, $title ) = split /,/, $_;
1958             my $record = GetMarcBiblio($biblionumber);
1959             my $callnumber;
1960             my $frameworkcode = GetFrameworkCode($biblionumber);
1961             my ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField(  'items.itemcallnumber', $frameworkcode);
1962                ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField('biblioitems.callnumber', $frameworkcode)
1963                 unless $callnumber_tag;
1964             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1965                 $callnumber = $record->subfield( '200', 'f' );
1966             } else {
1967                 $callnumber = $record->subfield( '100', 'a' );
1968             }
1969
1970 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1971 # and we don't want to get only 1 result for each of them !!!
1972             $result{ $callnumber . $biblionumber } = $record;
1973         }
1974
1975     # sort the hash and return the same structure as GetRecords (Zebra querying)
1976         my $result_hash;
1977         my $numbers = 0;
1978         if ( $ordering eq 'call_number_dsc' ) {    # sort by title desc
1979             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1980                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1981                   $result{$key}->as_usmarc();
1982             }
1983         }
1984         else {                                     # sort by title ASC
1985             foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
1986                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1987                   $result{$key}->as_usmarc();
1988             }
1989         }
1990         my $finalresult = ();
1991         $result_hash->{'hits'}         = $numbers;
1992         $finalresult->{'biblioserver'} = $result_hash;
1993         return $finalresult;
1994     }
1995     elsif ( $ordering =~ /pubdate/ ) {             #pub year
1996         my %result;
1997         foreach ( split /;/, $biblionumbers ) {
1998             my ( $biblionumber, $title ) = split /,/, $_;
1999             my $record = GetMarcBiblio($biblionumber);
2000             my ( $publicationyear_tag, $publicationyear_subfield ) =
2001               GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
2002             my $publicationyear =
2003               $record->subfield( $publicationyear_tag,
2004                 $publicationyear_subfield );
2005
2006 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2007 # and we don't want to get only 1 result for each of them !!!
2008             $result{ $publicationyear . $biblionumber } = $record;
2009         }
2010
2011     # sort the hash and return the same structure as GetRecords (Zebra querying)
2012         my $result_hash;
2013         my $numbers = 0;
2014         if ( $ordering eq 'pubdate_dsc' ) {    # sort by pubyear desc
2015             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2016                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2017                   $result{$key}->as_usmarc();
2018             }
2019         }
2020         else {                                 # sort by pub year ASC
2021             foreach my $key ( sort ( keys %result ) ) {
2022                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2023                   $result{$key}->as_usmarc();
2024             }
2025         }
2026         my $finalresult = ();
2027         $result_hash->{'hits'}         = $numbers;
2028         $finalresult->{'biblioserver'} = $result_hash;
2029         return $finalresult;
2030
2031         #
2032         # ORDER BY title
2033         #
2034     }
2035     elsif ( $ordering =~ /title/ ) {
2036
2037 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
2038         my %result;
2039         foreach ( split /;/, $biblionumbers ) {
2040             my ( $biblionumber, $title ) = split /,/, $_;
2041
2042 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2043 # and we don't want to get only 1 result for each of them !!!
2044 # hint & speed improvement : we can order without reading the record
2045 # so order, and read records only for the requested page !
2046             $result{ $title . $biblionumber } = $biblionumber;
2047         }
2048
2049     # sort the hash and return the same structure as GetRecords (Zebra querying)
2050         my $result_hash;
2051         my $numbers = 0;
2052         if ( $ordering eq 'title_az' ) {    # sort by title desc
2053             foreach my $key ( sort ( keys %result ) ) {
2054                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2055             }
2056         }
2057         else {                              # sort by title ASC
2058             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2059                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2060             }
2061         }
2062
2063         # limit the $results_per_page to result size if it's more
2064         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2065
2066         # for the requested page, replace biblionumber by the complete record
2067         # speed improvement : avoid reading too much things
2068         for (
2069             my $counter = $offset ;
2070             $counter <= $offset + $results_per_page ;
2071             $counter++
2072           )
2073         {
2074             $result_hash->{'RECORDS'}[$counter] =
2075               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2076         }
2077         my $finalresult = ();
2078         $result_hash->{'hits'}         = $numbers;
2079         $finalresult->{'biblioserver'} = $result_hash;
2080         return $finalresult;
2081     }
2082     else {
2083
2084 #
2085 # order by ranking
2086 #
2087 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2088         my %result;
2089         my %count_ranking;
2090         foreach ( split /;/, $biblionumbers ) {
2091             my ( $biblionumber, $title ) = split /,/, $_;
2092             $title =~ /(.*)-(\d)/;
2093
2094             # get weight
2095             my $ranking = $2;
2096
2097 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2098 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2099 # biblio N has ranking = 6
2100             $count_ranking{$biblionumber} += $ranking;
2101         }
2102
2103 # build the result by "inverting" the count_ranking hash
2104 # 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
2105 #         warn "counting";
2106         foreach ( keys %count_ranking ) {
2107             $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2108         }
2109
2110     # sort the hash and return the same structure as GetRecords (Zebra querying)
2111         my $result_hash;
2112         my $numbers = 0;
2113         foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2114             $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2115         }
2116
2117         # limit the $results_per_page to result size if it's more
2118         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2119
2120         # for the requested page, replace biblionumber by the complete record
2121         # speed improvement : avoid reading too much things
2122         for (
2123             my $counter = $offset ;
2124             $counter <= $offset + $results_per_page ;
2125             $counter++
2126           )
2127         {
2128             $result_hash->{'RECORDS'}[$counter] =
2129               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2130               if $result_hash->{'RECORDS'}[$counter];
2131         }
2132         my $finalresult = ();
2133         $result_hash->{'hits'}         = $numbers;
2134         $finalresult->{'biblioserver'} = $result_hash;
2135         return $finalresult;
2136     }
2137 }
2138
2139 END { }    # module clean-up code here (global destructor)
2140
2141 1;
2142 __END__
2143
2144 =head1 AUTHOR
2145
2146 Koha Developement team <info@koha.org>
2147
2148 =cut