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