C4/Search.pm

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