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         my @stopwords_removed;
 562     # phrase and exact-qualified indexes shouldn'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'd get "çon" and wouldn't find anything...
 568         foreach (keys %{C4::Context->stopwords}) {
 569             next if ($_ =~/(and|or|not)/); # don't remove operators
 570                         if ($operand =~ /(\P{IsAlpha}$_\P{IsAlpha}|^$_\P{IsAlpha}|\P{IsAlpha}$_$)/) {
 571                 $operand=~ s/\P{IsAlpha}$_\P{IsAlpha}/ /gi;
 572                 $operand=~ s/^$_\P{IsAlpha}/ /gi;
 573                 $operand=~ s/\P{IsAlpha}$_$/ /gi;
 574                                 push @stopwords_removed, $_;
 575                         }
 576         }
 577     }
 578     return ($operand, \@stopwords_removed);
 579 }
 580
 581 # TRUNCATION
 582 sub _detect_truncation {
 583     my ($operand,$index) = @_;
 584     my (@nontruncated,@righttruncated,@lefttruncated,@rightlefttruncated,@regexpr);
 585     $operand =~s/^ //g;
 586     my @wordlist= split (/\s/,$operand);
 587     foreach my $word (@wordlist){
 588         if ($word=~s/^\*([^\*]+)\*$/$1/){
 589             push @rightlefttruncated,$word;
 590         }
 591         elsif($word=~s/^\*([^\*]+)$/$1/){
 592             push @lefttruncated,$word;
 593         }
 594         elsif ($word=~s/^([^\*]+)\*$/$1/){
 595             push @righttruncated,$word;
 596         }
 597         elsif (index($word,"*")<0){
 598             push @nontruncated,$word;
 599         }
 600         else {
 601             push @regexpr,$word;
 602         }
 603     }
 604     return (\@nontruncated,\@righttruncated,\@lefttruncated,\@rightlefttruncated,\@regexpr);
 605 }
 606
 607 sub _build_stemmed_operand {
 608     my ($operand) = @_;
 609     my $stemmed_operand;
 610     # FIXME: the locale should be set based on the user's language and/or search choice
 611     my $stemmer = Lingua::Stem->new( -locale => 'EN-US' );
 612     # FIXME: these should be stored in the db so the librarian can modify the behavior
 613     $stemmer->add_exceptions(
 614             {
 615                 'and' => 'and',
 616                 'or'  => 'or',
 617                 'not' => 'not',
 618             }
 619
 620         );
 621     my @words = split( / /, $operand );
 622     my $stems = $stemmer->stem(@words);
 623     for my $stem (@$stems) {
 624             $stemmed_operand .= "$stem";
 625             $stemmed_operand .= "?" unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 626             $stemmed_operand .= " ";
 627     }
 628     #warn "STEMMED OPERAND: $stemmed_operand";
 629     return $stemmed_operand;
 630 }
 631
 632 sub _build_weighted_query {
 633     # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
 634     # pretty well but will work much better when we have an actual query parser
 635     my ($operand,$stemmed_operand,$index) = @_;
 636     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 637     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 638     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
 639
 640     my $weighted_query .= "(rk=(";     # Specifies that we're applying rank
 641
 642     # Keyword, or, no index specified
 643     if ( ( $index eq 'kw' ) || ( !$index ) ) {
 644         $weighted_query .= "Title-cover,ext,r1=\"$operand\"";       # exact title-cover
 645         $weighted_query .= " or ti,ext,r2=\"$operand\"";            # exact title
 646         $weighted_query .= " or ti,phr,r3=\"$operand\"";            # phrase title
 647        #$weighted_query .= " or any,ext,r4=$operand";               # exact any
 648        #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
 649         $weighted_query .= " or wrd,fuzzy,r8=\"$operand\"" if $fuzzy_enabled; # add fuzzy, word list
 650         $weighted_query .= " or wrd,right-Truncation,r9=\"$stemmed_operand\"" if ($stemming and $stemmed_operand); # add stemming, right truncation
 651        # embedded sorting: 0 a-z; 1 z-a
 652        # $weighted_query .= ") or (sort1,aut=1";
 653     }
 654     # if the index already has more than one qualifier, just wrap the operand
 655     # in quotes and pass it back
 656     elsif ($index =~ ',') {
 657         $weighted_query .=" $index=\"$operand\"";
 658     }
 659     #TODO: build better cases based on specific search indexes
 660     else {
 661        $weighted_query .= " $index,ext,r1=\"$operand\"";            # exact index
 662        #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
 663        $weighted_query .= " or $index,phr,r3=\"$operand\"";         # phrase index
 664        $weighted_query .= " or $index,rt,wrd,r3=\"$operand\"";      # word list index
 665     }
 666     $weighted_query .= "))";    # close rank specification
 667     return $weighted_query;
 668 }
 669
 670 # build the query itself
 671 sub buildQuery {
 672     my ( $operators, $operands, $indexes, $limits, $sort_by ) = @_;
 673
 674     my @operators = @$operators if $operators;
 675     my @indexes   = @$indexes   if $indexes;
 676     my @operands  = @$operands  if $operands;
 677     my @limits    = @$limits    if $limits;
 678     my @sort_by   = @$sort_by   if $sort_by;
 679
 680     my $stemming      = C4::Context->preference("QueryStemming")                || 0;
 681         my $auto_truncation = C4::Context->preference("QueryAutoTruncate")              || 0;
 682     my $weight_fields = C4::Context->preference("QueryWeightFields")            || 0;
 683     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy")                           || 0;
 684         my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords")  || 0;
 685
 686     my $query = $operands[0];
 687         my $simple_query = $operands[0];
 688         my $query_cgi;
 689         my $query_desc;
 690         my $query_type;
 691
 692         my $limit;
 693         my $limit_cgi;
 694         my $limit_desc;
 695
 696         my $stopwords_removed;
 697
 698         # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
 699         # DIAGNOSTIC ONLY!!
 700     if ( $query =~ /^ccl=/ ) {
 701         return ( undef, $', $', $', $', '', '', '', '', 'ccl' );
 702     }
 703     if ( $query =~ /^cql=/ ) {
 704         return ( undef, $', $', $', $', '', '', '', '', 'cql' );
 705     }
 706     if ( $query =~ /^pqf=/ ) {
 707         return ( undef, $', $', $', $', '', '', '', '', 'pqf' );
 708     }
 709
 710         # pass nested queries directly
 711     if ( $query =~ /(\(|\))/ ) {
 712         return ( undef, $query, $simple_query, $query_cgi, $query, $limit, $limit_cgi, $limit_desc, $stopwords_removed, 'ccl' );
 713     }
 714
 715 # form-based queries are limited to non-nested at a specific depth, so we can easily
 716 # modify the incoming query operands and indexes to do stemming and field weighting
 717 # Once we do so, we'll end up with a value in $query, just like if we had an
 718 # incoming $query from the user
 719     else {
 720         $query = ""; # clear it out so we can populate properly with field-weighted stemmed query
 721         my $previous_operand;    # a flag used to keep track if there was a previous query
 722                                 # if there was, we can apply the current operator
 723         # for every operand
 724         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
 725
 726             # COMBINE OPERANDS, INDEXES AND OPERATORS
 727             if ( $operands[$i] ) {
 728
 729                                 # a flag to determine whether or not to add the index to the query
 730                                 my $indexes_set;
 731                                 # if the user is sophisticated enough to specify an index, turn off some defaults
 732                                 if ($operands[$i] =~ /(:|=)/) {
 733                                         $weight_fields = 0;
 734                                         $stemming = 0;
 735                                         $remove_stopwords = 0;
 736                                 }
 737                 my $operand = $operands[$i];
 738                 my $index   = $indexes[$i];
 739
 740                                 # some helpful index modifs
 741                 my $index_plus = "$index:" if $index;
 742                 my $index_plus_comma="$index," if $index;
 743
 744                 # Remove Stopwords
 745                                 if ($remove_stopwords) {
 746                 ($operand, $stopwords_removed) = _remove_stopwords($operand,$index);
 747                         warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
 748                                         warn "REMOVED STOPWORDS: @$stopwords_removed" if ($stopwords_removed && $DEBUG);
 749                                 }
 750
 751                 # Detect Truncation
 752                 my ($nontruncated,$righttruncated,$lefttruncated,$rightlefttruncated,$regexpr);
 753                 my $truncated_operand;
 754                 ($nontruncated,$righttruncated,$lefttruncated,$rightlefttruncated,$regexpr) = _detect_truncation($operand,$index);
 755                 warn "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<" if $DEBUG;
 756
 757                 # Apply Truncation
 758                 if (scalar(@$righttruncated)+scalar(@$lefttruncated)+scalar(@$rightlefttruncated)>0){
 759                                         # don't field weight or add the index to the query, we do it here
 760                     $indexes_set = 1;
 761                     undef $weight_fields;
 762                     my $previous_truncation_operand;
 763                     if (scalar(@$nontruncated)>0) {
 764                         $truncated_operand.= "$index_plus @$nontruncated ";
 765                         $previous_truncation_operand = 1;
 766                     }
 767                     if (scalar(@$righttruncated)>0){
 768                         $truncated_operand .= "and " if $previous_truncation_operand;
 769                         $truncated_operand .= "$index_plus_comma"."rtrn:@$righttruncated ";
 770                         $previous_truncation_operand = 1;
 771                     }
 772                     if (scalar(@$lefttruncated)>0){
 773                         $truncated_operand .= "and " if $previous_truncation_operand;
 774                         $truncated_operand .= "$index_plus_comma"."ltrn:@$lefttruncated ";
 775                         $previous_truncation_operand = 1;
 776                     }
 777                     if (scalar(@$rightlefttruncated)>0){
 778                         $truncated_operand .= "and " if $previous_truncation_operand;
 779                         $truncated_operand .= "$index_plus_comma"."rltrn:@$rightlefttruncated ";
 780                         $previous_truncation_operand = 1;
 781                     }
 782                 }
 783                 $operand = $truncated_operand if $truncated_operand;
 784                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
 785
 786                 # Handle Stemming
 787                 my $stemmed_operand;
 788                 $stemmed_operand = _build_stemmed_operand($operand) if $stemming;
 789                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
 790
 791                 # Handle Field Weighting
 792                 my $weighted_operand;
 793                 $weighted_operand = _build_weighted_query($operand,$stemmed_operand,$index) if $weight_fields;
 794                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
 795                 $operand = $weighted_operand if $weight_fields;
 796                 $indexes_set = 1 if $weight_fields;
 797
 798                 # If there's a previous operand, we need to add an operator
 799                 if ($previous_operand) {
 800
 801                     # user-specified operator
 802                     if ( $operators[$i-1] ) {
 803                         $query .= " $operators[$i-1] ";
 804                         $query .= " $index_plus " unless $indexes_set;
 805                         $query .= " $operand";
 806                                                 $query_cgi .="&op=$operators[$i-1]";
 807                                                 $query_cgi .="&idx=$index" if $index;
 808                                                 $query_cgi .="&q=$operands[$i]" if $operands[$i];
 809                                                 $query_desc .=" $operators[$i-1] $index_plus $operands[$i]";
 810                     }
 811
 812                     # the default operator is and
 813                     else {
 814                         $query .= " and ";
 815                         $query .= "$index_plus " unless $indexes_set;
 816                         $query .= "$operand";
 817                                                 $query_cgi .="&op=and&idx=$index" if $index;
 818                                                 $query_cgi .="&q=$operands[$i]" if $operands[$i];
 819                         $query_desc .= " and $index_plus $operands[$i]";
 820                     }
 821                 }
 822
 823                                 # there isn't a pervious operand, don't need an operator
 824                 else {
 825                                         # field-weighted queries already have indexes set
 826                                         $query .=" $index_plus " unless $indexes_set;
 827                                         $query .= $operand;
 828                                         $query_desc .= " $index_plus $operands[$i]";
 829                                         $query_cgi.="&idx=$index" if $index;
 830                                         $query_cgi.="&q=$operands[$i]" if $operands[$i];
 831
 832                     $previous_operand = 1;
 833                 }
 834             }    #/if $operands
 835         }    # /for
 836     }
 837     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
 838
 839     # add limits
 840         my $group_OR_limits;
 841         my $availability_limit;
 842     foreach my $this_limit (@limits) {
 843         if ( $this_limit =~ /available/ ) {
 844                         # available is defined as (items.notloan is NULL) and (items.itemlost > 0 or NULL) (last clause handles NULL values for lost in zebra)
 845                         $availability_limit .="( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and ((lost,st-numeric gt 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
 846                         $limit_cgi .= "&limit=available";
 847                         $limit_desc .="";
 848         }
 849
 850                 # these are treated as OR
 851         elsif ( $this_limit =~ /mc/ ) {
 852             $group_OR_limits .= " or " if $group_OR_limits;
 853                         $limit_desc .=" or " if $group_OR_limits;
 854                         $group_OR_limits .= "$this_limit";
 855                         $limit_cgi .="&limit=$this_limit";
 856                         $limit_desc .= "$this_limit";
 857         }
 858
 859                 # regular old limits
 860                 else {
 861                         $limit .= " and " if $limit || $query;
 862                         $limit .= "$this_limit";
 863                         $limit_cgi .="&limit=$this_limit";
 864                         $limit_desc .=" and $this_limit";
 865                 }
 866     }
 867         if ($group_OR_limits) {
 868                 $limit.=" and " if ($query || $limit );
 869                 $limit.="($group_OR_limits)";
 870         }
 871         if ($availability_limit) {
 872                 $limit.=" not " if ($query || $limit );
 873                 $limit.="$availability_limit";
 874         }
 875         # normalize the strings
 876         for ($query, $query_desc, $limit, $limit_desc) {
 877                 $_ =~ s/  / /g;    # remove extra spaces
 878         $_ =~ s/^ //g;     # remove any beginning spaces
 879                 $_ =~ s/ $//g;     # remove any ending spaces
 880         $_ =~ s/:/=/g;     # causes probs for server
 881         $_ =~ s/==/=/g;    # remove double == from query
 882
 883         }
 884
 885         $query_cgi =~ s/^&//;
 886
 887         # append the limit to the query
 888         $query .= " ".$limit;
 889
 890     warn "QUERY:".$query if $DEBUG;
 891         warn "QUERY CGI:".$query_cgi if $DEBUG;
 892     warn "QUERY DESC:".$query_desc if $DEBUG;
 893     warn "LIMIT:".$limit if $DEBUG;
 894     warn "LIMIT CGI:".$limit_cgi if $DEBUG;
 895     warn "LIMIT DESC:".$limit_desc if $DEBUG;
 896
 897         return ( undef, $query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type );
 898 }
 899
 900 # IMO this subroutine is pretty messy still -- it's responsible for
 901 # building the HTML output for the template
 902 sub searchResults {
 903     my ( $searchdesc, $hits, $results_per_page, $offset, @marcresults ) = @_;
 904
 905     my $dbh = C4::Context->dbh;
 906     my $toggle;
 907     my $even = 1;
 908     my @newresults;
 909     my $span_terms_hashref;
 910     for my $span_term ( split( / /, $searchdesc ) ) {
 911         $span_term =~ s/(.*=|\)|\(|\+|\.)//g;
 912         $span_terms_hashref->{$span_term}++;
 913     }
 914
 915     #Build brancnames hash
 916     #find branchname
 917     #get branch information.....
 918     my %branches;
 919     my $bsth =
 920       $dbh->prepare("SELECT branchcode,branchname FROM branches")
 921       ;    # FIXME : use C4::Koha::GetBranches
 922     $bsth->execute();
 923     while ( my $bdata = $bsth->fetchrow_hashref ) {
 924         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
 925     }
 926
 927     #Build itemtype hash
 928     #find itemtype & itemtype image
 929     my %itemtypes;
 930     $bsth =
 931       $dbh->prepare("SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes");
 932     $bsth->execute();
 933     while ( my $bdata = $bsth->fetchrow_hashref ) {
 934         $itemtypes{ $bdata->{'itemtype'} }->{description} =
 935           $bdata->{'description'};
 936         $itemtypes{ $bdata->{'itemtype'} }->{imageurl} = $bdata->{'imageurl'};
 937         $itemtypes{ $bdata->{'itemtype'} }->{summary} = $bdata->{'summary'};
 938         $itemtypes{ $bdata->{'itemtype'} }->{notforloan} = $bdata->{'notforloan'};
 939     }
 940
 941     #search item field code
 942     my $sth =
 943       $dbh->prepare(
 944 "select tagfield from marc_subfield_structure where kohafield like 'items.itemnumber'"
 945       );
 946     $sth->execute;
 947     my ($itemtag) = $sth->fetchrow;
 948
 949     ## find column names of items related to MARC
 950     my $sth2 = $dbh->prepare("SHOW COLUMNS from items");
 951     $sth2->execute;
 952     my %subfieldstosearch;
 953     while ( ( my $column ) = $sth2->fetchrow ) {
 954         my ( $tagfield, $tagsubfield ) =
 955           &GetMarcFromKohaField( "items." . $column, "" );
 956         $subfieldstosearch{$column} = $tagsubfield;
 957     }
 958     my $times;
 959
 960     if ( $hits && $offset + $results_per_page <= $hits ) {
 961         $times = $offset + $results_per_page;
 962     }
 963     else {
 964         $times = $hits;
 965     }
 966
 967     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
 968         my $marcrecord;
 969         $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
 970         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, '' );
 971         # add image url if there is one
 972         if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} =~ /^http:/ ) {
 973             $oldbiblio->{imageurl} =
 974               $itemtypes{ $oldbiblio->{itemtype} }->{imageurl};
 975             $oldbiblio->{description} =
 976               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 977         }
 978         else {
 979             $oldbiblio->{imageurl} =
 980               getitemtypeimagesrc() . "/"
 981               . $itemtypes{ $oldbiblio->{itemtype} }->{imageurl}
 982               if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
 983             $oldbiblio->{description} =
 984               $itemtypes{ $oldbiblio->{itemtype} }->{description};
 985         }
 986         #
 987         # build summary if there is one (the summary is defined in itemtypes table
 988         #
 989         if ($itemtypes{ $oldbiblio->{itemtype} }->{summary}) {
 990             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
 991             my @fields = $marcrecord->fields();
 992             foreach my $field (@fields) {
 993                 my $tag = $field->tag();
 994                 my $tagvalue = $field->as_string();
 995                 $summary =~ s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
 996                 unless ($tag<10) {
 997                     my @subf = $field->subfields;
 998                     for my $i (0..$#subf) {
 999                         my $subfieldcode = $subf[$i][0];
1000                         my $subfieldvalue = $subf[$i][1];
1001                         my $tagsubf = $tag.$subfieldcode;
1002                         $summary =~ s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
1003                     }
1004                 }
1005             }
1006             $summary =~ s/\[(.*?)]//g;
1007             $summary =~ s/\n/<br>/g;
1008             $oldbiblio->{summary} = $summary;
1009         }
1010         # add spans to search term in results for search term highlighting
1011         foreach my $term ( keys %$span_terms_hashref ) {
1012             my $old_term = $term;
1013             if ( length($term) > 3 ) {
1014                 $term =~ s/(.*=|\)|\(|\+|\.|\?|\[|\])//g;
1015                 $term =~ s/\\//g;
1016                 $term =~ s/\*//g;
1017
1018                 #FIXME: is there a better way to do this?
1019                 $oldbiblio->{'title'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1020                 $oldbiblio->{'subtitle'} =~
1021                   s/$term/<span class=\"term\">$&<\/span>/gi;
1022
1023                 $oldbiblio->{'author'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1024                 $oldbiblio->{'publishercode'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1025                 $oldbiblio->{'place'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1026                 $oldbiblio->{'pages'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1027                 $oldbiblio->{'notes'} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1028                 $oldbiblio->{'size'}  =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1029             }
1030         }
1031
1032         if ( $i % 2 ) {
1033             $toggle = "#ffffcc";
1034         }
1035         else {
1036             $toggle = "white";
1037         }
1038         $oldbiblio->{'toggle'} = $toggle;
1039         my @fields = $marcrecord->field($itemtag);
1040         my @items_loop;
1041         my $items;
1042         my $ordered_count     = 0;
1043         my $onloan_count      = 0;
1044         my $wthdrawn_count    = 0;
1045         my $itemlost_count    = 0;
1046         my $norequests        = 1;
1047
1048         #
1049         # check the loan status of the item :
1050         # it is not stored in the MARC record, for pref (zebra reindexing)
1051         # reason. Thus, we have to get the status from a specific SQL query
1052         #
1053         my $sth_issue = $dbh->prepare("
1054             SELECT date_due,returndate
1055             FROM issues
1056             WHERE itemnumber=? AND returndate IS NULL");
1057         my $items_count=scalar(@fields);
1058         foreach my $field (@fields) {
1059             my $item;
1060             foreach my $code ( keys %subfieldstosearch ) {
1061                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1062             }
1063             $sth_issue->execute($item->{itemnumber});
1064             $item->{due_date} = format_date($sth_issue->fetchrow);
1065             $item->{onloan} = 1 if $item->{due_date};
1066             # at least one item can be reserved : suppose no
1067             $norequests = 1;
1068             if ( $item->{wthdrawn} ) {
1069                 $wthdrawn_count++;
1070                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1071                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{wthdrawn}=1;
1072             }
1073             elsif ( $item->{itemlost} ) {
1074                 $itemlost_count++;
1075                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1076                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemlost}=1;
1077             }
1078             unless ( $item->{notforloan}) {
1079                 # OK, this one can be issued, so at least one can be reserved
1080                 $norequests = 0;
1081             }
1082             if ( ( $item->{onloan} ) && ( $item->{onloan} != '0000-00-00' ) )
1083             {
1084                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{unavailable}=1;
1085                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{onloancount} = 1;
1086                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{due_date} = $item->{due_date};
1087                 $onloan_count++;
1088             }
1089             if ( $item->{'homebranch'} ) {
1090                 $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{count}++;
1091             }
1092
1093             # Last resort
1094             elsif ( $item->{'holdingbranch'} ) {
1095                 $items->{ $item->{'holdingbranch'} }->{count}++;
1096             }
1097             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{itemcallnumber} =                $item->{itemcallnumber};
1098             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{location} =                $item->{location};
1099             $items->{ $item->{'homebranch'}.'--'.$item->{'itemcallnumber'} }->{branchcode} =               $item->{homebranch};
1100         }    # notforloan, item level and biblioitem level
1101
1102         # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1103         $norequests = 1 if $itemtypes{$oldbiblio->{itemtype}}->{notforloan};
1104
1105         for my $key ( sort keys %$items ) {
1106             my $this_item = {
1107                 branchname     => $branches{$items->{$key}->{branchcode}},
1108                 branchcode     => $items->{$key}->{branchcode},
1109                 count          => $items->{$key}->{count},
1110                 itemcallnumber => $items->{$key}->{itemcallnumber},
1111                 location => $items->{$key}->{location},
1112                 onloancount      => $items->{$key}->{onloancount},
1113                 due_date         => $items->{$key}->{due_date},
1114                 wthdrawn      => $items->{$key}->{wthdrawn},
1115                 lost         => $items->{$key}->{itemlost},
1116             };
1117             push @items_loop, $this_item;
1118         }
1119         $oldbiblio->{norequests}    = $norequests;
1120         $oldbiblio->{items_count}    = $items_count;
1121         $oldbiblio->{items_loop}    = \@items_loop;
1122         $oldbiblio->{onloancount}   = $onloan_count;
1123         $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1124         $oldbiblio->{itemlostcount} = $itemlost_count;
1125         $oldbiblio->{orderedcount}  = $ordered_count;
1126         $oldbiblio->{isbn}          =~ s/-//g; # deleting - in isbn to enable amazon content
1127         push( @newresults, $oldbiblio );
1128     }
1129     return @newresults;
1130 }
1131
1132
1133
1134 #----------------------------------------------------------------------
1135 #
1136 # Non-Zebra GetRecords#
1137 #----------------------------------------------------------------------
1138
1139 =head2 NZgetRecords
1140
1141   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1142
1143 =cut
1144 sub NZgetRecords {
1145     my ($query,$simple_query,$sort_by_ref,$servers_ref,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan) = @_;
1146     my $result = NZanalyse($query);
1147     return (undef,NZorder($result,@$sort_by_ref[0],$results_per_page,$offset),undef);
1148 }
1149
1150 =head2 NZanalyse
1151
1152   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1153   the list is built from an inverted index in the nozebra SQL table
1154   note that title is here only for convenience : the sorting will be very fast when requested on title
1155   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1156
1157 =cut
1158
1159 sub NZanalyse {
1160     my ($string,$server) = @_;
1161     # $server contains biblioserver or authorities, depending on what we search on.
1162     #warn "querying : $string on $server";
1163     $server='biblioserver' unless $server;
1164
1165     # if we have a ", replace the content to discard temporarily any and/or/not inside
1166     my $commacontent;
1167     if ($string =~/"/) {
1168         $string =~ s/"(.*?)"/__X__/;
1169         $commacontent = $1;
1170                 warn "commacontent : $commacontent" if $DEBUG;
1171     }
1172     # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1173     # then, call again NZanalyse with $left and $right
1174     # (recursive until we find a leaf (=> something without and/or/not)
1175     $string =~ /(.*)( and | or | not | AND | OR | NOT )(.*)/;
1176     my $left = $1;
1177     my $right = $3;
1178     my $operand = lc($2); # FIXME: and/or/not are operators, not operands
1179     # it's not a leaf, we have a and/or/not
1180     if ($operand) {
1181         # reintroduce comma content if needed
1182         $right =~ s/__X__/"$commacontent"/ if $commacontent;
1183         $left =~ s/__X__/"$commacontent"/ if $commacontent;
1184         warn "node : $left / $operand / $right\n" if $DEBUG;
1185         my $leftresult = NZanalyse($left,$server);
1186         my $rightresult = NZanalyse($right,$server);
1187         # OK, we have the results for right and left part of the query
1188         # depending of operand, intersect, union or exclude both lists
1189         # to get a result list
1190         if ($operand eq ' and ') {
1191             my @leftresult = split /;/, $leftresult;
1192 #             my @rightresult = split /;/,$leftresult;
1193             my $finalresult;
1194             # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1195             # the result is stored twice, to have the same weight for AND than OR.
1196             # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1197             # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1198             foreach (@leftresult) {
1199                 if ($rightresult =~ "$_;") {
1200                     $finalresult .= "$_;$_;";
1201                 }
1202             }
1203             return $finalresult;
1204         } elsif ($operand eq ' or ') {
1205             # just merge the 2 strings
1206             return $leftresult.$rightresult;
1207         } elsif ($operand eq ' not ') {
1208             my @leftresult = split /;/, $leftresult;
1209 #             my @rightresult = split /;/,$leftresult;
1210             my $finalresult;
1211             foreach (@leftresult) {
1212                 unless ($rightresult =~ "$_;") {
1213                     $finalresult .= "$_;";
1214                 }
1215             }
1216             return $finalresult;
1217         } else {
1218             # this error is impossible, because of the regexp that isolate the operand, but just in case...
1219             die "error : operand unknown : $operand for $string";
1220         }
1221     # it's a leaf, do the real SQL query and return the result
1222     } else {
1223         $string =~  s/__X__/"$commacontent"/ if $commacontent;
1224         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1225          warn "leaf : $string\n" if $DEBUG;
1226         # parse the string in in operator/operand/value again
1227         $string =~ /(.*)(>=|<=)(.*)/;
1228         my $left = $1;
1229         my $operator = $2;
1230         my $right = $3;
1231         unless ($operator) {
1232             $string =~ /(.*)(>|<|=)(.*)/;
1233             $left = $1;
1234             $operator = $2;
1235             $right = $3;
1236         }
1237         my $results;
1238         # automatic replace for short operators
1239         $left='title' if $left =~ '^ti';
1240         $left='author' if $left =~ '^au';
1241         $left='publisher' if $left =~ '^pb';
1242         $left='subject' if $left =~ '^su';
1243         $left='koha-Auth-Number' if $left =~ '^an';
1244         $left='keyword' if $left =~ '^kw';
1245         if ($operator) {
1246             #do a specific search
1247             my $dbh = C4::Context->dbh;
1248             $operator='LIKE' if $operator eq '=' and $right=~ /%/;
1249             my $sth = $dbh->prepare("SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?");
1250             warn "$left / $operator / $right\n";
1251             # split each word, query the DB and build the biblionumbers result
1252             foreach (split / /,$right) {
1253                 my ($biblionumbers,$value);
1254                 next unless $_;
1255                 warn "EXECUTE : $server, $left, $_";
1256                 $sth->execute($server, $left, $_) or warn "execute failed: $!";
1257                 while (my ($line,$value) = $sth->fetchrow) {
1258                     # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1259                     # otherwise, fill the result
1260                     $biblionumbers .= $line unless ($right =~ /\d/ && $value =~ /\D/);
1261                     warn "result : $value ". ($right =~ /\d/) . "==".(!$value =~ /\d/) ;#= $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                     my @leftresult = split /;/, $biblionumbers;
1266                     my $temp;
1267                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1268                         # remove weight at the end
1269                         my $cleaned = $entry;
1270                         $cleaned =~ s/-\d*$//;
1271                         # if the entry already in the hash, take it & increase weight
1272                          warn "===== $cleaned =====" if $DEBUG;
1273                         if ($results =~ "$cleaned") {
1274                             $temp .= "$entry;$entry;";
1275                              warn "INCLUDING $entry" if $DEBUG;
1276                         }
1277                     }
1278                     $results = $temp;
1279                 } else {
1280                     $results = $biblionumbers;
1281                 }
1282             }
1283         } else {
1284             #do a complete search (all indexes)
1285             my $dbh = C4::Context->dbh;
1286             my $sth = $dbh->prepare("SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?");
1287             # split each word, query the DB and build the biblionumbers result
1288             foreach (split / /,$string) {
1289                 next if C4::Context->stopwords->{uc($_)}; # skip if stopword
1290                 warn "search on all indexes on $_" if $DEBUG;
1291                 my $biblionumbers;
1292                 next unless $_;
1293                 $sth->execute($server, $_);
1294                 while (my $line = $sth->fetchrow) {
1295                     $biblionumbers .= $line;
1296                 }
1297                 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1298                 if ($results) {
1299                  warn "RES for $_ = $biblionumbers" if $DEBUG;
1300                     my @leftresult = split /;/, $biblionumbers;
1301                     my $temp;
1302                     foreach my $entry (@leftresult) { # $_ contains biblionumber,title-weight
1303                         # remove weight at the end
1304                         my $cleaned = $entry;
1305                         $cleaned =~ s/-\d*$//;
1306                         # if the entry already in the hash, take it & increase weight
1307                          warn "===== $cleaned =====" if $DEBUG;
1308                         if ($results =~ "$cleaned") {
1309                             $temp .= "$entry;$entry;";
1310                              warn "INCLUDING $entry" if $DEBUG;
1311                         }
1312                     }
1313                     $results = $temp;
1314                 } else {
1315                  warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
1316                     $results = $biblionumbers;
1317                 }
1318             }
1319         }
1320          warn "return : $results for LEAF : $string" if $DEBUG;
1321         return $results;
1322     }
1323 }
1324
1325 =head2 NZorder
1326
1327   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1328
1329   TODO :: Description
1330
1331 =cut
1332
1333
1334 sub NZorder {
1335     my ($biblionumbers, $ordering,$results_per_page,$offset) = @_;
1336     # order title asc by default
1337 #     $ordering = '1=36 <i' unless $ordering;
1338     $results_per_page=20 unless $results_per_page;
1339     $offset = 0 unless $offset;
1340     my $dbh = C4::Context->dbh;
1341     #
1342     # order by POPULARITY
1343     #
1344     if ($ordering =~ /popularity/) {
1345         my %result;
1346         my %popularity;
1347         # popularity is not in MARC record, it's builded from a specific query
1348         my $sth = $dbh->prepare("select sum(issues) from items where biblionumber=?");
1349         foreach (split /;/,$biblionumbers) {
1350             my ($biblionumber,$title) = split /,/,$_;
1351             $result{$biblionumber}=GetMarcBiblio($biblionumber);
1352             $sth->execute($biblionumber);
1353             my $popularity= $sth->fetchrow ||0;
1354             # hint : the key is popularity.title because we can have
1355             # many results with the same popularity. In this cas, sub-ordering is done by title
1356             # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1357             # (un-frequent, I agree, but we won't forget anything that way ;-)
1358             $popularity{sprintf("%10d",$popularity).$title.$biblionumber} = $biblionumber;
1359         }
1360         # sort the hash and return the same structure as GetRecords (Zebra querying)
1361         my $result_hash;
1362         my $numbers=0;
1363         if ($ordering eq 'popularity_dsc') { # sort popularity DESC
1364             foreach my $key (sort {$b cmp $a} (keys %popularity)) {
1365                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1366             }
1367         } else { # sort popularity ASC
1368             foreach my $key (sort (keys %popularity)) {
1369                 $result_hash->{'RECORDS'}[$numbers++] = $result{$popularity{$key}}->as_usmarc();
1370             }
1371         }
1372         my $finalresult=();
1373         $result_hash->{'hits'} = $numbers;
1374         $finalresult->{'biblioserver'} = $result_hash;
1375         return $finalresult;
1376     #
1377     # ORDER BY author
1378     #
1379     } elsif ($ordering =~/author/){
1380         my %result;
1381         foreach (split /;/,$biblionumbers) {
1382             my ($biblionumber,$title) = split /,/,$_;
1383             my $record=GetMarcBiblio($biblionumber);
1384             my $author;
1385             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1386                 $author=$record->subfield('200','f');
1387                 $author=$record->subfield('700','a') unless $author;
1388             } else {
1389                 $author=$record->subfield('100','a');
1390             }
1391             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1392             # and we don't want to get only 1 result for each of them !!!
1393             $result{$author.$biblionumber}=$record;
1394         }
1395         # sort the hash and return the same structure as GetRecords (Zebra querying)
1396         my $result_hash;
1397         my $numbers=0;
1398         if ($ordering eq 'author_za') { # sort by author desc
1399             foreach my $key (sort { $b cmp $a } (keys %result)) {
1400                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1401             }
1402         } else { # sort by author ASC
1403             foreach my $key (sort (keys %result)) {
1404                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1405             }
1406         }
1407         my $finalresult=();
1408         $result_hash->{'hits'} = $numbers;
1409         $finalresult->{'biblioserver'} = $result_hash;
1410         return $finalresult;
1411     #
1412     # ORDER BY callnumber
1413     #
1414     } elsif ($ordering =~/callnumber/){
1415         my %result;
1416         foreach (split /;/,$biblionumbers) {
1417             my ($biblionumber,$title) = split /,/,$_;
1418             my $record=GetMarcBiblio($biblionumber);
1419             my $callnumber;
1420             my ($callnumber_tag,$callnumber_subfield)=GetMarcFromKohaField($dbh,'items.itemcallnumber');
1421             ($callnumber_tag,$callnumber_subfield)= GetMarcFromKohaField('biblioitems.callnumber') unless $callnumber_tag;
1422             if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1423                 $callnumber=$record->subfield('200','f');
1424             } else {
1425                 $callnumber=$record->subfield('100','a');
1426             }
1427             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1428             # and we don't want to get only 1 result for each of them !!!
1429             $result{$callnumber.$biblionumber}=$record;
1430         }
1431         # sort the hash and return the same structure as GetRecords (Zebra querying)
1432         my $result_hash;
1433         my $numbers=0;
1434         if ($ordering eq 'call_number_dsc') { # sort by title desc
1435             foreach my $key (sort { $b cmp $a } (keys %result)) {
1436                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1437             }
1438         } else { # sort by title ASC
1439             foreach my $key (sort { $a cmp $b } (keys %result)) {
1440                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1441             }
1442         }
1443         my $finalresult=();
1444         $result_hash->{'hits'} = $numbers;
1445         $finalresult->{'biblioserver'} = $result_hash;
1446         return $finalresult;
1447     } elsif ($ordering =~ /pubdate/){ #pub year
1448         my %result;
1449         foreach (split /;/,$biblionumbers) {
1450             my ($biblionumber,$title) = split /,/,$_;
1451             my $record=GetMarcBiblio($biblionumber);
1452             my ($publicationyear_tag,$publicationyear_subfield)=GetMarcFromKohaField('biblioitems.publicationyear','');
1453             my $publicationyear=$record->subfield($publicationyear_tag,$publicationyear_subfield);
1454             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1455             # and we don't want to get only 1 result for each of them !!!
1456             $result{$publicationyear.$biblionumber}=$record;
1457         }
1458         # sort the hash and return the same structure as GetRecords (Zebra querying)
1459         my $result_hash;
1460         my $numbers=0;
1461         if ($ordering eq 'pubdate_dsc') { # sort by pubyear desc
1462             foreach my $key (sort { $b cmp $a } (keys %result)) {
1463                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1464             }
1465         } else { # sort by pub year ASC
1466             foreach my $key (sort (keys %result)) {
1467                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key}->as_usmarc();
1468             }
1469         }
1470         my $finalresult=();
1471         $result_hash->{'hits'} = $numbers;
1472         $finalresult->{'biblioserver'} = $result_hash;
1473         return $finalresult;
1474     #
1475     # ORDER BY title
1476     #
1477     } elsif ($ordering =~ /title/) {
1478         # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
1479         my %result;
1480         foreach (split /;/,$biblionumbers) {
1481             my ($biblionumber,$title) = split /,/,$_;
1482             # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1483             # and we don't want to get only 1 result for each of them !!!
1484             # hint & speed improvement : we can order without reading the record
1485             # so order, and read records only for the requested page !
1486             $result{$title.$biblionumber}=$biblionumber;
1487         }
1488         # sort the hash and return the same structure as GetRecords (Zebra querying)
1489         my $result_hash;
1490         my $numbers=0;
1491         if ($ordering eq 'title_az') { # sort by title desc
1492             foreach my $key (sort (keys %result)) {
1493                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1494             }
1495         } else { # sort by title ASC
1496             foreach my $key (sort { $b cmp $a } (keys %result)) {
1497                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1498             }
1499         }
1500         # limit the $results_per_page to result size if it's more
1501         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1502         # for the requested page, replace biblionumber by the complete record
1503         # speed improvement : avoid reading too much things
1504         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1505             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc;
1506         }
1507         my $finalresult=();
1508         $result_hash->{'hits'} = $numbers;
1509         $finalresult->{'biblioserver'} = $result_hash;
1510         return $finalresult;
1511     } else {
1512     #
1513     # order by ranking
1514     #
1515         # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
1516         my %result;
1517         my %count_ranking;
1518         foreach (split /;/,$biblionumbers) {
1519             my ($biblionumber,$title) = split /,/,$_;
1520             $title =~ /(.*)-(\d)/;
1521             # get weight
1522             my $ranking =$2;
1523             # note that we + the ranking because ranking is calculated on weight of EACH term requested.
1524             # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
1525             # biblio N has ranking = 6
1526             $count_ranking{$biblionumber} += $ranking;
1527         }
1528         # build the result by "inverting" the count_ranking hash
1529         # 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
1530 #         warn "counting";
1531         foreach (keys %count_ranking) {
1532             $result{sprintf("%10d",$count_ranking{$_}).'-'.$_} = $_;
1533         }
1534         # sort the hash and return the same structure as GetRecords (Zebra querying)
1535         my $result_hash;
1536         my $numbers=0;
1537             foreach my $key (sort {$b cmp $a} (keys %result)) {
1538                 $result_hash->{'RECORDS'}[$numbers++] = $result{$key};
1539             }
1540         # limit the $results_per_page to result size if it's more
1541         $results_per_page = $numbers-1 if $numbers < $results_per_page;
1542         # for the requested page, replace biblionumber by the complete record
1543         # speed improvement : avoid reading too much things
1544         for (my $counter=$offset;$counter<=$offset+$results_per_page;$counter++) {
1545             $result_hash->{'RECORDS'}[$counter] = GetMarcBiblio($result_hash->{'RECORDS'}[$counter])->as_usmarc if $result_hash->{'RECORDS'}[$counter];
1546         }
1547         my $finalresult=();
1548         $result_hash->{'hits'} = $numbers;
1549         $finalresult->{'biblioserver'} = $result_hash;
1550         return $finalresult;
1551     }
1552 }
1553 =head2 ModBiblios
1554
1555 ($countchanged,$listunchanged) = ModBiblios($listbiblios, $tagsubfield,$initvalue,$targetvalue,$test);
1556
1557 this function changes all the values $initvalue in subfield $tag$subfield in any record in $listbiblios
1558 test parameter if set donot perform change to records in database.
1559
1560 =over 2
1561
1562 =item C<input arg:>
1563
1564     * $listbiblios is an array ref to marcrecords to be changed
1565     * $tagsubfield is the reference of the subfield to change.
1566     * $initvalue is the value to search the record for
1567     * $targetvalue is the value to set the subfield to
1568     * $test is to be set only not to perform changes in database.
1569
1570 =item C<Output arg:>
1571     * $countchanged counts all the changes performed.
1572     * $listunchanged contains the list of all the biblionumbers of records unchanged.
1573
1574 =item C<usage in the script:>
1575
1576 =back
1577
1578 my ($countchanged, $listunchanged) = EditBiblios($results->{RECORD}, $tagsubfield,$initvalue,$targetvalue);;
1579 #If one wants to display unchanged records, you should get biblios foreach @$listunchanged
1580 $template->param(countchanged => $countchanged, loopunchanged=>$listunchanged);
1581
1582 =cut
1583
1584 sub ModBiblios{
1585   my ($listbiblios,$tagsubfield,$initvalue,$targetvalue,$test)=@_;
1586   my $countmatched;
1587   my @unmatched;
1588   my ($tag,$subfield)=($1,$2) if ($tagsubfield=~/^(\d{1,3})([a-z0-9A-Z@])?$/);
1589   if ((length($tag)<3)&& $subfield=~/0-9/){
1590     $tag=$tag.$subfield;
1591     undef $subfield;
1592   }
1593   my ($bntag,$bnsubf) = GetMarcFromKohaField('biblio.biblionumber');
1594   my ($itemtag,$itemsubf) = GetMarcFromKohaField('items.itemnumber');
1595   foreach my $usmarc (@$listbiblios){
1596     my $record;
1597     $record=eval{MARC::Record->new_from_usmarc($usmarc)};
1598     my $biblionumber;
1599     if ($@){
1600       # usmarc is not a valid usmarc May be a biblionumber
1601       if ($tag eq $itemtag){
1602         my $bib=GetBiblioFromItemNumber($usmarc);
1603         $record=GetMarcItem($bib->{'biblionumber'},$usmarc) ;
1604         $biblionumber=$bib->{'biblionumber'};
1605       } else {
1606         $record=GetMarcBiblio($usmarc);
1607         $biblionumber=$usmarc;
1608       }
1609     }  else {
1610       if ($bntag >= 010){
1611         $biblionumber = $record->subfield($bntag,$bnsubf);
1612       }else {
1613         $biblionumber=$record->field($bntag)->data;
1614       }
1615     }
1616     #GetBiblionumber is to be written.
1617     #Could be replaced by TransformMarcToKoha (But Would be longer)
1618     if ($record->field($tag)){
1619       my $modify=0;
1620       foreach my $field ($record->field($tag)){
1621         if ($subfield){
1622           if ($field->delete_subfield('code' =>$subfield,'match'=>qr($initvalue))){
1623             $countmatched++;
1624             $modify=1;
1625             $field->update($subfield,$targetvalue) if ($targetvalue);
1626           }
1627         } else {
1628           if ($tag >= 010){
1629             if ($field->delete_field($field)){
1630               $countmatched++;
1631               $modify=1;
1632             }
1633           } else {
1634             $field->data=$targetvalue if ($field->data=~qr($initvalue));
1635           }
1636         }
1637       }
1638 #       warn $record->as_formatted;
1639       if ($modify){
1640         ModBiblio($record,$biblionumber,GetFrameworkCode($biblionumber)) unless ($test);
1641       } else {
1642         push @unmatched, $biblionumber;
1643       }
1644     } else {
1645       push @unmatched, $biblionumber;
1646     }
1647   }
1648   return ($countmatched,\@unmatched);
1649 }
1650
1651 END { }    # module clean-up code here (global destructor)
1652
1653 1;
1654 __END__
1655
1656 =head1 AUTHOR
1657
1658 Koha Developement team <info@koha.org>
1659
1660 =cut