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 require Exporter;
  20 use C4::Context;
  21 use C4::Biblio;    # GetMarcFromKohaField
  22 use C4::Koha;      # getFacets
  23 use Lingua::Stem;
  24 use C4::Date;
  25
  26 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  27
  28 # set the version for version checking
  29 $VERSION = 3.00;
  30 $DEBUG=1;
  31
  32 =head1 NAME
  33
  34 C4::Search - Functions for searching the Koha catalog.
  35
  36 =head1 SYNOPSIS
  37
  38 see opac/opac-search.pl or catalogue/search.pl for example of usage
  39
  40 =head1 DESCRIPTION
  41
  42 This module provides the searching facilities for the Koha into a zebra catalog.
  43
  44 =head1 FUNCTIONS
  45
  46 =cut
  47
  48 @ISA    = qw(Exporter);
  49 @EXPORT = qw(
  50   &SimpleSearch
  51   &findseealso
  52   &FindDuplicate
  53   &searchResults
  54   &getRecords
  55   &buildQuery
  56   &NZgetRecords
  57   &ModBiblios
  58 );
  59
  60 # make all your functions, whether exported or not;
  61
  62 =head2 findseealso($dbh,$fields);
  63
  64 C<$dbh> is a link to the DB handler.
  65
  66 use C4::Context;
  67 my $dbh =C4::Context->dbh;
  68
  69 C<$fields> is a reference to the fields array
  70
  71 This function modify the @$fields array and add related fields to search on.
  72
  73 =cut
  74
  75 sub findseealso {
  76     my ( $dbh, $fields ) = @_;
  77     my $tagslib = GetMarcStructure( 1 );
  78     for ( my $i = 0 ; $i <= $#{$fields} ; $i++ ) {
  79         my ($tag)      = substr( @$fields[$i], 1, 3 );
  80         my ($subfield) = substr( @$fields[$i], 4, 1 );
  81         @$fields[$i] .= ',' . $tagslib->{$tag}->{$subfield}->{seealso}
  82           if ( $tagslib->{$tag}->{$subfield}->{seealso} );
  83     }
  84 }
  85
  86 =head2 FindDuplicate
  87
  88 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
  89
  90 =cut
  91
  92 sub FindDuplicate {
  93     my ($record) = @_;
  94     my $dbh = C4::Context->dbh;
  95     my $result = TransformMarcToKoha( $dbh, $record, '' );
  96     my $sth;
  97     my $query;
  98     my $search;
  99     my $type;
 100     my ( $biblionumber, $title );
 101
 102     # search duplicate on ISBN, easy and fast..
 103     # ... normalize first
 104     if ( $result->{isbn} ) {
 105         $result->{isbn} =~ s/\(.*$//;
 106         $result->{isbn} =~ s/\s+$//;
 107     }
 108     #$search->{'avoidquerylog'}=1;
 109     if ( $result->{isbn} ) {
 110         $query = "isbn=$result->{isbn}";
 111     }
 112     else {
 113         $result->{title} =~ s /\\//g;
 114         $result->{title} =~ s /\"//g;
 115         $result->{title} =~ s /\(//g;
 116         $result->{title} =~ s /\)//g;
 117         # remove valid operators
 118         $result->{title} =~ s/(and|or|not)//g;
 119         $query = "ti,ext=$result->{title}";
 120         $query .= " and mt=$result->{itemtype}" if ($result->{itemtype});
 121         if ($result->{author}){
 122           $result->{author} =~ s /\\//g;
 123           $result->{author} =~ s /\"//g;
 124           $result->{author} =~ s /\(//g;
 125           $result->{author} =~ s /\)//g;
 126           # remove valid operators
 127           $result->{author} =~ s/(and|or|not)//g;
 128           $query .= " and au,ext=$result->{author}";
 129         }
 130     }
 131     my ($error,$searchresults) =
 132       SimpleSearch($query); # FIXME :: hardcoded !
 133     my @results;
 134     foreach my $possible_duplicate_record (@$searchresults) {
 135         my $marcrecord =
 136           MARC::Record->new_from_usmarc($possible_duplicate_record);
 137         my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
 138
 139         # FIXME :: why 2 $biblionumber ?
 140         if ($result){
 141           push @results, $result->{'biblionumber'};
 142           push @results, $result->{'title'};
 143         }
 144     }
 145     return @results;
 146 }
 147
 148 =head2 SimpleSearch
 149
 150 ($error,$results) = SimpleSearch($query,@servers);
 151
 152 this function performs a simple search on the catalog using zoom.
 153
 154 =over 2
 155
 156 =item C<input arg:>
 157
 158     * $query could be a simple keyword or a complete CCL query wich is depending on your ccl file.
 159     * @servers is optionnal. default one is read on koha.xml
 160
 161 =item C<Output arg:>
 162     * $error is a string which containt the description error if there is one. Else it's empty.
 163     * \@results is an array of marc record.
 164
 165 =item C<usage in the script:>
 166
 167 =back
 168
 169 my ($error, $marcresults) = SimpleSearch($query);
 170
 171 if (defined $error) {
 172     $template->param(query_error => $error);
 173     warn "error: ".$error;
 174     output_html_with_http_headers $input, $cookie, $template->output;
 175     exit;
 176 }
 177
 178 my $hits = scalar @$marcresults;
 179 my @results;
 180
 181 for(my $i=0;$i<$hits;$i++) {
 182     my %resultsloop;
 183     my $marcrecord = MARC::File::USMARC::decode($marcresults->[$i]);
 184     my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,'');
 185
 186     #build the hash for the template.
 187     $resultsloop{highlight}       = ($i % 2)?(1):(0);
 188     $resultsloop{title}           = $biblio->{'title'};
 189     $resultsloop{subtitle}        = $biblio->{'subtitle'};
 190     $resultsloop{biblionumber}    = $biblio->{'biblionumber'};
 191     $resultsloop{author}          = $biblio->{'author'};
 192     $resultsloop{publishercode}   = $biblio->{'publishercode'};
 193     $resultsloop{publicationyear} = $biblio->{'publicationyear'};
 194
 195     push @results, \%resultsloop;
 196 }
 197 $template->param(result=>\@results);
 198
 199 =cut
 200
 201 sub SimpleSearch {
 202     my $query   = shift;
 203     if (C4::Context->preference('NoZebra')) {
 204         my $result = NZorder(NZanalyse($query))->{'biblioserver'}->{'RECORDS'};
 205         return (undef,$result);
 206     } else {
 207         my @servers = @_;
 208         my @results;
 209         my @tmpresults;
 210         my @zconns;
 211         return ( "No query entered", undef ) unless $query;
 212
 213         #@servers = (C4::Context->config("biblioserver")) unless @servers;
 214         @servers =
 215         ("biblioserver") unless @servers
 216         ;    # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
 217
 218         # Connect & Search
 219         for ( my $i = 0 ; $i < @servers ; $i++ ) {
 220             $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 221             $tmpresults[$i] =
 222             $zconns[$i]
 223             ->search( new ZOOM::Query::CCL2RPN( $query, $zconns[$i] ) );
 224
 225             # getting error message if one occured.
 226             my $error =
 227                 $zconns[$i]->errmsg() . " ("
 228             . $zconns[$i]->errcode() . ") "
 229             . $zconns[$i]->addinfo() . " "
 230             . $zconns[$i]->diagset();
 231
 232             return ( $error, undef ) if $zconns[$i]->errcode();
 233         }
 234         my $hits;
 235         my $ev;
 236         while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
 237             $ev = $zconns[ $i - 1 ]->last_event();
 238             if ( $ev == ZOOM::Event::ZEND ) {
 239                 $hits = $tmpresults[ $i - 1 ]->size();
 240             }
 241             if ( $hits > 0 ) {
 242                 for ( my $j = 0 ; $j < $hits ; $j++ ) {
 243                     my $record = $tmpresults[ $i - 1 ]->record($j)->raw();
 244                     push @results, $record;
 245                 }
 246             }
 247         }
 248         return ( undef, \@results );
 249     }
 250 }
 251
 252 # performs the search
 253 sub getRecords {
 254     my (
 255         $koha_query,     $simple_query,  $sort_by_ref,
 256         $servers_ref,    $results_per_page, $offset,
 257         $expanded_facet, $branches,         $query_type,
 258         $scan
 259     ) = @_;
 260 #     warn "Query : $koha_query";
 261     my @servers = @$servers_ref;
 262     my @sort_by = @$sort_by_ref;
 263
 264     # create the zoom connection and query object
 265     my $zconn;
 266     my @zconns;
 267     my @results;
 268     my $results_hashref = ();
 269
 270     ### FACETED RESULTS
 271     my $facets_counter = ();
 272     my $facets_info    = ();
 273     my $facets         = getFacets();
 274
 275     #### INITIALIZE SOME VARS USED CREATE THE FACETED RESULTS
 276     my @facets_loop;    # stores the ref to array of hashes for template
 277     for ( my $i = 0 ; $i < @servers ; $i++ ) {
 278         $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 279
 280 # perform the search, create the results objects
 281 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
 282         my $query_to_use;
 283         if ( $servers[$i] =~ /biblioserver/ ) {
 284             $query_to_use = $koha_query;
 285         }
 286         else {
 287             $query_to_use = $simple_query;
 288         }
 289
 290                 $query_to_use = $simple_query if $scan;
 291
 292         # check if we've got a query_type defined
 293         eval {
 294             if ($query_type)
 295             {
 296                 if ( $query_type =~ /^ccl/ ) {
 297                     $query_to_use =~
 298                       s/\:/\=/g;    # change : to = last minute (FIXME)
 299
 300                     #                 warn "CCL : $query_to_use";
 301                     $results[$i] =
 302                       $zconns[$i]->search(
 303                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 304                       );
 305                 }
 306                 elsif ( $query_type =~ /^cql/ ) {
 307
 308                     #                 warn "CQL : $query_to_use";
 309                     $results[$i] =
 310                       $zconns[$i]->search(
 311                         new ZOOM::Query::CQL( $query_to_use, $zconns[$i] ) );
 312                 }
 313                 elsif ( $query_type =~ /^pqf/ ) {
 314
 315                     #                 warn "PQF : $query_to_use";
 316                     $results[$i] =
 317                       $zconns[$i]->search(
 318                         new ZOOM::Query::PQF( $query_to_use, $zconns[$i] ) );
 319                 }
 320             }
 321             else {
 322                 if ($scan) {
 323                                      warn "preparing to scan:$query_to_use";
 324                     $results[$i] =
 325                       $zconns[$i]->scan(
 326                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 327                       );
 328                 }
 329                 else {
 330                     #             warn "LAST : $query_to_use";
 331                     $results[$i] =
 332                       $zconns[$i]->search(
 333                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 334                       );
 335                 }
 336             }
 337         };
 338         if ($@) {
 339             warn "WARNING: query problem with $query_to_use " . $@;
 340         }
 341
 342         # concatenate the sort_by limits and pass them to the results object
 343         my $sort_by;
 344         foreach my $sort (@sort_by) {
 345             if ($sort eq "author_az") {
 346                 $sort_by.="1=1003 <i ";
 347             }
 348             elsif ($sort eq "author_za") {
 349                 $sort_by.="1=1003 >i ";
 350             }
 351             elsif ($sort eq "popularity_asc") {
 352                 $sort_by.="1=9003 <i ";
 353             }
 354             elsif ($sort eq "popularity_dsc") {
 355                 $sort_by.="1=9003 >i ";
 356             }
 357             elsif ($sort eq "call_number_asc") {
 358                 $sort_by.="1=20  <i ";
 359             }
 360             elsif ($sort eq "call_number_dsc") {
 361                 $sort_by.="1=20 >i ";
 362             }
 363             elsif ($sort eq "pubdate_asc") {
 364                 $sort_by.="1=31 <i ";
 365             }
 366             elsif ($sort eq "pubdate_dsc") {
 367                 $sort_by.="1=31 >i ";
 368             }
 369             elsif ($sort eq "acqdate_asc") {
 370                 $sort_by.="1=32 <i ";
 371             }
 372             elsif ($sort eq "acqdate_dsc") {
 373                 $sort_by.="1=32 >i ";
 374             }
 375             elsif ($sort eq "title_az") {
 376                 $sort_by.="1=4 <i ";
 377             }
 378             elsif ($sort eq "title_za") {
 379                 $sort_by.="1=4 >i ";
 380             }
 381         }
 382         if ($sort_by) {
 383             if ( $results[$i]->sort( "yaz", $sort_by ) < 0) {
 384                 warn "WARNING sort $sort_by failed";
 385             }
 386         }
 387     }
 388     while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
 389         my $ev = $zconns[ $i - 1 ]->last_event();
 390         if ( $ev == ZOOM::Event::ZEND ) {
 391             my $size = $results[ $i - 1 ]->size();
 392             if ( $size > 0 ) {
 393                 my $results_hash;
 394                 #$results_hash->{'server'} = $servers[$i-1];
 395                 # loop through the results
 396                 $results_hash->{'hits'} = $size;
 397                 my $times;
 398                 if ( $offset + $results_per_page <= $size ) {
 399                     $times = $offset + $results_per_page;
 400                 }
 401                 else {
 402                     $times = $size;
 403                 }
 404                 for ( my $j = $offset ; $j < $times ; $j++ )
 405                 {   #(($offset+$count<=$size) ? ($offset+$count):$size) ; $j++){
 406                     my $records_hash;
 407                     my $record;
 408                     my $facet_record;
 409                     ## This is just an index scan
 410                     if ($scan) {
 411                         my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
 412                  # here we create a minimal MARC record and hand it off to the
 413                  # template just like a normal result ... perhaps not ideal, but
 414                  # it works for now
 415                         my $tmprecord = MARC::Record->new();
 416                         $tmprecord->encoding('UTF-8');
 417                         my $tmptitle;
 418
 419                         # srote the minimal record in author/title (depending on MARC flavour)
 420                         if ( C4::Context->preference("marcflavour") eq
 421                             "UNIMARC" )
 422                         {
 423                             $tmptitle = MARC::Field->new(
 424                                 '200', ' ', ' ',
 425                                 a => $term,
 426                                 f => $occ
 427                             );
 428                         }
 429                         else {
 430                             $tmptitle = MARC::Field->new(
 431                                 '245', ' ', ' ',
 432                                 a => $term,
 433                                 b => $occ
 434                             );
 435                         }
 436                         $tmprecord->append_fields($tmptitle);
 437                         $results_hash->{'RECORDS'}[$j] =
 438                           $tmprecord->as_usmarc();
 439                     }
 440                     else {
 441                         $record = $results[ $i - 1 ]->record($j)->raw();
 442
 443                         #warn "RECORD $j:".$record;
 444                         $results_hash->{'RECORDS'}[$j] =
 445                           $record;    # making a reference to a hash
 446                                       # Fill the facets while we're looping
 447                         $facet_record = MARC::Record->new_from_usmarc($record);
 448
 449                         #warn $servers[$i-1].$facet_record->title();
 450                         for ( my $k = 0 ; $k <= @$facets ; $k++ ) {
 451                             if ( $facets->[$k] ) {
 452                                 my @fields;
 453                                 for my $tag ( @{ $facets->[$k]->{'tags'} } ) {
 454                                     push @fields, $facet_record->field($tag);
 455                                 }
 456                                 for my $field (@fields) {
 457                                     my @subfields = $field->subfields();
 458                                     for my $subfield (@subfields) {
 459                                         my ( $code, $data ) = @$subfield;
 460                                         if ( $code eq
 461                                             $facets->[$k]->{'subfield'} )
 462                                         {
 463                                             $facets_counter->{ $facets->[$k]
 464                                                   ->{'link_value'} }->{$data}++;
 465                                         }
 466                                     }
 467                                 }
 468                                 $facets_info->{ $facets->[$k]->{'link_value'} }
 469                                   ->{'label_value'} =
 470                                   $facets->[$k]->{'label_value'};
 471                                 $facets_info->{ $facets->[$k]->{'link_value'} }
 472                                   ->{'expanded'} = $facets->[$k]->{'expanded'};
 473                             }
 474                         }
 475                     }
 476                 }
 477                 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
 478             }
 479
 480             #print "connection ", $i-1, ": $size hits";
 481             #print $results[$i-1]->record(0)->render() if $size > 0;
 482             # BUILD FACETS
 483             for my $link_value (
 484                 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
 485                 keys %$facets_counter
 486               )
 487             {
 488                 my $expandable;
 489                 my $number_of_facets;
 490                 my @this_facets_array;
 491                 for my $one_facet (
 492                     sort {
 493                         $facets_counter->{$link_value}
 494                           ->{$b} <=> $facets_counter->{$link_value}->{$a}
 495                     } keys %{ $facets_counter->{$link_value} }
 496                   )
 497                 {
 498                     $number_of_facets++;
 499                     if (   ( $number_of_facets < 6 )
 500                         || ( $expanded_facet eq $link_value )
 501                         || ( $facets_info->{$link_value}->{'expanded'} ) )
 502                     {
 503
 504                        # sanitize the link value ), ( will cause errors with CCL
 505                         my $facet_link_value = $one_facet;
 506                         $facet_link_value =~ s/(\(|\))/ /g;
 507
 508                         # fix the length that will display in the label
 509                         my $facet_label_value = $one_facet;
 510                         $facet_label_value = substr( $one_facet, 0, 20 ) . "..."
 511                           unless length($facet_label_value) <= 20;
 512
 513                        # well, if it's a branch, label by the name, not the code
 514                         if ( $link_value =~ /branch/ ) {
 515                             $facet_label_value =
 516                               $branches->{$one_facet}->{'branchname'};
 517                         }
 518
 519                  # but we're down with the whole label being in the link's title
 520                         my $facet_title_value = $one_facet;
 521
 522                         push @this_facets_array,
 523                           (
 524                             {
 525                                 facet_count =>
 526                                   $facets_counter->{$link_value}->{$one_facet},
 527                                 facet_label_value => $facet_label_value,
 528                                 facet_title_value => $facet_title_value,
 529                                 facet_link_value  => $facet_link_value,
 530                                 type_link_value   => $link_value,
 531                             },
 532                           );
 533                     }
 534                 }
 535                 unless ( $facets_info->{$link_value}->{'expanded'} ) {
 536                     $expandable = 1
 537                       if ( ( $number_of_facets > 6 )
 538                         && ( $expanded_facet ne $link_value ) );
 539                 }
 540                 push @facets_loop,
 541                   (
 542                     {
 543                         type_link_value => $link_value,
 544                         type_id         => $link_value . "_id",
 545                         type_label      =>
 546                           $facets_info->{$link_value}->{'label_value'},
 547                         facets     => \@this_facets_array,
 548                         expandable => $expandable,
 549                         expand     => $link_value,
 550                     }
 551                   );
 552             }
 553         }
 554     }
 555     return ( undef, $results_hashref, \@facets_loop );
 556 }
 557
 558 # STOPWORDS
 559 sub _remove_stopwords {
 560     my ($operand,$index) = @_;
 561     # phrase and exact-qualified indexes shoudln't have stopwords removed
 562     if ($index!~m/phr|ext/){
 563     # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
 564     #       we use IsAlpha unicode definition, to deal correctly with diacritics.
 565     #       otherwise, a french word like "leçon" woudl be split into "le" "çon", le
 566     #       is an empty word, we get "çon" and wouldn't find anything...
 567         foreach (keys %{C4::Context->stopwords}) {
 568             next if ($_ =~/(and|or|not)/); # don't remove operators
 569             $operand=~ s/\P{IsAlpha}$_\P{IsAlpha}/ /i;
 570             $operand=~ s/^$_\P{IsAlpha}/ /i;
 571             $operand=~ s/\P{IsAlpha}$_$/ /i;
 572         }
 573     }
 574     return $operand;
 575 }
 576
 577 # TRUNCATION
 578 sub _detect_truncation {
 579     my ($operand,$index) = @_;
 580     my (@nontruncated,@righttruncated,@lefttruncated,@rightlefttruncated,@regexpr);
 581     $operand =~s/^ //g;
 582     my @wordlist= split (/\s/,$operand);
 583     foreach my $word (@wordlist){
 584         if ($word=~s/^\*([^\*]+)\*$/$1/){
 585             push @rightlefttruncated,$word;
 586         }
 587         elsif($word=~s/^\*([^\*]+)$/$1/){
 588             push @lefttruncated,$word;
 589         }
 590         elsif ($word=~s/^([^\*]+)\*$/$1/){
 591             push @righttruncated,$word;
 592         }
 593         elsif (index($word,"*")<0){
 594             push @nontruncated,$word;
 595         }
 596         else {
 597             push @regexpr,$word;
 598         }
 599     }
 600     return (\@nontruncated,\@righttruncated,\@lefttruncated,\@rightlefttruncated,\@regexpr);
 601 }
 602
 603 sub _build_stemmed_operand {
 604     my ($operand) = @_;
 605     my $stemmed_operand;
 606     # FIXME: the locale should be set based on the user's language and/or search choice
 607     my $stemmer = Lingua::Stem->new( -locale => 'EN-US' );
 608     # FIXME: these should be stored in the db so the librarian can modify the behavior
 609     $stemmer->add_exceptions(
 610             {
 611                 'and' => 'and',
 612                 'or'  => 'or',
 613                 'not' => 'not',
 614             }
 615
 616         );
 617     my @words = split( / /, $operand );
 618     my $stems = $stemmer->stem(@words);
 619     for my $stem (@$stems) {
 620             $stemmed_operand .= "$stem";
 621             $stemmed_operand .= "?" unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 622             $stemmed_operand .= " ";
 623     }
 624     #warn "STEMMED OPERAND: $stemmed_operand";
 625     return $stemmed_operand;
 626 }
 627
 628 sub _build_weighted_query {
 629     # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
 630     # pretty well but will work much better when we have an actual query parser
 631     my ($operand,$stemmed_operand,$index) = @_;
 632     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 633     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 634     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
 635
 636     my $weighted_query .= "(rk=(";     # Specifies that we're applying rank
 637
 638     # Keyword, or, no index specified
 639     if ( ( $index eq 'kw' ) || ( !$index ) ) {
 640         $weighted_query .= "Title-cover,ext,r1=\"$operand\"";       # exact title-cover
 641         $weighted_query .= " or ti,ext,r2=\"$operand\"";            # exact title
 642         $weighted_query .= " or ti,phr,r3=\"$operand\"";            # phrase title
 643        #$weighted_query .= " or any,ext,r4=$operand";               # exact any
 644        #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
 645         $weighted_query .= " or wrd,fuzzy,r8=\"$operand\"" if $fuzzy_enabled; # add fuzzy, word list
 646         $weighted_query .= " or wrd,right-Truncation,r9=\"$stemmed_operand\"" if ($stemming and $stemmed_operand); # add stemming, right truncation
 647        # embedded sorting: 0 a-z; 1 z-a
 648        # $weighted_query .= ") or (sort1,aut=1";
 649     }
 650     # if the index already has more than one qualifier, just wrap the operand
 651     # in quotes and pass it back
 652     elsif ($index =~ ',') {
 653         $weighted_query .=" $index=\"$operand\"";
 654     }
 655     #TODO: build better cases based on specific search indexes
 656     else {
 657        $weighted_query .= " $index,ext,r1=\"$operand\"";            # exact index
 658        #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
 659        $weighted_query .= " or $index,phr,r3=\"$operand\"";         # phrase index
 660        $weighted_query .= " or $index,rt,wrd,r3=\"$operand\"";      # word list index
 661     }
 662     $weighted_query .= "))";    # close rank specification
 663     return $weighted_query;
 664 }
 665
 666 # build the query itself
 667 sub buildQuery {
 668     my ( $operators, $operands, $indexes, $limits, $sort_by ) = @_;
 669
 670     my @operators = @$operators if $operators;
 671     my @indexes   = @$indexes   if $indexes;
 672     my @operands  = @$operands  if $operands;
 673     my @limits    = @$limits    if $limits;
 674     my @sort_by   = @$sort_by   if $sort_by;
 675
 676     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 677     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 678     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
 679
 680     my $query = $operands[0];
 681         my $simple_query = $operands[0];
 682         my $query_cgi;
 683         my $query_search_desc;
 684
 685         my $limit;
 686         my $limit_cgi;
 687         my $limit_desc;
 688
 689 # STEP I: determine if this is a form-based / simple query or if it's complex (if complex,
 690 # pass it off to zebra directly)
 691
 692 # check if this is a known query language query, if it is, return immediately,
 693 # the user is responsible for constructing valid syntax:
 694     if ( $query =~ /^ccl=/ ) {
 695         return ( undef, $', $', $', '', '', '', 'ccl' );
 696     }
 697     if ( $query =~ /^cql=/ ) {
 698         return ( undef, $', $', $', '', '', '', 'cql' );
 699     }
 700     if ( $query =~ /^pqf=/ ) {
 701         return ( undef, $', $', $', '', '', '', 'pqf' );
 702     }
 703
 704 # FIXME: this is bound to be broken now
 705     if ( $query =~ /(\(|\)|:|=)/ ) {    # sorry, too complex, assume CCL
 706         return ( undef, $query, $query_cgi, $query_search_desc, $limit, $limit_cgi, $limit_desc, 'ccl' );
 707     }
 708
 709 # form-based queries are limited to non-nested at a specific depth, so we can easily
 710 # modify the incoming query operands and indexes to do stemming and field weighting
 711 # Once we do so, we'll end up with a value in $query, just like if we had an
 712 # incoming $query from the user
 713     else {
 714         $query = ""; # clear it out so we can populate properly with field-weighted stemmed query
 715         my $previous_operand;    # a flag used to keep track if there was a previous query
 716                                 # if there was, we can apply the current operator
 717         # for every operand
 718         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
 719
 720             # COMBINE OPERANDS, INDEXES AND OPERATORS
 721             if ( $operands[$i] ) {
 722                 my $operand = $operands[$i];
 723                 my $index   = $indexes[$i];
 724
 725                 # if there's no index, don't use one, it will throw a CCL error
 726                 my $index_plus = "$index:" if $index;
 727                 my $index_plus_comma="$index," if $index;
 728
 729                 # Remove Stopwords
 730                 $operand = _remove_stopwords($operand,$index);
 731                 warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
 732
 733                 my $indexes_set;
 734
 735                 # Detect Truncation
 736                 my ($nontruncated,$righttruncated,$lefttruncated,$rightlefttruncated,$regexpr);
 737                 my $truncated_operand;
 738                 ($nontruncated,$righttruncated,$lefttruncated,$rightlefttruncated,$regexpr) = _detect_truncation($operand,$index);
 739                 warn "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<" if $DEBUG;
 740                 # Apply Truncation
 741                 # Problem is when build_weights gets ahold if this is wraps in quotes which breaks the truncation :/
 742                 if (scalar(@$righttruncated)+scalar(@$lefttruncated)+scalar(@$rightlefttruncated)>0){
 743                     $indexes_set = 1;
 744                     undef $weight_fields;
 745                     my $previous_truncation_operand;
 746                     if (scalar(@$nontruncated)>0) {
 747                         $truncated_operand.= "$index_plus @$nontruncated ";
 748                         $previous_truncation_operand = 1;
 749                     }
 750                     if (scalar(@$righttruncated)>0){
 751                         $truncated_operand .= "and " if $previous_truncation_operand;
 752                         $truncated_operand .= "$index_plus_comma"."rtrn:@$righttruncated ";
 753                         $previous_truncation_operand = 1;
 754                     }
 755                     if (scalar(@$lefttruncated)>0){
 756                         $truncated_operand .= "and " if $previous_truncation_operand;
 757                         $truncated_operand .= "$index_plus_comma"."ltrn:@$lefttruncated ";
 758                         $previous_truncation_operand = 1;
 759                     }
 760                     if (scalar(@$rightlefttruncated)>0){
 761                         $truncated_operand .= "and " if $previous_truncation_operand;
 762                         $truncated_operand .= "$index_plus_comma"."rltrn:@$rightlefttruncated ";
 763                         $previous_truncation_operand = 1;
 764                     }
 765                 }
 766                 $operand = $truncated_operand if $truncated_operand;
 767                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
 768
 769                 # Handle Stemming
 770                 my $stemmed_operand;
 771                 $stemmed_operand = _build_stemmed_operand($operand) if $stemming;
 772                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
 773
 774                 # Handle Field Weighting
 775                 my $weighted_operand;
 776                 $weighted_operand = _build_weighted_query($operand,$stemmed_operand,$index) if $weight_fields;
 777                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
 778                 $operand = $weighted_operand if $weight_fields;
 779                 $indexes_set = 1 if $weight_fields;
 780
 781                 # If there's a previous operand, we need to add an operator
 782                 if ($previous_operand) {
 783
 784                     # user-specified operator
 785                     if ( $operators[$i-1] ) {
 786                         $query .= " $operators[$i-1] ";
 787                         $query .= " $index_plus " unless $indexes_set;
 788                         $query .= " $operand";
 789                                                 $query_cgi .="";
 790                                                 $query_search_desc .=" $operators[$i-1] $index_plus $operands[$i]";
 791                     }
 792
 793                     # the default operator is and
 794                     else {
 795                         $query .= " and ";
 796                         $query .= "$index_plus " unless $indexes_set;
 797                         $query .= "$operand";
 798                                                 $query_cgi .="";
 799                         $query_search_desc .= " and $index_plus $operands[$i]";
 800                     }
 801                 }
 802
 803                 else {
 804                                         # field-weighted queries already have indexes set
 805                                         $query .=" $index_plus " unless $indexes_set;
 806                                         $query .= $operand;
 807                                         $query_search_desc .= " $index_plus $operands[$i]";
 808                                         $query_cgi.="";
 809
 810                     $previous_operand = 1;
 811                 }
 812             }    #/if $operands
 813         }    # /for
 814     }
 815     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
 816
 817     # add limits
 818         my $group_OR_limits;
 819     foreach my $this_limit (@limits) {
 820         if ( $this_limit =~ /available/ ) {
 821                         # FIXME: switch to zebra search for null values
 822             $limit .= " (($query and datedue=0000-00-00) or ($query and datedue=0000-00-00 not lost=1) or ($query and datedue=0000-00-00 not lost=2))";
 823                         $limit_cgi .= "&limit=available";
 824                         $limit_desc .="";
 825         }
 826                 # these are treated as OR
 827         elsif ( $this_limit =~ /mc/ ) {
 828             $group_OR_limits .= " or " if $group_OR_limits;
 829                         $group_OR_limits .= "$this_limit";
 830                         $limit_cgi .="&limit=$this_limit";
 831             $limit_desc .= " or $this_limit";
 832         }
 833                 else {
 834                         $limit .= " and " if $limit || $query;
 835                         $limit .= "$this_limit";
 836                         $limit_cgi .="&limit=$this_limit";
 837                         $limit_desc .=" and $this_limit";
 838                 }
 839     }
 840         $limit.=" and " if ($query && $limit);
 841         $limit.="($group_OR_limits)" if $group_OR_limits;
 842         # normalize the strings
 843         for ($query, $query_search_desc, $limit, $limit_desc) {
 844                 $_ =~ s/  / /g;    # remove extra spaces
 845         $_ =~ s/^ //g;     # remove any beginning spaces
 846                 $_ =~ s/ $//g;     # remove any beginning spaces
 847         $_ =~ s/:/=/g;     # causes probs for server
 848         $_ =~ s/==/=/g;    # remove double == from query
 849
 850         }
 851
 852         # append the limit to the query
 853         $query .= $limit;
 854
 855     warn "QUERY:".$query if $DEBUG;
 856         warn "QUERY CGI:".$query_cgi if $DEBUG;
 857     warn "QUERY DESC:".$query_search_desc if $DEBUG;
 858     warn "LIMIT:".$limit if $DEBUG;
 859     warn "LIMIT CGI:".$limit_cgi if $DEBUG;
 860     warn "LIMIT DESC:".$limit_desc if $DEBUG;
 861
 862         return ( undef, $query,$simple_query,$query_cgi,$query_search_desc,$limit,$limit_cgi,$limit_desc );
 863 }
 864
 865 # IMO this subroutine is pretty messy still -- it's responsible for
 866 # building the HTML output for the template
 867 sub searchResults {
 868     my ( $searchdesc, $hits, $results_per_page, $offset, @marcresults ) = @_;
 869
 870     my $dbh = C4::Context->dbh;
 871     my $toggle;
 872     my $even = 1;
 873     my @newresults;
 874     my $span_terms_hashref;
 875     for my $span_term ( split( / /, $searchdesc ) ) {
 876         $span_term =~ s/(.*=|\)|\(|\+|\.)//g;
 877         $span_terms_hashref->{$span_term}++;
 878     }
 879
 880     #Build brancnames hash
 881     #find branchname
 882     #get branch information.....
 883     my %branches;
 884     my $bsth =
 885       $dbh->prepare("SELECT branchcode,branchname FROM branches")
 886       ;    # FIXME : use C4::Koha::GetBranches
 887     $bsth->execute();
 888     while ( my $bdata = $bsth->fetchrow_hashref ) {
 889         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
 890     }
 891
 892     #Build itemtype hash
 893     #find itemtype & itemtype image
 894     my %itemtypes;
 895     $bsth =
 896       $dbh->prepare("SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes");
 897     $bsth->execute();
 898     while ( my $bdata = $bsth->fetchrow_hashref ) {
 899         $itemtypes{ $bdata->{'itemtype'} }->{description} =
 900           $bdata->{'description'};
 901         $itemtypes{ $bdata->{'itemtype'} }->{imageurl} = $bdata->{'imageurl'};
 902         $itemtypes{ $bdata->{'itemtype'} }->{summary} = $bdata->{'summary'};
 903         $itemtypes{ $bdata->{'itemtype'} }->{notforloan} = $bdata->{'notforloan'};
 904     }
 905
 906     #search item field code
 907     my $sth =
 908       $dbh->prepare(
 909 "select tagfield from marc_subfield_structure where kohafield like 'items.itemnumber'"
 910       );
 911     $sth->execute;
 912     my ($itemtag) = $sth->fetchrow;
 913
 914     ## find column names of items related to MARC
 915     my $sth2 = $dbh->prepare("SHOW COLUMNS from items");
 916     $sth2->execute;
 917     my %subfieldstosearch;
 918     while ( ( my $column ) = $sth2->fetchrow ) {
 919         my ( $tagfield, $tagsubfield ) =
 920           &GetMarcFromKohaField( "items." . $column, "" );
 921         $subfieldstosearch{$column} = $tagsubfield;
 922     }
 923     my $times;
 924
 925     if ( $hits && $offset + $results_per_page <= $hits ) {
 926         $times = $offset + $results_per_page;
 927     }
 928     else {
 929         $times = $hits;
 930     }
 931
 932     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
 933         my $marcrecord;
 934         $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
 935         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, '' );
 936         # add image url if there is one
 937         if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} =~ /^http:/ ) {
 938             $oldbiblio->{imageurl} =
 939               $itemtypes{ $oldbiblio->{itemtype} }->{imageurl};
 940             $oldbiblio->{description} =
 941               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 942         }
 943         else {
 944             $oldbiblio->{imageurl} =
 945               getitemtypeimagesrc() . "/"
 946               . $itemtypes{ $oldbiblio->{itemtype} }->{imageurl}
 947               if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
 948             $oldbiblio->{description} =
 949               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 950         }
 951         #
 952         # build summary if there is one (the summary is defined in itemtypes table
 953         #
 954         if ($itemtypes{ $oldbiblio->{itemtype} }->{summary}) {
 955             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
 956             my @fields = $marcrecord->fields();
 957             foreach my $field (@fields) {
 958                 my $tag = $field->tag();
 959                 my $tagvalue = $field->as_string();
 960                 $summary =~ s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
 961                 unless ($tag<10) {
 962                     my @subf = $field->subfields;
 963                     for my $i (0..$#subf) {
 964                         my $subfieldcode = $subf[$i][0];
 965                         my $subfieldvalue = $subf[$i][1];
 966                         my $tagsubf = $tag.$subfieldcode;
 967                         $summary =~ s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
 968                     }
 969                 }
 970             }
 971             $summary =~ s/\[(.*?)]//g;
 972             $summary =~ s/\n/<br>/g;
 973             $oldbiblio->{summary} = $summary;
 974         }
 975         # add spans to search term in results for search term highlighting
 976         foreach my $term ( keys %$span_terms_hashref ) {
 977             my $old_term = $term;
 978             if ( length($term) > 3 ) {
 979                 $term =~ s/(.*=|\)|\(|\+|\.|\?|\[|\])//g;
 980                 $term =~ s/\\//g;
 981                 $term =~ s/\*//g;
 982
 983                 #FIXME: is there a better way to do this?
 984                 $oldbiblio->{'title'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 985                 $oldbiblio->{'subtitle'} =~
 986                   s/$term/<span class=\"term\">$&<\/span>/gi;
 987
 988                 $oldbiblio->{'author'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 989                 $oldbiblio->{'publishercode'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 990                 $oldbiblio->{'place'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 991                 $oldbiblio->{'pages'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 992                 $oldbiblio->{'notes'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 993                 $oldbiblio->{'size'}  =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 994             }
 995         }
 996
 997         if ( $i % 2 ) {
 998             $toggle = "#ffffcc";
 999         }
1000         else {
1001             $toggle = "white";
1002         }
1003         $oldbiblio->{'toggle'} = $toggle;
1004         my @fields = $marcrecord->field($itemtag);
1005         my @items_loop;
1006         my $items;
1007         my $ordered_count     = 0;
1008         my $onloan_count      = 0;
1009         my $wthdrawn_count    = 0;
1010         my $itemlost_count    = 0;
1011         my $norequests        = 1;
1012
1013         #
1014         # check the loan status of the item :
1015         # it is not stored in the MARC record, for pref (zebra reindexing)
1016         # reason. Thus, we have to get the status from a specific SQL query
1017         #
1018         my $sth_issue = $dbh->prepare("
1019             SELECT date_due,returndate
1020             FROM issues
1021             WHERE itemnumber=? AND returndate IS NULL");
1022         my $items_count=scalar(@fields);
1023         foreach my $field (@fields) {
1024             my $item;
1025             foreach my $code ( keys %subfieldstosearch ) {
1026                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1027             }
1028             $sth_issue->execute($item->{itemnumber});
1029             $item->{due_date} = format_date($sth_issue->fetchrow);
1030             $item->{onloan} = 1 if $item->{due_date};
1031             # at least one item can be reserved : suppose no
1032             $norequests = 1;
1033             if ( $item->{wthdrawn} ) {
1034                 $wthdrawn_count++;
1035                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1036                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{wthdrawn}=1;
1037             }
1038             elsif ( $item->{itemlost} ) {
1039                 $itemlost_count++;
1040                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1041                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemlost}=1;
1042             }
1043             unless ( $item->{notforloan}) {
1044                 # OK, this one can be issued, so at least one can be reserved
1045                 $norequests = 0;
1046             }
1047             if ( ( $item->{onloan} ) && ( $item->{onloan} != '0000-00-00' ) )
1048             {
1049                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1050                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{onloancount} = 1;
1051                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{due_date} = $item->{due_date};
1052                 $onloan_count++;
1053             }
1054             if ( $item->{'homebranch'} ) {
1055                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{count}++;
1056             }
1057
1058             # Last resort
1059             elsif ( $item->{'holdingbranch'} ) {
1060                 $items->{ $item->{'holdingbranch'} }->{count}++;
1061             }
1062             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemcallnumber} =                $item->{itemcallnumber};
1063             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{location} =                $item->{location};
1064             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{branchcode} =               $item->{homebranch};
1065         }    # notforloan, item level and biblioitem level
1066
1067         # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1068         $norequests = 1 if $itemtypes{$oldbiblio->{itemtype}}->{notforloan};
1069
1070         for my $key ( sort keys %$items ) {
1071             my $this_item = {
1072                 branchname     => $branches{$items->{$key}->{branchcode}},
1073                 branchcode     => $items->{$key}->{branchcode},
1074                 count          => $items->{$key}->{count},
1075                 itemcallnumber => $items->{$key}->{itemcallnumber},
1076                 location => $items->{$key}->{location},
1077                 onloancount      => $items->{$key}->{onloancount},
1078                 due_date         => $items->{$key}->{due_date},
1079                 wthdrawn      => $items->{$key}->{wthdrawn},
1080                 lost         => $items->{$key}->{itemlost},
1081             };
1082             push @items_loop, $this_item;
1083         }
1084         $oldbiblio->{norequests}    = $norequests;
1085         $oldbiblio->{items_count}    = $items_count;
1086         $oldbiblio->{items_loop}    = \@items_loop;
1087         $oldbiblio->{onloancount}   = $onloan_count;
1088         $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1089         $oldbiblio->{itemlostcount} = $itemlost_count;
1090         $oldbiblio->{orderedcount}  = $ordered_count;
1091         $oldbiblio->{isbn}          =~ s/-//g; # deleting - in isbn to enable amazon content
1092         push( @newresults, $oldbiblio );
1093     }
1094     return @newresults;
1095 }
1096
1097
1098
1099 #----------------------------------------------------------------------
1100 #
1101 # Non-Zebra GetRecords#
1102 #----------------------------------------------------------------------
1103
1104 =head2 NZgetRecords
1105
1106   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1107
1108 =cut
1109
1110 sub NZgetRecords {
1111     my (
1112         $koha_query,     $simple_query,  $sort_by_ref,
1113         $servers_ref,    $results_per_page, $offset,
1114         $expanded_facet, $branches,         $query_type,
1115         $scan
1116     ) = @_;
1117     my $result = NZanalyse($koha_query);
1118     return (undef,NZorder($result,@$sort_by_ref[0],$results_per_page,$offset),undef);
1119 }
1120
1121 =head2 NZanalyse
1122
1123   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1124   the list is builded from inverted index in nozebra SQL table
1125   note that title is here only for convenience : the sorting will be very fast when requested on title
1126   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1127
1128 =cut
1129
1130 sub NZanalyse {
1131     my ($string,$server) = @_;
1132     # $server contains biblioserver or authorities, depending on what we search on.
1133     #warn "querying : $string on $server";
1134     $server='biblioserver' unless $server;
1135     # if we have a ", replace the content to discard temporarily any and/or/not inside
1136     my $commacontent;
1137     if ($string =~/"/) {
1138         $string =~ s/"(.*?)"/__X__/;
1139         $commacontent = $1;
1140 #         print "commacontent : $commacontent\n";
1141     }
1142     # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1143     # then, call again NZanalyse with $left and $right
1144     # (recursive until we find a leaf (=> something without and/or/not)
1145     $string =~ /(.*)( and | or | not | AND | OR | NOT )(.*)/;
1146     my $left = $1;
1147     my $right = $3;
1148     my $operand = lc($2);
1149     # it's not a leaf, we have a and/or/not
1150     if ($operand) {
1151         # reintroduce comma content if needed
1152         $right =~ s/__X__/"$commacontent"/ if $commacontent;
1153         $left =~ s/__X__/"$commacontent"/ if $commacontent;
1154 #         warn "node : $left / $operand / $right\n";
1155         my $leftresult = NZanalyse($left,$server);
1156         my $rightresult = NZanalyse($right,$server);
1157         # OK, we have the results for right and left part of the query
1158         # depending of operand, intersect, union or exclude both lists
1159         # to get a result list
1160         if ($operand eq ' and ') {
1161             my @leftresult = split /;/, $leftresult;
1162 #             my @rightresult = split /;/,$leftresult;
1163             my $finalresult;
1164             # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1165             # the result is stored twice, to have the same weight for AND than OR.
1166             # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1167             # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1168             foreach (@leftresult) {
1169                 if ($rightresult =~ "$_;") {
1170                     $finalresult .= "$_;$_;";
1171                 }
1172             }
1173             return $finalresult;
1174         } elsif ($operand eq ' or ') {
1175             # just merge the 2 strings
1176             return $leftresult.$rightresult;
1177         } elsif ($operand eq ' not ') {
1178             my @leftresult = split /;/, $leftresult;
1179 #             my @rightresult = split /;/,$leftresult;
1180             my $finalresult;
1181             foreach (@leftresult) {
1182                 unless ($rightresult =~ "$_;") {
1183                     $finalresult .= "$_;";
1184                 }
1185             }
1186             return $finalresult;
1187         } else {
1188             # this error is impossible, because of the regexp that isolate the operand, but just in case...
1189             die "error : operand unknown : $operand for $string";
1190         }
1191     # it's a leaf, do the real SQL query and return the result
1192     } else {
1193         $string =~  s/__X__/"$commacontent"/ if $commacontent;
1194         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1195 #         warn "leaf : $string\n";
1196         # parse the string in in operator/operand/value again
1197         $string =~ /(.*)(>=|<=)(.*)/;
1198         my $left = $1;
1199         my $operator = $2;
1200         my $right = $3;
1201         unless ($operator) {
1202             $string =~ /(.*)(>|<|=)(.*)/;
1203             $left = $1;
1204             $operator = $2;
1205             $right = $3;
1206         }
1207         my $results;
1208         # automatic replace for short operators
1209         $left='title' if $left =~ '^ti';
1210         $left='author' if $left =~ '^au';
1211         $left='publisher' if $left =~ '^pb';
1212         $left='subject' if $left =~ '^su';
1213         $left='koha-Auth-Number' if $left =~ '^an';
1214         $left='keyword' if $left =~ '^kw';
1215         if ($operator) {
1216             #do a specific search
1217             my $dbh = C4::Context->dbh;
1218             $operator='LIKE' if $operator eq '=' and $right=~ /%/;
1219             my $sth = $dbh->prepare("SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?");
1220             warn "$left / $operator / $right\n";
1221             # split each word, query the DB and build the biblionumbers result
1222             foreach (split / /,$right) {
1223                 my ($biblionumbers,$value);
1224                 next unless $_;
1225                 warn "EXECUTE : $server, $left, $_";
1226                 $sth->execute($server, $left, $_);
1227                 while (my ($line,$value) = $sth->fetchrow) {
1228                     # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1229                     # otherwise, fill the result
1230                     $biblionumbers .= $line unless ($right =~ /\d/ && $value =~ /\D/);
1231                     warn "result : $value ". ($right =~ /\d/) . "==".(!$value =~ /\d/) ;#= $line";
1232                 }
1233                 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1234                 if ($results) {
1235                     my @leftresult = split /;/, $biblionumbers;
1236                     my $temp;
1237                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1238                         # remove weight at the end
1239                         my $cleaned = $entry;
1240                         $cleaned =~ s/-\d*$//;
1241                         # if the entry already in the hash, take it & increase weight
1242 #                         warn "===== $cleaned =====";
1243                         if ($results =~ "$cleaned") {
1244                             $temp .= "$entry;$entry;";
1245 #                             warn "INCLUDING $entry";
1246                         }
1247                     }
1248                     $results = $temp;
1249                 } else {
1250                     $results = $biblionumbers;
1251                 }
1252             }
1253         } else {
1254             #do a complete search (all indexes)
1255             my $dbh = C4::Context->dbh;
1256             my $sth = $dbh->prepare("SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?");
1257             # split each word, query the DB and build the biblionumbers result
1258             foreach (split / /,$string) {
1259                 next if C4::Context->stopwords->{uc($_)}; # skip if stopword
1260                 #warn "search on all indexes on $_";
1261                 my $biblionumbers;
1262                 next unless $_;
1263                 $sth->execute($server, $_);
1264                 while (my $line = $sth->fetchrow) {
1265                     $biblionumbers .= $line;
1266                 }
1267                 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1268                 if ($results) {
1269 #                 warn "RES for $_ = $biblionumbers";
1270                     my @leftresult = split /;/, $biblionumbers;
1271                     my $temp;
1272                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1273                         # remove weight at the end
1274                         my $cleaned = $entry;
1275                         $cleaned =~ s/-\d*$//;
1276                         # if the entry already in the hash, take it & increase weight
1277 #                         warn "===== $cleaned =====";
1278                         if ($results =~ "$cleaned") {
1279                             $temp .= "$entry;$entry;";
1280 #                             warn "INCLUDING $entry";
1281                         }
1282                     }
1283                     $results = $temp;
1284                 } else {
1285 #                 warn "NEW RES for $_ = $biblionumbers";
1286                     $results = $biblionumbers;
1287                 }
1288             }
1289         }
1290 #         warn "return : $results for LEAF : $string";
1291         return $results;
1292     }
1293 }
1294
1295 =head2 NZorder
1296
1297   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1298
1299   TODO :: Description
1300
1301 =cut
1302
1303
1304 sub NZorder {
1305     my ($biblionumbers, $ordering,$results_per_page,$offset) = @_;
1306     # order title asc by default
1307 #     $ordering = '1=36 <i' unless $ordering;
1308     $results_per_page=20 unless $results_per_page;
1309     $offset = 0 unless $offset;
1310     my $dbh = C4::Context->dbh;
1311     #
1312     # order by POPULARITY
1313     #
1314     if ($ordering =~ /popularity/) {
1315         my %result;
1316         my %popularity;
1317         # popularity is not in MARC record, it's builded from a specific query
1318         my $sth = $dbh->prepare("select sum(issues) from items where biblionumber=?");
1319         foreach (split /;/,$biblionumbers) {
1320             my ($biblionumber,$title) = split /,/,$_;
1321             $result{$biblionumber}=GetMarcBiblio($biblionumber);
1322             $sth->execute($biblionumber);
1323             my $popularity= $sth->fetchrow ||0;
1324             # hint : the key is popularity.title because we can have
1325             # many results with the same popularity. In this cas, sub-ordering is done by title
1326             # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1327             # (un-frequent, I agree, but we won't forget anything that way ;-)
1328             $popularity{sprintf("%10d",$popularity).$title.$biblionumber} = $biblionumber;
1329         }
1330         # sort the hash and return the same structure as GetRecords (Zebra querying)
1331         my $result_hash;
1332         my $numbers=0;
1333         if ($ordering eq 'popularity_dsc') { # sort popularity DESC
1334             foreach my $key (sort {$b cmp $a} (keys %popularity)) {
1335                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1336             }
1337         } else { # sort popularity ASC
1338             foreach my $key (sort (keys %popularity)) {
1339                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1340             }
1341         }
1342         my $finalresult=();
1343         $result_hash->{'hits'} = $numbers;
1344         $finalresult->{'biblioserver'} = $result_hash;
1345         return $finalresult;
1346     #
1347     # ORDER BY author
1348     #
1349     } elsif ($ordering =~/author/){
1350         my %result;
1351         foreach (split /;/,$biblionumbers) {
1352             my ($biblionumber,$title) = split /,/,$_;
1353             my $record=GetMarcBiblio($biblionumber);
1354             my $author;
1355             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1356                 $author=$record->subfield('200','f');
1357                 $author=$record->subfield('700','a') unless $author;
1358             } else {
1359                 $author=$record->subfield('100','a');
1360             }
1361             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1362             # and we don't want to get only 1 result for each of them !!!
1363             $result{$author.$biblionumber}=$record;
1364         }
1365         # sort the hash and return the same structure as GetRecords (Zebra querying)
1366         my $result_hash;
1367         my $numbers=0;
1368         if ($ordering eq 'author_za') { # sort by author desc
1369             foreach my $key (sort { $b cmp $a } (keys %result)) {
1370                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1371             }
1372         } else { # sort by author ASC
1373             foreach my $key (sort (keys %result)) {
1374                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1375             }
1376         }
1377         my $finalresult=();
1378         $result_hash->{'hits'} = $numbers;
1379         $finalresult->{'biblioserver'} = $result_hash;
1380         return $finalresult;
1381     #
1382     # ORDER BY callnumber
1383     #
1384     } elsif ($ordering =~/callnumber/){
1385         my %result;
1386         foreach (split /;/,$biblionumbers) {
1387             my ($biblionumber,$title) = split /,/,$_;
1388             my $record=GetMarcBiblio($biblionumber);
1389             my $callnumber;
1390             my ($callnumber_tag,$callnumber_subfield)=GetMarcFromKohaField($dbh,'items.itemcallnumber');
1391             ($callnumber_tag,$callnumber_subfield)= GetMarcFromKohaField('biblioitems.callnumber') unless $callnumber_tag;
1392             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1393                 $callnumber=$record->subfield('200','f');
1394             } else {
1395                 $callnumber=$record->subfield('100','a');
1396             }
1397             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1398             # and we don't want to get only 1 result for each of them !!!
1399             $result{$callnumber.$biblionumber}=$record;
1400         }
1401         # sort the hash and return the same structure as GetRecords (Zebra querying)
1402         my $result_hash;
1403         my $numbers=0;
1404         if ($ordering eq 'call_number_dsc') { # sort by title desc
1405             foreach my $key (sort { $b cmp $a } (keys %result)) {
1406                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1407             }
1408         } else { # sort by title ASC
1409             foreach my $key (sort { $a cmp $b } (keys %result)) {
1410                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1411             }
1412         }
1413         my $finalresult=();
1414         $result_hash->{'hits'} = $numbers;
1415         $finalresult->{'biblioserver'} = $result_hash;
1416         return $finalresult;
1417     } elsif ($ordering =~ /pubdate/){ #pub year
1418         my %result;
1419         foreach (split /;/,$biblionumbers) {
1420             my ($biblionumber,$title) = split /,/,$_;
1421             my $record=GetMarcBiblio($biblionumber);
1422             my ($publicationyear_tag,$publicationyear_subfield)=GetMarcFromKohaField('biblioitems.publicationyear','');
1423             my $publicationyear=$record->subfield($publicationyear_tag,$publicationyear_subfield);
1424             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1425             # and we don't want to get only 1 result for each of them !!!
1426             $result{$publicationyear.$biblionumber}=$record;
1427         }
1428         # sort the hash and return the same structure as GetRecords (Zebra querying)
1429         my $result_hash;
1430         my $numbers=0;
1431         if ($ordering eq 'pubdate_dsc') { # sort by pubyear desc
1432             foreach my $key (sort { $b cmp $a } (keys %result)) {
1433                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1434             }
1435         } else { # sort by pub year ASC
1436             foreach my $key (sort (keys %result)) {
1437                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1438             }
1439         }
1440         my $finalresult=();
1441         $result_hash->{'hits'} = $numbers;
1442         $finalresult->{'biblioserver'} = $result_hash;
1443         return $finalresult;
1444     #
1445     # ORDER BY title
1446     #
1447     } elsif ($ordering =~ /title/) {
1448         # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
1449         my %result;
1450         foreach (split /;/,$biblionumbers) {
1451             my ($biblionumber,$title) = split /,/,$_;
1452             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1453             # and we don't want to get only 1 result for each of them !!!
1454             # hint & speed improvement : we can order without reading the record
1455             # so order, and read records only for the requested page !
1456             $result{$title.$biblionumber}=$biblionumber;
1457         }
1458         # sort the hash and return the same structure as GetRecords (Zebra querying)
1459         my $result_hash;
1460         my $numbers=0;
1461         if ($ordering eq 'title_az') { # sort by title desc
1462             foreach my $key (sort (keys %result)) {
1463                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1464             }
1465         } else { # sort by title ASC
1466             foreach my $key (sort { $b cmp $a } (keys %result)) {
1467                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1468             }
1469         }
1470         # limit the $results_per_page to result size if it's more
1471         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1472         # for the requested page, replace biblionumber by the complete record
1473         # speed improvement : avoid reading too much things
1474         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1475             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc;
1476         }
1477         my $finalresult=();
1478         $result_hash->{'hits'} = $numbers;
1479         $finalresult->{'biblioserver'} = $result_hash;
1480         return $finalresult;
1481     } else {
1482     #
1483     # order by ranking
1484     #
1485         # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
1486         my %result;
1487         my %count_ranking;
1488         foreach (split /;/,$biblionumbers) {
1489             my ($biblionumber,$title) = split /,/,$_;
1490             $title =~ /(.*)-(\d)/;
1491             # get weight
1492             my $ranking =$2;
1493             # note that we + the ranking because ranking is calculated on weight of EACH term requested.
1494             # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
1495             # biblio N has ranking = 6
1496             $count_ranking{$biblionumber} += $ranking;
1497         }
1498         # build the result by "inverting" the count_ranking hash
1499         # 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
1500 #         warn "counting";
1501         foreach (keys %count_ranking) {
1502             $result{sprintf("%10d",$count_ranking{$_}).'-'.$_} = $_;
1503         }
1504         # sort the hash and return the same structure as GetRecords (Zebra querying)
1505         my $result_hash;
1506         my $numbers=0;
1507             foreach my $key (sort {$b cmp $a} (keys %result)) {
1508                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1509             }
1510         # limit the $results_per_page to result size if it's more
1511         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1512         # for the requested page, replace biblionumber by the complete record
1513         # speed improvement : avoid reading too much things
1514         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1515             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc if $result_hash->{'RECORDS'}[$counter];
1516         }
1517         my $finalresult=();
1518         $result_hash->{'hits'} = $numbers;
1519         $finalresult->{'biblioserver'} = $result_hash;
1520         return $finalresult;
1521     }
1522 }
1523 =head2 ModBiblios
1524
1525 ($countchanged,$listunchanged) = ModBiblios($listbiblios, $tagsubfield,$initvalue,$targetvalue,$test);
1526
1527 this function changes all the values $initvalue in subfield $tag$subfield in any record in $listbiblios
1528 test parameter if set donot perform change to records in database.
1529
1530 =over 2
1531
1532 =item C<input arg:>
1533
1534     * $listbiblios is an array ref to marcrecords to be changed
1535     * $tagsubfield is the reference of the subfield to change.
1536     * $initvalue is the value to search the record for
1537     * $targetvalue is the value to set the subfield to
1538     * $test is to be set only not to perform changes in database.
1539
1540 =item C<Output arg:>
1541     * $countchanged counts all the changes performed.
1542     * $listunchanged contains the list of all the biblionumbers of records unchanged.
1543
1544 =item C<usage in the script:>
1545
1546 =back
1547
1548 my ($countchanged, $listunchanged) = EditBiblios($results->{RECORD}, $tagsubfield,$initvalue,$targetvalue);;
1549 #If one wants to display unchanged records, you should get biblios foreach @$listunchanged
1550 $template->param(countchanged => $countchanged, loopunchanged=>$listunchanged);
1551
1552 =cut
1553
1554 sub ModBiblios{
1555   my ($listbiblios,$tagsubfield,$initvalue,$targetvalue,$test)=@_;
1556   my $countmatched;
1557   my @unmatched;
1558   my ($tag,$subfield)=($1,$2) if ($tagsubfield=~/^(\d{1,3})([a-z0-9A-Z@])?$/);
1559   if ((length($tag)<3)&& $subfield=~/0-9/){
1560     $tag=$tag.$subfield;
1561     undef $subfield;
1562   }
1563   my ($bntag,$bnsubf) = GetMarcFromKohaField('biblio.biblionumber');
1564   my ($itemtag,$itemsubf) = GetMarcFromKohaField('items.itemnumber');
1565   foreach my $usmarc (@$listbiblios){
1566     my $record;
1567     $record=eval{MARC::Record->new_from_usmarc($usmarc)};
1568     my $biblionumber;
1569     if ($@){
1570       # usmarc is not a valid usmarc May be a biblionumber
1571       if ($tag eq $itemtag){
1572         my $bib=GetBiblioFromItemNumber($usmarc);
1573         $record=GetMarcItem($bib->{'biblionumber'},$usmarc) ;
1574         $biblionumber=$bib->{'biblionumber'};
1575       } else {
1576         $record=GetMarcBiblio($usmarc);
1577         $biblionumber=$usmarc;
1578       }
1579     }  else {
1580       if ($bntag >= 010){
1581         $biblionumber = $record->subfield($bntag,$bnsubf);
1582       }else {
1583         $biblionumber=$record->field($bntag)->data;
1584       }
1585     }
1586     #GetBiblionumber is to be written.
1587     #Could be replaced by TransformMarcToKoha (But Would be longer)
1588     if ($record->field($tag)){
1589       my $modify=0;
1590       foreach my $field ($record->field($tag)){
1591         if ($subfield){
1592           if ($field->delete_subfield('code' =>$subfield,'match'=>qr($initvalue))){
1593             $countmatched++;
1594             $modify=1;
1595             $field->update($subfield,$targetvalue) if ($targetvalue);
1596           }
1597         } else {
1598           if ($tag >= 010){
1599             if ($field->delete_field($field)){
1600               $countmatched++;
1601               $modify=1;
1602             }
1603           } else {
1604             $field->data=$targetvalue if ($field->data=~qr($initvalue));
1605           }
1606         }
1607       }
1608 #       warn $record->as_formatted;
1609       if ($modify){
1610         ModBiblio($record,$biblionumber,GetFrameworkCode($biblionumber)) unless ($test);
1611       } else {
1612         push @unmatched, $biblionumber;
1613       }
1614     } else {
1615       push @unmatched, $biblionumber;
1616     }
1617   }
1618   return ($countmatched,\@unmatched);
1619 }
1620
1621 END { }    # module clean-up code here (global destructor)
1622
1623 1;
1624 __END__
1625
1626 =head1 AUTHOR
1627
1628 Koha Developement team <info@koha.org>
1629
1630 =cut