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::Charset;
  34 use YAML;
  35 use URI::Escape;
  36 use Business::ISBN;
  37
  38 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
  39
  40 # set the version for version checking
  41 BEGIN {
  42     $VERSION = 3.07.00.049;
  43     $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
  44 }
  45
  46 =head1 NAME
  47
  48 C4::Search - Functions for searching the Koha catalog.
  49
  50 =head1 SYNOPSIS
  51
  52 See opac/opac-search.pl or catalogue/search.pl for example of usage
  53
  54 =head1 DESCRIPTION
  55
  56 This module provides searching functions for Koha's bibliographic databases
  57
  58 =head1 FUNCTIONS
  59
  60 =cut
  61
  62 @ISA    = qw(Exporter);
  63 @EXPORT = qw(
  64   &FindDuplicate
  65   &SimpleSearch
  66   &searchResults
  67   &getRecords
  68   &buildQuery
  69   &NZgetRecords
  70   &AddSearchHistory
  71   &GetDistinctValues
  72   &enabled_staff_search_views
  73   &SimpleSearch
  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     # Make sure we only use the first two letters from the language code
 736     $lang = lc(substr($lang, 0, 2));
 737     # The language codes for the two variants of Norwegian will now be "nb" and "nn",
 738     # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
 739     if ($lang eq 'nb' || $lang eq 'nn') {
 740       $lang = 'no';
 741     }
 742     my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
 743                                                encoding => "UTF-8" );
 744
 745     my @words = split( / /, $operand );
 746     my @stems = $stemmer->stem(\@words);
 747     for my $stem (@stems) {
 748         $stemmed_operand .= "$stem";
 749         $stemmed_operand .= "?"
 750           unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 751         $stemmed_operand .= " ";
 752     }
 753     warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
 754     return $stemmed_operand;
 755 }
 756
 757 # FIELD WEIGHTING
 758 sub _build_weighted_query {
 759
 760 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
 761 # pretty well but could work much better if we had a smarter query parser
 762     my ( $operand, $stemmed_operand, $index ) = @_;
 763     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 764     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 765     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy")        || 0;
 766
 767     my $weighted_query .= "(rk=(";    # Specifies that we're applying rank
 768
 769     # Keyword, or, no index specified
 770     if ( ( $index eq 'kw' ) || ( !$index ) ) {
 771         $weighted_query .=
 772           "Title-cover,ext,r1=\"$operand\"";    # exact title-cover
 773         $weighted_query .= " or ti,ext,r2=\"$operand\"";    # exact title
 774         $weighted_query .= " or Title-cover,phr,r3=\"$operand\"";    # phrase title
 775           #$weighted_query .= " or any,ext,r4=$operand";               # exact any
 776           #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
 777         $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
 778           if $fuzzy_enabled;    # add fuzzy, word list
 779         $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
 780           if ( $stemming and $stemmed_operand )
 781           ;                     # add stemming, right truncation
 782         $weighted_query .= " or wrdl,r9=\"$operand\"";
 783
 784         # embedded sorting: 0 a-z; 1 z-a
 785         # $weighted_query .= ") or (sort1,aut=1";
 786     }
 787
 788     # Barcode searches should skip this process
 789     elsif ( $index eq 'bc' ) {
 790         $weighted_query .= "bc=\"$operand\"";
 791     }
 792
 793     # Authority-number searches should skip this process
 794     elsif ( $index eq 'an' ) {
 795         $weighted_query .= "an=\"$operand\"";
 796     }
 797
 798     # If the index already has more than one qualifier, wrap the operand
 799     # in quotes and pass it back (assumption is that the user knows what they
 800     # are doing and won't appreciate us mucking up their query
 801     elsif ( $index =~ ',' ) {
 802         $weighted_query .= " $index=\"$operand\"";
 803     }
 804
 805     #TODO: build better cases based on specific search indexes
 806     else {
 807         $weighted_query .= " $index,ext,r1=\"$operand\"";    # exact index
 808           #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
 809         $weighted_query .= " or $index,phr,r3=\"$operand\"";    # phrase index
 810         $weighted_query .=
 811           " or $index,rt,wrdl,r3=\"$operand\"";    # word list index
 812     }
 813
 814     $weighted_query .= "))";                       # close rank specification
 815     return $weighted_query;
 816 }
 817
 818 =head2 getIndexes
 819
 820 Return an array with available indexes.
 821
 822 =cut
 823
 824 sub getIndexes{
 825     my @indexes = (
 826                     # biblio indexes
 827                     'ab',
 828                     'Abstract',
 829                     'acqdate',
 830                     'allrecords',
 831                     'an',
 832                     'Any',
 833                     'at',
 834                     'au',
 835                     'aub',
 836                     'aud',
 837                     'audience',
 838                     'auo',
 839                     'aut',
 840                     'Author',
 841                     'Author-in-order ',
 842                     'Author-personal-bibliography',
 843                     'Authority-Number',
 844                     'authtype',
 845                     'bc',
 846                     'Bib-level',
 847                     'biblionumber',
 848                     'bio',
 849                     'biography',
 850                     'callnum',
 851                     'cfn',
 852                     'Chronological-subdivision',
 853                     'cn-bib-source',
 854                     'cn-bib-sort',
 855                     'cn-class',
 856                     'cn-item',
 857                     'cn-prefix',
 858                     'cn-suffix',
 859                     'cpn',
 860                     'Code-institution',
 861                     'Conference-name',
 862                     'Conference-name-heading',
 863                     'Conference-name-see',
 864                     'Conference-name-seealso',
 865                     'Content-type',
 866                     'Control-number',
 867                     'copydate',
 868                     'Corporate-name',
 869                     'Corporate-name-heading',
 870                     'Corporate-name-see',
 871                     'Corporate-name-seealso',
 872                     'ctype',
 873                     'date-entered-on-file',
 874                     'Date-of-acquisition',
 875                     'Date-of-publication',
 876                     'Dewey-classification',
 877                     'EAN',
 878                     'extent',
 879                     'fic',
 880                     'fiction',
 881                     'Form-subdivision',
 882                     'format',
 883                     'Geographic-subdivision',
 884                     'he',
 885                     'Heading',
 886                     'Heading-use-main-or-added-entry',
 887                     'Heading-use-series-added-entry ',
 888                     'Heading-use-subject-added-entry',
 889                     'Host-item',
 890                     'id-other',
 891                     'Illustration-code',
 892                     'ISBN',
 893                     'isbn',
 894                     'ISSN',
 895                     'issn',
 896                     'itemtype',
 897                     'kw',
 898                     'Koha-Auth-Number',
 899                     'l-format',
 900                     'language',
 901                     'lc-card',
 902                     'LC-card-number',
 903                     'lcn',
 904                     'llength',
 905                     'ln',
 906                     'Local-classification',
 907                     'Local-number',
 908                     'Match-heading',
 909                     'Match-heading-see-from',
 910                     'Material-type',
 911                     'mc-itemtype',
 912                     'mc-rtype',
 913                     'mus',
 914                     'name',
 915                     'Music-number',
 916                     'Name-geographic',
 917                     'Name-geographic-heading',
 918                     'Name-geographic-see',
 919                     'Name-geographic-seealso',
 920                     'nb',
 921                     'Note',
 922                     'notes',
 923                     'ns',
 924                     'nt',
 925                     'pb',
 926                     'Personal-name',
 927                     'Personal-name-heading',
 928                     'Personal-name-see',
 929                     'Personal-name-seealso',
 930                     'pl',
 931                     'Place-publication',
 932                     'pn',
 933                     'popularity',
 934                     'pubdate',
 935                     'Publisher',
 936                     'Record-control-number',
 937                     'rcn',
 938                     'Record-type',
 939                     'rtype',
 940                     'se',
 941                     'See',
 942                     'See-also',
 943                     'sn',
 944                     'Stock-number',
 945                     'su',
 946                     'Subject',
 947                     'Subject-heading-thesaurus',
 948                     'Subject-name-personal',
 949                     'Subject-subdivision',
 950                     'Summary',
 951                     'Suppress',
 952                     'su-geo',
 953                     'su-na',
 954                     'su-to',
 955                     'su-ut',
 956                     'ut',
 957                     'UPC',
 958                     'Term-genre-form',
 959                     'Term-genre-form-heading',
 960                     'Term-genre-form-see',
 961                     'Term-genre-form-seealso',
 962                     'ti',
 963                     'Title',
 964                     'Title-cover',
 965                     'Title-series',
 966                     'Title-host',
 967                     'Title-uniform',
 968                     'Title-uniform-heading',
 969                     'Title-uniform-see',
 970                     'Title-uniform-seealso',
 971                     'totalissues',
 972                     'yr',
 973
 974                     # items indexes
 975                     'acqsource',
 976                     'barcode',
 977                     'bc',
 978                     'branch',
 979                     'ccode',
 980                     'classification-source',
 981                     'cn-sort',
 982                     'coded-location-qualifier',
 983                     'copynumber',
 984                     'damaged',
 985                     'datelastborrowed',
 986                     'datelastseen',
 987                     'holdingbranch',
 988                     'homebranch',
 989                     'issues',
 990                     'item',
 991                     'itemnumber',
 992                     'itype',
 993                     'Local-classification',
 994                     'location',
 995                     'lost',
 996                     'materials-specified',
 997                     'mc-ccode',
 998                     'mc-itype',
 999                     'mc-loc',
1000                     'notforloan',
1001                     'onloan',
1002                     'price',
1003                     'renewals',
1004                     'replacementprice',
1005                     'replacementpricedate',
1006                     'reserves',
1007                     'restricted',
1008                     'stack',
1009                     'stocknumber',
1010                     'inv',
1011                     'uri',
1012                     'withdrawn',
1013
1014                     # subject related
1015                   );
1016
1017     return \@indexes;
1018 }
1019
1020 =head2 buildQuery
1021
1022 ( $error, $query,
1023 $simple_query, $query_cgi,
1024 $query_desc, $limit,
1025 $limit_cgi, $limit_desc,
1026 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1027
1028 Build queries and limits in CCL, CGI, Human,
1029 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
1030
1031 See verbose embedded documentation.
1032
1033
1034 =cut
1035
1036 sub buildQuery {
1037     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1038
1039     warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1040
1041     # dereference
1042     my @operators = $operators ? @$operators : ();
1043     my @indexes   = $indexes   ? @$indexes   : ();
1044     my @operands  = $operands  ? @$operands  : ();
1045     my @limits    = $limits    ? @$limits    : ();
1046     my @sort_by   = $sort_by   ? @$sort_by   : ();
1047
1048     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
1049     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
1050     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
1051     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
1052     my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
1053
1054     # no stemming/weight/fuzzy in NoZebra
1055     if ( C4::Context->preference("NoZebra") ) {
1056         $stemming         = 0;
1057         $weight_fields    = 0;
1058         $fuzzy_enabled    = 0;
1059         $auto_truncation  = 0;
1060     }
1061
1062     my $query        = $operands[0];
1063     my $simple_query = $operands[0];
1064
1065     # initialize the variables we're passing back
1066     my $query_cgi;
1067     my $query_desc;
1068     my $query_type;
1069
1070     my $limit;
1071     my $limit_cgi;
1072     my $limit_desc;
1073
1074     my $stopwords_removed;    # flag to determine if stopwords have been removed
1075
1076     my $cclq       = 0;
1077     my $cclindexes = getIndexes();
1078     if ( $query !~ /\s*ccl=/ ) {
1079         while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1080             my $dx = lc($1);
1081             $cclq = grep { lc($_) eq $dx } @$cclindexes;
1082         }
1083         $query = "ccl=$query" if $cclq;
1084     }
1085
1086 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1087 # DIAGNOSTIC ONLY!!
1088     if ( $query =~ /^ccl=/ ) {
1089         my $q=$';
1090         # This is needed otherwise ccl= and &limit won't work together, and
1091         # this happens when selecting a subject on the opac-detail page
1092         if (@limits) {
1093             $q .= ' and '.join(' and ', @limits);
1094         }
1095         return ( undef, $q, $q, "q=ccl=$q", $q, '', '', '', '', 'ccl' );
1096     }
1097     if ( $query =~ /^cql=/ ) {
1098         return ( undef, $', $', "q=cql=$'", $', '', '', '', '', 'cql' );
1099     }
1100     if ( $query =~ /^pqf=/ ) {
1101         return ( undef, $', $', "q=pqf=$'", $', '', '', '', '', 'pqf' );
1102     }
1103
1104     # pass nested queries directly
1105     # FIXME: need better handling of some of these variables in this case
1106     # Nested queries aren't handled well and this implementation is flawed and causes users to be
1107     # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1108 #    if ( $query =~ /(\(|\))/ ) {
1109 #        return (
1110 #            undef,              $query, $simple_query, $query_cgi,
1111 #            $query,             $limit, $limit_cgi,    $limit_desc,
1112 #            $stopwords_removed, 'ccl'
1113 #        );
1114 #    }
1115
1116 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1117 # query operands and indexes and add stemming, truncation, field weighting, etc.
1118 # Once we do so, we'll end up with a value in $query, just like if we had an
1119 # incoming $query from the user
1120     else {
1121         $query = ""
1122           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1123         my $previous_operand
1124           ;    # a flag used to keep track if there was a previous query
1125                # if there was, we can apply the current operator
1126                # for every operand
1127         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1128
1129             # COMBINE OPERANDS, INDEXES AND OPERATORS
1130             if ( $operands[$i] ) {
1131                 $operands[$i]=~s/^\s+//;
1132
1133               # A flag to determine whether or not to add the index to the query
1134                 my $indexes_set;
1135
1136 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
1137                 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1138                     $weight_fields    = 0;
1139                     $stemming         = 0;
1140                     $remove_stopwords = 0;
1141                 } else {
1142                     $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1143                 }
1144                 my $operand = $operands[$i];
1145                 my $index   = $indexes[$i];
1146
1147                 # Add index-specific attributes
1148                 # Date of Publication
1149                 if ( $index eq 'yr' ) {
1150                     $index .= ",st-numeric";
1151                     $indexes_set++;
1152                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1153                 }
1154
1155                 # Date of Acquisition
1156                 elsif ( $index eq 'acqdate' ) {
1157                     $index .= ",st-date-normalized";
1158                     $indexes_set++;
1159                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1160                 }
1161                 # ISBN,ISSN,Standard Number, don't need special treatment
1162                 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1163                     (
1164                         $stemming,      $auto_truncation,
1165                         $weight_fields, $fuzzy_enabled,
1166                         $remove_stopwords
1167                     ) = ( 0, 0, 0, 0, 0 );
1168
1169                 }
1170
1171                 if(not $index){
1172                     $index = 'kw';
1173                 }
1174
1175                 # Set default structure attribute (word list)
1176                 my $struct_attr = q{};
1177                 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl|nb|ns)/ ) {
1178                     $struct_attr = ",wrdl";
1179                 }
1180
1181                 # Some helpful index variants
1182                 my $index_plus       = $index . $struct_attr . ':';
1183                 my $index_plus_comma = $index . $struct_attr . ',';
1184
1185                 # Remove Stopwords
1186                 if ($remove_stopwords) {
1187                     ( $operand, $stopwords_removed ) =
1188                       _remove_stopwords( $operand, $index );
1189                     warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
1190                     warn "REMOVED STOPWORDS: @$stopwords_removed"
1191                       if ( $stopwords_removed && $DEBUG );
1192                 }
1193
1194                 if ($auto_truncation){
1195                                         unless ( $index =~ /(st-|phr|ext)/ ) {
1196                                                 #FIXME only valid with LTR scripts
1197                                                 $operand=join(" ",map{
1198                                                                                         (index($_,"*")>0?"$_":"$_*")
1199                                                                                          }split (/\s+/,$operand));
1200                                                 warn $operand if $DEBUG;
1201                                         }
1202                                 }
1203
1204                 # Detect Truncation
1205                 my $truncated_operand;
1206                 my( $nontruncated, $righttruncated, $lefttruncated,
1207                     $rightlefttruncated, $regexpr
1208                 ) = _detect_truncation( $operand, $index );
1209                 warn
1210 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1211                   if $DEBUG;
1212
1213                 # Apply Truncation
1214                 if (
1215                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
1216                     scalar(@$rightlefttruncated) > 0 )
1217                 {
1218
1219                # Don't field weight or add the index to the query, we do it here
1220                     $indexes_set = 1;
1221                     undef $weight_fields;
1222                     my $previous_truncation_operand;
1223                     if (scalar @$nontruncated) {
1224                         $truncated_operand .= "$index_plus @$nontruncated ";
1225                         $previous_truncation_operand = 1;
1226                     }
1227                     if (scalar @$righttruncated) {
1228                         $truncated_operand .= "and " if $previous_truncation_operand;
1229                         $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1230                         $previous_truncation_operand = 1;
1231                     }
1232                     if (scalar @$lefttruncated) {
1233                         $truncated_operand .= "and " if $previous_truncation_operand;
1234                         $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1235                         $previous_truncation_operand = 1;
1236                     }
1237                     if (scalar @$rightlefttruncated) {
1238                         $truncated_operand .= "and " if $previous_truncation_operand;
1239                         $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1240                         $previous_truncation_operand = 1;
1241                     }
1242                 }
1243                 $operand = $truncated_operand if $truncated_operand;
1244                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1245
1246                 # Handle Stemming
1247                 my $stemmed_operand;
1248                 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1249                                                                                 if $stemming;
1250
1251                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1252
1253                 # Handle Field Weighting
1254                 my $weighted_operand;
1255                 if ($weight_fields) {
1256                     $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1257                     $operand = $weighted_operand;
1258                     $indexes_set = 1;
1259                 }
1260
1261                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1262
1263                 # If there's a previous operand, we need to add an operator
1264                 if ($previous_operand) {
1265
1266                     # User-specified operator
1267                     if ( $operators[ $i - 1 ] ) {
1268                         $query     .= " $operators[$i-1] ";
1269                         $query     .= " $index_plus " unless $indexes_set;
1270                         $query     .= " $operand";
1271                         $query_cgi .= "&op=$operators[$i-1]";
1272                         $query_cgi .= "&idx=$index" if $index;
1273                         $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1274                         $query_desc .=
1275                           " $operators[$i-1] $index_plus $operands[$i]";
1276                     }
1277
1278                     # Default operator is and
1279                     else {
1280                         $query      .= " and ";
1281                         $query      .= "$index_plus " unless $indexes_set;
1282                         $query      .= "$operand";
1283                         $query_cgi  .= "&op=and&idx=$index" if $index;
1284                         $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1285                         $query_desc .= " and $index_plus $operands[$i]";
1286                     }
1287                 }
1288
1289                 # There isn't a pervious operand, don't need an operator
1290                 else {
1291
1292                     # Field-weighted queries already have indexes set
1293                     $query .= " $index_plus " unless $indexes_set;
1294                     $query .= $operand;
1295                     $query_desc .= " $index_plus $operands[$i]";
1296                     $query_cgi  .= "&idx=$index" if $index;
1297                     $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1298                     $previous_operand = 1;
1299                 }
1300             }    #/if $operands
1301         }    # /for
1302     }
1303     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1304
1305     # add limits
1306     my %group_OR_limits;
1307     my $availability_limit;
1308     foreach my $this_limit (@limits) {
1309         if ( $this_limit =~ /available/ ) {
1310 #
1311 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1312 ## In English:
1313 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1314             $availability_limit .=
1315 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1316             $limit_cgi  .= "&limit=available";
1317             $limit_desc .= "";
1318         }
1319
1320         # group_OR_limits, prefixed by mc-
1321         # OR every member of the group
1322         elsif ( $this_limit =~ /mc/ ) {
1323             my ($k,$v) = split(/:/, $this_limit,2);
1324             if ( $k !~ /mc-i(tem)?type/ ) {
1325                 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1326                 $this_limit =~ tr/"//d;
1327                 $this_limit = $k.":\"".$v."\"";
1328             }
1329
1330             $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1331             $limit_desc      .= " or " if $group_OR_limits{$k};
1332             $group_OR_limits{$k} .= "$this_limit";
1333             $limit_cgi       .= "&limit=$this_limit";
1334             $limit_desc      .= " $this_limit";
1335         }
1336
1337         # Regular old limits
1338         else {
1339             $limit .= " and " if $limit || $query;
1340             $limit      .= "$this_limit";
1341             $limit_cgi  .= "&limit=$this_limit";
1342             if ($this_limit =~ /^branch:(.+)/) {
1343                 my $branchcode = $1;
1344                 my $branchname = GetBranchName($branchcode);
1345                 if (defined $branchname) {
1346                     $limit_desc .= " branch:$branchname";
1347                 } else {
1348                     $limit_desc .= " $this_limit";
1349                 }
1350             } else {
1351                 $limit_desc .= " $this_limit";
1352             }
1353         }
1354     }
1355     foreach my $k (keys (%group_OR_limits)) {
1356         $limit .= " and " if ( $query || $limit );
1357         $limit .= "($group_OR_limits{$k})";
1358     }
1359     if ($availability_limit) {
1360         $limit .= " and " if ( $query || $limit );
1361         $limit .= "($availability_limit)";
1362     }
1363
1364     # Normalize the query and limit strings
1365     # This is flawed , means we can't search anything with : in it
1366     # if user wants to do ccl or cql, start the query with that
1367 #    $query =~ s/:/=/g;
1368     $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1369     $query =~ s/(?<=(wrdl)):/=/g;
1370     $query =~ s/(?<=(trn|phr)):/=/g;
1371     $limit =~ s/:/=/g;
1372     for ( $query, $query_desc, $limit, $limit_desc ) {
1373         s/  +/ /g;    # remove extra spaces
1374         s/^ //g;     # remove any beginning spaces
1375         s/ $//g;     # remove any ending spaces
1376         s/==/=/g;    # remove double == from query
1377     }
1378     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1379
1380     for ($query_cgi,$simple_query) {
1381         s/"//g;
1382     }
1383     # append the limit to the query
1384     $query .= " " . $limit;
1385
1386     # Warnings if DEBUG
1387     if ($DEBUG) {
1388         warn "QUERY:" . $query;
1389         warn "QUERY CGI:" . $query_cgi;
1390         warn "QUERY DESC:" . $query_desc;
1391         warn "LIMIT:" . $limit;
1392         warn "LIMIT CGI:" . $limit_cgi;
1393         warn "LIMIT DESC:" . $limit_desc;
1394         warn "---------\nLeave buildQuery\n---------";
1395     }
1396     return (
1397         undef,              $query, $simple_query, $query_cgi,
1398         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1399         $stopwords_removed, $query_type
1400     );
1401 }
1402
1403 =head2 searchResults
1404
1405   my @search_results = searchResults($search_context, $searchdesc, $hits,
1406                                      $results_per_page, $offset, $scan,
1407                                      @marcresults, $hidelostitems);
1408
1409 Format results in a form suitable for passing to the template
1410
1411 =cut
1412
1413 # IMO this subroutine is pretty messy still -- it's responsible for
1414 # building the HTML output for the template
1415 sub searchResults {
1416     my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1417     my $dbh = C4::Context->dbh;
1418     my @newresults;
1419
1420     require C4::Items;
1421
1422     $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1423     my ($is_opac, $hidelostitems);
1424     if ($search_context eq 'opac') {
1425         $hidelostitems = C4::Context->preference('hidelostitems');
1426         $is_opac       = 1;
1427     }
1428
1429     #Build branchnames hash
1430     #find branchname
1431     #get branch information.....
1432     my %branches;
1433     my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1434     $bsth->execute();
1435     while ( my $bdata = $bsth->fetchrow_hashref ) {
1436         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1437     }
1438 # FIXME - We build an authorised values hash here, using the default framework
1439 # though it is possible to have different authvals for different fws.
1440
1441     my $shelflocations =GetKohaAuthorisedValues('items.location','');
1442
1443     # get notforloan authorised value list (see $shelflocations  FIXME)
1444     my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1445
1446     #Build itemtype hash
1447     #find itemtype & itemtype image
1448     my %itemtypes;
1449     $bsth =
1450       $dbh->prepare(
1451         "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1452       );
1453     $bsth->execute();
1454     while ( my $bdata = $bsth->fetchrow_hashref ) {
1455                 foreach (qw(description imageurl summary notforloan)) {
1456                 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1457                 }
1458     }
1459
1460     #search item field code
1461     my $sth =
1462       $dbh->prepare(
1463 "SELECT tagfield FROM marc_subfield_structure WHERE kohafield LIKE 'items.itemnumber'"
1464       );
1465     $sth->execute;
1466     my ($itemtag) = $sth->fetchrow;
1467
1468     ## find column names of items related to MARC
1469     my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1470     $sth2->execute;
1471     my %subfieldstosearch;
1472     while ( ( my $column ) = $sth2->fetchrow ) {
1473         my ( $tagfield, $tagsubfield ) =
1474           &GetMarcFromKohaField( "items." . $column, "" );
1475         $subfieldstosearch{$column} = $tagsubfield;
1476     }
1477
1478     # handle which records to actually retrieve
1479     my $times;
1480     if ( $hits && $offset + $results_per_page <= $hits ) {
1481         $times = $offset + $results_per_page;
1482     }
1483     else {
1484         $times = $hits;  # FIXME: if $hits is undefined, why do we want to equal it?
1485     }
1486
1487         my $marcflavour = C4::Context->preference("marcflavour");
1488     # We get the biblionumber position in MARC
1489     my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1490
1491     # loop through all of the records we've retrieved
1492     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1493         my $marcrecord = MARC::File::USMARC::decode( $marcresults->[$i] );
1494         my $fw = $scan
1495              ? undef
1496              : $bibliotag < 10
1497                ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1498                : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1499         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1500         $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1501         $oldbiblio->{result_number} = $i + 1;
1502
1503         # add imageurl to itemtype if there is one
1504         $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1505
1506         $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 ) ) : [];
1507                 $oldbiblio->{normalized_upc}  = GetNormalizedUPC(       $marcrecord,$marcflavour);
1508                 $oldbiblio->{normalized_ean}  = GetNormalizedEAN(       $marcrecord,$marcflavour);
1509                 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1510                 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1511                 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1512
1513                 # edition information, if any
1514         $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1515                 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1516  # Build summary if there is one (the summary is defined in the itemtypes table)
1517  # FIXME: is this used anywhere, I think it can be commented out? -- JF
1518         if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1519             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1520             my @fields  = $marcrecord->fields();
1521
1522             my $newsummary;
1523             foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1524                 my $tags = {};
1525                 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1526                     $tag =~ /(.{3})(.)/;
1527                     if($marcrecord->field($1)){
1528                         my @abc = $marcrecord->field($1)->subfield($2);
1529                         $tags->{$tag} = $#abc + 1 ;
1530                     }
1531                 }
1532
1533                 # We catch how many times to repeat this line
1534                 my $max = 0;
1535                 foreach my $tag (keys(%$tags)){
1536                     $max = $tags->{$tag} if($tags->{$tag} > $max);
1537                  }
1538
1539                 # we replace, and repeat each line
1540                 for (my $i = 0 ; $i < $max ; $i++){
1541                     my $newline = $line;
1542
1543                     foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1544                         $tag =~ /(.{3})(.)/;
1545
1546                         if($marcrecord->field($1)){
1547                             my @repl = $marcrecord->field($1)->subfield($2);
1548                             my $subfieldvalue = $repl[$i];
1549
1550                             if (! utf8::is_utf8($subfieldvalue)) {
1551                                 utf8::decode($subfieldvalue);
1552                             }
1553
1554                              $newline =~ s/\[$tag\]/$subfieldvalue/g;
1555                         }
1556                     }
1557                     $newsummary .= "$newline\n";
1558                 }
1559             }
1560
1561             $newsummary =~ s/\[(.*?)]//g;
1562             $newsummary =~ s/\n/<br\/>/g;
1563             $oldbiblio->{summary} = $newsummary;
1564         }
1565
1566         # Pull out the items fields
1567         my @fields = $marcrecord->field($itemtag);
1568         my $marcflavor = C4::Context->preference("marcflavour");
1569         # adding linked items that belong to host records
1570         my $analyticsfield = '773';
1571         if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1572             $analyticsfield = '773';
1573         } elsif ($marcflavor eq 'UNIMARC') {
1574             $analyticsfield = '461';
1575         }
1576         foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1577             my $hostbiblionumber = $hostfield->subfield("0");
1578             my $linkeditemnumber = $hostfield->subfield("9");
1579             if(!$hostbiblionumber eq undef){
1580                 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
1581                 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
1582                 if(!$hostbiblio eq undef){
1583                     my @hostitems = $hostbiblio->field($itemfield);
1584                     foreach my $hostitem (@hostitems){
1585                         if ($hostitem->subfield("9") eq $linkeditemnumber){
1586                             my $linkeditem =$hostitem;
1587                             # append linked items if they exist
1588                             if (!$linkeditem eq undef){
1589                                 push (@fields, $linkeditem);}
1590                         }
1591                     }
1592                 }
1593             }
1594         }
1595
1596         # Setting item statuses for display
1597         my @available_items_loop;
1598         my @onloan_items_loop;
1599         my @other_items_loop;
1600
1601         my $available_items;
1602         my $onloan_items;
1603         my $other_items;
1604
1605         my $ordered_count         = 0;
1606         my $available_count       = 0;
1607         my $onloan_count          = 0;
1608         my $longoverdue_count     = 0;
1609         my $other_count           = 0;
1610         my $wthdrawn_count        = 0;
1611         my $itemlost_count        = 0;
1612         my $hideatopac_count      = 0;
1613         my $itembinding_count     = 0;
1614         my $itemdamaged_count     = 0;
1615         my $item_in_transit_count = 0;
1616         my $can_place_holds       = 0;
1617         my $item_onhold_count     = 0;
1618         my $items_count           = scalar(@fields);
1619         my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
1620         my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
1621
1622         # loop through every item
1623               my @hiddenitems;
1624         foreach my $field (@fields) {
1625             my $item;
1626
1627             # populate the items hash
1628             foreach my $code ( keys %subfieldstosearch ) {
1629                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1630             }
1631             $item->{description} = $itemtypes{ $item->{itype} }{description};
1632
1633                 # Hidden items
1634             if ($is_opac) {
1635                 my @hi = C4::Items::GetHiddenItemnumbers($item);
1636                 $item->{'hideatopac'} = @hi;
1637                 push @hiddenitems, @hi;
1638             }
1639
1640             my $hbranch     = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch'    : 'holdingbranch';
1641             my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1642
1643             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1644             if ($item->{$hbranch}) {
1645                 $item->{'branchname'} = $branches{$item->{$hbranch}};
1646             }
1647             elsif ($item->{$otherbranch}) {     # Last resort
1648                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1649             }
1650
1651                         my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1652 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1653             my $userenv = C4::Context->userenv;
1654             if ( $item->{onloan} && !(C4::Members::GetHideLostItemsPreference($userenv->{'number'}) && $item->{itemlost}) ) {
1655                 $onloan_count++;
1656                                 my $key = $prefix . $item->{onloan} . $item->{barcode};
1657                                 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1658                                 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1659                                 $onloan_items->{$key}->{branchname} = $item->{branchname};
1660                                 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1661                                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1662                                 $onloan_items->{$key}->{description} = $item->{description};
1663                                 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1664                 # if something's checked out and lost, mark it as 'long overdue'
1665                 if ( $item->{itemlost} ) {
1666                     $onloan_items->{$prefix}->{longoverdue}++;
1667                     $longoverdue_count++;
1668                 } else {        # can place holds as long as item isn't lost
1669                     $can_place_holds = 1;
1670                 }
1671             }
1672
1673          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1674             else {
1675
1676                 # item is on order
1677                 if ( $item->{notforloan} == -1 ) {
1678                     $ordered_count++;
1679                 }
1680
1681                 # is item in transit?
1682                 my $transfertwhen = '';
1683                 my ($transfertfrom, $transfertto);
1684
1685                 # is item on the reserve shelf?
1686                 my $reservestatus = '';
1687                 my $reserveitem;
1688
1689                 unless ($item->{wthdrawn}
1690                         || $item->{itemlost}
1691                         || $item->{damaged}
1692                         || $item->{notforloan}
1693                         || $items_count > 20) {
1694
1695                     # A couple heuristics to limit how many times
1696                     # we query the database for item transfer information, sacrificing
1697                     # accuracy in some cases for speed;
1698                     #
1699                     # 1. don't query if item has one of the other statuses
1700                     # 2. don't check transit status if the bib has
1701                     #    more than 20 items
1702                     #
1703                     # FIXME: to avoid having the query the database like this, and to make
1704                     #        the in transit status count as unavailable for search limiting,
1705                     #        should map transit status to record indexed in Zebra.
1706                     #
1707                     ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1708                     ($reservestatus, $reserveitem, undef) = C4::Reserves::CheckReserves($item->{itemnumber});
1709                 }
1710
1711                 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
1712                 if (   $item->{wthdrawn}
1713                     || $item->{itemlost}
1714                     || $item->{damaged}
1715                     || $item->{notforloan} > 0
1716                     || $item->{hideatopac}
1717                     || $reservestatus eq 'Waiting'
1718                     || ($transfertwhen ne ''))
1719                 {
1720                     $wthdrawn_count++        if $item->{wthdrawn};
1721                     $itemlost_count++        if $item->{itemlost};
1722                     $itemdamaged_count++     if $item->{damaged};
1723                     $hideatopac_count++      if $item->{hideatopac};
1724                     $item_in_transit_count++ if $transfertwhen ne '';
1725                     $item_onhold_count++     if $reservestatus eq 'Waiting';
1726                     $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1727
1728                     # can place hold on item ?
1729                     if ((!$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems'))
1730                       && !$item->{itemlost}
1731                       && !$item->{withdrawn}
1732                     ) {
1733                         $can_place_holds = 1;
1734                     }
1735
1736                     $other_count++;
1737
1738                     my $key = $prefix . $item->{status};
1739                     foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber hideatopac)) {
1740                         $other_items->{$key}->{$_} = $item->{$_};
1741                     }
1742                     $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
1743                     $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
1744                     $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
1745                                         $other_items->{$key}->{count}++ if $item->{$hbranch};
1746                                         $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1747                                         $other_items->{$key}->{description} = $item->{description};
1748                                         $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1749                 }
1750                 # item is available
1751                 else {
1752                     $can_place_holds = 1;
1753                     $available_count++;
1754                                         $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1755                                         foreach (qw(branchname itemcallnumber hideatopac description)) {
1756                         $available_items->{$prefix}->{$_} = $item->{$_};
1757                                         }
1758                                         $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1759                                         $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1760                 }
1761             }
1762         }    # notforloan, item level and biblioitem level
1763         if ($items_count > 0) {
1764         next if $is_opac       && $hideatopac_count >= $items_count;
1765         next if $hidelostitems && $itemlost_count   >= $items_count;
1766         }
1767         my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1768         for my $key ( sort keys %$onloan_items ) {
1769             (++$onloanitemscount > $maxitems) and last;
1770             push @onloan_items_loop, $onloan_items->{$key};
1771         }
1772         for my $key ( sort keys %$other_items ) {
1773             (++$otheritemscount > $maxitems) and last;
1774             push @other_items_loop, $other_items->{$key};
1775         }
1776         for my $key ( sort keys %$available_items ) {
1777             (++$availableitemscount > $maxitems) and last;
1778             push @available_items_loop, $available_items->{$key}
1779         }
1780
1781         # XSLT processing of some stuff
1782         use C4::Charset;
1783         SetUTF8Flag($marcrecord);
1784         $debug && warn $marcrecord->as_formatted;
1785         my $interface = $search_context eq 'opac' ? 'OPAC' : '';
1786         if (!$scan && C4::Context->preference($interface . "XSLTResultsDisplay")) {
1787             $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $interface."XSLTResultsDisplay", 1, \@hiddenitems);
1788             # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
1789         }
1790
1791         # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
1792         if (!C4::Context->preference("item-level_itypes")) {
1793             if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
1794                 $can_place_holds = 0;
1795             }
1796         }
1797         $oldbiblio->{norequests} = 1 unless $can_place_holds;
1798         $oldbiblio->{itemsplural}          = 1 if $items_count > 1;
1799         $oldbiblio->{items_count}          = $items_count;
1800         $oldbiblio->{available_items_loop} = \@available_items_loop;
1801         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
1802         $oldbiblio->{other_items_loop}     = \@other_items_loop;
1803         $oldbiblio->{availablecount}       = $available_count;
1804         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
1805         $oldbiblio->{onloancount}          = $onloan_count;
1806         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
1807         $oldbiblio->{othercount}           = $other_count;
1808         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
1809         $oldbiblio->{wthdrawncount}        = $wthdrawn_count;
1810         $oldbiblio->{itemlostcount}        = $itemlost_count;
1811         $oldbiblio->{damagedcount}         = $itemdamaged_count;
1812         $oldbiblio->{intransitcount}       = $item_in_transit_count;
1813         $oldbiblio->{onholdcount}          = $item_onhold_count;
1814         $oldbiblio->{orderedcount}         = $ordered_count;
1815         # deleting - in isbn to enable amazon content
1816         $oldbiblio->{isbn} =~ s/-//g;
1817
1818         if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
1819             my $fieldspec = C4::Context->preference("AlternateHoldingsField");
1820             my $subfields = substr $fieldspec, 3;
1821             my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
1822             my @alternateholdingsinfo = ();
1823             my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
1824             my $alternateholdingscount = 0;
1825
1826             for my $field (@holdingsfields) {
1827                 my %holding = ( holding => '' );
1828                 my $havesubfield = 0;
1829                 for my $subfield ($field->subfields()) {
1830                     if ((index $subfields, $$subfield[0]) >= 0) {
1831                         $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
1832                         $holding{'holding'} .= $$subfield[1];
1833                         $havesubfield++;
1834                     }
1835                 }
1836                 if ($havesubfield) {
1837                     push(@alternateholdingsinfo, \%holding);
1838                     $alternateholdingscount++;
1839                 }
1840             }
1841
1842             $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
1843             $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
1844         }
1845
1846         push( @newresults, $oldbiblio );
1847     }
1848
1849     return @newresults;
1850 }
1851
1852 =head2 SearchAcquisitions
1853     Search for acquisitions
1854 =cut
1855
1856 sub SearchAcquisitions{
1857     my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
1858
1859     my $dbh=C4::Context->dbh;
1860     # Variable initialization
1861     my $str=qq|
1862     SELECT marcxml
1863     FROM biblio
1864     LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1865     LEFT JOIN items ON items.biblionumber=biblio.biblionumber
1866     WHERE dateaccessioned BETWEEN ? AND ?
1867     |;
1868
1869     my (@params,@loopcriteria);
1870
1871     push @params, $datebegin->output("iso");
1872     push @params, $dateend->output("iso");
1873
1874     if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
1875         if(C4::Context->preference("item-level_itypes")){
1876             $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1877         }else{
1878             $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1879         }
1880         push @params, @$itemtypes;
1881     }
1882
1883     if ($criteria =~/itemtype/){
1884         if(C4::Context->preference("item-level_itypes")){
1885             $str .= "AND items.itype=? ";
1886         }else{
1887             $str .= "AND biblioitems.itemtype=? ";
1888         }
1889
1890         if(scalar(@$itemtypes) == 0){
1891             my $itypes = GetItemTypes();
1892             for my $key (keys %$itypes){
1893                 push @$itemtypes, $key;
1894             }
1895         }
1896
1897         @loopcriteria= @$itemtypes;
1898     }elsif ($criteria=~/itemcallnumber/){
1899         $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
1900                  OR items.itemcallnumber is NULL
1901                  OR items.itemcallnumber = '')";
1902
1903         @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
1904     }else {
1905         $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
1906         @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
1907     }
1908
1909     if ($orderby =~ /date_desc/){
1910         $str.=" ORDER BY dateaccessioned DESC";
1911     } else {
1912         $str.=" ORDER BY title";
1913     }
1914
1915     my $qdataacquisitions=$dbh->prepare($str);
1916
1917     my @loopacquisitions;
1918     foreach my $value(@loopcriteria){
1919         push @params,$value;
1920         my %cell;
1921         $cell{"title"}=$value;
1922         $cell{"titlecode"}=$value;
1923
1924         eval{$qdataacquisitions->execute(@params);};
1925
1926         if ($@){ warn "recentacquisitions Error :$@";}
1927         else {
1928             my @loopdata;
1929             while (my $data=$qdataacquisitions->fetchrow_hashref){
1930                 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
1931             }
1932             $cell{"loopdata"}=\@loopdata;
1933         }
1934         push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
1935         pop @params;
1936     }
1937     $qdataacquisitions->finish;
1938     return \@loopacquisitions;
1939 }
1940 #----------------------------------------------------------------------
1941 #
1942 # Non-Zebra GetRecords#
1943 #----------------------------------------------------------------------
1944
1945 =head2 NZgetRecords
1946
1947   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1948
1949 =cut
1950
1951 sub NZgetRecords {
1952     my (
1953         $query,            $simple_query, $sort_by_ref,    $servers_ref,
1954         $results_per_page, $offset,       $expanded_facet, $branches,
1955         $query_type,       $scan
1956     ) = @_;
1957     warn "query =$query" if $DEBUG;
1958     my $result = NZanalyse($query);
1959     warn "results =$result" if $DEBUG;
1960     return ( undef,
1961         NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1962         undef );
1963 }
1964
1965 =head2 NZanalyse
1966
1967   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1968   the list is built from an inverted index in the nozebra SQL table
1969   note that title is here only for convenience : the sorting will be very fast when requested on title
1970   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1971
1972 =cut
1973
1974 sub NZanalyse {
1975     my ( $string, $server ) = @_;
1976 #     warn "---------"       if $DEBUG;
1977     warn " NZanalyse" if $DEBUG;
1978 #     warn "---------"       if $DEBUG;
1979
1980  # $server contains biblioserver or authorities, depending on what we search on.
1981  #warn "querying : $string on $server";
1982     $server = 'biblioserver' unless $server;
1983
1984 # if we have a ", replace the content to discard temporarily any and/or/not inside
1985     my $commacontent;
1986     if ( $string =~ /"/ ) {
1987         $string =~ s/"(.*?)"/__X__/;
1988         $commacontent = $1;
1989         warn "commacontent : $commacontent" if $DEBUG;
1990     }
1991
1992 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1993 # then, call again NZanalyse with $left and $right
1994 # (recursive until we find a leaf (=> something without and/or/not)
1995 # delete repeated operator... Would then go in infinite loop
1996     while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
1997     }
1998
1999     #process parenthesis before.
2000     if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
2001         my $left     = $1;
2002         my $right    = $4;
2003         my $operator = lc($3);   # FIXME: and/or/not are operators, not operands
2004         warn
2005 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
2006           if $DEBUG;
2007         my $leftresult = NZanalyse( $left, $server );
2008         if ($operator) {
2009             my $rightresult = NZanalyse( $right, $server );
2010
2011             # OK, we have the results for right and left part of the query
2012             # depending of operand, intersect, union or exclude both lists
2013             # to get a result list
2014             if ( $operator eq ' and ' ) {
2015                 return NZoperatorAND($leftresult,$rightresult);
2016             }
2017             elsif ( $operator eq ' or ' ) {
2018
2019                 # just merge the 2 strings
2020                 return $leftresult . $rightresult;
2021             }
2022             elsif ( $operator eq ' not ' ) {
2023                 return NZoperatorNOT($leftresult,$rightresult);
2024             }
2025         }
2026         else {
2027 # this error is impossible, because of the regexp that isolate the operand, but just in case...
2028             return $leftresult;
2029         }
2030     }
2031     warn "string :" . $string if $DEBUG;
2032     my $left = "";
2033     my $right = "";
2034     my $operator = "";
2035     if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
2036         $left     = $1;
2037         $right    = $3;
2038         $operator = lc($2);    # FIXME: and/or/not are operators, not operands
2039     }
2040     warn "no parenthesis. left : $left operator: $operator right: $right"
2041       if $DEBUG;
2042
2043     # it's not a leaf, we have a and/or/not
2044     if ($operator) {
2045
2046         # reintroduce comma content if needed
2047         $right =~ s/__X__/"$commacontent"/ if $commacontent;
2048         $left  =~ s/__X__/"$commacontent"/ if $commacontent;
2049         warn "node : $left / $operator / $right\n" if $DEBUG;
2050         my $leftresult  = NZanalyse( $left,  $server );
2051         my $rightresult = NZanalyse( $right, $server );
2052         warn " leftresult : $leftresult" if $DEBUG;
2053         warn " rightresult : $rightresult" if $DEBUG;
2054         # OK, we have the results for right and left part of the query
2055         # depending of operand, intersect, union or exclude both lists
2056         # to get a result list
2057         if ( $operator eq ' and ' ) {
2058             return NZoperatorAND($leftresult,$rightresult);
2059         }
2060         elsif ( $operator eq ' or ' ) {
2061
2062             # just merge the 2 strings
2063             return $leftresult . $rightresult;
2064         }
2065         elsif ( $operator eq ' not ' ) {
2066             return NZoperatorNOT($leftresult,$rightresult);
2067         }
2068         else {
2069
2070 # this error is impossible, because of the regexp that isolate the operand, but just in case...
2071             die "error : operand unknown : $operator for $string";
2072         }
2073
2074         # it's a leaf, do the real SQL query and return the result
2075     }
2076     else {
2077         $string =~ s/__X__/"$commacontent"/ if $commacontent;
2078         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
2079         #remove trailing blank at the beginning
2080         $string =~ s/^ //g;
2081         warn "leaf:$string" if $DEBUG;
2082
2083         # parse the string in in operator/operand/value again
2084         my $left = "";
2085         my $operator = "";
2086         my $right = "";
2087         if ($string =~ /(.*)(>=|<=)(.*)/) {
2088             $left     = $1;
2089             $operator = $2;
2090             $right    = $3;
2091         } else {
2092             $left = $string;
2093         }
2094 #         warn "handling leaf... left:$left operator:$operator right:$right"
2095 #           if $DEBUG;
2096         unless ($operator) {
2097             if ($string =~ /(.*)(>|<|=)(.*)/) {
2098                 $left     = $1;
2099                 $operator = $2;
2100                 $right    = $3;
2101                 warn
2102     "handling unless (operator)... left:$left operator:$operator right:$right"
2103                 if $DEBUG;
2104             } else {
2105                 $left = $string;
2106             }
2107         }
2108         my $results;
2109
2110 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
2111         $left =~ s/ .*$//;
2112
2113         # automatic replace for short operators
2114         $left = 'title'            if $left =~ '^ti$';
2115         $left = 'author'           if $left =~ '^au$';
2116         $left = 'publisher'        if $left =~ '^pb$';
2117         $left = 'subject'          if $left =~ '^su$';
2118         $left = 'koha-Auth-Number' if $left =~ '^an$';
2119         $left = 'keyword'          if $left =~ '^kw$';
2120         $left = 'itemtype'         if $left =~ '^mc$'; # Fix for Bug 2599 - Search limits not working for NoZebra
2121         warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
2122         my $dbh = C4::Context->dbh;
2123         if ( $operator && $left ne 'keyword' ) {
2124             #do a specific search
2125             $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
2126             my $sth = $dbh->prepare(
2127 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
2128             );
2129             warn "$left / $operator / $right\n" if $DEBUG;
2130
2131             # split each word, query the DB and build the biblionumbers result
2132             #sanitizing leftpart
2133             $left =~ s/^\s+|\s+$//;
2134             foreach ( split / /, $right ) {
2135                 my $biblionumbers;
2136                 $_ =~ s/^\s+|\s+$//;
2137                 next unless $_;
2138                 warn "EXECUTE : $server, $left, $_" if $DEBUG;
2139                 $sth->execute( $server, $left, $_ )
2140                   or warn "execute failed: $!";
2141                 while ( my ( $line, $value ) = $sth->fetchrow ) {
2142
2143 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
2144 # otherwise, fill the result
2145                     $biblionumbers .= $line
2146                       unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
2147                     warn "result : $value "
2148                       . ( $right  =~ /\d/ ) . "=="
2149                       . ( $value =~ /\D/?$line:"" ) if $DEBUG;         #= $line";
2150                 }
2151
2152 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
2153                 if ($results) {
2154                     warn "NZAND" if $DEBUG;
2155                     $results = NZoperatorAND($biblionumbers,$results);
2156                 } else {
2157                     $results = $biblionumbers;
2158                 }
2159             }
2160         }
2161         else {
2162       #do a complete search (all indexes), if index='kw' do complete search too.
2163             my $sth = $dbh->prepare(
2164 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
2165             );
2166
2167             # split each word, query the DB and build the biblionumbers result
2168             foreach ( split / /, $string ) {
2169                 next if C4::Context->stopwords->{ uc($_) };   # skip if stopword
2170                 warn "search on all indexes on $_" if $DEBUG;
2171                 my $biblionumbers;
2172                 next unless $_;
2173                 $sth->execute( $server, $_ );
2174                 while ( my $line = $sth->fetchrow ) {
2175                     $biblionumbers .= $line;
2176                 }
2177
2178 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
2179                 if ($results) {
2180                     $results = NZoperatorAND($biblionumbers,$results);
2181                 }
2182                 else {
2183                     warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
2184                     $results = $biblionumbers;
2185                 }
2186             }
2187         }
2188         warn "return : $results for LEAF : $string" if $DEBUG;
2189         return $results;
2190     }
2191     warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
2192 }
2193
2194 sub NZoperatorAND{
2195     my ($rightresult, $leftresult)=@_;
2196
2197     my @leftresult = split /;/, $leftresult;
2198     warn " @leftresult / $rightresult \n" if $DEBUG;
2199
2200     #             my @rightresult = split /;/,$leftresult;
2201     my $finalresult;
2202
2203 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
2204 # the result is stored twice, to have the same weight for AND than OR.
2205 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
2206 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
2207     foreach (@leftresult) {
2208         my $value = $_;
2209         my $countvalue;
2210         ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
2211         if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
2212             $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
2213             $finalresult .=
2214                 "$value-$countvalue;$value-$countvalue;";
2215         }
2216     }
2217     warn "NZAND DONE : $finalresult \n" if $DEBUG;
2218     return $finalresult;
2219 }
2220
2221 sub NZoperatorOR{
2222     my ($rightresult, $leftresult)=@_;
2223     return $rightresult.$leftresult;
2224 }
2225
2226 sub NZoperatorNOT{
2227     my ($leftresult, $rightresult)=@_;
2228
2229     my @leftresult = split /;/, $leftresult;
2230
2231     #             my @rightresult = split /;/,$leftresult;
2232     my $finalresult;
2233     foreach (@leftresult) {
2234         my $value=$_;
2235         $value=$1 if $value=~m/(.*)-\d+$/;
2236         unless ($rightresult =~ "$value-") {
2237             $finalresult .= "$_;";
2238         }
2239     }
2240     return $finalresult;
2241 }
2242
2243 =head2 NZorder
2244
2245   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
2246
2247   TODO :: Description
2248
2249 =cut
2250
2251 sub NZorder {
2252     my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
2253     warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
2254
2255     # order title asc by default
2256     #     $ordering = '1=36 <i' unless $ordering;
2257     $results_per_page = 20 unless $results_per_page;
2258     $offset           = 0  unless $offset;
2259     my $dbh = C4::Context->dbh;
2260
2261     #
2262     # order by POPULARITY
2263     #
2264     if ( $ordering =~ /popularity/ ) {
2265         my %result;
2266         my %popularity;
2267
2268         # popularity is not in MARC record, it's builded from a specific query
2269         my $sth =
2270           $dbh->prepare("select sum(issues) from items where biblionumber=?");
2271         foreach ( split /;/, $biblionumbers ) {
2272             my ( $biblionumber, $title ) = split /,/, $_;
2273             $result{$biblionumber} = GetMarcBiblio($biblionumber);
2274             $sth->execute($biblionumber);
2275             my $popularity = $sth->fetchrow || 0;
2276
2277 # hint : the key is popularity.title because we can have
2278 # many results with the same popularity. In this case, sub-ordering is done by title
2279 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
2280 # (un-frequent, I agree, but we won't forget anything that way ;-)
2281             $popularity{ sprintf( "%10d", $popularity ) . $title
2282                   . $biblionumber } = $biblionumber;
2283         }
2284
2285     # sort the hash and return the same structure as GetRecords (Zebra querying)
2286         my $result_hash;
2287         my $numbers = 0;
2288         if ( $ordering eq 'popularity_dsc' ) {    # sort popularity DESC
2289             foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
2290                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2291                   $result{ $popularity{$key} }->as_usmarc();
2292             }
2293         }
2294         else {                                    # sort popularity ASC
2295             foreach my $key ( sort ( keys %popularity ) ) {
2296                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2297                   $result{ $popularity{$key} }->as_usmarc();
2298             }
2299         }
2300         my $finalresult = ();
2301         $result_hash->{'hits'}         = $numbers;
2302         $finalresult->{'biblioserver'} = $result_hash;
2303         return $finalresult;
2304
2305         #
2306         # ORDER BY author
2307         #
2308     }
2309     elsif ( $ordering =~ /author/ ) {
2310         my %result;
2311         foreach ( split /;/, $biblionumbers ) {
2312             my ( $biblionumber, $title ) = split /,/, $_;
2313             my $record = GetMarcBiblio($biblionumber);
2314             my $author;
2315             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2316                 $author = $record->subfield( '200', 'f' );
2317                 $author = $record->subfield( '700', 'a' ) unless $author;
2318             }
2319             else {
2320                 $author = $record->subfield( '100', 'a' );
2321             }
2322
2323 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2324 # and we don't want to get only 1 result for each of them !!!
2325             $result{ $author . $biblionumber } = $record;
2326         }
2327
2328     # sort the hash and return the same structure as GetRecords (Zebra querying)
2329         my $result_hash;
2330         my $numbers = 0;
2331         if ( $ordering eq 'author_za' || $ordering eq 'author_dsc' ) {    # sort by author desc
2332             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2333                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2334                   $result{$key}->as_usmarc();
2335             }
2336         }
2337         else {                               # sort by author ASC
2338             foreach my $key ( sort ( keys %result ) ) {
2339                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2340                   $result{$key}->as_usmarc();
2341             }
2342         }
2343         my $finalresult = ();
2344         $result_hash->{'hits'}         = $numbers;
2345         $finalresult->{'biblioserver'} = $result_hash;
2346         return $finalresult;
2347
2348         #
2349         # ORDER BY callnumber
2350         #
2351     }
2352     elsif ( $ordering =~ /callnumber/ ) {
2353         my %result;
2354         foreach ( split /;/, $biblionumbers ) {
2355             my ( $biblionumber, $title ) = split /,/, $_;
2356             my $record = GetMarcBiblio($biblionumber);
2357             my $callnumber;
2358             my $frameworkcode = GetFrameworkCode($biblionumber);
2359             my ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField(  'items.itemcallnumber', $frameworkcode);
2360                ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField('biblioitems.callnumber', $frameworkcode)
2361                 unless $callnumber_tag;
2362             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2363                 $callnumber = $record->subfield( '200', 'f' );
2364             } else {
2365                 $callnumber = $record->subfield( '100', 'a' );
2366             }
2367
2368 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2369 # and we don't want to get only 1 result for each of them !!!
2370             $result{ $callnumber . $biblionumber } = $record;
2371         }
2372
2373     # sort the hash and return the same structure as GetRecords (Zebra querying)
2374         my $result_hash;
2375         my $numbers = 0;
2376         if ( $ordering eq 'call_number_dsc' ) {    # sort by title desc
2377             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2378                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2379                   $result{$key}->as_usmarc();
2380             }
2381         }
2382         else {                                     # sort by title ASC
2383             foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
2384                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2385                   $result{$key}->as_usmarc();
2386             }
2387         }
2388         my $finalresult = ();
2389         $result_hash->{'hits'}         = $numbers;
2390         $finalresult->{'biblioserver'} = $result_hash;
2391         return $finalresult;
2392     }
2393     elsif ( $ordering =~ /pubdate/ ) {             #pub year
2394         my %result;
2395         foreach ( split /;/, $biblionumbers ) {
2396             my ( $biblionumber, $title ) = split /,/, $_;
2397             my $record = GetMarcBiblio($biblionumber);
2398             my ( $publicationyear_tag, $publicationyear_subfield ) =
2399               GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
2400             my $publicationyear =
2401               $record->subfield( $publicationyear_tag,
2402                 $publicationyear_subfield );
2403
2404 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2405 # and we don't want to get only 1 result for each of them !!!
2406             $result{ $publicationyear . $biblionumber } = $record;
2407         }
2408
2409     # sort the hash and return the same structure as GetRecords (Zebra querying)
2410         my $result_hash;
2411         my $numbers = 0;
2412         if ( $ordering eq 'pubdate_dsc' ) {    # sort by pubyear desc
2413             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2414                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2415                   $result{$key}->as_usmarc();
2416             }
2417         }
2418         else {                                 # sort by pub year ASC
2419             foreach my $key ( sort ( keys %result ) ) {
2420                 $result_hash->{'RECORDS'}[ $numbers++ ] =
2421                   $result{$key}->as_usmarc();
2422             }
2423         }
2424         my $finalresult = ();
2425         $result_hash->{'hits'}         = $numbers;
2426         $finalresult->{'biblioserver'} = $result_hash;
2427         return $finalresult;
2428
2429         #
2430         # ORDER BY title
2431         #
2432     }
2433     elsif ( $ordering =~ /title/ ) {
2434
2435 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
2436         my %result;
2437         foreach ( split /;/, $biblionumbers ) {
2438             my ( $biblionumber, $title ) = split /,/, $_;
2439
2440 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2441 # and we don't want to get only 1 result for each of them !!!
2442 # hint & speed improvement : we can order without reading the record
2443 # so order, and read records only for the requested page !
2444             $result{ $title . $biblionumber } = $biblionumber;
2445         }
2446
2447     # sort the hash and return the same structure as GetRecords (Zebra querying)
2448         my $result_hash;
2449         my $numbers = 0;
2450         if ( $ordering eq 'title_az' ) {    # sort by title desc
2451             foreach my $key ( sort ( keys %result ) ) {
2452                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2453             }
2454         }
2455         else {                              # sort by title ASC
2456             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2457                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2458             }
2459         }
2460
2461         # limit the $results_per_page to result size if it's more
2462         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2463
2464         # for the requested page, replace biblionumber by the complete record
2465         # speed improvement : avoid reading too much things
2466         for (
2467             my $counter = $offset ;
2468             $counter <= $offset + $results_per_page ;
2469             $counter++
2470           )
2471         {
2472             $result_hash->{'RECORDS'}[$counter] =
2473               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2474         }
2475         my $finalresult = ();
2476         $result_hash->{'hits'}         = $numbers;
2477         $finalresult->{'biblioserver'} = $result_hash;
2478         return $finalresult;
2479     }
2480     else {
2481
2482 #
2483 # order by ranking
2484 #
2485 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2486         my %result;
2487         my %count_ranking;
2488         foreach ( split /;/, $biblionumbers ) {
2489             my ( $biblionumber, $title ) = split /,/, $_;
2490             $title =~ /(.*)-(\d)/;
2491
2492             # get weight
2493             my $ranking = $2;
2494
2495 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2496 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2497 # biblio N has ranking = 6
2498             $count_ranking{$biblionumber} += $ranking;
2499         }
2500
2501 # build the result by "inverting" the count_ranking hash
2502 # 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
2503 #         warn "counting";
2504         foreach ( keys %count_ranking ) {
2505             $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2506         }
2507
2508     # sort the hash and return the same structure as GetRecords (Zebra querying)
2509         my $result_hash;
2510         my $numbers = 0;
2511         foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2512             $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2513         }
2514
2515         # limit the $results_per_page to result size if it's more
2516         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2517
2518         # for the requested page, replace biblionumber by the complete record
2519         # speed improvement : avoid reading too much things
2520         for (
2521             my $counter = $offset ;
2522             $counter <= $offset + $results_per_page ;
2523             $counter++
2524           )
2525         {
2526             $result_hash->{'RECORDS'}[$counter] =
2527               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2528               if $result_hash->{'RECORDS'}[$counter];
2529         }
2530         my $finalresult = ();
2531         $result_hash->{'hits'}         = $numbers;
2532         $finalresult->{'biblioserver'} = $result_hash;
2533         return $finalresult;
2534     }
2535 }
2536
2537 =head2 enabled_staff_search_views
2538
2539 %hash = enabled_staff_search_views()
2540
2541 This function returns a hash that contains three flags obtained from the system
2542 preferences, used to determine whether a particular staff search results view
2543 is enabled.
2544
2545 =over 2
2546
2547 =item C<Output arg:>
2548
2549     * $hash{can_view_MARC} is true only if the MARC view is enabled
2550     * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2551     * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2552
2553 =item C<usage in the script:>
2554
2555 =back
2556
2557 $template->param ( C4::Search::enabled_staff_search_views );
2558
2559 =cut
2560
2561 sub enabled_staff_search_views
2562 {
2563         return (
2564                 can_view_MARC                   => C4::Context->preference('viewMARC'),                 # 1 if the staff search allows the MARC view
2565                 can_view_ISBD                   => C4::Context->preference('viewISBD'),                 # 1 if the staff search allows the ISBD view
2566                 can_view_labeledMARC    => C4::Context->preference('viewLabeledMARC'),  # 1 if the staff search allows the Labeled MARC view
2567         );
2568 }
2569
2570 sub AddSearchHistory{
2571         my ($borrowernumber,$session,$query_desc,$query_cgi, $total)=@_;
2572     my $dbh = C4::Context->dbh;
2573
2574     # Add the request the user just made
2575     my $sql = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES(?, ?, ?, ?, ?, NOW())";
2576     my $sth   = $dbh->prepare($sql);
2577     $sth->execute($borrowernumber, $session, $query_desc, $query_cgi, $total);
2578         return $dbh->last_insert_id(undef, 'search_history', undef,undef,undef);
2579 }
2580
2581 sub GetSearchHistory{
2582         my ($borrowernumber,$session)=@_;
2583     my $dbh = C4::Context->dbh;
2584
2585     # Add the request the user just made
2586     my $query = "SELECT FROM search_history WHERE (userid=? OR sessionid=?)";
2587     my $sth   = $dbh->prepare($query);
2588         $sth->execute($borrowernumber, $session);
2589     return  $sth->fetchall_hashref({});
2590 }
2591
2592 =head2 z3950_search_args
2593
2594 $arrayref = z3950_search_args($matchpoints)
2595
2596 This function returns an array reference that contains the search parameters to be
2597 passed to the Z39.50 search script (z3950_search.pl). The array elements
2598 are hash refs whose keys are name, value and encvalue, and whose values are the
2599 name of a search parameter, the value of that search parameter and the URL encoded
2600 value of that parameter.
2601
2602 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2603
2604 The search parameter values are obtained from the bibliographic record whose
2605 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2606
2607 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2608 a general purpose search argument. In this case, the returned array contains only
2609 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2610
2611 If a search parameter value is undefined or empty, it is not included in the returned
2612 array.
2613
2614 The returned array reference may be passed directly to the template parameters.
2615
2616 =over 2
2617
2618 =item C<Output arg:>
2619
2620     * $array containing hash refs as described above
2621
2622 =item C<usage in the script:>
2623
2624 =back
2625
2626 $data = Biblio::GetBiblioData($bibno);
2627 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2628
2629 *OR*
2630
2631 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2632
2633 =cut
2634
2635 sub z3950_search_args {
2636     my $bibrec = shift;
2637     my $isbn = Business::ISBN->new($bibrec);
2638
2639     if (defined $isbn && $isbn->is_valid)
2640     {
2641         $bibrec = { isbn => $bibrec } if !ref $bibrec;
2642     }
2643     else {
2644         $bibrec = { title => $bibrec } if !ref $bibrec;
2645     }
2646     my $array = [];
2647     for my $field (qw/ lccn isbn issn title author dewey subject /)
2648     {
2649         my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2650         push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2651     }
2652     return $array;
2653 }
2654
2655 =head2 GetDistinctValues($field);
2656
2657 C<$field> is a reference to the fields array
2658
2659 =cut
2660
2661 sub GetDistinctValues {
2662     my ($fieldname,$string)=@_;
2663     # returns a reference to a hash of references to branches...
2664     if ($fieldname=~/\./){
2665                         my ($table,$column)=split /\./, $fieldname;
2666                         my $dbh = C4::Context->dbh;
2667                         warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2668                         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 ");
2669                         $sth->execute;
2670                         my $elements=$sth->fetchall_arrayref({});
2671                         return $elements;
2672    }
2673    else {
2674                 $string||= qq("");
2675                 my @servers=qw<biblioserver authorityserver>;
2676                 my (@zconns,@results);
2677         for ( my $i = 0 ; $i < @servers ; $i++ ) {
2678                 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2679                         $results[$i] =
2680                       $zconns[$i]->scan(
2681                         ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2682                       );
2683                 }
2684                 # The big moment: asynchronously retrieve results from all servers
2685                 my @elements;
2686                 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
2687                         my $ev = $zconns[ $i - 1 ]->last_event();
2688                         if ( $ev == ZOOM::Event::ZEND ) {
2689                                 next unless $results[ $i - 1 ];
2690                                 my $size = $results[ $i - 1 ]->size();
2691                                 if ( $size > 0 ) {
2692                       for (my $j=0;$j<$size;$j++){
2693                                                 my %hashscan;
2694                                                 @hashscan{qw(value cnt)}=$results[ $i - 1 ]->display_term($j);
2695                                                 push @elements, \%hashscan;
2696                                           }
2697                                 }
2698                         }
2699                 }
2700                 return \@elements;
2701    }
2702 }
2703
2704
2705 END { }    # module clean-up code here (global destructor)
2706
2707 1;
2708 __END__
2709
2710 =head1 AUTHOR
2711
2712 Koha Development Team <http://koha-community.org/>
2713
2714 =cut