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 buildQuery
 776
 777 ( $error, $query,
 778 $simple_query, $query_cgi,
 779 $query_desc, $limit,
 780 $limit_cgi, $limit_desc,
 781 $stopwords_removed, $query_type ) = getRecords ( $operators, $operands, $indexes, $limits, $sort_by, $scan);
 782
 783 Build queries and limits in CCL, CGI, Human,
 784 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
 785
 786 See verbose embedded documentation.
 787
 788
 789 =cut
 790
 791 sub buildQuery {
 792     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan ) = @_;
 793
 794     warn "---------\nEnter buildQuery\n---------" if $DEBUG;
 795
 796     # dereference
 797     my @operators = $operators ? @$operators : ();
 798     my @indexes   = $indexes   ? @$indexes   : ();
 799     my @operands  = $operands  ? @$operands  : ();
 800     my @limits    = $limits    ? @$limits    : ();
 801     my @sort_by   = $sort_by   ? @$sort_by   : ();
 802
 803     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
 804     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
 805     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
 806     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
 807     my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
 808
 809     # no stemming/weight/fuzzy in NoZebra
 810     if ( C4::Context->preference("NoZebra") ) {
 811         $stemming      = 0;
 812         $weight_fields = 0;
 813         $fuzzy_enabled = 0;
 814     }
 815
 816     my $query        = $operands[0];
 817     my $simple_query = $operands[0];
 818
 819     # initialize the variables we're passing back
 820     my $query_cgi;
 821     my $query_desc;
 822     my $query_type;
 823
 824     my $limit;
 825     my $limit_cgi;
 826     my $limit_desc;
 827
 828     my $stopwords_removed;    # flag to determine if stopwords have been removed
 829
 830 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
 831 # DIAGNOSTIC ONLY!!
 832     if ( $query =~ /^ccl=/ ) {
 833         return ( undef, $', $', "q=ccl=$'", $', '', '', '', '', 'ccl' );
 834     }
 835     if ( $query =~ /^cql=/ ) {
 836         return ( undef, $', $', "q=cql=$'", $', '', '', '', '', 'cql' );
 837     }
 838     if ( $query =~ /^pqf=/ ) {
 839         return ( undef, $', $', "q=pqf=$'", $', '', '', '', '', 'pqf' );
 840     }
 841
 842     # pass nested queries directly
 843     # FIXME: need better handling of some of these variables in this case
 844     if ( $query =~ /(\(|\))/ ) {
 845         return (
 846             undef,              $query, $simple_query, $query_cgi,
 847             $query,             $limit, $limit_cgi,    $limit_desc,
 848             $stopwords_removed, 'ccl'
 849         );
 850     }
 851
 852 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
 853 # query operands and indexes and add stemming, truncation, field weighting, etc.
 854 # Once we do so, we'll end up with a value in $query, just like if we had an
 855 # incoming $query from the user
 856     else {
 857         $query = ""
 858           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
 859         my $previous_operand
 860           ;    # a flag used to keep track if there was a previous query
 861                # if there was, we can apply the current operator
 862                # for every operand
 863         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
 864
 865             # COMBINE OPERANDS, INDEXES AND OPERATORS
 866             if ( $operands[$i] ) {
 867
 868               # A flag to determine whether or not to add the index to the query
 869                 my $indexes_set;
 870
 871 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
 872                 if ( $operands[$i] =~ /(:|=)/ || $scan ) {
 873                     $weight_fields    = 0;
 874                     $stemming         = 0;
 875                     $remove_stopwords = 0;
 876                 }
 877                 my $operand = $operands[$i];
 878                 my $index   = $indexes[$i];
 879
 880                 # Add index-specific attributes
 881                 # Date of Publication
 882                 if ( $index eq 'yr' ) {
 883                     $index .= ",st-numeric";
 884 #                     $indexes_set++;
 885                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
 886                 }
 887
 888                 # Date of Acquisition
 889                 elsif ( $index eq 'acqdate' ) {
 890                     $index .= ",st-date-normalized";
 891 #                     $indexes_set++;
 892                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
 893                 }
 894                 # ISBN,ISSN,Standard Number, don't need special treatment
 895                 elsif ( $index eq 'nb' || $index eq 'ns' ) {
 896 #                     $indexes_set++;
 897                     (
 898                         $stemming,      $auto_truncation,
 899                         $weight_fields, $fuzzy_enabled,
 900                         $remove_stopwords
 901                     ) = ( 0, 0, 0, 0, 0 );
 902
 903                 }
 904                 # Set default structure attribute (word list)
 905                 my $struct_attr;
 906                 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl)/ ) {
 907                     $struct_attr = ",wrdl";
 908                 }
 909
 910                 # Some helpful index variants
 911                 my $index_plus       = $index . $struct_attr . ":" if $index;
 912                 my $index_plus_comma = $index . $struct_attr . "," if $index;
 913
 914                 # Remove Stopwords
 915                 if ($remove_stopwords) {
 916                     ( $operand, $stopwords_removed ) =
 917                       _remove_stopwords( $operand, $index );
 918                     warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
 919                     warn "REMOVED STOPWORDS: @$stopwords_removed"
 920                       if ( $stopwords_removed && $DEBUG );
 921                 }
 922
 923                 if ($auto_truncation){
 924                                         #FIXME only valid with LTR scripts
 925                                         $operand=join(" ",map{
 926                                                                                         "$_*"
 927                                                                              }split (/\s+/,$operand));
 928                         warn $operand if $DEBUG;
 929                                 }
 930
 931                 # Detect Truncation
 932                 my $truncated_operand;
 933                 my( $nontruncated, $righttruncated, $lefttruncated,
 934                     $rightlefttruncated, $regexpr
 935                 ) = _detect_truncation( $operand, $index );
 936                 warn
 937 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
 938                   if $DEBUG;
 939
 940                 # Apply Truncation
 941                 if (
 942                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
 943                     scalar(@$rightlefttruncated) > 0 )
 944                 {
 945
 946                # Don't field weight or add the index to the query, we do it here
 947                     $indexes_set = 1;
 948                     undef $weight_fields;
 949                     my $previous_truncation_operand;
 950                     if (scalar @$nontruncated) {
 951                         $truncated_operand .= "$index_plus @$nontruncated ";
 952                         $previous_truncation_operand = 1;
 953                     }
 954                     if (scalar @$righttruncated) {
 955                         $truncated_operand .= "and " if $previous_truncation_operand;
 956                         $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
 957                         $previous_truncation_operand = 1;
 958                     }
 959                     if (scalar @$lefttruncated) {
 960                         $truncated_operand .= "and " if $previous_truncation_operand;
 961                         $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
 962                         $previous_truncation_operand = 1;
 963                     }
 964                     if (scalar @$rightlefttruncated) {
 965                         $truncated_operand .= "and " if $previous_truncation_operand;
 966                         $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
 967                         $previous_truncation_operand = 1;
 968                     }
 969                 }
 970                 $operand = $truncated_operand if $truncated_operand;
 971                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
 972
 973                 # Handle Stemming
 974                 my $stemmed_operand;
 975                 $stemmed_operand = _build_stemmed_operand($operand) if $stemming;
 976
 977                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
 978
 979                 # Handle Field Weighting
 980                 my $weighted_operand;
 981                 if ($weight_fields) {
 982                     $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
 983                     $operand = $weighted_operand;
 984                     $indexes_set = 1;
 985                 }
 986
 987                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
 988
 989                 # If there's a previous operand, we need to add an operator
 990                 if ($previous_operand) {
 991
 992                     # User-specified operator
 993                     if ( $operators[ $i - 1 ] ) {
 994                         $query     .= " $operators[$i-1] ";
 995                         $query     .= " $index_plus " unless $indexes_set;
 996                         $query     .= " $operand";
 997                         $query_cgi .= "&op=$operators[$i-1]";
 998                         $query_cgi .= "&idx=$index" if $index;
 999                         $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1000                         $query_desc .=
1001                           " $operators[$i-1] $index_plus $operands[$i]";
1002                     }
1003
1004                     # Default operator is and
1005                     else {
1006                         $query      .= " and ";
1007                         $query      .= "$index_plus " unless $indexes_set;
1008                         $query      .= "$operand";
1009                         $query_cgi  .= "&op=and&idx=$index" if $index;
1010                         $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1011                         $query_desc .= " and $index_plus $operands[$i]";
1012                     }
1013                 }
1014
1015                 # There isn't a pervious operand, don't need an operator
1016                 else {
1017
1018                     # Field-weighted queries already have indexes set
1019                     $query .= " $index_plus " unless $indexes_set;
1020                     $query .= $operand;
1021                     $query_desc .= " $index_plus $operands[$i]";
1022                     $query_cgi  .= "&idx=$index" if $index;
1023                     $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1024                     $previous_operand = 1;
1025                 }
1026             }    #/if $operands
1027         }    # /for
1028     }
1029     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1030
1031     # add limits
1032     my $group_OR_limits;
1033     my $availability_limit;
1034     foreach my $this_limit (@limits) {
1035         if ( $this_limit =~ /available/ ) {
1036
1037 # 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1038 # In English:
1039 # all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1040             $availability_limit .=
1041 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1042             $limit_cgi  .= "&limit=available";
1043             $limit_desc .= "";
1044         }
1045
1046         # group_OR_limits, prefixed by mc-
1047         # OR every member of the group
1048         elsif ( $this_limit =~ /mc/ ) {
1049             $group_OR_limits .= " or " if $group_OR_limits;
1050             $limit_desc      .= " or " if $group_OR_limits;
1051             $group_OR_limits .= "$this_limit";
1052             $limit_cgi       .= "&limit=$this_limit";
1053             $limit_desc      .= " $this_limit";
1054         }
1055
1056         # Regular old limits
1057         else {
1058             $limit .= " and " if $limit || $query;
1059             $limit      .= "$this_limit";
1060             $limit_cgi  .= "&limit=$this_limit";
1061             if ($this_limit =~ /^branch:(.+)/) {
1062                 my $branchcode = $1;
1063                 my $branchname = GetBranchName($branchcode);
1064                 if (defined $branchname) {
1065                     $limit_desc .= " branch:$branchname";
1066                 } else {
1067                     $limit_desc .= " $this_limit";
1068                 }
1069             } else {
1070                 $limit_desc .= " $this_limit";
1071             }
1072         }
1073     }
1074     if ($group_OR_limits) {
1075         $limit .= " and " if ( $query || $limit );
1076         $limit .= "($group_OR_limits)";
1077     }
1078     if ($availability_limit) {
1079         $limit .= " and " if ( $query || $limit );
1080         $limit .= "($availability_limit)";
1081     }
1082
1083     # Normalize the query and limit strings
1084     $query =~ s/:/=/g;
1085     $limit =~ s/:/=/g;
1086     for ( $query, $query_desc, $limit, $limit_desc ) {
1087         s/  / /g;    # remove extra spaces
1088         s/^ //g;     # remove any beginning spaces
1089         s/ $//g;     # remove any ending spaces
1090         s/==/=/g;    # remove double == from query
1091     }
1092     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1093
1094     for ($query_cgi,$simple_query) {
1095         s/"//g;
1096     }
1097     # append the limit to the query
1098     $query .= " " . $limit;
1099
1100     # Warnings if DEBUG
1101     if ($DEBUG) {
1102         warn "QUERY:" . $query;
1103         warn "QUERY CGI:" . $query_cgi;
1104         warn "QUERY DESC:" . $query_desc;
1105         warn "LIMIT:" . $limit;
1106         warn "LIMIT CGI:" . $limit_cgi;
1107         warn "LIMIT DESC:" . $limit_desc;
1108         warn "---------\nLeave buildQuery\n---------";
1109     }
1110     return (
1111         undef,              $query, $simple_query, $query_cgi,
1112         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1113         $stopwords_removed, $query_type
1114     );
1115 }
1116
1117 =head2 searchResults
1118
1119 Format results in a form suitable for passing to the template
1120
1121 =cut
1122
1123 # IMO this subroutine is pretty messy still -- it's responsible for
1124 # building the HTML output for the template
1125 sub searchResults {
1126     my ( $searchdesc, $hits, $results_per_page, $offset, $scan, @marcresults ) = @_;
1127     my $dbh = C4::Context->dbh;
1128     my @newresults;
1129
1130     #Build branchnames hash
1131     #find branchname
1132     #get branch information.....
1133     my %branches;
1134     my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1135     $bsth->execute();
1136     while ( my $bdata = $bsth->fetchrow_hashref ) {
1137         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1138     }
1139 # FIXME - We build an authorised values hash here, using the default framework
1140 # though it is possible to have different authvals for different fws.
1141
1142     my $shelflocations =GetKohaAuthorisedValues('items.location','');
1143
1144     # get notforloan authorised value list (see $shelflocations  FIXME)
1145     my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1146
1147     #Build itemtype hash
1148     #find itemtype & itemtype image
1149     my %itemtypes;
1150     $bsth =
1151       $dbh->prepare(
1152         "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1153       );
1154     $bsth->execute();
1155     while ( my $bdata = $bsth->fetchrow_hashref ) {
1156                 foreach (qw(description imageurl summary notforloan)) {
1157                 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1158                 }
1159     }
1160
1161     #search item field code
1162     my $sth =
1163       $dbh->prepare(
1164 "SELECT tagfield FROM marc_subfield_structure WHERE kohafield LIKE 'items.itemnumber'"
1165       );
1166     $sth->execute;
1167     my ($itemtag) = $sth->fetchrow;
1168
1169     ## find column names of items related to MARC
1170     my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1171     $sth2->execute;
1172     my %subfieldstosearch;
1173     while ( ( my $column ) = $sth2->fetchrow ) {
1174         my ( $tagfield, $tagsubfield ) =
1175           &GetMarcFromKohaField( "items." . $column, "" );
1176         $subfieldstosearch{$column} = $tagsubfield;
1177     }
1178
1179     # handle which records to actually retrieve
1180     my $times;
1181     if ( $hits && $offset + $results_per_page <= $hits ) {
1182         $times = $offset + $results_per_page;
1183     }
1184     else {
1185         $times = $hits;  # FIXME: if $hits is undefined, why do we want to equal it?
1186     }
1187      my $marcflavour = C4::Context->preference("marcflavour");
1188     # loop through all of the records we've retrieved
1189     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1190         my $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
1191         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, '' );
1192         $oldbiblio->{subtitle} = C4::Biblio::get_koha_field_from_marc('bibliosubtitle', 'subtitle', $marcrecord, '');
1193         $oldbiblio->{result_number} = $i + 1;
1194
1195         # add imageurl to itemtype if there is one
1196         $oldbiblio->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1197
1198         $oldbiblio->{'authorised_value_images'}  = C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{'biblionumber'}, $marcrecord ) );
1199         (my $aisbn) = $oldbiblio->{isbn} =~ /([\d-]*[X]*)/;
1200         $aisbn =~ s/-//g;
1201         $oldbiblio->{amazonisbn} = $aisbn;
1202         $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1203         $oldbiblio->{normalized_upc} = GetNormalizedUPC($marcrecord,$marcflavour);
1204         $oldbiblio->{normalized_ean} = GetNormalizedEAN($marcrecord,$marcflavour);
1205         $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1206         $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1207         $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1208         $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1209         $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1210  # Build summary if there is one (the summary is defined in the itemtypes table)
1211  # FIXME: is this used anywhere, I think it can be commented out? -- JF
1212         if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1213             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1214             my @fields  = $marcrecord->fields();
1215             foreach my $field (@fields) {
1216                 my $tag      = $field->tag();
1217                 my $tagvalue = $field->as_string();
1218                 if (! utf8::is_utf8($tagvalue)) {
1219                     utf8::decode($tagvalue);
1220                 }
1221
1222                 $summary =~
1223                   s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
1224                 unless ( $tag < 10 ) {
1225                     my @subf = $field->subfields;
1226                     for my $i ( 0 .. $#subf ) {
1227                         my $subfieldcode  = $subf[$i][0];
1228                         my $subfieldvalue = $subf[$i][1];
1229                         if (! utf8::is_utf8($subfieldvalue)) {
1230                             utf8::decode($subfieldvalue);
1231                         }
1232                         my $tagsubf       = $tag . $subfieldcode;
1233                         $summary =~
1234 s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
1235                     }
1236                 }
1237             }
1238             # FIXME: yuk
1239             $summary =~ s/\[(.*?)]//g;
1240             $summary =~ s/\n/<br\/>/g;
1241             $oldbiblio->{summary} = $summary;
1242         }
1243
1244         # Pull out the items fields
1245         my @fields = $marcrecord->field($itemtag);
1246
1247         # Setting item statuses for display
1248         my @available_items_loop;
1249         my @onloan_items_loop;
1250         my @notforloan_items_loop;
1251         my @other_items_loop;
1252
1253         my $available_items;
1254         my $onloan_items;
1255         my $notforloan_items;
1256         my $other_items;
1257
1258         my $ordered_count         = 0;
1259         my $available_count       = 0;
1260         my $onloan_count          = 0;
1261         my $notforloan_count      = 0;
1262         my $longoverdue_count     = 0;
1263         my $other_count           = 0;
1264         my $wthdrawn_count        = 0;
1265         my $itemlost_count        = 0;
1266         my $itembinding_count     = 0;
1267         my $itemdamaged_count     = 0;
1268         my $item_in_transit_count = 0;
1269         my $can_place_holds       = 0;
1270         my $items_count           = scalar(@fields);
1271         my $maxitems =
1272           ( C4::Context->preference('maxItemsinSearchResults') )
1273           ? C4::Context->preference('maxItemsinSearchResults') - 1
1274           : 1;
1275
1276         # loop through every item
1277         foreach my $field (@fields) {
1278             my $item;
1279
1280             # populate the items hash
1281             foreach my $code ( keys %subfieldstosearch ) {
1282                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1283             }
1284                         my $hbranch     = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch'    : 'holdingbranch';
1285                         my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1286             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1287             if ($item->{$hbranch}) {
1288                 $item->{'branchname'} = $branches{$item->{$hbranch}};
1289             }
1290             elsif ($item->{$otherbranch}) {     # Last resort
1291                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1292             }
1293
1294             ($item->{'reserved'}) = C4::Reserves::CheckReserves($item->{itemnumber});
1295
1296                         my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1297 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1298             if ( $item->{onloan} or $item->{reserved} ) {
1299                 $onloan_count++;
1300                                 my $key = $prefix . $item->{onloan} . $item->{barcode};
1301                                 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1302                                 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1303                                 $onloan_items->{$key}->{branchname} = $item->{branchname};
1304                                 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1305                                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1306                                 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1307                                 $onloan_items->{$key}->{barcode} = $item->{barcode};
1308                 # if something's checked out and lost, mark it as 'long overdue'
1309                 if ( $item->{itemlost} ) {
1310                     $onloan_items->{$prefix}->{longoverdue}++;
1311                     $longoverdue_count++;
1312                 } else {        # can place holds as long as item isn't lost
1313                     $can_place_holds = 1;
1314                 }
1315             }
1316
1317          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1318             else {
1319
1320                 # item is on order
1321                 if ( $item->{notforloan} == -1 ) {
1322                     $ordered_count++;
1323                 }
1324
1325                 # is item in transit?
1326                 my $transfertwhen = '';
1327                 my ($transfertfrom, $transfertto);
1328
1329                 unless ($item->{wthdrawn}
1330                         || $item->{itemlost}
1331                         || $item->{damaged}
1332                         || $item->{notforloan}
1333                         || $items_count > 20) {
1334
1335                     # A couple heuristics to limit how many times
1336                     # we query the database for item transfer information, sacrificing
1337                     # accuracy in some cases for speed;
1338                     #
1339                     # 1. don't query if item has one of the other statuses
1340                     # 2. don't check transit status if the bib has
1341                     #    more than 20 items
1342                     #
1343                     # FIXME: to avoid having the query the database like this, and to make
1344                     #        the in transit status count as unavailable for search limiting,
1345                     #        should map transit status to record indexed in Zebra.
1346                     #
1347                     ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1348                 }
1349
1350                 # item is withdrawn, lost or damaged
1351                 if (   $item->{wthdrawn}
1352                     || $item->{itemlost}
1353                     || $item->{damaged}
1354                     || $item->{notforloan}
1355                     || $item->{reserved}
1356                     || ($transfertwhen ne ''))
1357                 {
1358                     $wthdrawn_count++        if $item->{wthdrawn};
1359                     $itemlost_count++        if $item->{itemlost};
1360                     $itemdamaged_count++     if $item->{damaged};
1361                     $item_in_transit_count++ if $transfertwhen ne '';
1362                     $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1363
1364                                         my $key = $prefix . $item->{status};
1365
1366                                         foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber)) {
1367                                             if($item->{notforloan} == 1){
1368                                                 $notforloan_items->{$key}->{$_} = $item->{$_};
1369                                             }else{
1370                            $other_items->{$key}->{$_} = $item->{$_};
1371                                             }
1372                                         }
1373                                         if($item->{notforloan} == 1){
1374                         $notforloan_count++;
1375
1376                         $notforloan_items->{$key}->{intransit} = ($transfertwhen ne '') ? 1 : 0;
1377                                         $notforloan_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value;
1378                                         $notforloan_items->{$key}->{count}++ if $item->{$hbranch};
1379                                         $notforloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1380                                         $notforloan_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1381                                         $notforloan_items->{$key}->{barcode} = $item->{barcode};
1382                     }else{
1383                         $other_count++;
1384
1385                         $other_items->{$key}->{intransit} = ($transfertwhen ne '') ? 1 : 0;
1386                                         $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value;
1387                                         $other_items->{$key}->{count}++ if $item->{$hbranch};
1388                                         $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1389                                         $other_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1390                                         $other_items->{$key}->{barcode} = $item->{barcode};
1391                     }
1392
1393                 }
1394                 # item is available
1395                 else {
1396                     $can_place_holds = 1;
1397                     $available_count++;
1398                                         $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1399                                         foreach (qw(branchname itemcallnumber barcode)) {
1400                         $available_items->{$prefix}->{$_} = $item->{$_};
1401                                         }
1402                                         $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1403                                         $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1404                 }
1405             }
1406         }    # notforloan, item level and biblioitem level
1407         my ( $availableitemscount, $onloanitemscount, $notforloanitemscount,$otheritemscount );
1408         $maxitems =
1409           ( C4::Context->preference('maxItemsinSearchResults') )
1410           ? C4::Context->preference('maxItemsinSearchResults') - 1
1411           : 1;
1412         for my $key ( sort keys %$onloan_items ) {
1413             (++$onloanitemscount > $maxitems) and last;
1414             push @onloan_items_loop, $onloan_items->{$key};
1415         }
1416         for my $key ( sort keys %$other_items ) {
1417             (++$otheritemscount > $maxitems) and last;
1418             push @other_items_loop, $other_items->{$key};
1419         }
1420         for my $key ( sort keys %$notforloan_items ) {
1421             (++$notforloanitemscount > $maxitems) and last;
1422             push @notforloan_items_loop, $notforloan_items->{$key};
1423         }
1424         for my $key ( sort keys %$available_items ) {
1425             (++$availableitemscount > $maxitems) and last;
1426             push @available_items_loop, $available_items->{$key}
1427         }
1428
1429         # XSLT processing of some stuff
1430         if (C4::Context->preference("XSLTResultsDisplay") && !$scan) {
1431             $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display(
1432                 $oldbiblio->{biblionumber}, $marcrecord, 'Results' );
1433         }
1434
1435         # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1436         $can_place_holds = 0 if $itemtypes{ $oldbiblio->{itemtype} }->{notforloan};
1437         $oldbiblio->{norequests} = 1 unless $can_place_holds;
1438         $oldbiblio->{itemsplural}          = 1 if $items_count > 1;
1439         $oldbiblio->{items_count}          = $items_count;
1440         $oldbiblio->{available_items_loop} = \@available_items_loop;
1441         $oldbiblio->{notforloan_items_loop}= \@notforloan_items_loop;
1442         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
1443         $oldbiblio->{other_items_loop}     = \@other_items_loop;
1444         $oldbiblio->{availablecount}       = $available_count;
1445         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
1446         $oldbiblio->{onloancount}          = $onloan_count;
1447         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
1448         $oldbiblio->{notforloancount}      = $notforloan_count;
1449         $oldbiblio->{othercount}           = $other_count;
1450         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
1451         $oldbiblio->{wthdrawncount}        = $wthdrawn_count;
1452         $oldbiblio->{itemlostcount}        = $itemlost_count;
1453         $oldbiblio->{damagedcount}         = $itemdamaged_count;
1454         $oldbiblio->{intransitcount}       = $item_in_transit_count;
1455         $oldbiblio->{orderedcount}         = $ordered_count;
1456         $oldbiblio->{isbn} =~
1457           s/-//g;    # deleting - in isbn to enable amazon content
1458         push( @newresults, $oldbiblio );
1459     }
1460     return @newresults;
1461 }
1462
1463 #----------------------------------------------------------------------
1464 #
1465 # Non-Zebra GetRecords#
1466 #----------------------------------------------------------------------
1467
1468 =head2 NZgetRecords
1469
1470   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1471
1472 =cut
1473
1474 sub NZgetRecords {
1475     my (
1476         $query,            $simple_query, $sort_by_ref,    $servers_ref,
1477         $results_per_page, $offset,       $expanded_facet, $branches,
1478         $query_type,       $scan
1479     ) = @_;
1480     warn "query =$query" if $DEBUG;
1481     my $result = NZanalyse($query);
1482     warn "results =$result" if $DEBUG;
1483     return ( undef,
1484         NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1485         undef );
1486 }
1487
1488 =head2 NZanalyse
1489
1490   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1491   the list is built from an inverted index in the nozebra SQL table
1492   note that title is here only for convenience : the sorting will be very fast when requested on title
1493   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1494
1495 =cut
1496
1497 sub NZanalyse {
1498     my ( $string, $server ) = @_;
1499 #     warn "---------"       if $DEBUG;
1500     warn " NZanalyse" if $DEBUG;
1501 #     warn "---------"       if $DEBUG;
1502
1503  # $server contains biblioserver or authorities, depending on what we search on.
1504  #warn "querying : $string on $server";
1505     $server = 'biblioserver' unless $server;
1506
1507 # if we have a ", replace the content to discard temporarily any and/or/not inside
1508     my $commacontent;
1509     if ( $string =~ /"/ ) {
1510         $string =~ s/"(.*?)"/__X__/;
1511         $commacontent = $1;
1512         warn "commacontent : $commacontent" if $DEBUG;
1513     }
1514
1515 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1516 # then, call again NZanalyse with $left and $right
1517 # (recursive until we find a leaf (=> something without and/or/not)
1518 # delete repeated operator... Would then go in infinite loop
1519     while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
1520     }
1521
1522     #process parenthesis before.
1523     if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
1524         my $left     = $1;
1525         my $right    = $4;
1526         my $operator = lc($3);   # FIXME: and/or/not are operators, not operands
1527         warn
1528 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
1529           if $DEBUG;
1530         my $leftresult = NZanalyse( $left, $server );
1531         if ($operator) {
1532             my $rightresult = NZanalyse( $right, $server );
1533
1534             # OK, we have the results for right and left part of the query
1535             # depending of operand, intersect, union or exclude both lists
1536             # to get a result list
1537             if ( $operator eq ' and ' ) {
1538                 return NZoperatorAND($leftresult,$rightresult);
1539             }
1540             elsif ( $operator eq ' or ' ) {
1541
1542                 # just merge the 2 strings
1543                 return $leftresult . $rightresult;
1544             }
1545             elsif ( $operator eq ' not ' ) {
1546                 return NZoperatorNOT($leftresult,$rightresult);
1547             }
1548         }
1549         else {
1550 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1551             return $leftresult;
1552         }
1553     }
1554     warn "string :" . $string if $DEBUG;
1555     my $left = "";
1556     my $right = "";
1557     my $operator = "";
1558     if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
1559         $left     = $1;
1560         $right    = $3;
1561         $operator = lc($2);    # FIXME: and/or/not are operators, not operands
1562     }
1563     warn "no parenthesis. left : $left operator: $operator right: $right"
1564       if $DEBUG;
1565
1566     # it's not a leaf, we have a and/or/not
1567     if ($operator) {
1568
1569         # reintroduce comma content if needed
1570         $right =~ s/__X__/"$commacontent"/ if $commacontent;
1571         $left  =~ s/__X__/"$commacontent"/ if $commacontent;
1572         warn "node : $left / $operator / $right\n" if $DEBUG;
1573         my $leftresult  = NZanalyse( $left,  $server );
1574         my $rightresult = NZanalyse( $right, $server );
1575         warn " leftresult : $leftresult" if $DEBUG;
1576         warn " rightresult : $rightresult" if $DEBUG;
1577         # OK, we have the results for right and left part of the query
1578         # depending of operand, intersect, union or exclude both lists
1579         # to get a result list
1580         if ( $operator eq ' and ' ) {
1581             warn "NZAND";
1582             return NZoperatorAND($leftresult,$rightresult);
1583         }
1584         elsif ( $operator eq ' or ' ) {
1585
1586             # just merge the 2 strings
1587             return $leftresult . $rightresult;
1588         }
1589         elsif ( $operator eq ' not ' ) {
1590             return NZoperatorNOT($leftresult,$rightresult);
1591         }
1592         else {
1593
1594 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1595             die "error : operand unknown : $operator for $string";
1596         }
1597
1598         # it's a leaf, do the real SQL query and return the result
1599     }
1600     else {
1601         $string =~ s/__X__/"$commacontent"/ if $commacontent;
1602         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1603         #remove trailing blank at the beginning
1604         $string =~ s/^ //g;
1605         warn "leaf:$string" if $DEBUG;
1606
1607         # parse the string in in operator/operand/value again
1608         my $left = "";
1609         my $operator = "";
1610         my $right = "";
1611         if ($string =~ /(.*)(>=|<=)(.*)/) {
1612             $left     = $1;
1613             $operator = $2;
1614             $right    = $3;
1615         } else {
1616             $left = $string;
1617         }
1618 #         warn "handling leaf... left:$left operator:$operator right:$right"
1619 #           if $DEBUG;
1620         unless ($operator) {
1621             if ($string =~ /(.*)(>|<|=)(.*)/) {
1622                 $left     = $1;
1623                 $operator = $2;
1624                 $right    = $3;
1625                 warn
1626     "handling unless (operator)... left:$left operator:$operator right:$right"
1627                 if $DEBUG;
1628             } else {
1629                 $left = $string;
1630             }
1631         }
1632         my $results;
1633
1634 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
1635         $left =~ s/ .*$//;
1636
1637         # automatic replace for short operators
1638         $left = 'title'            if $left =~ '^ti$';
1639         $left = 'author'           if $left =~ '^au$';
1640         $left = 'publisher'        if $left =~ '^pb$';
1641         $left = 'subject'          if $left =~ '^su$';
1642         $left = 'koha-Auth-Number' if $left =~ '^an$';
1643         $left = 'keyword'          if $left =~ '^kw$';
1644         $left = 'itemtype'         if $left =~ '^mc$'; # Fix for Bug 2599 - Search limits not working for NoZebra
1645         warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
1646         my $dbh = C4::Context->dbh;
1647         if ( $operator && $left ne 'keyword' ) {
1648             #do a specific search
1649             $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
1650             my $sth = $dbh->prepare(
1651 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
1652             );
1653             warn "$left / $operator / $right\n" if $DEBUG;
1654
1655             # split each word, query the DB and build the biblionumbers result
1656             #sanitizing leftpart
1657             $left =~ s/^\s+|\s+$//;
1658             foreach ( split / /, $right ) {
1659                 my $biblionumbers;
1660                 $_ =~ s/^\s+|\s+$//;
1661                 next unless $_;
1662                 warn "EXECUTE : $server, $left, $_" if $DEBUG;
1663                 $sth->execute( $server, $left, $_ )
1664                   or warn "execute failed: $!";
1665                 while ( my ( $line, $value ) = $sth->fetchrow ) {
1666
1667 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1668 # otherwise, fill the result
1669                     $biblionumbers .= $line
1670                       unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
1671                     warn "result : $value "
1672                       . ( $right  =~ /\d/ ) . "=="
1673                       . ( $value =~ /\D/?$line:"" ) if $DEBUG;         #= $line";
1674                 }
1675
1676 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1677                 if ($results) {
1678                     warn "NZAND" if $DEBUG;
1679                     $results = NZoperatorAND($biblionumbers,$results);
1680                 } else {
1681                     $results = $biblionumbers;
1682                 }
1683             }
1684         }
1685         else {
1686       #do a complete search (all indexes), if index='kw' do complete search too.
1687             my $sth = $dbh->prepare(
1688 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
1689             );
1690
1691             # split each word, query the DB and build the biblionumbers result
1692             foreach ( split / /, $string ) {
1693                 next if C4::Context->stopwords->{ uc($_) };   # skip if stopword
1694                 warn "search on all indexes on $_" if $DEBUG;
1695                 my $biblionumbers;
1696                 next unless $_;
1697                 $sth->execute( $server, $_ );
1698                 while ( my $line = $sth->fetchrow ) {
1699                     $biblionumbers .= $line;
1700                 }
1701
1702 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1703                 if ($results) {
1704                     $results = NZoperatorAND($biblionumbers,$results);
1705                 }
1706                 else {
1707                     warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
1708                     $results = $biblionumbers;
1709                 }
1710             }
1711         }
1712         warn "return : $results for LEAF : $string" if $DEBUG;
1713         return $results;
1714     }
1715     warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
1716 }
1717
1718 sub NZoperatorAND{
1719     my ($rightresult, $leftresult)=@_;
1720
1721     my @leftresult = split /;/, $leftresult;
1722     warn " @leftresult / $rightresult \n" if $DEBUG;
1723
1724     #             my @rightresult = split /;/,$leftresult;
1725     my $finalresult;
1726
1727 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1728 # the result is stored twice, to have the same weight for AND than OR.
1729 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1730 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1731     foreach (@leftresult) {
1732         my $value = $_;
1733         my $countvalue;
1734         ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
1735         if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
1736             $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
1737             $finalresult .=
1738                 "$value-$countvalue;$value-$countvalue;";
1739         }
1740     }
1741     warn "NZAND DONE : $finalresult \n" if $DEBUG;
1742     return $finalresult;
1743 }
1744
1745 sub NZoperatorOR{
1746     my ($rightresult, $leftresult)=@_;
1747     return $rightresult.$leftresult;
1748 }
1749
1750 sub NZoperatorNOT{
1751     my ($leftresult, $rightresult)=@_;
1752
1753     my @leftresult = split /;/, $leftresult;
1754
1755     #             my @rightresult = split /;/,$leftresult;
1756     my $finalresult;
1757     foreach (@leftresult) {
1758         my $value=$_;
1759         $value=$1 if $value=~m/(.*)-\d+$/;
1760         unless ($rightresult =~ "$value-") {
1761             $finalresult .= "$_;";
1762         }
1763     }
1764     return $finalresult;
1765 }
1766
1767 =head2 NZorder
1768
1769   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1770
1771   TODO :: Description
1772
1773 =cut
1774
1775 sub NZorder {
1776     my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
1777     warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
1778
1779     # order title asc by default
1780     #     $ordering = '1=36 <i' unless $ordering;
1781     $results_per_page = 20 unless $results_per_page;
1782     $offset           = 0  unless $offset;
1783     my $dbh = C4::Context->dbh;
1784
1785     #
1786     # order by POPULARITY
1787     #
1788     if ( $ordering =~ /popularity/ ) {
1789         my %result;
1790         my %popularity;
1791
1792         # popularity is not in MARC record, it's builded from a specific query
1793         my $sth =
1794           $dbh->prepare("select sum(issues) from items where biblionumber=?");
1795         foreach ( split /;/, $biblionumbers ) {
1796             my ( $biblionumber, $title ) = split /,/, $_;
1797             $result{$biblionumber} = GetMarcBiblio($biblionumber);
1798             $sth->execute($biblionumber);
1799             my $popularity = $sth->fetchrow || 0;
1800
1801 # hint : the key is popularity.title because we can have
1802 # many results with the same popularity. In this case, sub-ordering is done by title
1803 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1804 # (un-frequent, I agree, but we won't forget anything that way ;-)
1805             $popularity{ sprintf( "%10d", $popularity ) . $title
1806                   . $biblionumber } = $biblionumber;
1807         }
1808
1809     # sort the hash and return the same structure as GetRecords (Zebra querying)
1810         my $result_hash;
1811         my $numbers = 0;
1812         if ( $ordering eq 'popularity_dsc' ) {    # sort popularity DESC
1813             foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
1814                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1815                   $result{ $popularity{$key} }->as_usmarc();
1816             }
1817         }
1818         else {                                    # sort popularity ASC
1819             foreach my $key ( sort ( keys %popularity ) ) {
1820                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1821                   $result{ $popularity{$key} }->as_usmarc();
1822             }
1823         }
1824         my $finalresult = ();
1825         $result_hash->{'hits'}         = $numbers;
1826         $finalresult->{'biblioserver'} = $result_hash;
1827         return $finalresult;
1828
1829         #
1830         # ORDER BY author
1831         #
1832     }
1833     elsif ( $ordering =~ /author/ ) {
1834         my %result;
1835         foreach ( split /;/, $biblionumbers ) {
1836             my ( $biblionumber, $title ) = split /,/, $_;
1837             my $record = GetMarcBiblio($biblionumber);
1838             my $author;
1839             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1840                 $author = $record->subfield( '200', 'f' );
1841                 $author = $record->subfield( '700', 'a' ) unless $author;
1842             }
1843             else {
1844                 $author = $record->subfield( '100', 'a' );
1845             }
1846
1847 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1848 # and we don't want to get only 1 result for each of them !!!
1849             $result{ $author . $biblionumber } = $record;
1850         }
1851
1852     # sort the hash and return the same structure as GetRecords (Zebra querying)
1853         my $result_hash;
1854         my $numbers = 0;
1855         if ( $ordering eq 'author_za' ) {    # sort by author desc
1856             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1857                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1858                   $result{$key}->as_usmarc();
1859             }
1860         }
1861         else {                               # sort by author ASC
1862             foreach my $key ( sort ( keys %result ) ) {
1863                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1864                   $result{$key}->as_usmarc();
1865             }
1866         }
1867         my $finalresult = ();
1868         $result_hash->{'hits'}         = $numbers;
1869         $finalresult->{'biblioserver'} = $result_hash;
1870         return $finalresult;
1871
1872         #
1873         # ORDER BY callnumber
1874         #
1875     }
1876     elsif ( $ordering =~ /callnumber/ ) {
1877         my %result;
1878         foreach ( split /;/, $biblionumbers ) {
1879             my ( $biblionumber, $title ) = split /,/, $_;
1880             my $record = GetMarcBiblio($biblionumber);
1881             my $callnumber;
1882             my ( $callnumber_tag, $callnumber_subfield ) =
1883               GetMarcFromKohaField( 'items.itemcallnumber','' );
1884             ( $callnumber_tag, $callnumber_subfield ) =
1885               GetMarcFromKohaField('biblioitems.callnumber','')
1886               unless $callnumber_tag;
1887             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1888                 $callnumber = $record->subfield( '200', 'f' );
1889             }
1890             else {
1891                 $callnumber = $record->subfield( '100', 'a' );
1892             }
1893
1894 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1895 # and we don't want to get only 1 result for each of them !!!
1896             $result{ $callnumber . $biblionumber } = $record;
1897         }
1898
1899     # sort the hash and return the same structure as GetRecords (Zebra querying)
1900         my $result_hash;
1901         my $numbers = 0;
1902         if ( $ordering eq 'call_number_dsc' ) {    # sort by title desc
1903             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1904                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1905                   $result{$key}->as_usmarc();
1906             }
1907         }
1908         else {                                     # sort by title ASC
1909             foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
1910                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1911                   $result{$key}->as_usmarc();
1912             }
1913         }
1914         my $finalresult = ();
1915         $result_hash->{'hits'}         = $numbers;
1916         $finalresult->{'biblioserver'} = $result_hash;
1917         return $finalresult;
1918     }
1919     elsif ( $ordering =~ /pubdate/ ) {             #pub year
1920         my %result;
1921         foreach ( split /;/, $biblionumbers ) {
1922             my ( $biblionumber, $title ) = split /,/, $_;
1923             my $record = GetMarcBiblio($biblionumber);
1924             my ( $publicationyear_tag, $publicationyear_subfield ) =
1925               GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
1926             my $publicationyear =
1927               $record->subfield( $publicationyear_tag,
1928                 $publicationyear_subfield );
1929
1930 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1931 # and we don't want to get only 1 result for each of them !!!
1932             $result{ $publicationyear . $biblionumber } = $record;
1933         }
1934
1935     # sort the hash and return the same structure as GetRecords (Zebra querying)
1936         my $result_hash;
1937         my $numbers = 0;
1938         if ( $ordering eq 'pubdate_dsc' ) {    # sort by pubyear desc
1939             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1940                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1941                   $result{$key}->as_usmarc();
1942             }
1943         }
1944         else {                                 # sort by pub year ASC
1945             foreach my $key ( sort ( keys %result ) ) {
1946                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1947                   $result{$key}->as_usmarc();
1948             }
1949         }
1950         my $finalresult = ();
1951         $result_hash->{'hits'}         = $numbers;
1952         $finalresult->{'biblioserver'} = $result_hash;
1953         return $finalresult;
1954
1955         #
1956         # ORDER BY title
1957         #
1958     }
1959     elsif ( $ordering =~ /title/ ) {
1960
1961 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
1962         my %result;
1963         foreach ( split /;/, $biblionumbers ) {
1964             my ( $biblionumber, $title ) = split /,/, $_;
1965
1966 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1967 # and we don't want to get only 1 result for each of them !!!
1968 # hint & speed improvement : we can order without reading the record
1969 # so order, and read records only for the requested page !
1970             $result{ $title . $biblionumber } = $biblionumber;
1971         }
1972
1973     # sort the hash and return the same structure as GetRecords (Zebra querying)
1974         my $result_hash;
1975         my $numbers = 0;
1976         if ( $ordering eq 'title_az' ) {    # sort by title desc
1977             foreach my $key ( sort ( keys %result ) ) {
1978                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
1979             }
1980         }
1981         else {                              # sort by title ASC
1982             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1983                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
1984             }
1985         }
1986
1987         # limit the $results_per_page to result size if it's more
1988         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
1989
1990         # for the requested page, replace biblionumber by the complete record
1991         # speed improvement : avoid reading too much things
1992         for (
1993             my $counter = $offset ;
1994             $counter <= $offset + $results_per_page ;
1995             $counter++
1996           )
1997         {
1998             $result_hash->{'RECORDS'}[$counter] =
1999               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2000         }
2001         my $finalresult = ();
2002         $result_hash->{'hits'}         = $numbers;
2003         $finalresult->{'biblioserver'} = $result_hash;
2004         return $finalresult;
2005     }
2006     else {
2007
2008 #
2009 # order by ranking
2010 #
2011 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2012         my %result;
2013         my %count_ranking;
2014         foreach ( split /;/, $biblionumbers ) {
2015             my ( $biblionumber, $title ) = split /,/, $_;
2016             $title =~ /(.*)-(\d)/;
2017
2018             # get weight
2019             my $ranking = $2;
2020
2021 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2022 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2023 # biblio N has ranking = 6
2024             $count_ranking{$biblionumber} += $ranking;
2025         }
2026
2027 # build the result by "inverting" the count_ranking hash
2028 # 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
2029 #         warn "counting";
2030         foreach ( keys %count_ranking ) {
2031             $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2032         }
2033
2034     # sort the hash and return the same structure as GetRecords (Zebra querying)
2035         my $result_hash;
2036         my $numbers = 0;
2037         foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2038             $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2039         }
2040
2041         # limit the $results_per_page to result size if it's more
2042         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2043
2044         # for the requested page, replace biblionumber by the complete record
2045         # speed improvement : avoid reading too much things
2046         for (
2047             my $counter = $offset ;
2048             $counter <= $offset + $results_per_page ;
2049             $counter++
2050           )
2051         {
2052             $result_hash->{'RECORDS'}[$counter] =
2053               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2054               if $result_hash->{'RECORDS'}[$counter];
2055         }
2056         my $finalresult = ();
2057         $result_hash->{'hits'}         = $numbers;
2058         $finalresult->{'biblioserver'} = $result_hash;
2059         return $finalresult;
2060     }
2061 }
2062
2063 =head2 enabled_staff_search_views
2064
2065 %hash = enabled_staff_search_views()
2066
2067 This function returns a hash that contains three flags obtained from the system
2068 preferences, used to determine whether a particular staff search results view
2069 is enabled.
2070
2071 =over 2
2072
2073 =item C<Output arg:>
2074
2075     * $hash{can_view_MARC} is true only if the MARC view is enabled
2076     * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2077     * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2078
2079 =item C<usage in the script:>
2080
2081 =back
2082
2083 $template->param ( C4::Search::enabled_staff_search_views );
2084
2085 =cut
2086
2087 sub enabled_staff_search_views
2088 {
2089         return (
2090                 can_view_MARC                   => C4::Context->preference('viewMARC'),                 # 1 if the staff search allows the MARC view
2091                 can_view_ISBD                   => C4::Context->preference('viewISBD'),                 # 1 if the staff search allows the ISBD view
2092                 can_view_labeledMARC    => C4::Context->preference('viewLabeledMARC'),  # 1 if the staff search allows the Labeled MARC view
2093         );
2094 }
2095
2096
2097 =head2 z3950_search_args
2098
2099 $arrayref = z3950_search_args($matchpoints)
2100
2101 This function returns an array reference that contains the search parameters to be
2102 passed to the Z39.50 search script (z3950_search.pl). The array elements
2103 are hash refs whose keys are name, value and encvalue, and whose values are the
2104 name of a search parameter, the value of that search parameter and the URL encoded
2105 value of that parameter.
2106
2107 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2108
2109 The search parameter values are obtained from the bibliographic record whose
2110 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2111
2112 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2113 a general purpose search argument. In this case, the returned array contains only
2114 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2115
2116 If a search parameter value is undefined or empty, it is not included in the returned
2117 array.
2118
2119 The returned array reference may be passed directly to the template parameters.
2120
2121 =over 2
2122
2123 =item C<Output arg:>
2124
2125     * $array containing hash refs as described above
2126
2127 =item C<usage in the script:>
2128
2129 =back
2130
2131 $data = Biblio::GetBiblioData($bibno);
2132 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2133
2134 *OR*
2135
2136 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2137
2138 =cut
2139
2140 sub z3950_search_args {
2141     my $bibrec = shift;
2142     $bibrec = { title => $bibrec } if !ref $bibrec;
2143     my $array = [];
2144     for my $field (qw/ lccn isbn issn title author dewey subject /)
2145     {
2146         my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2147         push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2148     }
2149     return $array;
2150 }
2151
2152
2153 END { }    # module clean-up code here (global destructor)
2154
2155 1;
2156 __END__
2157
2158 =head1 AUTHOR
2159
2160 Koha Developement team <info@koha.org>
2161
2162 =cut