C4/Search.pm

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