koha-dev.rot13.org Git - koha_gimpoz/blob - 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
 827                 # these are treated as OR
 828         elsif ( $this_limit =~ /mc/ ) {
 829             $group_OR_limits .= " or " if $group_OR_limits;
 830                         $group_OR_limits .= "$this_limit";
 831                         $limit_cgi .="&limit=$this_limit";
 832             $limit_desc .= " or $this_limit";
 833         }
 834
 835                 # regular old limits
 836                 else {
 837                         $limit .= " and " if $limit || $query;
 838                         $limit .= "$this_limit";
 839                         $limit_cgi .="&limit=$this_limit";
 840                         $limit_desc .=" and $this_limit";
 841                 }
 842     }
 843         if ($group_OR_limits) {
 844                 $limit.=" and " if ($query || $limit );
 845                 $limit.="($group_OR_limits)";
 846         }
 847         # normalize the strings
 848         for ($query, $query_search_desc, $limit, $limit_desc) {
 849                 $_ =~ s/  / /g;    # remove extra spaces
 850         $_ =~ s/^ //g;     # remove any beginning spaces
 851                 $_ =~ s/ $//g;     # remove any beginning spaces
 852         $_ =~ s/:/=/g;     # causes probs for server
 853         $_ =~ s/==/=/g;    # remove double == from query
 854
 855         }
 856
 857         # append the limit to the query
 858         $query .= $limit;
 859
 860     warn "QUERY:".$query if $DEBUG;
 861         warn "QUERY CGI:".$query_cgi if $DEBUG;
 862     warn "QUERY DESC:".$query_search_desc if $DEBUG;
 863     warn "LIMIT:".$limit if $DEBUG;
 864     warn "LIMIT CGI:".$limit_cgi if $DEBUG;
 865     warn "LIMIT DESC:".$limit_desc if $DEBUG;
 866
 867         return ( undef, $query,$simple_query,$query_cgi,$query_search_desc,$limit,$limit_cgi,$limit_desc );
 868 }
 869
 870 # IMO this subroutine is pretty messy still -- it's responsible for
 871 # building the HTML output for the template
 872 sub searchResults {
 873     my ( $searchdesc, $hits, $results_per_page, $offset, @marcresults ) = @_;
 874
 875     my $dbh = C4::Context->dbh;
 876     my $toggle;
 877     my $even = 1;
 878     my @newresults;
 879     my $span_terms_hashref;
 880     for my $span_term ( split( / /, $searchdesc ) ) {
 881         $span_term =~ s/(.*=|\)|\(|\+|\.)//g;
 882         $span_terms_hashref->{$span_term}++;
 883     }
 884
 885     #Build brancnames hash
 886     #find branchname
 887     #get branch information.....
 888     my %branches;
 889     my $bsth =
 890       $dbh->prepare("SELECT branchcode,branchname FROM branches")
 891       ;    # FIXME : use C4::Koha::GetBranches
 892     $bsth->execute();
 893     while ( my $bdata = $bsth->fetchrow_hashref ) {
 894         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
 895     }
 896
 897     #Build itemtype hash
 898     #find itemtype & itemtype image
 899     my %itemtypes;
 900     $bsth =
 901       $dbh->prepare("SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes");
 902     $bsth->execute();
 903     while ( my $bdata = $bsth->fetchrow_hashref ) {
 904         $itemtypes{ $bdata->{'itemtype'} }->{description} =
 905           $bdata->{'description'};
 906         $itemtypes{ $bdata->{'itemtype'} }->{imageurl} = $bdata->{'imageurl'};
 907         $itemtypes{ $bdata->{'itemtype'} }->{summary} = $bdata->{'summary'};
 908         $itemtypes{ $bdata->{'itemtype'} }->{notforloan} = $bdata->{'notforloan'};
 909     }
 910
 911     #search item field code
 912     my $sth =
 913       $dbh->prepare(
 914 "select tagfield from marc_subfield_structure where kohafield like 'items.itemnumber'"
 915       );
 916     $sth->execute;
 917     my ($itemtag) = $sth->fetchrow;
 918
 919     ## find column names of items related to MARC
 920     my $sth2 = $dbh->prepare("SHOW COLUMNS from items");
 921     $sth2->execute;
 922     my %subfieldstosearch;
 923     while ( ( my $column ) = $sth2->fetchrow ) {
 924         my ( $tagfield, $tagsubfield ) =
 925           &GetMarcFromKohaField( "items." . $column, "" );
 926         $subfieldstosearch{$column} = $tagsubfield;
 927     }
 928     my $times;
 929
 930     if ( $hits && $offset + $results_per_page <= $hits ) {
 931         $times = $offset + $results_per_page;
 932     }
 933     else {
 934         $times = $hits;
 935     }
 936
 937     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
 938         my $marcrecord;
 939         $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
 940         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, '' );
 941         # add image url if there is one
 942         if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} =~ /^http:/ ) {
 943             $oldbiblio->{imageurl} =
 944               $itemtypes{ $oldbiblio->{itemtype} }->{imageurl};
 945             $oldbiblio->{description} =
 946               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 947         }
 948         else {
 949             $oldbiblio->{imageurl} =
 950               getitemtypeimagesrc() . "/"
 951               . $itemtypes{ $oldbiblio->{itemtype} }->{imageurl}
 952               if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
 953             $oldbiblio->{description} =
 954               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 955         }
 956         #
 957         # build summary if there is one (the summary is defined in itemtypes table
 958         #
 959         if ($itemtypes{ $oldbiblio->{itemtype} }->{summary}) {
 960             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
 961             my @fields = $marcrecord->fields();
 962             foreach my $field (@fields) {
 963                 my $tag = $field->tag();
 964                 my $tagvalue = $field->as_string();
 965                 $summary =~ s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
 966                 unless ($tag<10) {
 967                     my @subf = $field->subfields;
 968                     for my $i (0..$#subf) {
 969                         my $subfieldcode = $subf[$i][0];
 970                         my $subfieldvalue = $subf[$i][1];
 971                         my $tagsubf = $tag.$subfieldcode;
 972                         $summary =~ s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
 973                     }
 974                 }
 975             }
 976             $summary =~ s/\[(.*?)]//g;
 977             $summary =~ s/\n/<br>/g;
 978             $oldbiblio->{summary} = $summary;
 979         }
 980         # add spans to search term in results for search term highlighting
 981         foreach my $term ( keys %$span_terms_hashref ) {
 982             my $old_term = $term;
 983             if ( length($term) > 3 ) {
 984                 $term =~ s/(.*=|\)|\(|\+|\.|\?|\[|\])//g;
 985                 $term =~ s/\\//g;
 986                 $term =~ s/\*//g;
 987
 988                 #FIXME: is there a better way to do this?
 989                 $oldbiblio->{'title'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 990                 $oldbiblio->{'subtitle'} =~
 991                   s/$term/<span class=\"term\">$&<\/span>/gi;
 992
 993                 $oldbiblio->{'author'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 994                 $oldbiblio->{'publishercode'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 995                 $oldbiblio->{'place'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 996                 $oldbiblio->{'pages'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 997                 $oldbiblio->{'notes'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 998                 $oldbiblio->{'size'}  =~ s/$term/<span class=\"term\">$&<\/span>/gi;
 999             }
1000         }
1001
1002         if ( $i % 2 ) {
1003             $toggle = "#ffffcc";
1004         }
1005         else {
1006             $toggle = "white";
1007         }
1008         $oldbiblio->{'toggle'} = $toggle;
1009         my @fields = $marcrecord->field($itemtag);
1010         my @items_loop;
1011         my $items;
1012         my $ordered_count     = 0;
1013         my $onloan_count      = 0;
1014         my $wthdrawn_count    = 0;
1015         my $itemlost_count    = 0;
1016         my $norequests        = 1;
1017
1018         #
1019         # check the loan status of the item :
1020         # it is not stored in the MARC record, for pref (zebra reindexing)
1021         # reason. Thus, we have to get the status from a specific SQL query
1022         #
1023         my $sth_issue = $dbh->prepare("
1024             SELECT date_due,returndate
1025             FROM issues
1026             WHERE itemnumber=? AND returndate IS NULL");
1027         my $items_count=scalar(@fields);
1028         foreach my $field (@fields) {
1029             my $item;
1030             foreach my $code ( keys %subfieldstosearch ) {
1031                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1032             }
1033             $sth_issue->execute($item->{itemnumber});
1034             $item->{due_date} = format_date($sth_issue->fetchrow);
1035             $item->{onloan} = 1 if $item->{due_date};
1036             # at least one item can be reserved : suppose no
1037             $norequests = 1;
1038             if ( $item->{wthdrawn} ) {
1039                 $wthdrawn_count++;
1040                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1041                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{wthdrawn}=1;
1042             }
1043             elsif ( $item->{itemlost} ) {
1044                 $itemlost_count++;
1045                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1046                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemlost}=1;
1047             }
1048             unless ( $item->{notforloan}) {
1049                 # OK, this one can be issued, so at least one can be reserved
1050                 $norequests = 0;
1051             }
1052             if ( ( $item->{onloan} ) && ( $item->{onloan} != '0000-00-00' ) )
1053             {
1054                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1055                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{onloancount} = 1;
1056                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{due_date} = $item->{due_date};
1057                 $onloan_count++;
1058             }
1059             if ( $item->{'homebranch'} ) {
1060                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{count}++;
1061             }
1062
1063             # Last resort
1064             elsif ( $item->{'holdingbranch'} ) {
1065                 $items->{ $item->{'holdingbranch'} }->{count}++;
1066             }
1067             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemcallnumber} =                $item->{itemcallnumber};
1068             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{location} =                $item->{location};
1069             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{branchcode} =               $item->{homebranch};
1070         }    # notforloan, item level and biblioitem level
1071
1072         # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1073         $norequests = 1 if $itemtypes{$oldbiblio->{itemtype}}->{notforloan};
1074
1075         for my $key ( sort keys %$items ) {
1076             my $this_item = {
1077                 branchname     => $branches{$items->{$key}->{branchcode}},
1078                 branchcode     => $items->{$key}->{branchcode},
1079                 count          => $items->{$key}->{count},
1080                 itemcallnumber => $items->{$key}->{itemcallnumber},
1081                 location => $items->{$key}->{location},
1082                 onloancount      => $items->{$key}->{onloancount},
1083                 due_date         => $items->{$key}->{due_date},
1084                 wthdrawn      => $items->{$key}->{wthdrawn},
1085                 lost         => $items->{$key}->{itemlost},
1086             };
1087             push @items_loop, $this_item;
1088         }
1089         $oldbiblio->{norequests}    = $norequests;
1090         $oldbiblio->{items_count}    = $items_count;
1091         $oldbiblio->{items_loop}    = \@items_loop;
1092         $oldbiblio->{onloancount}   = $onloan_count;
1093         $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1094         $oldbiblio->{itemlostcount} = $itemlost_count;
1095         $oldbiblio->{orderedcount}  = $ordered_count;
1096         $oldbiblio->{isbn}          =~ s/-//g; # deleting - in isbn to enable amazon content
1097         push( @newresults, $oldbiblio );
1098     }
1099     return @newresults;
1100 }
1101
1102
1103
1104 #----------------------------------------------------------------------
1105 #
1106 # Non-Zebra GetRecords#
1107 #----------------------------------------------------------------------
1108
1109 =head2 NZgetRecords
1110
1111   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1112
1113 =cut
1114
1115 sub NZgetRecords {
1116     my (
1117         $koha_query,     $simple_query,  $sort_by_ref,
1118         $servers_ref,    $results_per_page, $offset,
1119         $expanded_facet, $branches,         $query_type,
1120         $scan
1121     ) = @_;
1122     my $result = NZanalyse($koha_query);
1123     return (undef,NZorder($result,@$sort_by_ref[0],$results_per_page,$offset),undef);
1124 }
1125
1126 =head2 NZanalyse
1127
1128   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1129   the list is builded from inverted index in nozebra SQL table
1130   note that title is here only for convenience : the sorting will be very fast when requested on title
1131   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1132
1133 =cut
1134
1135 sub NZanalyse {
1136     my ($string,$server) = @_;
1137     # $server contains biblioserver or authorities, depending on what we search on.
1138     #warn "querying : $string on $server";
1139     $server='biblioserver' unless $server;
1140     # if we have a ", replace the content to discard temporarily any and/or/not inside
1141     my $commacontent;
1142     if ($string =~/"/) {
1143         $string =~ s/"(.*?)"/__X__/;
1144         $commacontent = $1;
1145 #         print "commacontent : $commacontent\n";
1146     }
1147     # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1148     # then, call again NZanalyse with $left and $right
1149     # (recursive until we find a leaf (=> something without and/or/not)
1150     $string =~ /(.*)( and | or | not | AND | OR | NOT )(.*)/;
1151     my $left = $1;
1152     my $right = $3;
1153     my $operand = lc($2);
1154     # it's not a leaf, we have a and/or/not
1155     if ($operand) {
1156         # reintroduce comma content if needed
1157         $right =~ s/__X__/"$commacontent"/ if $commacontent;
1158         $left =~ s/__X__/"$commacontent"/ if $commacontent;
1159 #         warn "node : $left / $operand / $right\n";
1160         my $leftresult = NZanalyse($left,$server);
1161         my $rightresult = NZanalyse($right,$server);
1162         # OK, we have the results for right and left part of the query
1163         # depending of operand, intersect, union or exclude both lists
1164         # to get a result list
1165         if ($operand eq ' and ') {
1166             my @leftresult = split /;/, $leftresult;
1167 #             my @rightresult = split /;/,$leftresult;
1168             my $finalresult;
1169             # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1170             # the result is stored twice, to have the same weight for AND than OR.
1171             # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1172             # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1173             foreach (@leftresult) {
1174                 if ($rightresult =~ "$_;") {
1175                     $finalresult .= "$_;$_;";
1176                 }
1177             }
1178             return $finalresult;
1179         } elsif ($operand eq ' or ') {
1180             # just merge the 2 strings
1181             return $leftresult.$rightresult;
1182         } elsif ($operand eq ' not ') {
1183             my @leftresult = split /;/, $leftresult;
1184 #             my @rightresult = split /;/,$leftresult;
1185             my $finalresult;
1186             foreach (@leftresult) {
1187                 unless ($rightresult =~ "$_;") {
1188                     $finalresult .= "$_;";
1189                 }
1190             }
1191             return $finalresult;
1192         } else {
1193             # this error is impossible, because of the regexp that isolate the operand, but just in case...
1194             die "error : operand unknown : $operand for $string";
1195         }
1196     # it's a leaf, do the real SQL query and return the result
1197     } else {
1198         $string =~  s/__X__/"$commacontent"/ if $commacontent;
1199         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1200 #         warn "leaf : $string\n";
1201         # parse the string in in operator/operand/value again
1202         $string =~ /(.*)(>=|<=)(.*)/;
1203         my $left = $1;
1204         my $operator = $2;
1205         my $right = $3;
1206         unless ($operator) {
1207             $string =~ /(.*)(>|<|=)(.*)/;
1208             $left = $1;
1209             $operator = $2;
1210             $right = $3;
1211         }
1212         my $results;
1213         # automatic replace for short operators
1214         $left='title' if $left =~ '^ti';
1215         $left='author' if $left =~ '^au';
1216         $left='publisher' if $left =~ '^pb';
1217         $left='subject' if $left =~ '^su';
1218         $left='koha-Auth-Number' if $left =~ '^an';
1219         $left='keyword' if $left =~ '^kw';
1220         if ($operator) {
1221             #do a specific search
1222             my $dbh = C4::Context->dbh;
1223             $operator='LIKE' if $operator eq '=' and $right=~ /%/;
1224             my $sth = $dbh->prepare("SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?");
1225             warn "$left / $operator / $right\n";
1226             # split each word, query the DB and build the biblionumbers result
1227             foreach (split / /,$right) {
1228                 my ($biblionumbers,$value);
1229                 next unless $_;
1230                 warn "EXECUTE : $server, $left, $_";
1231                 $sth->execute($server, $left, $_);
1232                 while (my ($line,$value) = $sth->fetchrow) {
1233                     # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1234                     # otherwise, fill the result
1235                     $biblionumbers .= $line unless ($right =~ /\d/ && $value =~ /\D/);
1236                     warn "result : $value ". ($right =~ /\d/) . "==".(!$value =~ /\d/) ;#= $line";
1237                 }
1238                 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1239                 if ($results) {
1240                     my @leftresult = split /;/, $biblionumbers;
1241                     my $temp;
1242                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1243                         # remove weight at the end
1244                         my $cleaned = $entry;
1245                         $cleaned =~ s/-\d*$//;
1246                         # if the entry already in the hash, take it & increase weight
1247 #                         warn "===== $cleaned =====";
1248                         if ($results =~ "$cleaned") {
1249                             $temp .= "$entry;$entry;";
1250 #                             warn "INCLUDING $entry";
1251                         }
1252                     }
1253                     $results = $temp;
1254                 } else {
1255                     $results = $biblionumbers;
1256                 }
1257             }
1258         } else {
1259             #do a complete search (all indexes)
1260             my $dbh = C4::Context->dbh;
1261             my $sth = $dbh->prepare("SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?");
1262             # split each word, query the DB and build the biblionumbers result
1263             foreach (split / /,$string) {
1264                 next if C4::Context->stopwords->{uc($_)}; # skip if stopword
1265                 #warn "search on all indexes on $_";
1266                 my $biblionumbers;
1267                 next unless $_;
1268                 $sth->execute($server, $_);
1269                 while (my $line = $sth->fetchrow) {
1270                     $biblionumbers .= $line;
1271                 }
1272                 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1273                 if ($results) {
1274 #                 warn "RES for $_ = $biblionumbers";
1275                     my @leftresult = split /;/, $biblionumbers;
1276                     my $temp;
1277                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1278                         # remove weight at the end
1279                         my $cleaned = $entry;
1280                         $cleaned =~ s/-\d*$//;
1281                         # if the entry already in the hash, take it & increase weight
1282 #                         warn "===== $cleaned =====";
1283                         if ($results =~ "$cleaned") {
1284                             $temp .= "$entry;$entry;";
1285 #                             warn "INCLUDING $entry";
1286                         }
1287                     }
1288                     $results = $temp;
1289                 } else {
1290 #                 warn "NEW RES for $_ = $biblionumbers";
1291                     $results = $biblionumbers;
1292                 }
1293             }
1294         }
1295 #         warn "return : $results for LEAF : $string";
1296         return $results;
1297     }
1298 }
1299
1300 =head2 NZorder
1301
1302   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1303
1304   TODO :: Description
1305
1306 =cut
1307
1308
1309 sub NZorder {
1310     my ($biblionumbers, $ordering,$results_per_page,$offset) = @_;
1311     # order title asc by default
1312 #     $ordering = '1=36 <i' unless $ordering;
1313     $results_per_page=20 unless $results_per_page;
1314     $offset = 0 unless $offset;
1315     my $dbh = C4::Context->dbh;
1316     #
1317     # order by POPULARITY
1318     #
1319     if ($ordering =~ /popularity/) {
1320         my %result;
1321         my %popularity;
1322         # popularity is not in MARC record, it's builded from a specific query
1323         my $sth = $dbh->prepare("select sum(issues) from items where biblionumber=?");
1324         foreach (split /;/,$biblionumbers) {
1325             my ($biblionumber,$title) = split /,/,$_;
1326             $result{$biblionumber}=GetMarcBiblio($biblionumber);
1327             $sth->execute($biblionumber);
1328             my $popularity= $sth->fetchrow ||0;
1329             # hint : the key is popularity.title because we can have
1330             # many results with the same popularity. In this cas, sub-ordering is done by title
1331             # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1332             # (un-frequent, I agree, but we won't forget anything that way ;-)
1333             $popularity{sprintf("%10d",$popularity).$title.$biblionumber} = $biblionumber;
1334         }
1335         # sort the hash and return the same structure as GetRecords (Zebra querying)
1336         my $result_hash;
1337         my $numbers=0;
1338         if ($ordering eq 'popularity_dsc') { # sort popularity DESC
1339             foreach my $key (sort {$b cmp $a} (keys %popularity)) {
1340                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1341             }
1342         } else { # sort popularity ASC
1343             foreach my $key (sort (keys %popularity)) {
1344                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1345             }
1346         }
1347         my $finalresult=();
1348         $result_hash->{'hits'} = $numbers;
1349         $finalresult->{'biblioserver'} = $result_hash;
1350         return $finalresult;
1351     #
1352     # ORDER BY author
1353     #
1354     } elsif ($ordering =~/author/){
1355         my %result;
1356         foreach (split /;/,$biblionumbers) {
1357             my ($biblionumber,$title) = split /,/,$_;
1358             my $record=GetMarcBiblio($biblionumber);
1359             my $author;
1360             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1361                 $author=$record->subfield('200','f');
1362                 $author=$record->subfield('700','a') unless $author;
1363             } else {
1364                 $author=$record->subfield('100','a');
1365             }
1366             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1367             # and we don't want to get only 1 result for each of them !!!
1368             $result{$author.$biblionumber}=$record;
1369         }
1370         # sort the hash and return the same structure as GetRecords (Zebra querying)
1371         my $result_hash;
1372         my $numbers=0;
1373         if ($ordering eq 'author_za') { # sort by author desc
1374             foreach my $key (sort { $b cmp $a } (keys %result)) {
1375                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1376             }
1377         } else { # sort by author ASC
1378             foreach my $key (sort (keys %result)) {
1379                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1380             }
1381         }
1382         my $finalresult=();
1383         $result_hash->{'hits'} = $numbers;
1384         $finalresult->{'biblioserver'} = $result_hash;
1385         return $finalresult;
1386     #
1387     # ORDER BY callnumber
1388     #
1389     } elsif ($ordering =~/callnumber/){
1390         my %result;
1391         foreach (split /;/,$biblionumbers) {
1392             my ($biblionumber,$title) = split /,/,$_;
1393             my $record=GetMarcBiblio($biblionumber);
1394             my $callnumber;
1395             my ($callnumber_tag,$callnumber_subfield)=GetMarcFromKohaField($dbh,'items.itemcallnumber');
1396             ($callnumber_tag,$callnumber_subfield)= GetMarcFromKohaField('biblioitems.callnumber') unless $callnumber_tag;
1397             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1398                 $callnumber=$record->subfield('200','f');
1399             } else {
1400                 $callnumber=$record->subfield('100','a');
1401             }
1402             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1403             # and we don't want to get only 1 result for each of them !!!
1404             $result{$callnumber.$biblionumber}=$record;
1405         }
1406         # sort the hash and return the same structure as GetRecords (Zebra querying)
1407         my $result_hash;
1408         my $numbers=0;
1409         if ($ordering eq 'call_number_dsc') { # sort by title desc
1410             foreach my $key (sort { $b cmp $a } (keys %result)) {
1411                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1412             }
1413         } else { # sort by title ASC
1414             foreach my $key (sort { $a cmp $b } (keys %result)) {
1415                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1416             }
1417         }
1418         my $finalresult=();
1419         $result_hash->{'hits'} = $numbers;
1420         $finalresult->{'biblioserver'} = $result_hash;
1421         return $finalresult;
1422     } elsif ($ordering =~ /pubdate/){ #pub year
1423         my %result;
1424         foreach (split /;/,$biblionumbers) {
1425             my ($biblionumber,$title) = split /,/,$_;
1426             my $record=GetMarcBiblio($biblionumber);
1427             my ($publicationyear_tag,$publicationyear_subfield)=GetMarcFromKohaField('biblioitems.publicationyear','');
1428             my $publicationyear=$record->subfield($publicationyear_tag,$publicationyear_subfield);
1429             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1430             # and we don't want to get only 1 result for each of them !!!
1431             $result{$publicationyear.$biblionumber}=$record;
1432         }
1433         # sort the hash and return the same structure as GetRecords (Zebra querying)
1434         my $result_hash;
1435         my $numbers=0;
1436         if ($ordering eq 'pubdate_dsc') { # sort by pubyear desc
1437             foreach my $key (sort { $b cmp $a } (keys %result)) {
1438                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1439             }
1440         } else { # sort by pub year ASC
1441             foreach my $key (sort (keys %result)) {
1442                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1443             }
1444         }
1445         my $finalresult=();
1446         $result_hash->{'hits'} = $numbers;
1447         $finalresult->{'biblioserver'} = $result_hash;
1448         return $finalresult;
1449     #
1450     # ORDER BY title
1451     #
1452     } elsif ($ordering =~ /title/) {
1453         # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
1454         my %result;
1455         foreach (split /;/,$biblionumbers) {
1456             my ($biblionumber,$title) = split /,/,$_;
1457             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1458             # and we don't want to get only 1 result for each of them !!!
1459             # hint & speed improvement : we can order without reading the record
1460             # so order, and read records only for the requested page !
1461             $result{$title.$biblionumber}=$biblionumber;
1462         }
1463         # sort the hash and return the same structure as GetRecords (Zebra querying)
1464         my $result_hash;
1465         my $numbers=0;
1466         if ($ordering eq 'title_az') { # sort by title desc
1467             foreach my $key (sort (keys %result)) {
1468                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1469             }
1470         } else { # sort by title ASC
1471             foreach my $key (sort { $b cmp $a } (keys %result)) {
1472                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1473             }
1474         }
1475         # limit the $results_per_page to result size if it's more
1476         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1477         # for the requested page, replace biblionumber by the complete record
1478         # speed improvement : avoid reading too much things
1479         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1480             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc;
1481         }
1482         my $finalresult=();
1483         $result_hash->{'hits'} = $numbers;
1484         $finalresult->{'biblioserver'} = $result_hash;
1485         return $finalresult;
1486     } else {
1487     #
1488     # order by ranking
1489     #
1490         # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
1491         my %result;
1492         my %count_ranking;
1493         foreach (split /;/,$biblionumbers) {
1494             my ($biblionumber,$title) = split /,/,$_;
1495             $title =~ /(.*)-(\d)/;
1496             # get weight
1497             my $ranking =$2;
1498             # note that we + the ranking because ranking is calculated on weight of EACH term requested.
1499             # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
1500             # biblio N has ranking = 6
1501             $count_ranking{$biblionumber} += $ranking;
1502         }
1503         # build the result by "inverting" the count_ranking hash
1504         # 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
1505 #         warn "counting";
1506         foreach (keys %count_ranking) {
1507             $result{sprintf("%10d",$count_ranking{$_}).'-'.$_} = $_;
1508         }
1509         # sort the hash and return the same structure as GetRecords (Zebra querying)
1510         my $result_hash;
1511         my $numbers=0;
1512             foreach my $key (sort {$b cmp $a} (keys %result)) {
1513                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1514             }
1515         # limit the $results_per_page to result size if it's more
1516         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1517         # for the requested page, replace biblionumber by the complete record
1518         # speed improvement : avoid reading too much things
1519         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1520             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc if $result_hash->{'RECORDS'}[$counter];
1521         }
1522         my $finalresult=();
1523         $result_hash->{'hits'} = $numbers;
1524         $finalresult->{'biblioserver'} = $result_hash;
1525         return $finalresult;
1526     }
1527 }
1528 =head2 ModBiblios
1529
1530 ($countchanged,$listunchanged) = ModBiblios($listbiblios, $tagsubfield,$initvalue,$targetvalue,$test);
1531
1532 this function changes all the values $initvalue in subfield $tag$subfield in any record in $listbiblios
1533 test parameter if set donot perform change to records in database.
1534
1535 =over 2
1536
1537 =item C<input arg:>
1538
1539     * $listbiblios is an array ref to marcrecords to be changed
1540     * $tagsubfield is the reference of the subfield to change.
1541     * $initvalue is the value to search the record for
1542     * $targetvalue is the value to set the subfield to
1543     * $test is to be set only not to perform changes in database.
1544
1545 =item C<Output arg:>
1546     * $countchanged counts all the changes performed.
1547     * $listunchanged contains the list of all the biblionumbers of records unchanged.
1548
1549 =item C<usage in the script:>
1550
1551 =back
1552
1553 my ($countchanged, $listunchanged) = EditBiblios($results->{RECORD}, $tagsubfield,$initvalue,$targetvalue);;
1554 #If one wants to display unchanged records, you should get biblios foreach @$listunchanged
1555 $template->param(countchanged => $countchanged, loopunchanged=>$listunchanged);
1556
1557 =cut
1558
1559 sub ModBiblios{
1560   my ($listbiblios,$tagsubfield,$initvalue,$targetvalue,$test)=@_;
1561   my $countmatched;
1562   my @unmatched;
1563   my ($tag,$subfield)=($1,$2) if ($tagsubfield=~/^(\d{1,3})([a-z0-9A-Z@])?$/);
1564   if ((length($tag)<3)&& $subfield=~/0-9/){
1565     $tag=$tag.$subfield;
1566     undef $subfield;
1567   }
1568   my ($bntag,$bnsubf) = GetMarcFromKohaField('biblio.biblionumber');
1569   my ($itemtag,$itemsubf) = GetMarcFromKohaField('items.itemnumber');
1570   foreach my $usmarc (@$listbiblios){
1571     my $record;
1572     $record=eval{MARC::Record->new_from_usmarc($usmarc)};
1573     my $biblionumber;
1574     if ($@){
1575       # usmarc is not a valid usmarc May be a biblionumber
1576       if ($tag eq $itemtag){
1577         my $bib=GetBiblioFromItemNumber($usmarc);
1578         $record=GetMarcItem($bib->{'biblionumber'},$usmarc) ;
1579         $biblionumber=$bib->{'biblionumber'};
1580       } else {
1581         $record=GetMarcBiblio($usmarc);
1582         $biblionumber=$usmarc;
1583       }
1584     }  else {
1585       if ($bntag >= 010){
1586         $biblionumber = $record->subfield($bntag,$bnsubf);
1587       }else {
1588         $biblionumber=$record->field($bntag)->data;
1589       }
1590     }
1591     #GetBiblionumber is to be written.
1592     #Could be replaced by TransformMarcToKoha (But Would be longer)
1593     if ($record->field($tag)){
1594       my $modify=0;
1595       foreach my $field ($record->field($tag)){
1596         if ($subfield){
1597           if ($field->delete_subfield('code' =>$subfield,'match'=>qr($initvalue))){
1598             $countmatched++;
1599             $modify=1;
1600             $field->update($subfield,$targetvalue) if ($targetvalue);
1601           }
1602         } else {
1603           if ($tag >= 010){
1604             if ($field->delete_field($field)){
1605               $countmatched++;
1606               $modify=1;
1607             }
1608           } else {
1609             $field->data=$targetvalue if ($field->data=~qr($initvalue));
1610           }
1611         }
1612       }
1613 #       warn $record->as_formatted;
1614       if ($modify){
1615         ModBiblio($record,$biblionumber,GetFrameworkCode($biblionumber)) unless ($test);
1616       } else {
1617         push @unmatched, $biblionumber;
1618       }
1619     } else {
1620       push @unmatched, $biblionumber;
1621     }
1622   }
1623   return ($countmatched,\@unmatched);
1624 }
1625
1626 END { }    # module clean-up code here (global destructor)
1627
1628 1;
1629 __END__
1630
1631 =head1 AUTHOR
1632
1633 Koha Developement team <info@koha.org>
1634
1635 =cut