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