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