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