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,     $federated_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 = $federated_query;
 288         }
 289
 290         # check if we've got a query_type defined
 291         eval {
 292             if ($query_type)
 293             {
 294                 if ( $query_type =~ /^ccl/ ) {
 295                     $query_to_use =~
 296                       s/\:/\=/g;    # change : to = last minute (FIXME)
 297
 298                     #                 warn "CCL : $query_to_use";
 299                     $results[$i] =
 300                       $zconns[$i]->search(
 301                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 302                       );
 303                 }
 304                 elsif ( $query_type =~ /^cql/ ) {
 305
 306                     #                 warn "CQL : $query_to_use";
 307                     $results[$i] =
 308                       $zconns[$i]->search(
 309                         new ZOOM::Query::CQL( $query_to_use, $zconns[$i] ) );
 310                 }
 311                 elsif ( $query_type =~ /^pqf/ ) {
 312
 313                     #                 warn "PQF : $query_to_use";
 314                     $results[$i] =
 315                       $zconns[$i]->search(
 316                         new ZOOM::Query::PQF( $query_to_use, $zconns[$i] ) );
 317                 }
 318             }
 319             else {
 320                 if ($scan) {
 321
 322                     #                 warn "preparing to scan";
 323                     $results[$i] =
 324                       $zconns[$i]->scan(
 325                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 326                       );
 327                 }
 328                 else {
 329
 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
 413                  # here we create a minimal MARC record and hand it off to the
 414                  # template just like a normal result ... perhaps not ideal, but
 415                  # it works for now
 416                         my $tmprecord = MARC::Record->new();
 417                         $tmprecord->encoding('UTF-8');
 418                         my $tmptitle;
 419
 420           # srote the minimal record in author/title (depending on MARC flavour)
 421                         if ( C4::Context->preference("marcflavour") eq
 422                             "UNIMARC" )
 423                         {
 424                             $tmptitle = MARC::Field->new(
 425                                 '200', ' ', ' ',
 426                                 a => $term,
 427                                 f => $occ
 428                             );
 429                         }
 430                         else {
 431                             $tmptitle = MARC::Field->new(
 432                                 '245', ' ', ' ',
 433                                 a => $term,
 434                                 b => $occ
 435                             );
 436                         }
 437                         $tmprecord->append_fields($tmptitle);
 438                         $results_hash->{'RECORDS'}[$j] =
 439                           $tmprecord->as_usmarc();
 440                     }
 441                     else {
 442                         $record = $results[ $i - 1 ]->record($j)->raw();
 443
 444                         #warn "RECORD $j:".$record;
 445                         $results_hash->{'RECORDS'}[$j] =
 446                           $record;    # making a reference to a hash
 447                                       # Fill the facets while we're looping
 448                         $facet_record = MARC::Record->new_from_usmarc($record);
 449
 450                         #warn $servers[$i-1].$facet_record->title();
 451                         for ( my $k = 0 ; $k <= @$facets ; $k++ ) {
 452                             if ( $facets->[$k] ) {
 453                                 my @fields;
 454                                 for my $tag ( @{ $facets->[$k]->{'tags'} } ) {
 455                                     push @fields, $facet_record->field($tag);
 456                                 }
 457                                 for my $field (@fields) {
 458                                     my @subfields = $field->subfields();
 459                                     for my $subfield (@subfields) {
 460                                         my ( $code, $data ) = @$subfield;
 461                                         if ( $code eq
 462                                             $facets->[$k]->{'subfield'} )
 463                                         {
 464                                             $facets_counter->{ $facets->[$k]
 465                                                   ->{'link_value'} }->{$data}++;
 466                                         }
 467                                     }
 468                                 }
 469                                 $facets_info->{ $facets->[$k]->{'link_value'} }
 470                                   ->{'label_value'} =
 471                                   $facets->[$k]->{'label_value'};
 472                                 $facets_info->{ $facets->[$k]->{'link_value'} }
 473                                   ->{'expanded'} = $facets->[$k]->{'expanded'};
 474                             }
 475                         }
 476                     }
 477                 }
 478                 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
 479             }
 480
 481             #print "connection ", $i-1, ": $size hits";
 482             #print $results[$i-1]->record(0)->render() if $size > 0;
 483             # BUILD FACETS
 484             for my $link_value (
 485                 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
 486                 keys %$facets_counter
 487               )
 488             {
 489                 my $expandable;
 490                 my $number_of_facets;
 491                 my @this_facets_array;
 492                 for my $one_facet (
 493                     sort {
 494                         $facets_counter->{$link_value}
 495                           ->{$b} <=> $facets_counter->{$link_value}->{$a}
 496                     } keys %{ $facets_counter->{$link_value} }
 497                   )
 498                 {
 499                     $number_of_facets++;
 500                     if (   ( $number_of_facets < 6 )
 501                         || ( $expanded_facet eq $link_value )
 502                         || ( $facets_info->{$link_value}->{'expanded'} ) )
 503                     {
 504
 505                        # sanitize the link value ), ( will cause errors with CCL
 506                         my $facet_link_value = $one_facet;
 507                         $facet_link_value =~ s/(\(|\))/ /g;
 508
 509                         # fix the length that will display in the label
 510                         my $facet_label_value = $one_facet;
 511                         $facet_label_value = substr( $one_facet, 0, 20 ) . "..."
 512                           unless length($facet_label_value) <= 20;
 513
 514                        # well, if it's a branch, label by the name, not the code
 515                         if ( $link_value =~ /branch/ ) {
 516                             $facet_label_value =
 517                               $branches->{$one_facet}->{'branchname'};
 518                         }
 519
 520                  # but we're down with the whole label being in the link's title
 521                         my $facet_title_value = $one_facet;
 522
 523                         push @this_facets_array,
 524                           (
 525                             {
 526                                 facet_count =>
 527                                   $facets_counter->{$link_value}->{$one_facet},
 528                                 facet_label_value => $facet_label_value,
 529                                 facet_title_value => $facet_title_value,
 530                                 facet_link_value  => $facet_link_value,
 531                                 type_link_value   => $link_value,
 532                             },
 533                           );
 534                     }
 535                 }
 536                 unless ( $facets_info->{$link_value}->{'expanded'} ) {
 537                     $expandable = 1
 538                       if ( ( $number_of_facets > 6 )
 539                         && ( $expanded_facet ne $link_value ) );
 540                 }
 541                 push @facets_loop,
 542                   (
 543                     {
 544                         type_link_value => $link_value,
 545                         type_id         => $link_value . "_id",
 546                         type_label      =>
 547                           $facets_info->{$link_value}->{'label_value'},
 548                         facets     => \@this_facets_array,
 549                         expandable => $expandable,
 550                         expand     => $link_value,
 551                     }
 552                   );
 553             }
 554         }
 555     }
 556     return ( undef, $results_hashref, \@facets_loop );
 557 }
 558
 559 # STOPWORDS
 560 sub _remove_stopwords {
 561     my ($operand,$index) = @_;
 562     # phrase and exact-qualified indexes shoudln't have stopwords removed
 563     if ($index!~m/phr|ext/){
 564     # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
 565     #       we use IsAlpha unicode definition, to deal correctly with diacritics.
 566     #       otherwise, a french word like "leçon" woudl be split into "le" "çon", le
 567     #       is an empty word, we get "çon" and wouldn't find anything...
 568         foreach (keys %{C4::Context->stopwords}) {
 569             next if ($_ =~/(and|or|not)/); # don't remove operators
 570             $operand=~ s/\P{IsAlpha}$_\P{IsAlpha}/ /i;
 571             $operand=~ s/^$_\P{IsAlpha}/ /i;
 572             $operand=~ s/\P{IsAlpha}$_$/ /i;
 573         }
 574     }
 575     return $operand;
 576 }
 577
 578 # TRUNCATION
 579 sub _detect_truncation {
 580     my ($operand,$index) = @_;
 581     my (@nontruncated,@righttruncated,@lefttruncated,@rightlefttruncated,@regexpr);
 582     $operand =~s/^ //g;
 583     my @wordlist= split (/\s/,$operand);
 584     foreach my $word (@wordlist){
 585         if ($word=~s/^\*([^\*]+)\*$/$1/){
 586             push @rightlefttruncated,$word;
 587         }
 588         elsif($word=~s/^\*([^\*]+)$/$1/){
 589             push @lefttruncated,$word;
 590         }
 591         elsif ($word=~s/^([^\*]+)\*$/$1/){
 592             push @righttruncated,$word;
 593         }
 594         elsif (index($word,"*")<0){
 595             push @nontruncated,$word;
 596         }
 597         else {
 598             push @regexpr,$word;
 599         }
 600     }
 601     return (\@nontruncated,\@righttruncated,\@lefttruncated,\@rightlefttruncated,\@regexpr);
 602 }
 603
 604 sub _build_stemmed_operand {
 605     my ($operand) = @_;
 606     my $stemmed_operand;
 607     # FIXME: the locale should be set based on the user's language and/or search choice
 608     my $stemmer = Lingua::Stem->new( -locale => 'EN-US' );
 609     # FIXME: these should be stored in the db so the librarian can modify the behavior
 610     $stemmer->add_exceptions(
 611             {
 612                 'and' => 'and',
 613                 'or'  => 'or',
 614                 'not' => 'not',
 615             }
 616
 617         );
 618     my @words = split( / /, $operand );
 619     my $stems = $stemmer->stem(@words);
 620     for my $stem (@$stems) {
 621             $stemmed_operand .= "$stem";
 622             $stemmed_operand .= "?" unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 623             $stemmed_operand .= " ";
 624     }
 625     #warn "STEMMED OPERAND: $stemmed_operand";
 626     return $stemmed_operand;
 627 }
 628
 629 sub _build_weighted_query {
 630     # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
 631     # pretty well but will work much better when we have an actual query parser
 632     my ($operand,$stemmed_operand,$index) = @_;
 633     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 634     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 635     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
 636
 637     my $weighted_query .= "(rk=(";     # Specifies that we're applying rank
 638
 639     # Keyword, or, no index specified
 640     if ( ( $index eq 'kw' ) || ( !$index ) ) {
 641         $weighted_query .= "Title-cover,ext,r1=\"$operand\"";       # exact title-cover
 642         $weighted_query .= " or ti,ext,r2=\"$operand\"";            # exact title
 643         $weighted_query .= " or ti,phr,r3=\"$operand\"";            # phrase title
 644        #$weighted_query .= " or any,ext,r4=$operand";               # exact any
 645        #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
 646         $weighted_query .= " or wrd,fuzzy,r8=\"$operand\"" if $fuzzy_enabled; # add fuzzy, word list
 647         $weighted_query .= " or wrd,right-Truncation,r9=\"$stemmed_operand\"" if ($stemming and $stemmed_operand); # add stemming, right truncation
 648        # embedded sorting: 0 a-z; 1 z-a
 649        # $weighted_query .= ") or (sort1,aut=1";
 650     }
 651     # if the index already has more than one qualifier, just wrap the operand
 652     # in quotes and pass it back
 653     elsif ($index =~ ',') {
 654         $weighted_query .=" $index=\"$operand\"";
 655     }
 656     #TODO: build better cases based on specific search indexes
 657     else {
 658        $weighted_query .= " $index,ext,r1=\"$operand\"";            # exact index
 659        #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
 660        $weighted_query .= " or $index,phr,r3=\"$operand\"";         # phrase index
 661        $weighted_query .= " or $index,rt,wrd,r3=\"$operand\"";      # word list index
 662     }
 663     $weighted_query .= "))";    # close rank specification
 664     return $weighted_query;
 665 }
 666
 667 # build the query itself
 668 sub buildQuery {
 669     my ( $operators, $operands, $indexes, $limits, $sort_by ) = @_;
 670
 671     my @operators = @$operators if $operators;
 672     my @indexes   = @$indexes   if $indexes;
 673     my @operands  = @$operands  if $operands;
 674     my @limits    = @$limits    if $limits;
 675     my @sort_by   = @$sort_by   if $sort_by;
 676
 677     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 678     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 679     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
 680
 681     my $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     foreach my $this_limit (@limits) {
 819         if ( $this_limit =~ /available/ ) {
 820                         # FIXME: switch to zebra search for null values
 821             $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))";
 822                         $limit_cgi .= "&limit=available";
 823                         $limit_desc .="";
 824         }
 825                 # these are treated as OR
 826         elsif ( $this_limit =~ /mc/ ) {
 827             $limit .= " or $this_limit";
 828                         $limit_cgi .="&limit=$this_limit";
 829             $limit_desc .= " or $this_limit";
 830         }
 831                 else {
 832                         $limit .= " and $this_limit";
 833                         $limit_cgi .="&limit=$this_limit";
 834                         $limit_desc .=" and $this_limit";
 835                 }
 836     }
 837
 838         # normalize the strings
 839         for ($query, $query_search_desc, $limit, $limit_desc) {
 840                 $_ =~ s/  / /g;    # remove extra spaces
 841         $_ =~ s/^ //g;     # remove any beginning spaces
 842                 $_ =~ s/ $//g;     # remove any beginning spaces
 843         $_ =~ s/:/=/g;     # causes probs for server
 844         $_ =~ s/==/=/g;    # remove double == from query
 845
 846         }
 847
 848         # append the limit to the query
 849         $query .= $limit;
 850
 851     warn "QUERY:".$query if $DEBUG;
 852         warn "QUERY CGI:".$query_cgi if $DEBUG;
 853     warn "QUERY DESC:".$query_search_desc if $DEBUG;
 854     warn "LIMIT:".$limit if $DEBUG;
 855     warn "LIMIT CGI:".$limit_cgi if $DEBUG;
 856     warn "LIMIT DESC:".$limit_desc if $DEBUG;
 857
 858         return ( undef, $query,$query_cgi,$query_search_desc,$limit,$limit_cgi,$limit_desc );
 859 }
 860
 861 # IMO this subroutine is pretty messy still -- it's responsible for
 862 # building the HTML output for the template
 863 sub searchResults {
 864     my ( $searchdesc, $hits, $results_per_page, $offset, @marcresults ) = @_;
 865
 866     my $dbh = C4::Context->dbh;
 867     my $toggle;
 868     my $even = 1;
 869     my @newresults;
 870     my $span_terms_hashref;
 871     for my $span_term ( split( / /, $searchdesc ) ) {
 872         $span_term =~ s/(.*=|\)|\(|\+|\.)//g;
 873         $span_terms_hashref->{$span_term}++;
 874     }
 875
 876     #Build brancnames hash
 877     #find branchname
 878     #get branch information.....
 879     my %branches;
 880     my $bsth =
 881       $dbh->prepare("SELECT branchcode,branchname FROM branches")
 882       ;    # FIXME : use C4::Koha::GetBranches
 883     $bsth->execute();
 884     while ( my $bdata = $bsth->fetchrow_hashref ) {
 885         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
 886     }
 887
 888     #Build itemtype hash
 889     #find itemtype & itemtype image
 890     my %itemtypes;
 891     $bsth =
 892       $dbh->prepare("SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes");
 893     $bsth->execute();
 894     while ( my $bdata = $bsth->fetchrow_hashref ) {
 895         $itemtypes{ $bdata->{'itemtype'} }->{description} =
 896           $bdata->{'description'};
 897         $itemtypes{ $bdata->{'itemtype'} }->{imageurl} = $bdata->{'imageurl'};
 898         $itemtypes{ $bdata->{'itemtype'} }->{summary} = $bdata->{'summary'};
 899         $itemtypes{ $bdata->{'itemtype'} }->{notforloan} = $bdata->{'notforloan'};
 900     }
 901
 902     #search item field code
 903     my $sth =
 904       $dbh->prepare(
 905 "select tagfield from marc_subfield_structure where kohafield like 'items.itemnumber'"
 906       );
 907     $sth->execute;
 908     my ($itemtag) = $sth->fetchrow;
 909
 910     ## find column names of items related to MARC
 911     my $sth2 = $dbh->prepare("SHOW COLUMNS from items");
 912     $sth2->execute;
 913     my %subfieldstosearch;
 914     while ( ( my $column ) = $sth2->fetchrow ) {
 915         my ( $tagfield, $tagsubfield ) =
 916           &GetMarcFromKohaField( "items." . $column, "" );
 917         $subfieldstosearch{$column} = $tagsubfield;
 918     }
 919     my $times;
 920
 921     if ( $hits && $offset + $results_per_page <= $hits ) {
 922         $times = $offset + $results_per_page;
 923     }
 924     else {
 925         $times = $hits;
 926     }
 927
 928     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
 929         my $marcrecord;
 930         $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
 931         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, '' );
 932         # add image url if there is one
 933         if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} =~ /^http:/ ) {
 934             $oldbiblio->{imageurl} =
 935               $itemtypes{ $oldbiblio->{itemtype} }->{imageurl};
 936             $oldbiblio->{description} =
 937               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 938         }
 939         else {
 940             $oldbiblio->{imageurl} =
 941               getitemtypeimagesrc() . "/"
 942               . $itemtypes{ $oldbiblio->{itemtype} }->{imageurl}
 943               if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
 944             $oldbiblio->{description} =
 945               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 946         }
 947         #
 948         # build summary if there is one (the summary is defined in itemtypes table
 949         #
 950         if ($itemtypes{ $oldbiblio->{itemtype} }->{summary}) {
 951             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
 952             my @fields = $marcrecord->fields();
 953             foreach my $field (@fields) {
 954                 my $tag = $field->tag();
 955                 my $tagvalue = $field->as_string();
 956                 $summary =~ s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
 957                 unless ($tag<10) {
 958                     my @subf = $field->subfields;
 959                     for my $i (0..$#subf) {
 960                         my $subfieldcode = $subf[$i][0];
 961                         my $subfieldvalue = $subf[$i][1];
 962                         my $tagsubf = $tag.$subfieldcode;
 963                         $summary =~ s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
 964                     }
 965                 }
 966             }
 967             $summary =~ s/\[(.*?)]//g;
 968             $summary =~ s/\n/<br>/g;
 969             $oldbiblio->{summary} = $summary;
 970         }
 971         # add spans to search term in results for search term highlighting
 972         foreach my $term ( keys %$span_terms_hashref ) {
 973             my $old_term = $term;
 974             if ( length($term) > 3 ) {
 975                 $term =~ s/(.*=|\)|\(|\+|\.|\?|\[|\])//g;
 976                 $term =~ s/\\//g;
 977                 $term =~ s/\*//g;
 978
 979                 #FIXME: is there a better way to do this?
 980                 $oldbiblio->{'title'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 981                 $oldbiblio->{'subtitle'} =~
 982                   s/$term/<span class=\"term\">$&<\/span>/gi;
 983
 984                 $oldbiblio->{'author'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 985                 $oldbiblio->{'publishercode'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 986                 $oldbiblio->{'place'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 987                 $oldbiblio->{'pages'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 988                 $oldbiblio->{'notes'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 989                 $oldbiblio->{'size'}  =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 990             }
 991         }
 992
 993         if ( $i % 2 ) {
 994             $toggle = "#ffffcc";
 995         }
 996         else {
 997             $toggle = "white";
 998         }
 999         $oldbiblio->{'toggle'} = $toggle;
1000         my @fields = $marcrecord->field($itemtag);
1001         my @items_loop;
1002         my $items;
1003         my $ordered_count     = 0;
1004         my $onloan_count      = 0;
1005         my $wthdrawn_count    = 0;
1006         my $itemlost_count    = 0;
1007         my $norequests        = 1;
1008
1009         #
1010         # check the loan status of the item :
1011         # it is not stored in the MARC record, for pref (zebra reindexing)
1012         # reason. Thus, we have to get the status from a specific SQL query
1013         #
1014         my $sth_issue = $dbh->prepare("
1015             SELECT date_due,returndate
1016             FROM issues
1017             WHERE itemnumber=? AND returndate IS NULL");
1018         my $items_count=scalar(@fields);
1019         foreach my $field (@fields) {
1020             my $item;
1021             foreach my $code ( keys %subfieldstosearch ) {
1022                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1023             }
1024             $sth_issue->execute($item->{itemnumber});
1025             $item->{due_date} = format_date($sth_issue->fetchrow);
1026             $item->{onloan} = 1 if $item->{due_date};
1027             # at least one item can be reserved : suppose no
1028             $norequests = 1;
1029             if ( $item->{wthdrawn} ) {
1030                 $wthdrawn_count++;
1031                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1032                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{wthdrawn}=1;
1033             }
1034             elsif ( $item->{itemlost} ) {
1035                 $itemlost_count++;
1036                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1037                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemlost}=1;
1038             }
1039             unless ( $item->{notforloan}) {
1040                 # OK, this one can be issued, so at least one can be reserved
1041                 $norequests = 0;
1042             }
1043             if ( ( $item->{onloan} ) && ( $item->{onloan} != '0000-00-00' ) )
1044             {
1045                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1046                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{onloancount} = 1;
1047                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{due_date} = $item->{due_date};
1048                 $onloan_count++;
1049             }
1050             if ( $item->{'homebranch'} ) {
1051                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{count}++;
1052             }
1053
1054             # Last resort
1055             elsif ( $item->{'holdingbranch'} ) {
1056                 $items->{ $item->{'holdingbranch'} }->{count}++;
1057             }
1058             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemcallnumber} =                $item->{itemcallnumber};
1059             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{location} =                $item->{location};
1060             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{branchcode} =               $item->{homebranch};
1061         }    # notforloan, item level and biblioitem level
1062
1063         # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1064         $norequests = 1 if $itemtypes{$oldbiblio->{itemtype}}->{notforloan};
1065
1066         for my $key ( sort keys %$items ) {
1067             my $this_item = {
1068                 branchname     => $branches{$items->{$key}->{branchcode}},
1069                 branchcode     => $items->{$key}->{branchcode},
1070                 count          => $items->{$key}->{count},
1071                 itemcallnumber => $items->{$key}->{itemcallnumber},
1072                 location => $items->{$key}->{location},
1073                 onloancount      => $items->{$key}->{onloancount},
1074                 due_date         => $items->{$key}->{due_date},
1075                 wthdrawn      => $items->{$key}->{wthdrawn},
1076                 lost         => $items->{$key}->{itemlost},
1077             };
1078             push @items_loop, $this_item;
1079         }
1080         $oldbiblio->{norequests}    = $norequests;
1081         $oldbiblio->{items_count}    = $items_count;
1082         $oldbiblio->{items_loop}    = \@items_loop;
1083         $oldbiblio->{onloancount}   = $onloan_count;
1084         $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1085         $oldbiblio->{itemlostcount} = $itemlost_count;
1086         $oldbiblio->{orderedcount}  = $ordered_count;
1087         $oldbiblio->{isbn}          =~ s/-//g; # deleting - in isbn to enable amazon content
1088         push( @newresults, $oldbiblio );
1089     }
1090     return @newresults;
1091 }
1092
1093
1094
1095 #----------------------------------------------------------------------
1096 #
1097 # Non-Zebra GetRecords#
1098 #----------------------------------------------------------------------
1099
1100 =head2 NZgetRecords
1101
1102   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1103
1104 =cut
1105
1106 sub NZgetRecords {
1107     my (
1108         $koha_query,     $federated_query,  $sort_by_ref,
1109         $servers_ref,    $results_per_page, $offset,
1110         $expanded_facet, $branches,         $query_type,
1111         $scan
1112     ) = @_;
1113     my $result = NZanalyse($koha_query);
1114     return (undef,NZorder($result,@$sort_by_ref[0],$results_per_page,$offset),undef);
1115 }
1116
1117 =head2 NZanalyse
1118
1119   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1120   the list is builded from inverted index in nozebra SQL table
1121   note that title is here only for convenience : the sorting will be very fast when requested on title
1122   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1123
1124 =cut
1125
1126 sub NZanalyse {
1127     my ($string,$server) = @_;
1128     # $server contains biblioserver or authorities, depending on what we search on.
1129     #warn "querying : $string on $server";
1130     $server='biblioserver' unless $server;
1131     # if we have a ", replace the content to discard temporarily any and/or/not inside
1132     my $commacontent;
1133     if ($string =~/"/) {
1134         $string =~ s/"(.*?)"/__X__/;
1135         $commacontent = $1;
1136 #         print "commacontent : $commacontent\n";
1137     }
1138     # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1139     # then, call again NZanalyse with $left and $right
1140     # (recursive until we find a leaf (=> something without and/or/not)
1141     $string =~ /(.*)( and | or | not | AND | OR | NOT )(.*)/;
1142     my $left = $1;
1143     my $right = $3;
1144     my $operand = lc($2);
1145     # it's not a leaf, we have a and/or/not
1146     if ($operand) {
1147         # reintroduce comma content if needed
1148         $right =~ s/__X__/"$commacontent"/ if $commacontent;
1149         $left =~ s/__X__/"$commacontent"/ if $commacontent;
1150 #         warn "node : $left / $operand / $right\n";
1151         my $leftresult = NZanalyse($left,$server);
1152         my $rightresult = NZanalyse($right,$server);
1153         # OK, we have the results for right and left part of the query
1154         # depending of operand, intersect, union or exclude both lists
1155         # to get a result list
1156         if ($operand eq ' and ') {
1157             my @leftresult = split /;/, $leftresult;
1158 #             my @rightresult = split /;/,$leftresult;
1159             my $finalresult;
1160             # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1161             # the result is stored twice, to have the same weight for AND than OR.
1162             # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1163             # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1164             foreach (@leftresult) {
1165                 if ($rightresult =~ "$_;") {
1166                     $finalresult .= "$_;$_;";
1167                 }
1168             }
1169             return $finalresult;
1170         } elsif ($operand eq ' or ') {
1171             # just merge the 2 strings
1172             return $leftresult.$rightresult;
1173         } elsif ($operand eq ' not ') {
1174             my @leftresult = split /;/, $leftresult;
1175 #             my @rightresult = split /;/,$leftresult;
1176             my $finalresult;
1177             foreach (@leftresult) {
1178                 unless ($rightresult =~ "$_;") {
1179                     $finalresult .= "$_;";
1180                 }
1181             }
1182             return $finalresult;
1183         } else {
1184             # this error is impossible, because of the regexp that isolate the operand, but just in case...
1185             die "error : operand unknown : $operand for $string";
1186         }
1187     # it's a leaf, do the real SQL query and return the result
1188     } else {
1189         $string =~  s/__X__/"$commacontent"/ if $commacontent;
1190         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1191 #         warn "leaf : $string\n";
1192         # parse the string in in operator/operand/value again
1193         $string =~ /(.*)(>=|<=)(.*)/;
1194         my $left = $1;
1195         my $operator = $2;
1196         my $right = $3;
1197         unless ($operator) {
1198             $string =~ /(.*)(>|<|=)(.*)/;
1199             $left = $1;
1200             $operator = $2;
1201             $right = $3;
1202         }
1203         my $results;
1204         # automatic replace for short operators
1205         $left='title' if $left =~ '^ti';
1206         $left='author' if $left =~ '^au';
1207         $left='publisher' if $left =~ '^pb';
1208         $left='subject' if $left =~ '^su';
1209         $left='koha-Auth-Number' if $left =~ '^an';
1210         $left='keyword' if $left =~ '^kw';
1211         if ($operator) {
1212             #do a specific search
1213             my $dbh = C4::Context->dbh;
1214             $operator='LIKE' if $operator eq '=' and $right=~ /%/;
1215             my $sth = $dbh->prepare("SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?");
1216             warn "$left / $operator / $right\n";
1217             # split each word, query the DB and build the biblionumbers result
1218             foreach (split / /,$right) {
1219                 my ($biblionumbers,$value);
1220                 next unless $_;
1221                 warn "EXECUTE : $server, $left, $_";
1222                 $sth->execute($server, $left, $_);
1223                 while (my ($line,$value) = $sth->fetchrow) {
1224                     # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1225                     # otherwise, fill the result
1226                     $biblionumbers .= $line unless ($right =~ /\d/ && $value =~ /\D/);
1227                     warn "result : $value ". ($right =~ /\d/) . "==".(!$value =~ /\d/) ;#= $line";
1228                 }
1229                 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1230                 if ($results) {
1231                     my @leftresult = split /;/, $biblionumbers;
1232                     my $temp;
1233                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1234                         # remove weight at the end
1235                         my $cleaned = $entry;
1236                         $cleaned =~ s/-\d*$//;
1237                         # if the entry already in the hash, take it & increase weight
1238 #                         warn "===== $cleaned =====";
1239                         if ($results =~ "$cleaned") {
1240                             $temp .= "$entry;$entry;";
1241 #                             warn "INCLUDING $entry";
1242                         }
1243                     }
1244                     $results = $temp;
1245                 } else {
1246                     $results = $biblionumbers;
1247                 }
1248             }
1249         } else {
1250             #do a complete search (all indexes)
1251             my $dbh = C4::Context->dbh;
1252             my $sth = $dbh->prepare("SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?");
1253             # split each word, query the DB and build the biblionumbers result
1254             foreach (split / /,$string) {
1255                 next if C4::Context->stopwords->{uc($_)}; # skip if stopword
1256                 #warn "search on all indexes on $_";
1257                 my $biblionumbers;
1258                 next unless $_;
1259                 $sth->execute($server, $_);
1260                 while (my $line = $sth->fetchrow) {
1261                     $biblionumbers .= $line;
1262                 }
1263                 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1264                 if ($results) {
1265 #                 warn "RES for $_ = $biblionumbers";
1266                     my @leftresult = split /;/, $biblionumbers;
1267                     my $temp;
1268                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1269                         # remove weight at the end
1270                         my $cleaned = $entry;
1271                         $cleaned =~ s/-\d*$//;
1272                         # if the entry already in the hash, take it & increase weight
1273 #                         warn "===== $cleaned =====";
1274                         if ($results =~ "$cleaned") {
1275                             $temp .= "$entry;$entry;";
1276 #                             warn "INCLUDING $entry";
1277                         }
1278                     }
1279                     $results = $temp;
1280                 } else {
1281 #                 warn "NEW RES for $_ = $biblionumbers";
1282                     $results = $biblionumbers;
1283                 }
1284             }
1285         }
1286 #         warn "return : $results for LEAF : $string";
1287         return $results;
1288     }
1289 }
1290
1291 =head2 NZorder
1292
1293   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1294
1295   TODO :: Description
1296
1297 =cut
1298
1299
1300 sub NZorder {
1301     my ($biblionumbers, $ordering,$results_per_page,$offset) = @_;
1302     # order title asc by default
1303 #     $ordering = '1=36 <i' unless $ordering;
1304     $results_per_page=20 unless $results_per_page;
1305     $offset = 0 unless $offset;
1306     my $dbh = C4::Context->dbh;
1307     #
1308     # order by POPULARITY
1309     #
1310     if ($ordering =~ /popularity/) {
1311         my %result;
1312         my %popularity;
1313         # popularity is not in MARC record, it's builded from a specific query
1314         my $sth = $dbh->prepare("select sum(issues) from items where biblionumber=?");
1315         foreach (split /;/,$biblionumbers) {
1316             my ($biblionumber,$title) = split /,/,$_;
1317             $result{$biblionumber}=GetMarcBiblio($biblionumber);
1318             $sth->execute($biblionumber);
1319             my $popularity= $sth->fetchrow ||0;
1320             # hint : the key is popularity.title because we can have
1321             # many results with the same popularity. In this cas, sub-ordering is done by title
1322             # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1323             # (un-frequent, I agree, but we won't forget anything that way ;-)
1324             $popularity{sprintf("%10d",$popularity).$title.$biblionumber} = $biblionumber;
1325         }
1326         # sort the hash and return the same structure as GetRecords (Zebra querying)
1327         my $result_hash;
1328         my $numbers=0;
1329         if ($ordering eq 'popularity_dsc') { # sort popularity DESC
1330             foreach my $key (sort {$b cmp $a} (keys %popularity)) {
1331                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1332             }
1333         } else { # sort popularity ASC
1334             foreach my $key (sort (keys %popularity)) {
1335                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1336             }
1337         }
1338         my $finalresult=();
1339         $result_hash->{'hits'} = $numbers;
1340         $finalresult->{'biblioserver'} = $result_hash;
1341         return $finalresult;
1342     #
1343     # ORDER BY author
1344     #
1345     } elsif ($ordering =~/author/){
1346         my %result;
1347         foreach (split /;/,$biblionumbers) {
1348             my ($biblionumber,$title) = split /,/,$_;
1349             my $record=GetMarcBiblio($biblionumber);
1350             my $author;
1351             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1352                 $author=$record->subfield('200','f');
1353                 $author=$record->subfield('700','a') unless $author;
1354             } else {
1355                 $author=$record->subfield('100','a');
1356             }
1357             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1358             # and we don't want to get only 1 result for each of them !!!
1359             $result{$author.$biblionumber}=$record;
1360         }
1361         # sort the hash and return the same structure as GetRecords (Zebra querying)
1362         my $result_hash;
1363         my $numbers=0;
1364         if ($ordering eq 'author_za') { # sort by author desc
1365             foreach my $key (sort { $b cmp $a } (keys %result)) {
1366                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1367             }
1368         } else { # sort by author ASC
1369             foreach my $key (sort (keys %result)) {
1370                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1371             }
1372         }
1373         my $finalresult=();
1374         $result_hash->{'hits'} = $numbers;
1375         $finalresult->{'biblioserver'} = $result_hash;
1376         return $finalresult;
1377     #
1378     # ORDER BY callnumber
1379     #
1380     } elsif ($ordering =~/callnumber/){
1381         my %result;
1382         foreach (split /;/,$biblionumbers) {
1383             my ($biblionumber,$title) = split /,/,$_;
1384             my $record=GetMarcBiblio($biblionumber);
1385             my $callnumber;
1386             my ($callnumber_tag,$callnumber_subfield)=GetMarcFromKohaField($dbh,'items.itemcallnumber');
1387             ($callnumber_tag,$callnumber_subfield)= GetMarcFromKohaField('biblioitems.callnumber') unless $callnumber_tag;
1388             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1389                 $callnumber=$record->subfield('200','f');
1390             } else {
1391                 $callnumber=$record->subfield('100','a');
1392             }
1393             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1394             # and we don't want to get only 1 result for each of them !!!
1395             $result{$callnumber.$biblionumber}=$record;
1396         }
1397         # sort the hash and return the same structure as GetRecords (Zebra querying)
1398         my $result_hash;
1399         my $numbers=0;
1400         if ($ordering eq 'call_number_dsc') { # sort by title desc
1401             foreach my $key (sort { $b cmp $a } (keys %result)) {
1402                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1403             }
1404         } else { # sort by title ASC
1405             foreach my $key (sort { $a cmp $b } (keys %result)) {
1406                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1407             }
1408         }
1409         my $finalresult=();
1410         $result_hash->{'hits'} = $numbers;
1411         $finalresult->{'biblioserver'} = $result_hash;
1412         return $finalresult;
1413     } elsif ($ordering =~ /pubdate/){ #pub year
1414         my %result;
1415         foreach (split /;/,$biblionumbers) {
1416             my ($biblionumber,$title) = split /,/,$_;
1417             my $record=GetMarcBiblio($biblionumber);
1418             my ($publicationyear_tag,$publicationyear_subfield)=GetMarcFromKohaField('biblioitems.publicationyear','');
1419             my $publicationyear=$record->subfield($publicationyear_tag,$publicationyear_subfield);
1420             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1421             # and we don't want to get only 1 result for each of them !!!
1422             $result{$publicationyear.$biblionumber}=$record;
1423         }
1424         # sort the hash and return the same structure as GetRecords (Zebra querying)
1425         my $result_hash;
1426         my $numbers=0;
1427         if ($ordering eq 'pubdate_dsc') { # sort by pubyear desc
1428             foreach my $key (sort { $b cmp $a } (keys %result)) {
1429                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1430             }
1431         } else { # sort by pub year ASC
1432             foreach my $key (sort (keys %result)) {
1433                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1434             }
1435         }
1436         my $finalresult=();
1437         $result_hash->{'hits'} = $numbers;
1438         $finalresult->{'biblioserver'} = $result_hash;
1439         return $finalresult;
1440     #
1441     # ORDER BY title
1442     #
1443     } elsif ($ordering =~ /title/) {
1444         # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
1445         my %result;
1446         foreach (split /;/,$biblionumbers) {
1447             my ($biblionumber,$title) = split /,/,$_;
1448             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1449             # and we don't want to get only 1 result for each of them !!!
1450             # hint & speed improvement : we can order without reading the record
1451             # so order, and read records only for the requested page !
1452             $result{$title.$biblionumber}=$biblionumber;
1453         }
1454         # sort the hash and return the same structure as GetRecords (Zebra querying)
1455         my $result_hash;
1456         my $numbers=0;
1457         if ($ordering eq 'title_az') { # sort by title desc
1458             foreach my $key (sort (keys %result)) {
1459                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1460             }
1461         } else { # sort by title ASC
1462             foreach my $key (sort { $b cmp $a } (keys %result)) {
1463                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1464             }
1465         }
1466         # limit the $results_per_page to result size if it's more
1467         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1468         # for the requested page, replace biblionumber by the complete record
1469         # speed improvement : avoid reading too much things
1470         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1471             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc;
1472         }
1473         my $finalresult=();
1474         $result_hash->{'hits'} = $numbers;
1475         $finalresult->{'biblioserver'} = $result_hash;
1476         return $finalresult;
1477     } else {
1478     #
1479     # order by ranking
1480     #
1481         # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
1482         my %result;
1483         my %count_ranking;
1484         foreach (split /;/,$biblionumbers) {
1485             my ($biblionumber,$title) = split /,/,$_;
1486             $title =~ /(.*)-(\d)/;
1487             # get weight
1488             my $ranking =$2;
1489             # note that we + the ranking because ranking is calculated on weight of EACH term requested.
1490             # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
1491             # biblio N has ranking = 6
1492             $count_ranking{$biblionumber} += $ranking;
1493         }
1494         # build the result by "inverting" the count_ranking hash
1495         # 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
1496 #         warn "counting";
1497         foreach (keys %count_ranking) {
1498             $result{sprintf("%10d",$count_ranking{$_}).'-'.$_} = $_;
1499         }
1500         # sort the hash and return the same structure as GetRecords (Zebra querying)
1501         my $result_hash;
1502         my $numbers=0;
1503             foreach my $key (sort {$b cmp $a} (keys %result)) {
1504                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1505             }
1506         # limit the $results_per_page to result size if it's more
1507         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1508         # for the requested page, replace biblionumber by the complete record
1509         # speed improvement : avoid reading too much things
1510         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1511             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc if $result_hash->{'RECORDS'}[$counter];
1512         }
1513         my $finalresult=();
1514         $result_hash->{'hits'} = $numbers;
1515         $finalresult->{'biblioserver'} = $result_hash;
1516         return $finalresult;
1517     }
1518 }
1519 =head2 ModBiblios
1520
1521 ($countchanged,$listunchanged) = ModBiblios($listbiblios, $tagsubfield,$initvalue,$targetvalue,$test);
1522
1523 this function changes all the values $initvalue in subfield $tag$subfield in any record in $listbiblios
1524 test parameter if set donot perform change to records in database.
1525
1526 =over 2
1527
1528 =item C<input arg:>
1529
1530     * $listbiblios is an array ref to marcrecords to be changed
1531     * $tagsubfield is the reference of the subfield to change.
1532     * $initvalue is the value to search the record for
1533     * $targetvalue is the value to set the subfield to
1534     * $test is to be set only not to perform changes in database.
1535
1536 =item C<Output arg:>
1537     * $countchanged counts all the changes performed.
1538     * $listunchanged contains the list of all the biblionumbers of records unchanged.
1539
1540 =item C<usage in the script:>
1541
1542 =back
1543
1544 my ($countchanged, $listunchanged) = EditBiblios($results->{RECORD}, $tagsubfield,$initvalue,$targetvalue);;
1545 #If one wants to display unchanged records, you should get biblios foreach @$listunchanged
1546 $template->param(countchanged => $countchanged, loopunchanged=>$listunchanged);
1547
1548 =cut
1549
1550 sub ModBiblios{
1551   my ($listbiblios,$tagsubfield,$initvalue,$targetvalue,$test)=@_;
1552   my $countmatched;
1553   my @unmatched;
1554   my ($tag,$subfield)=($1,$2) if ($tagsubfield=~/^(\d{1,3})([a-z0-9A-Z@])?$/);
1555   if ((length($tag)<3)&& $subfield=~/0-9/){
1556     $tag=$tag.$subfield;
1557     undef $subfield;
1558   }
1559   my ($bntag,$bnsubf) = GetMarcFromKohaField('biblio.biblionumber');
1560   my ($itemtag,$itemsubf) = GetMarcFromKohaField('items.itemnumber');
1561   foreach my $usmarc (@$listbiblios){
1562     my $record;
1563     $record=eval{MARC::Record->new_from_usmarc($usmarc)};
1564     my $biblionumber;
1565     if ($@){
1566       # usmarc is not a valid usmarc May be a biblionumber
1567       if ($tag eq $itemtag){
1568         my $bib=GetBiblioFromItemNumber($usmarc);
1569         $record=GetMarcItem($bib->{'biblionumber'},$usmarc) ;
1570         $biblionumber=$bib->{'biblionumber'};
1571       } else {
1572         $record=GetMarcBiblio($usmarc);
1573         $biblionumber=$usmarc;
1574       }
1575     }  else {
1576       if ($bntag >= 010){
1577         $biblionumber = $record->subfield($bntag,$bnsubf);
1578       }else {
1579         $biblionumber=$record->field($bntag)->data;
1580       }
1581     }
1582     #GetBiblionumber is to be written.
1583     #Could be replaced by TransformMarcToKoha (But Would be longer)
1584     if ($record->field($tag)){
1585       my $modify=0;
1586       foreach my $field ($record->field($tag)){
1587         if ($subfield){
1588           if ($field->delete_subfield('code' =>$subfield,'match'=>qr($initvalue))){
1589             $countmatched++;
1590             $modify=1;
1591             $field->update($subfield,$targetvalue) if ($targetvalue);
1592           }
1593         } else {
1594           if ($tag >= 010){
1595             if ($field->delete_field($field)){
1596               $countmatched++;
1597               $modify=1;
1598             }
1599           } else {
1600             $field->data=$targetvalue if ($field->data=~qr($initvalue));
1601           }
1602         }
1603       }
1604 #       warn $record->as_formatted;
1605       if ($modify){
1606         ModBiblio($record,$biblionumber,GetFrameworkCode($biblionumber)) unless ($test);
1607       } else {
1608         push @unmatched, $biblionumber;
1609       }
1610     } else {
1611       push @unmatched, $biblionumber;
1612     }
1613   }
1614   return ($countmatched,\@unmatched);
1615 }
1616
1617 END { }    # module clean-up code here (global destructor)
1618
1619 1;
1620 __END__
1621
1622 =head1 AUTHOR
1623
1624 Koha Developement team <info@koha.org>
1625
1626 =cut