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::Search::PazPar2;
  25 use XML::Simple;
  26 use C4::Dates qw(format_date);
  27 use C4::XSLT;
  28
  29 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
  30
  31 # set the version for version checking
  32 BEGIN {
  33     $VERSION = 3.01;
  34     $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
  35 }
  36
  37 =head1 NAME
  38
  39 C4::Search - Functions for searching the Koha catalog.
  40
  41 =head1 SYNOPSIS
  42
  43 See opac/opac-search.pl or catalogue/search.pl for example of usage
  44
  45 =head1 DESCRIPTION
  46
  47 This module provides searching functions for Koha's bibliographic databases
  48
  49 =head1 FUNCTIONS
  50
  51 =cut
  52
  53 @ISA    = qw(Exporter);
  54 @EXPORT = qw(
  55   &findseealso
  56   &FindDuplicate
  57   &SimpleSearch
  58   &searchResults
  59   &getRecords
  60   &buildQuery
  61   &NZgetRecords
  62   &ModBiblios
  63 );
  64
  65 # make all your functions, whether exported or not;
  66
  67 =head2 findseealso($dbh,$fields);
  68
  69 C<$dbh> is a link to the DB handler.
  70
  71 use C4::Context;
  72 my $dbh =C4::Context->dbh;
  73
  74 C<$fields> is a reference to the fields array
  75
  76 This function modifies the @$fields array and adds related fields to search on.
  77
  78 FIXME: this function is probably deprecated in Koha 3
  79
  80 =cut
  81
  82 sub findseealso {
  83     my ( $dbh, $fields ) = @_;
  84     my $tagslib = GetMarcStructure(1);
  85     for ( my $i = 0 ; $i <= $#{$fields} ; $i++ ) {
  86         my ($tag)      = substr( @$fields[$i], 1, 3 );
  87         my ($subfield) = substr( @$fields[$i], 4, 1 );
  88         @$fields[$i] .= ',' . $tagslib->{$tag}->{$subfield}->{seealso}
  89           if ( $tagslib->{$tag}->{$subfield}->{seealso} );
  90     }
  91 }
  92
  93 =head2 FindDuplicate
  94
  95 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
  96
  97 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
  98
  99 =cut
 100
 101 sub FindDuplicate {
 102     my ($record) = @_;
 103     my $dbh = C4::Context->dbh;
 104     my $result = TransformMarcToKoha( $dbh, $record, '' );
 105     my $sth;
 106     my $query;
 107     my $search;
 108     my $type;
 109     my ( $biblionumber, $title );
 110
 111     # search duplicate on ISBN, easy and fast..
 112     # ... normalize first
 113     if ( $result->{isbn} ) {
 114         $result->{isbn} =~ s/\(.*$//;
 115         $result->{isbn} =~ s/\s+$//;
 116         $query = "isbn=$result->{isbn}";
 117     }
 118     else {
 119         $result->{title} =~ s /\\//g;
 120         $result->{title} =~ s /\"//g;
 121         $result->{title} =~ s /\(//g;
 122         $result->{title} =~ s /\)//g;
 123
 124         # FIXME: instead of removing operators, could just do
 125         # quotes around the value
 126         $result->{title} =~ s/(and|or|not)//g;
 127         $query = "ti,ext=$result->{title}";
 128         $query .= " and itemtype=$result->{itemtype}"
 129           if ( $result->{itemtype} );
 130         if   ( $result->{author} ) {
 131             $result->{author} =~ s /\\//g;
 132             $result->{author} =~ s /\"//g;
 133             $result->{author} =~ s /\(//g;
 134             $result->{author} =~ s /\)//g;
 135
 136             # remove valid operators
 137             $result->{author} =~ s/(and|or|not)//g;
 138             $query .= " and au,ext=$result->{author}";
 139         }
 140     }
 141
 142     # FIXME: add error handling
 143     my ( $error, $searchresults ) = SimpleSearch($query); # FIXME :: hardcoded !
 144     my @results;
 145     foreach my $possible_duplicate_record (@$searchresults) {
 146         my $marcrecord =
 147           MARC::Record->new_from_usmarc($possible_duplicate_record);
 148         my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
 149
 150         # FIXME :: why 2 $biblionumber ?
 151         if ($result) {
 152             push @results, $result->{'biblionumber'};
 153             push @results, $result->{'title'};
 154         }
 155     }
 156     return @results;
 157 }
 158
 159 =head2 SimpleSearch
 160
 161 ($error,$results) = SimpleSearch( $query, $offset, $max_results, [ @servers ] );
 162
 163 This function provides a simple search API on the bibliographic catalog
 164
 165 =over 2
 166
 167 =item C<input arg:>
 168
 169     * $query can be a simple keyword or a complete CCL query
 170     * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
 171     * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
 172     * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
 173
 174
 175 =item C<Output arg:>
 176     * $error is a empty unless an error is detected
 177     * \@results is an array of records.
 178
 179 =item C<usage in the script:>
 180
 181 =back
 182
 183 my ($error, $marcresults) = SimpleSearch($query);
 184
 185 if (defined $error) {
 186     $template->param(query_error => $error);
 187     warn "error: ".$error;
 188     output_html_with_http_headers $input, $cookie, $template->output;
 189     exit;
 190 }
 191
 192 my $hits = scalar @$marcresults;
 193 my @results;
 194
 195 for(my $i=0;$i<$hits;$i++) {
 196     my %resultsloop;
 197     my $marcrecord = MARC::File::USMARC::decode($marcresults->[$i]);
 198     my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,'');
 199
 200     #build the hash for the template.
 201     $resultsloop{highlight}       = ($i % 2)?(1):(0);
 202     $resultsloop{title}           = $biblio->{'title'};
 203     $resultsloop{subtitle}        = $biblio->{'subtitle'};
 204     $resultsloop{biblionumber}    = $biblio->{'biblionumber'};
 205     $resultsloop{author}          = $biblio->{'author'};
 206     $resultsloop{publishercode}   = $biblio->{'publishercode'};
 207     $resultsloop{publicationyear} = $biblio->{'publicationyear'};
 208
 209     push @results, \%resultsloop;
 210 }
 211
 212 $template->param(result=>\@results);
 213
 214 =cut
 215
 216 sub SimpleSearch {
 217     my ( $query, $offset, $max_results, $servers )  = @_;
 218
 219     if ( C4::Context->preference('NoZebra') ) {
 220         my $result = NZorder( NZanalyse($query) )->{'biblioserver'};
 221         my $search_result =
 222           (      $result->{hits}
 223               && $result->{hits} > 0 ? $result->{'RECORDS'} : [] );
 224         return ( undef, $search_result, scalar($search_result) );
 225     }
 226     else {
 227         # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
 228         my @servers = defined ( $servers ) ? @$servers : ( "biblioserver" );
 229         my @results;
 230         my @zoom_queries;
 231         my @tmpresults;
 232         my @zconns;
 233         my $total_hits;
 234         return ( "No query entered", undef, undef ) unless $query;
 235
 236         # Initialize & Search Zebra
 237         for ( my $i = 0 ; $i < @servers ; $i++ ) {
 238             eval {
 239                 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 240                 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
 241                 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
 242
 243                 # error handling
 244                 my $error =
 245                     $zconns[$i]->errmsg() . " ("
 246                   . $zconns[$i]->errcode() . ") "
 247                   . $zconns[$i]->addinfo() . " "
 248                   . $zconns[$i]->diagset();
 249
 250                 return ( $error, undef, undef ) if $zconns[$i]->errcode();
 251             };
 252             if ($@) {
 253
 254                 # caught a ZOOM::Exception
 255                 my $error =
 256                     $@->message() . " ("
 257                   . $@->code() . ") "
 258                   . $@->addinfo() . " "
 259                   . $@->diagset();
 260                 warn $error;
 261                 return ( $error, undef, undef );
 262             }
 263         }
 264         while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
 265             my $event = $zconns[ $i - 1 ]->last_event();
 266             if ( $event == ZOOM::Event::ZEND ) {
 267
 268                 my $first_record = defined( $offset ) ? $offset+1 : 1;
 269                 my $hits = $tmpresults[ $i - 1 ]->size();
 270                 $total_hits += $hits;
 271                 my $last_record = $hits;
 272                 if ( defined $max_results && $offset + $max_results < $hits ) {
 273                     $last_record  = $offset + $max_results;
 274                 }
 275
 276                 for my $j ( $first_record..$last_record ) {
 277                     my $record = $tmpresults[ $i - 1 ]->record( $j-1 )->raw(); # 0 indexed
 278                     push @results, $record;
 279                 }
 280             }
 281         }
 282
 283         foreach my $result (@tmpresults) {
 284             $result->destroy();
 285         }
 286         foreach my $zoom_query (@zoom_queries) {
 287             $zoom_query->destroy();
 288         }
 289
 290         return ( undef, \@results, $total_hits );
 291     }
 292 }
 293
 294 =head2 getRecords
 295
 296 ( undef, $results_hashref, \@facets_loop ) = getRecords (
 297
 298         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 299         $results_per_page, $offset,       $expanded_facet, $branches,
 300         $query_type,       $scan
 301     );
 302
 303 The all singing, all dancing, multi-server, asynchronous, scanning,
 304 searching, record nabbing, facet-building
 305
 306 See verbse embedded documentation.
 307
 308 =cut
 309
 310 sub getRecords {
 311     my (
 312         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 313         $results_per_page, $offset,       $expanded_facet, $branches,
 314         $query_type,       $scan
 315     ) = @_;
 316
 317     my @servers = @$servers_ref;
 318     my @sort_by = @$sort_by_ref;
 319
 320     # Initialize variables for the ZOOM connection and results object
 321     my $zconn;
 322     my @zconns;
 323     my @results;
 324     my $results_hashref = ();
 325
 326     # Initialize variables for the faceted results objects
 327     my $facets_counter = ();
 328     my $facets_info    = ();
 329     my $facets         = getFacets();
 330
 331     my @facets_loop
 332       ;    # stores the ref to array of hashes for template facets loop
 333
 334     ### LOOP THROUGH THE SERVERS
 335     for ( my $i = 0 ; $i < @servers ; $i++ ) {
 336         $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
 337
 338 # perform the search, create the results objects
 339 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
 340         my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
 341
 342         #$query_to_use = $simple_query if $scan;
 343         warn $simple_query if ( $scan and $DEBUG );
 344
 345         # Check if we've got a query_type defined, if so, use it
 346         eval {
 347             if ($query_type)
 348             {
 349                 if ( $query_type =~ /^ccl/ ) {
 350                     $query_to_use =~
 351                       s/\:/\=/g;    # change : to = last minute (FIXME)
 352                     $results[$i] =
 353                       $zconns[$i]->search(
 354                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 355                       );
 356                 }
 357                 elsif ( $query_type =~ /^cql/ ) {
 358                     $results[$i] =
 359                       $zconns[$i]->search(
 360                         new ZOOM::Query::CQL( $query_to_use, $zconns[$i] ) );
 361                 }
 362                 elsif ( $query_type =~ /^pqf/ ) {
 363                     $results[$i] =
 364                       $zconns[$i]->search(
 365                         new ZOOM::Query::PQF( $query_to_use, $zconns[$i] ) );
 366                 }
 367             }
 368             else {
 369                 if ($scan) {
 370                     $results[$i] =
 371                       $zconns[$i]->scan(
 372                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 373                       );
 374                 }
 375                 else {
 376                     $results[$i] =
 377                       $zconns[$i]->search(
 378                         new ZOOM::Query::CCL2RPN( $query_to_use, $zconns[$i] )
 379                       );
 380                 }
 381             }
 382         };
 383         if ($@) {
 384             warn "WARNING: query problem with $query_to_use " . $@;
 385         }
 386
 387         # Concatenate the sort_by limits and pass them to the results object
 388         # Note: sort will override rank
 389         my $sort_by;
 390         foreach my $sort (@sort_by) {
 391             if ( $sort eq "author_az" ) {
 392                 $sort_by .= "1=1003 <i ";
 393             }
 394             elsif ( $sort eq "author_za" ) {
 395                 $sort_by .= "1=1003 >i ";
 396             }
 397             elsif ( $sort eq "popularity_asc" ) {
 398                 $sort_by .= "1=9003 <i ";
 399             }
 400             elsif ( $sort eq "popularity_dsc" ) {
 401                 $sort_by .= "1=9003 >i ";
 402             }
 403             elsif ( $sort eq "call_number_asc" ) {
 404                 $sort_by .= "1=20  <i ";
 405             }
 406             elsif ( $sort eq "call_number_dsc" ) {
 407                 $sort_by .= "1=20 >i ";
 408             }
 409             elsif ( $sort eq "pubdate_asc" ) {
 410                 $sort_by .= "1=31 <i ";
 411             }
 412             elsif ( $sort eq "pubdate_dsc" ) {
 413                 $sort_by .= "1=31 >i ";
 414             }
 415             elsif ( $sort eq "acqdate_asc" ) {
 416                 $sort_by .= "1=32 <i ";
 417             }
 418             elsif ( $sort eq "acqdate_dsc" ) {
 419                 $sort_by .= "1=32 >i ";
 420             }
 421             elsif ( $sort eq "title_az" ) {
 422                 $sort_by .= "1=4 <i ";
 423             }
 424             elsif ( $sort eq "title_za" ) {
 425                 $sort_by .= "1=4 >i ";
 426             }
 427         }
 428         if ($sort_by) {
 429             if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
 430                 warn "WARNING sort $sort_by failed";
 431             }
 432         }
 433     }    # finished looping through servers
 434
 435     # The big moment: asynchronously retrieve results from all servers
 436     while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
 437         my $ev = $zconns[ $i - 1 ]->last_event();
 438         if ( $ev == ZOOM::Event::ZEND ) {
 439             next unless $results[ $i - 1 ];
 440             my $size = $results[ $i - 1 ]->size();
 441             if ( $size > 0 ) {
 442                 my $results_hash;
 443
 444                 # loop through the results
 445                 $results_hash->{'hits'} = $size;
 446                 my $times;
 447                 if ( $offset + $results_per_page <= $size ) {
 448                     $times = $offset + $results_per_page;
 449                 }
 450                 else {
 451                     $times = $size;
 452                 }
 453                 for ( my $j = $offset ; $j < $times ; $j++ ) {
 454                     my $records_hash;
 455                     my $record;
 456                     my $facet_record;
 457
 458                     ## Check if it's an index scan
 459                     if ($scan) {
 460                         my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
 461
 462                  # here we create a minimal MARC record and hand it off to the
 463                  # template just like a normal result ... perhaps not ideal, but
 464                  # it works for now
 465                         my $tmprecord = MARC::Record->new();
 466                         $tmprecord->encoding('UTF-8');
 467                         my $tmptitle;
 468                         my $tmpauthor;
 469
 470                 # the minimal record in author/title (depending on MARC flavour)
 471                         if (C4::Context->preference("marcflavour") eq "UNIMARC") {
 472                             $tmptitle = MARC::Field->new('200',' ',' ', a => $term, f => $occ);
 473                             $tmprecord->append_fields($tmptitle);
 474                         } else {
 475                             $tmptitle  = MARC::Field->new('245',' ',' ', a => $term,);
 476                             $tmpauthor = MARC::Field->new('100',' ',' ', a => $occ,);
 477                             $tmprecord->append_fields($tmptitle);
 478                             $tmprecord->append_fields($tmpauthor);
 479                         }
 480                         $results_hash->{'RECORDS'}[$j] = $tmprecord->as_usmarc();
 481                     }
 482
 483                     # not an index scan
 484                     else {
 485                         $record = $results[ $i - 1 ]->record($j)->raw();
 486
 487                         # warn "RECORD $j:".$record;
 488                         $results_hash->{'RECORDS'}[$j] = $record;
 489
 490             # Fill the facets while we're looping, but only for the biblioserver
 491                         $facet_record = MARC::Record->new_from_usmarc($record)
 492                           if $servers[ $i - 1 ] =~ /biblioserver/;
 493
 494                     #warn $servers[$i-1]."\n".$record; #.$facet_record->title();
 495                         if ($facet_record) {
 496                             for ( my $k = 0 ; $k <= @$facets ; $k++ ) {
 497
 498                                 if ( $facets->[$k] ) {
 499                                     my @fields;
 500                                     for my $tag ( @{ $facets->[$k]->{'tags'} } )
 501                                     {
 502                                         push @fields,
 503                                           $facet_record->field($tag);
 504                                     }
 505                                     for my $field (@fields) {
 506                                         my @subfields = $field->subfields();
 507                                         for my $subfield (@subfields) {
 508                                             my ( $code, $data ) = @$subfield;
 509                                             if ( $code eq
 510                                                 $facets->[$k]->{'subfield'} )
 511                                             {
 512                                                 $facets_counter->{ $facets->[$k]
 513                                                       ->{'link_value'} }
 514                                                   ->{$data}++;
 515                                             }
 516                                         }
 517                                     }
 518                                     $facets_info->{ $facets->[$k]
 519                                           ->{'link_value'} }->{'label_value'} =
 520                                       $facets->[$k]->{'label_value'};
 521                                     $facets_info->{ $facets->[$k]
 522                                           ->{'link_value'} }->{'expanded'} =
 523                                       $facets->[$k]->{'expanded'};
 524                                 }
 525                             }
 526                         }
 527                     }
 528                 }
 529                 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
 530             }
 531
 532             # warn "connection ", $i-1, ": $size hits";
 533             # warn $results[$i-1]->record(0)->render() if $size > 0;
 534
 535             # BUILD FACETS
 536             if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
 537                 for my $link_value (
 538                     sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
 539                     keys %$facets_counter )
 540                 {
 541                     my $expandable;
 542                     my $number_of_facets;
 543                     my @this_facets_array;
 544                     for my $one_facet (
 545                         sort {
 546                             $facets_counter->{$link_value}
 547                               ->{$b} <=> $facets_counter->{$link_value}->{$a}
 548                         } keys %{ $facets_counter->{$link_value} }
 549                       )
 550                     {
 551                         $number_of_facets++;
 552                         if (   ( $number_of_facets < 6 )
 553                             || ( $expanded_facet eq $link_value )
 554                             || ( $facets_info->{$link_value}->{'expanded'} ) )
 555                         {
 556
 557                       # Sanitize the link value ), ( will cause errors with CCL,
 558                             my $facet_link_value = $one_facet;
 559                             $facet_link_value =~ s/(\(|\))/ /g;
 560
 561                             # fix the length that will display in the label,
 562                             my $facet_label_value = $one_facet;
 563                             $facet_label_value =
 564                               substr( $one_facet, 0, 20 ) . "..."
 565                               unless length($facet_label_value) <= 20;
 566
 567                             # if it's a branch, label by the name, not the code,
 568                             if ( $link_value =~ /branch/ ) {
 569                                 $facet_label_value =
 570                                   $branches->{$one_facet}->{'branchname'};
 571                             }
 572
 573                 # but we're down with the whole label being in the link's title.
 574                             my $facet_title_value = $one_facet;
 575
 576                             push @this_facets_array,
 577                               (
 578                                 {
 579                                     facet_count =>
 580                                       $facets_counter->{$link_value}
 581                                       ->{$one_facet},
 582                                     facet_label_value => $facet_label_value,
 583                                     facet_title_value => $facet_title_value,
 584                                     facet_link_value  => $facet_link_value,
 585                                     type_link_value   => $link_value,
 586                                 },
 587                               );
 588                         }
 589                     }
 590
 591                     # handle expanded option
 592                     unless ( $facets_info->{$link_value}->{'expanded'} ) {
 593                         $expandable = 1
 594                           if ( ( $number_of_facets > 6 )
 595                             && ( $expanded_facet ne $link_value ) );
 596                     }
 597                     push @facets_loop,
 598                       (
 599                         {
 600                             type_link_value => $link_value,
 601                             type_id         => $link_value . "_id",
 602                             "type_label_" . $facets_info->{$link_value}->{'label_value'} => 1,
 603                             facets     => \@this_facets_array,
 604                             expandable => $expandable,
 605                             expand     => $link_value,
 606                         }
 607                       );
 608                 }
 609             }
 610         }
 611     }
 612     return ( undef, $results_hashref, \@facets_loop );
 613 }
 614
 615 sub pazGetRecords {
 616     my (
 617         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
 618         $results_per_page, $offset,       $expanded_facet, $branches,
 619         $query_type,       $scan
 620     ) = @_;
 621
 622     my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
 623     $paz->init();
 624     $paz->search($simple_query);
 625     sleep 1;
 626
 627     # do results
 628     my $results_hashref = {};
 629     my $stats = XMLin($paz->stat);
 630     my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
 631
 632     # for a grouped search result, the number of hits
 633     # is the number of groups returned; 'bib_hits' will have
 634     # the total number of bibs.
 635     $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
 636     $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
 637
 638     HIT: foreach my $hit (@{ $results->{'hit'} }) {
 639         my $recid = $hit->{recid}->[0];
 640
 641         my $work_title = $hit->{'md-work-title'}->[0];
 642         my $work_author;
 643         if (exists $hit->{'md-work-author'}) {
 644             $work_author = $hit->{'md-work-author'}->[0];
 645         }
 646         my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
 647
 648         my $result_group = {};
 649         $result_group->{'group_label'} = $group_label;
 650         $result_group->{'group_merge_key'} = $recid;
 651
 652         my $count = 1;
 653         if (exists $hit->{count}) {
 654             $count = $hit->{count}->[0];
 655         }
 656         $result_group->{'group_count'} = $count;
 657
 658         for (my $i = 0; $i < $count; $i++) {
 659             # FIXME -- may need to worry about diacritics here
 660             my $rec = $paz->record($recid, $i);
 661             push @{ $result_group->{'RECORDS'} }, $rec;
 662         }
 663
 664         push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
 665     }
 666
 667     # pass through facets
 668     my $termlist_xml = $paz->termlist('author,subject');
 669     my $terms = XMLin($termlist_xml, forcearray => 1);
 670     my @facets_loop = ();
 671     #die Dumper($results);
 672 #    foreach my $list (sort keys %{ $terms->{'list'} }) {
 673 #        my @facets = ();
 674 #        foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
 675 #            push @facets, {
 676 #                facet_label_value => $facet->{'name'}->[0],
 677 #            };
 678 #        }
 679 #        push @facets_loop, ( {
 680 #            type_label => $list,
 681 #            facets => \@facets,
 682 #        } );
 683 #    }
 684
 685     return ( undef, $results_hashref, \@facets_loop );
 686 }
 687
 688 # STOPWORDS
 689 sub _remove_stopwords {
 690     my ( $operand, $index ) = @_;
 691     my @stopwords_removed;
 692
 693     # phrase and exact-qualified indexes shouldn't have stopwords removed
 694     if ( $index !~ m/phr|ext/ ) {
 695
 696 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
 697 #       we use IsAlpha unicode definition, to deal correctly with diacritics.
 698 #       otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
 699 #       is a stopword, we'd get "çon" and wouldn't find anything...
 700         foreach ( keys %{ C4::Context->stopwords } ) {
 701             next if ( $_ =~ /(and|or|not)/ );    # don't remove operators
 702             if ( $operand =~
 703                 /(\P{IsAlpha}$_\P{IsAlpha}|^$_\P{IsAlpha}|\P{IsAlpha}$_$)/ )
 704             {
 705                 $operand =~ s/\P{IsAlpha}$_\P{IsAlpha}/ /gi;
 706                 $operand =~ s/^$_\P{IsAlpha}/ /gi;
 707                 $operand =~ s/\P{IsAlpha}$_$/ /gi;
 708                 push @stopwords_removed, $_;
 709             }
 710         }
 711     }
 712     return ( $operand, \@stopwords_removed );
 713 }
 714
 715 # TRUNCATION
 716 sub _detect_truncation {
 717     my ( $operand, $index ) = @_;
 718     my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
 719         @regexpr );
 720     $operand =~ s/^ //g;
 721     my @wordlist = split( /\s/, $operand );
 722     foreach my $word (@wordlist) {
 723         if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
 724             push @rightlefttruncated, $word;
 725         }
 726         elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
 727             push @lefttruncated, $word;
 728         }
 729         elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
 730             push @righttruncated, $word;
 731         }
 732         elsif ( index( $word, "*" ) < 0 ) {
 733             push @nontruncated, $word;
 734         }
 735         else {
 736             push @regexpr, $word;
 737         }
 738     }
 739     return (
 740         \@nontruncated,       \@righttruncated, \@lefttruncated,
 741         \@rightlefttruncated, \@regexpr
 742     );
 743 }
 744
 745 # STEMMING
 746 sub _build_stemmed_operand {
 747     my ($operand) = @_;
 748     my $stemmed_operand;
 749
 750     # If operand contains a digit, it is almost certainly an identifier, and should
 751     # not be stemmed.  This is particularly relevant for ISBNs and ISSNs, which
 752     # can contain the letter "X" - for example, _build_stemmend_operand would reduce
 753     # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
 754     # results (e.g., "23 x 29 cm." from the 300$c).  Bug 2098.
 755     return $operand if $operand =~ /\d/;
 756
 757 # FIXME: the locale should be set based on the user's language and/or search choice
 758     my $stemmer = Lingua::Stem->new( -locale => 'EN-US' );
 759
 760 # FIXME: these should be stored in the db so the librarian can modify the behavior
 761     $stemmer->add_exceptions(
 762         {
 763             'and' => 'and',
 764             'or'  => 'or',
 765             'not' => 'not',
 766         }
 767     );
 768     my @words = split( / /, $operand );
 769     my $stems = $stemmer->stem(@words);
 770     for my $stem (@$stems) {
 771         $stemmed_operand .= "$stem";
 772         $stemmed_operand .= "?"
 773           unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
 774         $stemmed_operand .= " ";
 775     }
 776     warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
 777     return $stemmed_operand;
 778 }
 779
 780 # FIELD WEIGHTING
 781 sub _build_weighted_query {
 782
 783 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
 784 # pretty well but could work much better if we had a smarter query parser
 785     my ( $operand, $stemmed_operand, $index ) = @_;
 786     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
 787     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
 788     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy")        || 0;
 789
 790     my $weighted_query .= "(rk=(";    # Specifies that we're applying rank
 791
 792     # Keyword, or, no index specified
 793     if ( ( $index eq 'kw' ) || ( !$index ) ) {
 794         $weighted_query .=
 795           "Title-cover,ext,r1=\"$operand\"";    # exact title-cover
 796         $weighted_query .= " or ti,ext,r2=\"$operand\"";    # exact title
 797         $weighted_query .= " or ti,phr,r3=\"$operand\"";    # phrase title
 798           #$weighted_query .= " or any,ext,r4=$operand";               # exact any
 799           #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
 800         $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
 801           if $fuzzy_enabled;    # add fuzzy, word list
 802         $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
 803           if ( $stemming and $stemmed_operand )
 804           ;                     # add stemming, right truncation
 805         $weighted_query .= " or wrdl,r9=\"$operand\"";
 806
 807         # embedded sorting: 0 a-z; 1 z-a
 808         # $weighted_query .= ") or (sort1,aut=1";
 809     }
 810
 811     # Barcode searches should skip this process
 812     elsif ( $index eq 'bc' ) {
 813         $weighted_query .= "bc=\"$operand\"";
 814     }
 815
 816     # Authority-number searches should skip this process
 817     elsif ( $index eq 'an' ) {
 818         $weighted_query .= "an=\"$operand\"";
 819     }
 820
 821     # If the index already has more than one qualifier, wrap the operand
 822     # in quotes and pass it back (assumption is that the user knows what they
 823     # are doing and won't appreciate us mucking up their query
 824     elsif ( $index =~ ',' ) {
 825         $weighted_query .= " $index=\"$operand\"";
 826     }
 827
 828     #TODO: build better cases based on specific search indexes
 829     else {
 830         $weighted_query .= " $index,ext,r1=\"$operand\"";    # exact index
 831           #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
 832         $weighted_query .= " or $index,phr,r3=\"$operand\"";    # phrase index
 833         $weighted_query .=
 834           " or $index,rt,wrdl,r3=\"$operand\"";    # word list index
 835     }
 836
 837     $weighted_query .= "))";                       # close rank specification
 838     return $weighted_query;
 839 }
 840
 841 =head2 buildQuery
 842
 843 ( $error, $query,
 844 $simple_query, $query_cgi,
 845 $query_desc, $limit,
 846 $limit_cgi, $limit_desc,
 847 $stopwords_removed, $query_type ) = getRecords ( $operators, $operands, $indexes, $limits, $sort_by, $scan);
 848
 849 Build queries and limits in CCL, CGI, Human,
 850 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
 851
 852 See verbose embedded documentation.
 853
 854
 855 =cut
 856
 857 sub buildQuery {
 858     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan ) = @_;
 859
 860     warn "---------\nEnter buildQuery\n---------" if $DEBUG;
 861
 862     # dereference
 863     my @operators = @$operators if $operators;
 864     my @indexes   = @$indexes   if $indexes;
 865     my @operands  = @$operands  if $operands;
 866     my @limits    = @$limits    if $limits;
 867     my @sort_by   = @$sort_by   if $sort_by;
 868
 869     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
 870     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
 871     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
 872     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
 873     my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
 874
 875     # no stemming/weight/fuzzy in NoZebra
 876     if ( C4::Context->preference("NoZebra") ) {
 877         $stemming      = 0;
 878         $weight_fields = 0;
 879         $fuzzy_enabled = 0;
 880     }
 881
 882     my $query        = $operands[0];
 883     my $simple_query = $operands[0];
 884
 885     # initialize the variables we're passing back
 886     my $query_cgi;
 887     my $query_desc;
 888     my $query_type;
 889
 890     my $limit;
 891     my $limit_cgi;
 892     my $limit_desc;
 893
 894     my $stopwords_removed;    # flag to determine if stopwords have been removed
 895
 896 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
 897 # DIAGNOSTIC ONLY!!
 898     if ( $query =~ /^ccl=/ ) {
 899         return ( undef, $', $', $', $', '', '', '', '', 'ccl' );
 900     }
 901     if ( $query =~ /^cql=/ ) {
 902         return ( undef, $', $', $', $', '', '', '', '', 'cql' );
 903     }
 904     if ( $query =~ /^pqf=/ ) {
 905         return ( undef, $', $', $', $', '', '', '', '', 'pqf' );
 906     }
 907
 908     # pass nested queries directly
 909     # FIXME: need better handling of some of these variables in this case
 910     if ( $query =~ /(\(|\))/ ) {
 911         return (
 912             undef,              $query, $simple_query, $query_cgi,
 913             $query,             $limit, $limit_cgi,    $limit_desc,
 914             $stopwords_removed, 'ccl'
 915         );
 916     }
 917
 918 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
 919 # query operands and indexes and add stemming, truncation, field weighting, etc.
 920 # Once we do so, we'll end up with a value in $query, just like if we had an
 921 # incoming $query from the user
 922     else {
 923         $query = ""
 924           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
 925         my $previous_operand
 926           ;    # a flag used to keep track if there was a previous query
 927                # if there was, we can apply the current operator
 928                # for every operand
 929         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
 930
 931             # COMBINE OPERANDS, INDEXES AND OPERATORS
 932             if ( $operands[$i] ) {
 933
 934               # A flag to determine whether or not to add the index to the query
 935                 my $indexes_set;
 936
 937 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
 938                 if ( $operands[$i] =~ /(:|=)/ || $scan ) {
 939                     $weight_fields    = 0;
 940                     $stemming         = 0;
 941                     $remove_stopwords = 0;
 942                 }
 943                 my $operand = $operands[$i];
 944                 my $index   = $indexes[$i];
 945
 946                 # Add index-specific attributes
 947                 # Date of Publication
 948                 if ( $index eq 'yr' ) {
 949                     $index .= ",st-numeric";
 950                     $indexes_set++;
 951                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
 952                 }
 953
 954                 # Date of Acquisition
 955                 elsif ( $index eq 'acqdate' ) {
 956                     $index .= ",st-date-normalized";
 957                     $indexes_set++;
 958                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
 959                 }
 960                 # ISBN,ISSN,Standard Number, don't need special treatment
 961                 elsif ( $index eq 'nb' || $index eq 'ns' ) {
 962                     $indexes_set++;
 963                     (
 964                         $stemming,      $auto_truncation,
 965                         $weight_fields, $fuzzy_enabled,
 966                         $remove_stopwords
 967                     ) = ( 0, 0, 0, 0, 0 );
 968
 969                 }
 970                 # Set default structure attribute (word list)
 971                 my $struct_attr;
 972                 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl)/ ) {
 973                     $struct_attr = ",wrdl";
 974                 }
 975
 976                 # Some helpful index variants
 977                 my $index_plus       = $index . $struct_attr . ":" if $index;
 978                 my $index_plus_comma = $index . $struct_attr . "," if $index;
 979
 980                 # Remove Stopwords
 981                 if ($remove_stopwords) {
 982                     ( $operand, $stopwords_removed ) =
 983                       _remove_stopwords( $operand, $index );
 984                     warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
 985                     warn "REMOVED STOPWORDS: @$stopwords_removed"
 986                       if ( $stopwords_removed && $DEBUG );
 987                 }
 988
 989                 # Detect Truncation
 990                 my ( $nontruncated, $righttruncated, $lefttruncated,
 991                     $rightlefttruncated, $regexpr );
 992                 my $truncated_operand;
 993                 (
 994                     $nontruncated, $righttruncated, $lefttruncated,
 995                     $rightlefttruncated, $regexpr
 996                 ) = _detect_truncation( $operand, $index );
 997                 warn
 998 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
 999                   if $DEBUG;
1000
1001                 # Apply Truncation
1002                 if (
1003                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
1004                     scalar(@$rightlefttruncated) > 0 )
1005                 {
1006
1007                # Don't field weight or add the index to the query, we do it here
1008                     $indexes_set = 1;
1009                     undef $weight_fields;
1010                     my $previous_truncation_operand;
1011                     if ( scalar(@$nontruncated) > 0 ) {
1012                         $truncated_operand .= "$index_plus @$nontruncated ";
1013                         $previous_truncation_operand = 1;
1014                     }
1015                     if ( scalar(@$righttruncated) > 0 ) {
1016                         $truncated_operand .= "and "
1017                           if $previous_truncation_operand;
1018                         $truncated_operand .=
1019                           "$index_plus_comma" . "rtrn:@$righttruncated ";
1020                         $previous_truncation_operand = 1;
1021                     }
1022                     if ( scalar(@$lefttruncated) > 0 ) {
1023                         $truncated_operand .= "and "
1024                           if $previous_truncation_operand;
1025                         $truncated_operand .=
1026                           "$index_plus_comma" . "ltrn:@$lefttruncated ";
1027                         $previous_truncation_operand = 1;
1028                     }
1029                     if ( scalar(@$rightlefttruncated) > 0 ) {
1030                         $truncated_operand .= "and "
1031                           if $previous_truncation_operand;
1032                         $truncated_operand .=
1033                           "$index_plus_comma" . "rltrn:@$rightlefttruncated ";
1034                         $previous_truncation_operand = 1;
1035                     }
1036                 }
1037                 $operand = $truncated_operand if $truncated_operand;
1038                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1039
1040                 # Handle Stemming
1041                 my $stemmed_operand;
1042                 $stemmed_operand = _build_stemmed_operand($operand)
1043                   if $stemming;
1044                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1045
1046                 # Handle Field Weighting
1047                 my $weighted_operand;
1048                 $weighted_operand =
1049                   _build_weighted_query( $operand, $stemmed_operand, $index )
1050                   if $weight_fields;
1051                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1052                 $operand = $weighted_operand if $weight_fields;
1053                 $indexes_set = 1 if $weight_fields;
1054
1055                 # If there's a previous operand, we need to add an operator
1056                 if ($previous_operand) {
1057
1058                     # User-specified operator
1059                     if ( $operators[ $i - 1 ] ) {
1060                         $query     .= " $operators[$i-1] ";
1061                         $query     .= " $index_plus " unless $indexes_set;
1062                         $query     .= " $operand";
1063                         $query_cgi .= "&op=$operators[$i-1]";
1064                         $query_cgi .= "&idx=$index" if $index;
1065                         $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1066                         $query_desc .=
1067                           " $operators[$i-1] $index_plus $operands[$i]";
1068                     }
1069
1070                     # Default operator is and
1071                     else {
1072                         $query      .= " and ";
1073                         $query      .= "$index_plus " unless $indexes_set;
1074                         $query      .= "$operand";
1075                         $query_cgi  .= "&op=and&idx=$index" if $index;
1076                         $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1077                         $query_desc .= " and $index_plus $operands[$i]";
1078                     }
1079                 }
1080
1081                 # There isn't a pervious operand, don't need an operator
1082                 else {
1083
1084                     # Field-weighted queries already have indexes set
1085                     $query .= " $index_plus " unless $indexes_set;
1086                     $query .= $operand;
1087                     $query_desc .= " $index_plus $operands[$i]";
1088                     $query_cgi  .= "&idx=$index" if $index;
1089                     $query_cgi  .= "&q=$operands[$i]" if $operands[$i];
1090                     $previous_operand = 1;
1091                 }
1092             }    #/if $operands
1093         }    # /for
1094     }
1095     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1096
1097     # add limits
1098     my $group_OR_limits;
1099     my $availability_limit;
1100     foreach my $this_limit (@limits) {
1101         if ( $this_limit =~ /available/ ) {
1102
1103 # 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1104 # In English:
1105 # all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1106             $availability_limit .=
1107 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1108             $limit_cgi  .= "&limit=available";
1109             $limit_desc .= "";
1110         }
1111
1112         # group_OR_limits, prefixed by mc-
1113         # OR every member of the group
1114         elsif ( $this_limit =~ /mc/ ) {
1115             $group_OR_limits .= " or " if $group_OR_limits;
1116             $limit_desc      .= " or " if $group_OR_limits;
1117             $group_OR_limits .= "$this_limit";
1118             $limit_cgi       .= "&limit=$this_limit";
1119             $limit_desc      .= " $this_limit";
1120         }
1121
1122         # Regular old limits
1123         else {
1124             $limit .= " and " if $limit || $query;
1125             $limit      .= "$this_limit";
1126             $limit_cgi  .= "&limit=$this_limit";
1127             $limit_desc .= " $this_limit";
1128         }
1129     }
1130     if ($group_OR_limits) {
1131         $limit .= " and " if ( $query || $limit );
1132         $limit .= "($group_OR_limits)";
1133     }
1134     if ($availability_limit) {
1135         $limit .= " and " if ( $query || $limit );
1136         $limit .= "($availability_limit)";
1137     }
1138
1139     # Normalize the query and limit strings
1140     $query =~ s/:/=/g;
1141     $limit =~ s/:/=/g;
1142     for ( $query, $query_desc, $limit, $limit_desc ) {
1143         $_ =~ s/  / /g;    # remove extra spaces
1144         $_ =~ s/^ //g;     # remove any beginning spaces
1145         $_ =~ s/ $//g;     # remove any ending spaces
1146         $_ =~ s/==/=/g;    # remove double == from query
1147     }
1148     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1149
1150     for ($query_cgi,$simple_query) {
1151         $_ =~ s/"//g;
1152     }
1153     # append the limit to the query
1154     $query .= " " . $limit;
1155
1156     # Warnings if DEBUG
1157     if ($DEBUG) {
1158         warn "QUERY:" . $query;
1159         warn "QUERY CGI:" . $query_cgi;
1160         warn "QUERY DESC:" . $query_desc;
1161         warn "LIMIT:" . $limit;
1162         warn "LIMIT CGI:" . $limit_cgi;
1163         warn "LIMIT DESC:" . $limit_desc;
1164         warn "---------\nLeave buildQuery\n---------";
1165     }
1166     return (
1167         undef,              $query, $simple_query, $query_cgi,
1168         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1169         $stopwords_removed, $query_type
1170     );
1171 }
1172
1173 =head2 searchResults
1174
1175 Format results in a form suitable for passing to the template
1176
1177 =cut
1178
1179 # IMO this subroutine is pretty messy still -- it's responsible for
1180 # building the HTML output for the template
1181 sub searchResults {
1182     my ( $searchdesc, $hits, $results_per_page, $offset, @marcresults ) = @_;
1183     my $dbh = C4::Context->dbh;
1184     my $even = 1;
1185     my @newresults;
1186
1187     # add search-term highlighting via <span>s on the search terms
1188     my $span_terms_hashref;
1189     for my $span_term ( split( / /, $searchdesc ) ) {
1190         $span_term =~ s/(.*=|\)|\(|\+|\.|\*)//g;
1191         $span_terms_hashref->{$span_term}++;
1192     }
1193
1194     #Build branchnames hash
1195     #find branchname
1196     #get branch information.....
1197     my %branches;
1198     my $bsth =
1199       $dbh->prepare("SELECT branchcode,branchname FROM branches")
1200       ;    # FIXME : use C4::Koha::GetBranches
1201     $bsth->execute();
1202     while ( my $bdata = $bsth->fetchrow_hashref ) {
1203         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1204     }
1205 # FIXME - We build an authorised values hash here, using the default framework
1206 # though it is possible to have different authvals for different fws.
1207
1208     my $shelflocations =GetKohaAuthorisedValues('items.location','');
1209
1210     # get notforloan authorised value list (see $shelflocations  FIXME)
1211     my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1212
1213     #Build itemtype hash
1214     #find itemtype & itemtype image
1215     my %itemtypes;
1216     $bsth =
1217       $dbh->prepare(
1218         "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1219       );
1220     $bsth->execute();
1221     while ( my $bdata = $bsth->fetchrow_hashref ) {
1222                 foreach (qw(description imageurl summary notforloan)) {
1223                 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1224                 }
1225     }
1226
1227     #search item field code
1228     my $sth =
1229       $dbh->prepare(
1230 "SELECT tagfield FROM marc_subfield_structure WHERE kohafield LIKE 'items.itemnumber'"
1231       );
1232     $sth->execute;
1233     my ($itemtag) = $sth->fetchrow;
1234
1235     ## find column names of items related to MARC
1236     my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1237     $sth2->execute;
1238     my %subfieldstosearch;
1239     while ( ( my $column ) = $sth2->fetchrow ) {
1240         my ( $tagfield, $tagsubfield ) =
1241           &GetMarcFromKohaField( "items." . $column, "" );
1242         $subfieldstosearch{$column} = $tagsubfield;
1243     }
1244
1245     # handle which records to actually retrieve
1246     my $times;
1247     if ( $hits && $offset + $results_per_page <= $hits ) {
1248         $times = $offset + $results_per_page;
1249     }
1250     else {
1251         $times = $hits;  # FIXME: if $hits is undefined, why do we want to equal it?
1252     }
1253
1254     # loop through all of the records we've retrieved
1255     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1256         my $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
1257         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, '' );
1258         $oldbiblio->{subtitle} = C4::Biblio::get_koha_field_from_marc('bibliosubtitle', 'subtitle', $marcrecord, '');
1259         $oldbiblio->{result_number} = $i + 1;
1260
1261         # add imageurl to itemtype if there is one
1262         if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} =~ /^http:/ ) {
1263             $oldbiblio->{imageurl} =
1264               $itemtypes{ $oldbiblio->{itemtype} }->{imageurl};
1265         } else {
1266             $oldbiblio->{imageurl} =
1267               getitemtypeimagesrc() . "/"
1268               . $itemtypes{ $oldbiblio->{itemtype} }->{imageurl}
1269               if ( $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1270         }
1271                 my $biblio_authorised_value_images = C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{biblionumber} ) );
1272                 $oldbiblio->{authorised_value_images} = $biblio_authorised_value_images;
1273         my $aisbn = $oldbiblio->{'isbn'};
1274         $aisbn =~ /(\d*[X]*)/;
1275         $oldbiblio->{amazonisbn} = $1;
1276                 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1277  # Build summary if there is one (the summary is defined in the itemtypes table)
1278  # FIXME: is this used anywhere, I think it can be commented out? -- JF
1279         if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1280             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1281             my @fields  = $marcrecord->fields();
1282             foreach my $field (@fields) {
1283                 my $tag      = $field->tag();
1284                 my $tagvalue = $field->as_string();
1285                 $summary =~
1286                   s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
1287                 unless ( $tag < 10 ) {
1288                     my @subf = $field->subfields;
1289                     for my $i ( 0 .. $#subf ) {
1290                         my $subfieldcode  = $subf[$i][0];
1291                         my $subfieldvalue = $subf[$i][1];
1292                         my $tagsubf       = $tag . $subfieldcode;
1293                         $summary =~
1294 s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
1295                     }
1296                 }
1297             }
1298             # FIXME: yuk
1299             $summary =~ s/\[(.*?)]//g;
1300             $summary =~ s/\n/<br\/>/g;
1301             $oldbiblio->{summary} = $summary;
1302         }
1303
1304         # save an author with no <span> tag, for the <a href=search.pl?q=<!--tmpl_var name="author"-->> link
1305         $oldbiblio->{'author_nospan'} = $oldbiblio->{'author'};
1306         $oldbiblio->{'title_nospan'} = $oldbiblio->{'title'};
1307         # Add search-term highlighting to the whole record where they match using <span>s
1308         if (C4::Context->preference("OpacHighlightedWords")){
1309             my $searchhighlightblob;
1310             for my $highlight_field ( $marcrecord->fields ) {
1311
1312     # FIXME: need to skip title, subtitle, author, etc., as they are handled below
1313                 next if $highlight_field->tag() =~ /(^00)/;    # skip fixed fields
1314                 for my $subfield ($highlight_field->subfields()) {
1315                     my $match;
1316                     next if $subfield->[0] eq '9';
1317                     my $field = $subfield->[1];
1318                     for my $term ( keys %$span_terms_hashref ) {
1319                         if ( ( $field =~ /$term/i ) && (( length($term) > 3 ) || ($field =~ / $term /i)) ) {
1320                             $field =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1321                         $match++;
1322                         }
1323                     }
1324                     $searchhighlightblob .= $field . " ... " if $match;
1325                 }
1326
1327             }
1328             $searchhighlightblob = ' ... '.$searchhighlightblob if $searchhighlightblob;
1329             $oldbiblio->{'searchhighlightblob'} = $searchhighlightblob;
1330         }
1331
1332         # Add search-term highlighting to the title, subtitle, etc. fields
1333         for my $term ( keys %$span_terms_hashref ) {
1334             my $old_term = $term;
1335             if ( length($term) > 3 ) {
1336                 $term =~ s/(.*=|\)|\(|\+|\.|\?|\[|\]|\\|\*)//g;
1337                                 foreach(qw(title subtitle author publishercode place pages notes size)) {
1338                         $oldbiblio->{$_} =~ s/$term/<span class=\"term\">$&<\/span>/gi;
1339                                 }
1340             }
1341         }
1342
1343         ($i % 2) and $oldbiblio->{'toggle'} = 1;
1344
1345         # Pull out the items fields
1346         my @fields = $marcrecord->field($itemtag);
1347
1348         # Setting item statuses for display
1349         my @available_items_loop;
1350         my @onloan_items_loop;
1351         my @other_items_loop;
1352
1353         my $available_items;
1354         my $onloan_items;
1355         my $other_items;
1356
1357         my $ordered_count     = 0;
1358         my $available_count   = 0;
1359         my $onloan_count      = 0;
1360         my $longoverdue_count = 0;
1361         my $other_count       = 0;
1362         my $wthdrawn_count    = 0;
1363         my $itemlost_count    = 0;
1364         my $itembinding_count = 0;
1365         my $itemdamaged_count = 0;
1366         my $can_place_holds   = 0;
1367         my $items_count       = scalar(@fields);
1368         my $items_counter;
1369         my $maxitems =
1370           ( C4::Context->preference('maxItemsinSearchResults') )
1371           ? C4::Context->preference('maxItemsinSearchResults') - 1
1372           : 1;
1373
1374         # loop through every item
1375         foreach my $field (@fields) {
1376             my $item;
1377             $items_counter++;
1378
1379             # populate the items hash
1380             foreach my $code ( keys %subfieldstosearch ) {
1381                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1382             }
1383                         my $hbranch     = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch'    : 'holdingbranch';
1384                         my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1385             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1386             if ($item->{$hbranch}) {
1387                 $item->{'branchname'} = $branches{$item->{$hbranch}};
1388             }
1389             elsif ($item->{$otherbranch}) {     # Last resort
1390                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1391             }
1392
1393                         my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1394 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1395             if ( $item->{onloan} ) {
1396                 $onloan_count++;
1397                                 my $key = $prefix . $item->{due_date};
1398                                 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1399                                 $onloan_items->{$key}->{count}++ if $item->{homebranch};
1400                                 $onloan_items->{$key}->{branchname} = $item->{branchname};
1401                                 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1402                                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1403                                 $onloan_items->{$key}->{imageurl} = getitemtypeimagesrc() . "/" . $itemtypes{ $item->{itype} }->{imageurl};
1404                 # if something's checked out and lost, mark it as 'long overdue'
1405                 if ( $item->{itemlost} ) {
1406                     $onloan_items->{$prefix}->{longoverdue}++;
1407                     $longoverdue_count++;
1408                 } else {        # can place holds as long as item isn't lost
1409                     $can_place_holds = 1;
1410                 }
1411             }
1412
1413          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1414             else {
1415
1416                 # item is on order
1417                 if ( $item->{notforloan} == -1 ) {
1418                     $ordered_count++;
1419                 }
1420
1421                 # item is withdrawn, lost or damaged
1422                 if (   $item->{wthdrawn}
1423                     || $item->{itemlost}
1424                     || $item->{damaged}
1425                     || $item->{notforloan} )
1426                 {
1427                     $wthdrawn_count++    if $item->{wthdrawn};
1428                     $itemlost_count++    if $item->{itemlost};
1429                     $itemdamaged_count++ if $item->{damaged};
1430                     $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1431                     $other_count++;
1432
1433                                         my $key = $prefix . $item->{status};
1434                                         foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber)) {
1435                         $other_items->{$key}->{$_} = $item->{$_};
1436                                         }
1437                                         $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value;
1438                                         $other_items->{$key}->{count}++ if $item->{homebranch};
1439                                         $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1440                                         $other_items->{$key}->{imageurl} = getitemtypeimagesrc() . "/" . $itemtypes{ $item->{itype} }->{imageurl};
1441                 }
1442                 # item is available
1443                 else {
1444                     $can_place_holds = 1;
1445                     $available_count++;
1446                                         $available_items->{$prefix}->{count}++ if $item->{homebranch};
1447                                         foreach (qw(branchname itemcallnumber)) {
1448                         $available_items->{$prefix}->{$_} = $item->{$_};
1449                                         }
1450                                         $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1451                                         $available_items->{$prefix}->{imageurl} = getitemtypeimagesrc() . "/" . $itemtypes{ $item->{itype} }->{imageurl};
1452                 }
1453             }
1454         }    # notforloan, item level and biblioitem level
1455         my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1456         $maxitems =
1457           ( C4::Context->preference('maxItemsinSearchResults') )
1458           ? C4::Context->preference('maxItemsinSearchResults') - 1
1459           : 1;
1460         for my $key ( sort keys %$onloan_items ) {
1461             (++$onloanitemscount > $maxitems) and last;
1462             push @onloan_items_loop, $onloan_items->{$key};
1463         }
1464         for my $key ( sort keys %$other_items ) {
1465             (++$otheritemscount > $maxitems) and last;
1466             push @other_items_loop, $other_items->{$key};
1467         }
1468         for my $key ( sort keys %$available_items ) {
1469             (++$availableitemscount > $maxitems) and last;
1470             push @available_items_loop, $available_items->{$key}
1471         }
1472
1473         # XSLT processing of some stuff
1474         if (C4::Context->preference("XSLTResultsDisplay") ) {
1475             my $newxmlrecord = XSLTParse4Display($oldbiblio->{biblionumber},C4::Context->config('opachtdocs')."/prog/en/xslt/MARC21slim2OPACResults.xsl");
1476             $oldbiblio->{XSLTResultsRecord} = $newxmlrecord;
1477         }
1478
1479         # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1480         $can_place_holds = 0
1481           if $itemtypes{ $oldbiblio->{itemtype} }->{notforloan};
1482         $oldbiblio->{norequests} = 1 unless $can_place_holds;
1483         $oldbiblio->{itemsplural}          = 1 if $items_count > 1;
1484         $oldbiblio->{items_count}          = $items_count;
1485         $oldbiblio->{available_items_loop} = \@available_items_loop;
1486         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
1487         $oldbiblio->{other_items_loop}     = \@other_items_loop;
1488         $oldbiblio->{availablecount}       = $available_count;
1489         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
1490         $oldbiblio->{onloancount}          = $onloan_count;
1491         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
1492         $oldbiblio->{othercount}           = $other_count;
1493         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
1494         $oldbiblio->{wthdrawncount}        = $wthdrawn_count;
1495         $oldbiblio->{itemlostcount}        = $itemlost_count;
1496         $oldbiblio->{damagedcount}         = $itemdamaged_count;
1497         $oldbiblio->{orderedcount}         = $ordered_count;
1498         $oldbiblio->{isbn} =~
1499           s/-//g;    # deleting - in isbn to enable amazon content
1500         $oldbiblio->{'authorised_value_images'}  = C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{'biblionumber'} ) );
1501         push( @newresults, $oldbiblio );
1502     }
1503     return @newresults;
1504 }
1505
1506 #----------------------------------------------------------------------
1507 #
1508 # Non-Zebra GetRecords#
1509 #----------------------------------------------------------------------
1510
1511 =head2 NZgetRecords
1512
1513   NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1514
1515 =cut
1516
1517 sub NZgetRecords {
1518     my (
1519         $query,            $simple_query, $sort_by_ref,    $servers_ref,
1520         $results_per_page, $offset,       $expanded_facet, $branches,
1521         $query_type,       $scan
1522     ) = @_;
1523     warn "query =$query" if $DEBUG;
1524     my $result = NZanalyse($query);
1525     warn "results =$result" if $DEBUG;
1526     return ( undef,
1527         NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1528         undef );
1529 }
1530
1531 =head2 NZanalyse
1532
1533   NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1534   the list is built from an inverted index in the nozebra SQL table
1535   note that title is here only for convenience : the sorting will be very fast when requested on title
1536   if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1537
1538 =cut
1539
1540 sub NZanalyse {
1541     my ( $string, $server ) = @_;
1542 #     warn "---------"       if $DEBUG;
1543     warn " NZanalyse" if $DEBUG;
1544 #     warn "---------"       if $DEBUG;
1545
1546  # $server contains biblioserver or authorities, depending on what we search on.
1547  #warn "querying : $string on $server";
1548     $server = 'biblioserver' unless $server;
1549
1550 # if we have a ", replace the content to discard temporarily any and/or/not inside
1551     my $commacontent;
1552     if ( $string =~ /"/ ) {
1553         $string =~ s/"(.*?)"/__X__/;
1554         $commacontent = $1;
1555         warn "commacontent : $commacontent" if $DEBUG;
1556     }
1557
1558 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1559 # then, call again NZanalyse with $left and $right
1560 # (recursive until we find a leaf (=> something without and/or/not)
1561 # delete repeated operator... Would then go in infinite loop
1562     while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
1563     }
1564
1565     #process parenthesis before.
1566     if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
1567         my $left     = $1;
1568         my $right    = $4;
1569         my $operator = lc($3);   # FIXME: and/or/not are operators, not operands
1570         warn
1571 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
1572           if $DEBUG;
1573         my $leftresult = NZanalyse( $left, $server );
1574         if ($operator) {
1575             my $rightresult = NZanalyse( $right, $server );
1576
1577             # OK, we have the results for right and left part of the query
1578             # depending of operand, intersect, union or exclude both lists
1579             # to get a result list
1580             if ( $operator eq ' and ' ) {
1581                 return NZoperatorAND($leftresult,$rightresult);
1582             }
1583             elsif ( $operator eq ' or ' ) {
1584
1585                 # just merge the 2 strings
1586                 return $leftresult . $rightresult;
1587             }
1588             elsif ( $operator eq ' not ' ) {
1589                 return NZoperatorNOT($leftresult,$rightresult);
1590             }
1591         }
1592         else {
1593 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1594             return $leftresult;
1595         }
1596     }
1597     warn "string :" . $string if $DEBUG;
1598     my $left = "";
1599     my $right = "";
1600     my $operator = "";
1601     if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
1602         $left     = $1;
1603         $right    = $3;
1604         $operator = lc($2);    # FIXME: and/or/not are operators, not operands
1605     }
1606     warn "no parenthesis. left : $left operator: $operator right: $right"
1607       if $DEBUG;
1608
1609     # it's not a leaf, we have a and/or/not
1610     if ($operator) {
1611
1612         # reintroduce comma content if needed
1613         $right =~ s/__X__/"$commacontent"/ if $commacontent;
1614         $left  =~ s/__X__/"$commacontent"/ if $commacontent;
1615         warn "node : $left / $operator / $right\n" if $DEBUG;
1616         my $leftresult  = NZanalyse( $left,  $server );
1617         my $rightresult = NZanalyse( $right, $server );
1618         warn " leftresult : $leftresult" if $DEBUG;
1619         warn " rightresult : $rightresult" if $DEBUG;
1620         # OK, we have the results for right and left part of the query
1621         # depending of operand, intersect, union or exclude both lists
1622         # to get a result list
1623         if ( $operator eq ' and ' ) {
1624             warn "NZAND";
1625             return NZoperatorAND($leftresult,$rightresult);
1626         }
1627         elsif ( $operator eq ' or ' ) {
1628
1629             # just merge the 2 strings
1630             return $leftresult . $rightresult;
1631         }
1632         elsif ( $operator eq ' not ' ) {
1633             return NZoperatorNOT($leftresult,$rightresult);
1634         }
1635         else {
1636
1637 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1638             die "error : operand unknown : $operator for $string";
1639         }
1640
1641         # it's a leaf, do the real SQL query and return the result
1642     }
1643     else {
1644         $string =~ s/__X__/"$commacontent"/ if $commacontent;
1645         $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1646         #remove trailing blank at the beginning
1647         $string =~ s/^ //g;
1648         warn "leaf:$string" if $DEBUG;
1649
1650         # parse the string in in operator/operand/value again
1651         my $left = "";
1652         my $operator = "";
1653         my $right = "";
1654         if ($string =~ /(.*)(>=|<=)(.*)/) {
1655             $left     = $1;
1656             $operator = $2;
1657             $right    = $3;
1658         } else {
1659             $left = $string;
1660         }
1661 #         warn "handling leaf... left:$left operator:$operator right:$right"
1662 #           if $DEBUG;
1663         unless ($operator) {
1664             if ($string =~ /(.*)(>|<|=)(.*)/) {
1665                 $left     = $1;
1666                 $operator = $2;
1667                 $right    = $3;
1668                 warn
1669     "handling unless (operator)... left:$left operator:$operator right:$right"
1670                 if $DEBUG;
1671             } else {
1672                 $left = $string;
1673             }
1674         }
1675         my $results;
1676
1677 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
1678         $left =~ s/ .*$//;
1679
1680         # automatic replace for short operators
1681         $left = 'title'            if $left =~ '^ti$';
1682         $left = 'author'           if $left =~ '^au$';
1683         $left = 'publisher'        if $left =~ '^pb$';
1684         $left = 'subject'          if $left =~ '^su$';
1685         $left = 'koha-Auth-Number' if $left =~ '^an$';
1686         $left = 'keyword'          if $left =~ '^kw$';
1687         warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
1688         if ( $operator && $left ne 'keyword' ) {
1689
1690             #do a specific search
1691             my $dbh = C4::Context->dbh;
1692             $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
1693             my $sth =
1694               $dbh->prepare(
1695 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
1696               );
1697             warn "$left / $operator / $right\n" if $DEBUG;
1698
1699             # split each word, query the DB and build the biblionumbers result
1700             #sanitizing leftpart
1701             $left =~ s/^\s+|\s+$//;
1702             foreach ( split / /, $right ) {
1703                 my $biblionumbers;
1704                 $_ =~ s/^\s+|\s+$//;
1705                 next unless $_;
1706                 warn "EXECUTE : $server, $left, $_" if $DEBUG;
1707                 $sth->execute( $server, $left, $_ )
1708                   or warn "execute failed: $!";
1709                 while ( my ( $line, $value ) = $sth->fetchrow ) {
1710
1711 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1712 # otherwise, fill the result
1713                     $biblionumbers .= $line
1714                       unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
1715                     warn "result : $value "
1716                       . ( $right  =~ /\d/ ) . "=="
1717                       . ( $value =~ /\D/?$line:"" ) if $DEBUG;         #= $line";
1718                 }
1719
1720 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1721                 if ($results) {
1722                     warn "NZAND" if $DEBUG;
1723                     $results = NZoperatorAND($biblionumbers,$results);
1724                 }
1725                 else {
1726                     $results = $biblionumbers;
1727                 }
1728             }
1729         }
1730         else {
1731
1732       #do a complete search (all indexes), if index='kw' do complete search too.
1733             my $dbh = C4::Context->dbh;
1734             my $sth =
1735               $dbh->prepare(
1736 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
1737               );
1738
1739             # split each word, query the DB and build the biblionumbers result
1740             foreach ( split / /, $string ) {
1741                 next if C4::Context->stopwords->{ uc($_) };   # skip if stopword
1742                 warn "search on all indexes on $_" if $DEBUG;
1743                 my $biblionumbers;
1744                 next unless $_;
1745                 $sth->execute( $server, $_ );
1746                 while ( my $line = $sth->fetchrow ) {
1747                     $biblionumbers .= $line;
1748                 }
1749
1750 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1751                 if ($results) {
1752                     $results = NZoperatorAND($biblionumbers,$results);
1753                 }
1754                 else {
1755                     warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
1756                     $results = $biblionumbers;
1757                 }
1758             }
1759         }
1760         warn "return : $results for LEAF : $string" if $DEBUG;
1761         return $results;
1762     }
1763     warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
1764 }
1765
1766 sub NZoperatorAND{
1767     my ($rightresult, $leftresult)=@_;
1768
1769     my @leftresult = split /;/, $leftresult;
1770     warn " @leftresult / $rightresult \n" if $DEBUG;
1771
1772     #             my @rightresult = split /;/,$leftresult;
1773     my $finalresult;
1774
1775 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1776 # the result is stored twice, to have the same weight for AND than OR.
1777 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1778 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1779     foreach (@leftresult) {
1780         my $value = $_;
1781         my $countvalue;
1782         ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
1783         if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
1784             $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
1785             $finalresult .=
1786                 "$value-$countvalue;$value-$countvalue;";
1787         }
1788     }
1789     warn "NZAND DONE : $finalresult \n" if $DEBUG;
1790     return $finalresult;
1791 }
1792
1793 sub NZoperatorOR{
1794     my ($rightresult, $leftresult)=@_;
1795     return $rightresult.$leftresult;
1796 }
1797
1798 sub NZoperatorNOT{
1799     my ($leftresult, $rightresult)=@_;
1800
1801     my @leftresult = split /;/, $leftresult;
1802
1803     #             my @rightresult = split /;/,$leftresult;
1804     my $finalresult;
1805     foreach (@leftresult) {
1806         my $value=$_;
1807         $value=$1 if $value=~m/(.*)-\d+$/;
1808         unless ($rightresult =~ "$value-") {
1809             $finalresult .= "$_;";
1810         }
1811     }
1812     return $finalresult;
1813 }
1814
1815 =head2 NZorder
1816
1817   $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1818
1819   TODO :: Description
1820
1821 =cut
1822
1823 sub NZorder {
1824     my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
1825     warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
1826
1827     # order title asc by default
1828     #     $ordering = '1=36 <i' unless $ordering;
1829     $results_per_page = 20 unless $results_per_page;
1830     $offset           = 0  unless $offset;
1831     my $dbh = C4::Context->dbh;
1832
1833     #
1834     # order by POPULARITY
1835     #
1836     if ( $ordering =~ /popularity/ ) {
1837         my %result;
1838         my %popularity;
1839
1840         # popularity is not in MARC record, it's builded from a specific query
1841         my $sth =
1842           $dbh->prepare("select sum(issues) from items where biblionumber=?");
1843         foreach ( split /;/, $biblionumbers ) {
1844             my ( $biblionumber, $title ) = split /,/, $_;
1845             $result{$biblionumber} = GetMarcBiblio($biblionumber);
1846             $sth->execute($biblionumber);
1847             my $popularity = $sth->fetchrow || 0;
1848
1849 # hint : the key is popularity.title because we can have
1850 # many results with the same popularity. In this cas, sub-ordering is done by title
1851 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1852 # (un-frequent, I agree, but we won't forget anything that way ;-)
1853             $popularity{ sprintf( "%10d", $popularity ) . $title
1854                   . $biblionumber } = $biblionumber;
1855         }
1856
1857     # sort the hash and return the same structure as GetRecords (Zebra querying)
1858         my $result_hash;
1859         my $numbers = 0;
1860         if ( $ordering eq 'popularity_dsc' ) {    # sort popularity DESC
1861             foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
1862                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1863                   $result{ $popularity{$key} }->as_usmarc();
1864             }
1865         }
1866         else {                                    # sort popularity ASC
1867             foreach my $key ( sort ( keys %popularity ) ) {
1868                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1869                   $result{ $popularity{$key} }->as_usmarc();
1870             }
1871         }
1872         my $finalresult = ();
1873         $result_hash->{'hits'}         = $numbers;
1874         $finalresult->{'biblioserver'} = $result_hash;
1875         return $finalresult;
1876
1877         #
1878         # ORDER BY author
1879         #
1880     }
1881     elsif ( $ordering =~ /author/ ) {
1882         my %result;
1883         foreach ( split /;/, $biblionumbers ) {
1884             my ( $biblionumber, $title ) = split /,/, $_;
1885             my $record = GetMarcBiblio($biblionumber);
1886             my $author;
1887             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1888                 $author = $record->subfield( '200', 'f' );
1889                 $author = $record->subfield( '700', 'a' ) unless $author;
1890             }
1891             else {
1892                 $author = $record->subfield( '100', 'a' );
1893             }
1894
1895 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1896 # and we don't want to get only 1 result for each of them !!!
1897             $result{ $author . $biblionumber } = $record;
1898         }
1899
1900     # sort the hash and return the same structure as GetRecords (Zebra querying)
1901         my $result_hash;
1902         my $numbers = 0;
1903         if ( $ordering eq 'author_za' ) {    # sort by author desc
1904             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1905                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1906                   $result{$key}->as_usmarc();
1907             }
1908         }
1909         else {                               # sort by author ASC
1910             foreach my $key ( sort ( keys %result ) ) {
1911                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1912                   $result{$key}->as_usmarc();
1913             }
1914         }
1915         my $finalresult = ();
1916         $result_hash->{'hits'}         = $numbers;
1917         $finalresult->{'biblioserver'} = $result_hash;
1918         return $finalresult;
1919
1920         #
1921         # ORDER BY callnumber
1922         #
1923     }
1924     elsif ( $ordering =~ /callnumber/ ) {
1925         my %result;
1926         foreach ( split /;/, $biblionumbers ) {
1927             my ( $biblionumber, $title ) = split /,/, $_;
1928             my $record = GetMarcBiblio($biblionumber);
1929             my $callnumber;
1930             my ( $callnumber_tag, $callnumber_subfield ) =
1931               GetMarcFromKohaField( $dbh, 'items.itemcallnumber' );
1932             ( $callnumber_tag, $callnumber_subfield ) =
1933               GetMarcFromKohaField('biblioitems.callnumber')
1934               unless $callnumber_tag;
1935             if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1936                 $callnumber = $record->subfield( '200', 'f' );
1937             }
1938             else {
1939                 $callnumber = $record->subfield( '100', 'a' );
1940             }
1941
1942 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1943 # and we don't want to get only 1 result for each of them !!!
1944             $result{ $callnumber . $biblionumber } = $record;
1945         }
1946
1947     # sort the hash and return the same structure as GetRecords (Zebra querying)
1948         my $result_hash;
1949         my $numbers = 0;
1950         if ( $ordering eq 'call_number_dsc' ) {    # sort by title desc
1951             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1952                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1953                   $result{$key}->as_usmarc();
1954             }
1955         }
1956         else {                                     # sort by title ASC
1957             foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
1958                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1959                   $result{$key}->as_usmarc();
1960             }
1961         }
1962         my $finalresult = ();
1963         $result_hash->{'hits'}         = $numbers;
1964         $finalresult->{'biblioserver'} = $result_hash;
1965         return $finalresult;
1966     }
1967     elsif ( $ordering =~ /pubdate/ ) {             #pub year
1968         my %result;
1969         foreach ( split /;/, $biblionumbers ) {
1970             my ( $biblionumber, $title ) = split /,/, $_;
1971             my $record = GetMarcBiblio($biblionumber);
1972             my ( $publicationyear_tag, $publicationyear_subfield ) =
1973               GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
1974             my $publicationyear =
1975               $record->subfield( $publicationyear_tag,
1976                 $publicationyear_subfield );
1977
1978 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1979 # and we don't want to get only 1 result for each of them !!!
1980             $result{ $publicationyear . $biblionumber } = $record;
1981         }
1982
1983     # sort the hash and return the same structure as GetRecords (Zebra querying)
1984         my $result_hash;
1985         my $numbers = 0;
1986         if ( $ordering eq 'pubdate_dsc' ) {    # sort by pubyear desc
1987             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1988                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1989                   $result{$key}->as_usmarc();
1990             }
1991         }
1992         else {                                 # sort by pub year ASC
1993             foreach my $key ( sort ( keys %result ) ) {
1994                 $result_hash->{'RECORDS'}[ $numbers++ ] =
1995                   $result{$key}->as_usmarc();
1996             }
1997         }
1998         my $finalresult = ();
1999         $result_hash->{'hits'}         = $numbers;
2000         $finalresult->{'biblioserver'} = $result_hash;
2001         return $finalresult;
2002
2003         #
2004         # ORDER BY title
2005         #
2006     }
2007     elsif ( $ordering =~ /title/ ) {
2008
2009 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
2010         my %result;
2011         foreach ( split /;/, $biblionumbers ) {
2012             my ( $biblionumber, $title ) = split /,/, $_;
2013
2014 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2015 # and we don't want to get only 1 result for each of them !!!
2016 # hint & speed improvement : we can order without reading the record
2017 # so order, and read records only for the requested page !
2018             $result{ $title . $biblionumber } = $biblionumber;
2019         }
2020
2021     # sort the hash and return the same structure as GetRecords (Zebra querying)
2022         my $result_hash;
2023         my $numbers = 0;
2024         if ( $ordering eq 'title_az' ) {    # sort by title desc
2025             foreach my $key ( sort ( keys %result ) ) {
2026                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2027             }
2028         }
2029         else {                              # sort by title ASC
2030             foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2031                 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2032             }
2033         }
2034
2035         # limit the $results_per_page to result size if it's more
2036         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2037
2038         # for the requested page, replace biblionumber by the complete record
2039         # speed improvement : avoid reading too much things
2040         for (
2041             my $counter = $offset ;
2042             $counter <= $offset + $results_per_page ;
2043             $counter++
2044           )
2045         {
2046             $result_hash->{'RECORDS'}[$counter] =
2047               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2048         }
2049         my $finalresult = ();
2050         $result_hash->{'hits'}         = $numbers;
2051         $finalresult->{'biblioserver'} = $result_hash;
2052         return $finalresult;
2053     }
2054     else {
2055
2056 #
2057 # order by ranking
2058 #
2059 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2060         my %result;
2061         my %count_ranking;
2062         foreach ( split /;/, $biblionumbers ) {
2063             my ( $biblionumber, $title ) = split /,/, $_;
2064             $title =~ /(.*)-(\d)/;
2065
2066             # get weight
2067             my $ranking = $2;
2068
2069 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2070 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2071 # biblio N has ranking = 6
2072             $count_ranking{$biblionumber} += $ranking;
2073         }
2074
2075 # build the result by "inverting" the count_ranking hash
2076 # 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
2077 #         warn "counting";
2078         foreach ( keys %count_ranking ) {
2079             $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2080         }
2081
2082     # sort the hash and return the same structure as GetRecords (Zebra querying)
2083         my $result_hash;
2084         my $numbers = 0;
2085         foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2086             $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2087         }
2088
2089         # limit the $results_per_page to result size if it's more
2090         $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2091
2092         # for the requested page, replace biblionumber by the complete record
2093         # speed improvement : avoid reading too much things
2094         for (
2095             my $counter = $offset ;
2096             $counter <= $offset + $results_per_page ;
2097             $counter++
2098           )
2099         {
2100             $result_hash->{'RECORDS'}[$counter] =
2101               GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2102               if $result_hash->{'RECORDS'}[$counter];
2103         }
2104         my $finalresult = ();
2105         $result_hash->{'hits'}         = $numbers;
2106         $finalresult->{'biblioserver'} = $result_hash;
2107         return $finalresult;
2108     }
2109 }
2110
2111 =head2 ModBiblios
2112
2113 ($countchanged,$listunchanged) = ModBiblios($listbiblios, $tagsubfield,$initvalue,$targetvalue,$test);
2114
2115 this function changes all the values $initvalue in subfield $tag$subfield in any record in $listbiblios
2116 test parameter if set donot perform change to records in database.
2117
2118 =over 2
2119
2120 =item C<input arg:>
2121
2122     * $listbiblios is an array ref to marcrecords to be changed
2123     * $tagsubfield is the reference of the subfield to change.
2124     * $initvalue is the value to search the record for
2125     * $targetvalue is the value to set the subfield to
2126     * $test is to be set only not to perform changes in database.
2127
2128 =item C<Output arg:>
2129     * $countchanged counts all the changes performed.
2130     * $listunchanged contains the list of all the biblionumbers of records unchanged.
2131
2132 =item C<usage in the script:>
2133
2134 =back
2135
2136 my ($countchanged, $listunchanged) = EditBiblios($results->{RECORD}, $tagsubfield,$initvalue,$targetvalue);;
2137 #If one wants to display unchanged records, you should get biblios foreach @$listunchanged
2138 $template->param(countchanged => $countchanged, loopunchanged=>$listunchanged);
2139
2140 =cut
2141
2142 sub ModBiblios {
2143     my ( $listbiblios, $tagsubfield, $initvalue, $targetvalue, $test ) = @_;
2144     my $countmatched;
2145     my @unmatched;
2146     my ( $tag, $subfield ) = ( $1, $2 )
2147       if ( $tagsubfield =~ /^(\d{1,3})([a-z0-9A-Z@])?$/ );
2148     if ( ( length($tag) < 3 ) && $subfield =~ /0-9/ ) {
2149         $tag = $tag . $subfield;
2150         undef $subfield;
2151     }
2152     my ( $bntag,   $bnsubf )   = GetMarcFromKohaField('biblio.biblionumber');
2153     my ( $itemtag, $itemsubf ) = GetMarcFromKohaField('items.itemnumber');
2154     if ($tag eq $itemtag) {
2155         # do not allow the embedded item tag to be
2156         # edited from here
2157         warn "Attempting to edit item tag via C4::Search::ModBiblios -- not allowed";
2158         return (0, []);
2159     }
2160     foreach my $usmarc (@$listbiblios) {
2161         my $record;
2162         $record = eval { MARC::Record->new_from_usmarc($usmarc) };
2163         my $biblionumber;
2164         if ($@) {
2165
2166             # usmarc is not a valid usmarc May be a biblionumber
2167             # FIXME - sorry, please let's figure out whether
2168             #         this function is to be passed a list of
2169             #         record numbers or a list of MARC::Record
2170             #         objects.  The former is probably better
2171             #         because the MARC records supplied by Zebra
2172             #         may be not current.
2173             $record       = GetMarcBiblio($usmarc);
2174             $biblionumber = $usmarc;
2175         }
2176         else {
2177             if ( $bntag >= 010 ) {
2178                 $biblionumber = $record->subfield( $bntag, $bnsubf );
2179             }
2180             else {
2181                 $biblionumber = $record->field($bntag)->data;
2182             }
2183         }
2184
2185         #GetBiblionumber is to be written.
2186         #Could be replaced by TransformMarcToKoha (But Would be longer)
2187         if ( $record->field($tag) ) {
2188             my $modify = 0;
2189             foreach my $field ( $record->field($tag) ) {
2190                 if ($subfield) {
2191                     if (
2192                         $field->delete_subfield(
2193                             'code'  => $subfield,
2194                             'match' => qr($initvalue)
2195                         )
2196                       )
2197                     {
2198                         $countmatched++;
2199                         $modify = 1;
2200                         $field->update( $subfield, $targetvalue )
2201                           if ($targetvalue);
2202                     }
2203                 }
2204                 else {
2205                     if ( $tag >= 010 ) {
2206                         if ( $field->delete_field($field) ) {
2207                             $countmatched++;
2208                             $modify = 1;
2209                         }
2210                     }
2211                     else {
2212                         $field->data = $targetvalue
2213                           if ( $field->data =~ qr($initvalue) );
2214                     }
2215                 }
2216             }
2217
2218             #       warn $record->as_formatted;
2219             if ($modify) {
2220                 ModBiblio( $record, $biblionumber,
2221                     GetFrameworkCode($biblionumber) )
2222                   unless ($test);
2223             }
2224             else {
2225                 push @unmatched, $biblionumber;
2226             }
2227         }
2228         else {
2229             push @unmatched, $biblionumber;
2230         }
2231     }
2232     return ( $countmatched, \@unmatched );
2233 }
2234
2235 END { }    # module clean-up code here (global destructor)
2236
2237 1;
2238 __END__
2239
2240 =head1 AUTHOR
2241
2242 Koha Developement team <info@koha.org>
2243
2244 =cut