bug 8215: (followup) make sure C4::CourseReserves doesn't export anything
[koha.git] / 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 #use warnings; FIXME - Bug 2505
20 require Exporter;
21 use C4::Context;
22 use C4::Biblio;    # GetMarcFromKohaField, GetBiblioData
23 use C4::Koha;      # getFacets
24 use Lingua::Stem;
25 use C4::Search::PazPar2;
26 use XML::Simple;
27 use C4::Dates qw(format_date);
28 use C4::Members qw(GetHideLostItemsPreference);
29 use C4::XSLT;
30 use C4::Branch;
31 use C4::Reserves;    # GetReserveStatus
32 use C4::Debug;
33 use C4::Charset;
34 use YAML;
35 use URI::Escape;
36 use Business::ISBN;
37 use MARC::Record;
38 use MARC::Field;
39 use utf8;
40 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
41
42 # set the version for version checking
43 BEGIN {
44     $VERSION = 3.07.00.049;
45     $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
46 }
47
48 =head1 NAME
49
50 C4::Search - Functions for searching the Koha catalog.
51
52 =head1 SYNOPSIS
53
54 See opac/opac-search.pl or catalogue/search.pl for example of usage
55
56 =head1 DESCRIPTION
57
58 This module provides searching functions for Koha's bibliographic databases
59
60 =head1 FUNCTIONS
61
62 =cut
63
64 @ISA    = qw(Exporter);
65 @EXPORT = qw(
66   &FindDuplicate
67   &SimpleSearch
68   &searchResults
69   &getRecords
70   &buildQuery
71   &AddSearchHistory
72   &GetDistinctValues
73   &enabled_staff_search_views
74   &SimpleSearch
75 );
76
77 # make all your functions, whether exported or not;
78
79 =head2 FindDuplicate
80
81 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
82
83 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
84
85 =cut
86
87 sub FindDuplicate {
88     my ($record) = @_;
89     my $dbh = C4::Context->dbh;
90     my $result = TransformMarcToKoha( $dbh, $record, '' );
91     my $sth;
92     my $query;
93     my $search;
94     my $type;
95     my ( $biblionumber, $title );
96
97     # search duplicate on ISBN, easy and fast..
98     # ... normalize first
99     if ( $result->{isbn} ) {
100         $result->{isbn} =~ s/\(.*$//;
101         $result->{isbn} =~ s/\s+$//;
102         $query = "isbn:$result->{isbn}";
103     }
104     else {
105         my $QParser;
106         $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
107         my $titleindex;
108         my $authorindex;
109         my $op;
110
111         if ($QParser) {
112             $titleindex = 'title|exact';
113             $authorindex = 'author|exact';
114             $op = '&&';
115             $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
116         } else {
117             $titleindex = 'ti,ext';
118             $authorindex = 'au,ext';
119             $op = 'and';
120         }
121
122         $result->{title} =~ s /\\//g;
123         $result->{title} =~ s /\"//g;
124         $result->{title} =~ s /\(//g;
125         $result->{title} =~ s /\)//g;
126
127         # FIXME: instead of removing operators, could just do
128         # quotes around the value
129         $result->{title} =~ s/(and|or|not)//g;
130         $query = "$titleindex:\"$result->{title}\"";
131         if   ( $result->{author} ) {
132             $result->{author} =~ s /\\//g;
133             $result->{author} =~ s /\"//g;
134             $result->{author} =~ s /\(//g;
135             $result->{author} =~ s /\)//g;
136
137             # remove valid operators
138             $result->{author} =~ s/(and|or|not)//g;
139             $query .= " $op $authorindex:\"$result->{author}\"";
140         }
141     }
142
143     my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
144     my @results;
145     if (!defined $error) {
146         foreach my $possible_duplicate_record (@{$searchresults}) {
147             my $marcrecord =
148             MARC::Record->new_from_usmarc($possible_duplicate_record);
149             my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
150
151             # FIXME :: why 2 $biblionumber ?
152             if ($result) {
153                 push @results, $result->{'biblionumber'};
154                 push @results, $result->{'title'};
155             }
156         }
157     }
158     return @results;
159 }
160
161 =head2 SimpleSearch
162
163 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
164
165 This function provides a simple search API on the bibliographic catalog
166
167 =over 2
168
169 =item C<input arg:>
170
171     * $query can be a simple keyword or a complete CCL query
172     * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
173     * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
174     * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
175
176
177 =item C<Return:>
178
179     Returns an array consisting of three elements
180     * $error is undefined unless an error is detected
181     * $results is a reference to an array of records.
182     * $total_hits is the number of hits that would have been returned with no limit
183
184     If an error is returned the two other return elements are undefined. If error itself is undefined
185     the other two elements are always defined
186
187 =item C<usage in the script:>
188
189 =back
190
191 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
192
193 if (defined $error) {
194     $template->param(query_error => $error);
195     warn "error: ".$error;
196     output_html_with_http_headers $input, $cookie, $template->output;
197     exit;
198 }
199
200 my $hits = @{$marcresults};
201 my @results;
202
203 for my $r ( @{$marcresults} ) {
204     my $marcrecord = MARC::File::USMARC::decode($r);
205     my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,q{});
206
207     #build the iarray of hashs for the template.
208     push @results, {
209         title           => $biblio->{'title'},
210         subtitle        => $biblio->{'subtitle'},
211         biblionumber    => $biblio->{'biblionumber'},
212         author          => $biblio->{'author'},
213         publishercode   => $biblio->{'publishercode'},
214         publicationyear => $biblio->{'publicationyear'},
215         };
216
217 }
218
219 $template->param(result=>\@results);
220
221 =cut
222
223 sub SimpleSearch {
224     my ( $query, $offset, $max_results, $servers )  = @_;
225
226     return ( 'No query entered', undef, undef ) unless $query;
227     # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
228     my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
229     my @zoom_queries;
230     my @tmpresults;
231     my @zconns;
232     my $results = [];
233     my $total_hits = 0;
234
235     my $QParser;
236     $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') && ! ($query =~ m/\w,\w|\w=\w/));
237     if ($QParser) {
238         $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
239     }
240
241     # Initialize & Search Zebra
242     for ( my $i = 0 ; $i < @servers ; $i++ ) {
243         eval {
244             $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
245             if ($QParser) {
246                 $query =~ s/=/:/g;
247                 $QParser->parse( $query );
248                 $query = $QParser->target_syntax($servers[$i]);
249                 $zoom_queries[$i] = new ZOOM::Query::PQF( $query, $zconns[$i]);
250             } else {
251                 $query =~ s/:/=/g;
252                 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
253             }
254             $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
255
256             # error handling
257             my $error =
258                 $zconns[$i]->errmsg() . " ("
259               . $zconns[$i]->errcode() . ") "
260               . $zconns[$i]->addinfo() . " "
261               . $zconns[$i]->diagset();
262
263             return ( $error, undef, undef ) if $zconns[$i]->errcode();
264         };
265         if ($@) {
266
267             # caught a ZOOM::Exception
268             my $error =
269                 $@->message() . " ("
270               . $@->code() . ") "
271               . $@->addinfo() . " "
272               . $@->diagset();
273             warn $error." for query: $query";
274             return ( $error, undef, undef );
275         }
276     }
277
278     _ZOOM_event_loop(
279         \@zconns,
280         \@tmpresults,
281         sub {
282             my ($i, $size) = @_;
283             my $first_record = defined($offset) ? $offset + 1 : 1;
284             my $hits = $tmpresults[ $i - 1 ]->size();
285             $total_hits += $hits;
286             my $last_record = $hits;
287             if ( defined $max_results && $offset + $max_results < $hits ) {
288                 $last_record = $offset + $max_results;
289             }
290
291             for my $j ( $first_record .. $last_record ) {
292                 my $record =
293                   $tmpresults[ $i - 1 ]->record( $j - 1 )->raw()
294                   ;    # 0 indexed
295                 push @{$results}, $record;
296             }
297         }
298     );
299
300     foreach my $zoom_query (@zoom_queries) {
301         $zoom_query->destroy();
302     }
303
304     return ( undef, $results, $total_hits );
305 }
306
307 =head2 getRecords
308
309 ( undef, $results_hashref, \@facets_loop ) = getRecords (
310
311         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
312         $results_per_page, $offset,       $expanded_facet, $branches,$itemtypes,
313         $query_type,       $scan
314     );
315
316 The all singing, all dancing, multi-server, asynchronous, scanning,
317 searching, record nabbing, facet-building
318
319 See verbse embedded documentation.
320
321 =cut
322
323 sub getRecords {
324     my (
325         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
326         $results_per_page, $offset,       $expanded_facet, $branches,
327         $itemtypes,        $query_type,   $scan,           $opac
328     ) = @_;
329
330     my @servers = @$servers_ref;
331     my @sort_by = @$sort_by_ref;
332
333     # Initialize variables for the ZOOM connection and results object
334     my $zconn;
335     my @zconns;
336     my @results;
337     my $results_hashref = ();
338
339     # Initialize variables for the faceted results objects
340     my $facets_counter = ();
341     my $facets_info    = ();
342     my $facets         = getFacets();
343     my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets')||20;
344
345     my @facets_loop;    # stores the ref to array of hashes for template facets loop
346
347     ### LOOP THROUGH THE SERVERS
348     for ( my $i = 0 ; $i < @servers ; $i++ ) {
349         $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
350
351 # perform the search, create the results objects
352 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
353         my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
354
355         #$query_to_use = $simple_query if $scan;
356         warn $simple_query if ( $scan and $DEBUG );
357
358         # Check if we've got a query_type defined, if so, use it
359         eval {
360             if ($query_type) {
361                 if ($query_type =~ /^ccl/) {
362                     $query_to_use =~ s/\:/\=/g;    # change : to = last minute (FIXME)
363                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
364                 } elsif ($query_type =~ /^cql/) {
365                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
366                 } elsif ($query_type =~ /^pqf/) {
367                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
368                 } else {
369                     warn "Unknown query_type '$query_type'.  Results undetermined.";
370                 }
371             } elsif ($scan) {
372                     $results[$i] = $zconns[$i]->scan(  new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
373             } else {
374                     $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
375             }
376         };
377         if ($@) {
378             warn "WARNING: query problem with $query_to_use " . $@;
379         }
380
381         # Concatenate the sort_by limits and pass them to the results object
382         # Note: sort will override rank
383         my $sort_by;
384         foreach my $sort (@sort_by) {
385             if ( $sort eq "author_az" || $sort eq "author_asc" ) {
386                 $sort_by .= "1=1003 <i ";
387             }
388             elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
389                 $sort_by .= "1=1003 >i ";
390             }
391             elsif ( $sort eq "popularity_asc" ) {
392                 $sort_by .= "1=9003 <i ";
393             }
394             elsif ( $sort eq "popularity_dsc" ) {
395                 $sort_by .= "1=9003 >i ";
396             }
397             elsif ( $sort eq "call_number_asc" ) {
398                 $sort_by .= "1=8007  <i ";
399             }
400             elsif ( $sort eq "call_number_dsc" ) {
401                 $sort_by .= "1=8007 >i ";
402             }
403             elsif ( $sort eq "pubdate_asc" ) {
404                 $sort_by .= "1=31 <i ";
405             }
406             elsif ( $sort eq "pubdate_dsc" ) {
407                 $sort_by .= "1=31 >i ";
408             }
409             elsif ( $sort eq "acqdate_asc" ) {
410                 $sort_by .= "1=32 <i ";
411             }
412             elsif ( $sort eq "acqdate_dsc" ) {
413                 $sort_by .= "1=32 >i ";
414             }
415             elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
416                 $sort_by .= "1=4 <i ";
417             }
418             elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
419                 $sort_by .= "1=4 >i ";
420             }
421             else {
422                 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
423             }
424         }
425         if ($sort_by && !$scan) {
426             if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
427                 warn "WARNING sort $sort_by failed";
428             }
429         }
430     }    # finished looping through servers
431
432     # The big moment: asynchronously retrieve results from all servers
433         _ZOOM_event_loop(
434             \@zconns,
435             \@results,
436             sub {
437                 my ( $i, $size ) = @_;
438                 my $results_hash;
439
440                 # loop through the results
441                 $results_hash->{'hits'} = $size;
442                 my $times;
443                 if ( $offset + $results_per_page <= $size ) {
444                     $times = $offset + $results_per_page;
445                 }
446                 else {
447                     $times = $size;
448                 }
449                 for ( my $j = $offset ; $j < $times ; $j++ ) {
450                     my $records_hash;
451                     my $record;
452
453                     ## Check if it's an index scan
454                     if ($scan) {
455                         my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
456
457                  # here we create a minimal MARC record and hand it off to the
458                  # template just like a normal result ... perhaps not ideal, but
459                  # it works for now
460                         my $tmprecord = MARC::Record->new();
461                         $tmprecord->encoding('UTF-8');
462                         my $tmptitle;
463                         my $tmpauthor;
464
465                 # the minimal record in author/title (depending on MARC flavour)
466                         if ( C4::Context->preference("marcflavour") eq
467                             "UNIMARC" )
468                         {
469                             $tmptitle = MARC::Field->new(
470                                 '200', ' ', ' ',
471                                 a => $term,
472                                 f => $occ
473                             );
474                             $tmprecord->append_fields($tmptitle);
475                         }
476                         else {
477                             $tmptitle =
478                               MARC::Field->new( '245', ' ', ' ', a => $term, );
479                             $tmpauthor =
480                               MARC::Field->new( '100', ' ', ' ', a => $occ, );
481                             $tmprecord->append_fields($tmptitle);
482                             $tmprecord->append_fields($tmpauthor);
483                         }
484                         $results_hash->{'RECORDS'}[$j] =
485                           $tmprecord->as_usmarc();
486                     }
487
488                     # not an index scan
489                     else {
490                         $record = $results[ $i - 1 ]->record($j)->raw();
491
492                         # warn "RECORD $j:".$record;
493                         $results_hash->{'RECORDS'}[$j] = $record;
494                     }
495
496                 }
497                 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
498
499 # Fill the facets while we're looping, but only for the biblioserver and not for a scan
500                 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
501
502                     my $jmax =
503                       $size > $facets_maxrecs ? $facets_maxrecs : $size;
504                     for my $facet (@$facets) {
505                         for ( my $j = 0 ; $j < $jmax ; $j++ ) {
506                             my $render_record =
507                               $results[ $i - 1 ]->record($j)->render();
508                             my @used_datas = ();
509                             foreach my $tag ( @{ $facet->{tags} } ) {
510
511                                 # avoid first line
512                                 my $tag_num = substr( $tag, 0, 3 );
513                                 my $letters = substr( $tag, 3 );
514                                 my $field_pattern =
515                                   '\n' . $tag_num . ' ([^z][^\n]+)';
516                                 $field_pattern = '\n' . $tag_num . ' ([^\n]+)'
517                                   if ( int($tag_num) < 10 );
518                                 my @field_tokens =
519                                   ( $render_record =~ /$field_pattern/g );
520                                 foreach my $field_token (@field_tokens) {
521                                     my @subf = ( $field_token =~
522                                           /\$([a-zA-Z0-9]) ([^\$]+)/g );
523                                     my @values;
524                                     for ( my $i = 0 ; $i < @subf ; $i += 2 ) {
525                                         if ( $letters =~ $subf[$i] ) {
526                                             my $value = $subf[ $i + 1 ];
527                                             $value =~ s/^ *//;
528                                             $value =~ s/ *$//;
529                                             push @values, $value;
530                                         }
531                                     }
532                                     my $data = join( $facet->{sep}, @values );
533                                     unless ( $data ~~ @used_datas ) {
534                                         $facets_counter->{ $facet->{idx} }
535                                           ->{$data}++;
536                                         push @used_datas, $data;
537                                     }
538                                 }    # fields
539                             }    # field codes
540                         }    # records
541                         $facets_info->{ $facet->{idx} }->{label_value} =
542                           $facet->{label};
543                         $facets_info->{ $facet->{idx} }->{expanded} =
544                           $facet->{expanded};
545                     }    # facets
546                 }
547
548                 # warn "connection ", $i-1, ": $size hits";
549                 # warn $results[$i-1]->record(0)->render() if $size > 0;
550
551                 # BUILD FACETS
552                 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
553                     for my $link_value (
554                         sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
555                         keys %$facets_counter
556                       )
557                     {
558                         my $expandable;
559                         my $number_of_facets;
560                         my @this_facets_array;
561                         for my $one_facet (
562                             sort {
563                                 $facets_counter->{$link_value}
564                                   ->{$b} <=> $facets_counter->{$link_value}
565                                   ->{$a}
566                             } keys %{ $facets_counter->{$link_value} }
567                           )
568                         {
569                             $number_of_facets++;
570                             if (   ( $number_of_facets < 6 )
571                                 || ( $expanded_facet eq $link_value )
572                                 || ( $facets_info->{$link_value}->{'expanded'} )
573                               )
574                             {
575
576 # Sanitize the link value : parenthesis, question and exclamation mark will cause errors with CCL
577                                 my $facet_link_value = $one_facet;
578                                 $facet_link_value =~ s/[()!?¡¿؟]/ /g;
579
580                                 # fix the length that will display in the label,
581                                 my $facet_label_value = $one_facet;
582                                 my $facet_max_length  = C4::Context->preference(
583                                     'FacetLabelTruncationLength')
584                                   || 20;
585                                 $facet_label_value =
586                                   substr( $one_facet, 0, $facet_max_length )
587                                   . "..."
588                                   if length($facet_label_value) >
589                                       $facet_max_length;
590
591                             # if it's a branch, label by the name, not the code,
592                                 if ( $link_value =~ /branch/ ) {
593                                     if (   defined $branches
594                                         && ref($branches) eq "HASH"
595                                         && defined $branches->{$one_facet}
596                                         && ref( $branches->{$one_facet} ) eq
597                                         "HASH" )
598                                     {
599                                         $facet_label_value =
600                                           $branches->{$one_facet}
601                                           ->{'branchname'};
602                                     }
603                                     else {
604                                         $facet_label_value = "*";
605                                     }
606                                 }
607
608                           # if it's a itemtype, label by the name, not the code,
609                                 if ( $link_value =~ /itype/ ) {
610                                     if (   defined $itemtypes
611                                         && ref($itemtypes) eq "HASH"
612                                         && defined $itemtypes->{$one_facet}
613                                         && ref( $itemtypes->{$one_facet} ) eq
614                                         "HASH" )
615                                     {
616                                         $facet_label_value =
617                                           $itemtypes->{$one_facet}
618                                           ->{'description'};
619                                     }
620                                 }
621
622                # also, if it's a location code, use the name instead of the code
623                                 if ( $link_value =~ /location/ ) {
624                                     $facet_label_value =
625                                       GetKohaAuthorisedValueLib( 'LOC',
626                                         $one_facet, $opac );
627                                 }
628
629                 # but we're down with the whole label being in the link's title.
630                                 push @this_facets_array,
631                                   {
632                                     facet_count =>
633                                       $facets_counter->{$link_value}
634                                       ->{$one_facet},
635                                     facet_label_value => $facet_label_value,
636                                     facet_title_value => $one_facet,
637                                     facet_link_value  => $facet_link_value,
638                                     type_link_value   => $link_value,
639                                   }
640                                   if ($facet_label_value);
641                             }
642                         }
643
644                         # handle expanded option
645                         unless ( $facets_info->{$link_value}->{'expanded'} ) {
646                             $expandable = 1
647                               if ( ( $number_of_facets > 6 )
648                                 && ( $expanded_facet ne $link_value ) );
649                         }
650                         push @facets_loop,
651                           {
652                             type_link_value => $link_value,
653                             type_id         => $link_value . "_id",
654                             "type_label_"
655                               . $facets_info->{$link_value}->{'label_value'} =>
656                               1,
657                             facets     => \@this_facets_array,
658                             expandable => $expandable,
659                             expand     => $link_value,
660                           }
661                           unless (
662                             (
663                                 $facets_info->{$link_value}->{'label_value'} =~
664                                 /Libraries/
665                             )
666                             and ( C4::Context->preference('singleBranchMode') )
667                           );
668                     }
669                 }
670             }
671         );
672     return ( undef, $results_hashref, \@facets_loop );
673 }
674
675 sub pazGetRecords {
676     my (
677         $koha_query,       $simple_query, $sort_by_ref,    $servers_ref,
678         $results_per_page, $offset,       $expanded_facet, $branches,
679         $query_type,       $scan
680     ) = @_;
681
682     my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
683     $paz->init();
684     $paz->search($simple_query);
685     sleep 1;   # FIXME: WHY?
686
687     # do results
688     my $results_hashref = {};
689     my $stats = XMLin($paz->stat);
690     my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
691
692     # for a grouped search result, the number of hits
693     # is the number of groups returned; 'bib_hits' will have
694     # the total number of bibs.
695     $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
696     $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
697
698     HIT: foreach my $hit (@{ $results->{'hit'} }) {
699         my $recid = $hit->{recid}->[0];
700
701         my $work_title = $hit->{'md-work-title'}->[0];
702         my $work_author;
703         if (exists $hit->{'md-work-author'}) {
704             $work_author = $hit->{'md-work-author'}->[0];
705         }
706         my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
707
708         my $result_group = {};
709         $result_group->{'group_label'} = $group_label;
710         $result_group->{'group_merge_key'} = $recid;
711
712         my $count = 1;
713         if (exists $hit->{count}) {
714             $count = $hit->{count}->[0];
715         }
716         $result_group->{'group_count'} = $count;
717
718         for (my $i = 0; $i < $count; $i++) {
719             # FIXME -- may need to worry about diacritics here
720             my $rec = $paz->record($recid, $i);
721             push @{ $result_group->{'RECORDS'} }, $rec;
722         }
723
724         push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
725     }
726
727     # pass through facets
728     my $termlist_xml = $paz->termlist('author,subject');
729     my $terms = XMLin($termlist_xml, forcearray => 1);
730     my @facets_loop = ();
731     #die Dumper($results);
732 #    foreach my $list (sort keys %{ $terms->{'list'} }) {
733 #        my @facets = ();
734 #        foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
735 #            push @facets, {
736 #                facet_label_value => $facet->{'name'}->[0],
737 #            };
738 #        }
739 #        push @facets_loop, ( {
740 #            type_label => $list,
741 #            facets => \@facets,
742 #        } );
743 #    }
744
745     return ( undef, $results_hashref, \@facets_loop );
746 }
747
748 # STOPWORDS
749 sub _remove_stopwords {
750     my ( $operand, $index ) = @_;
751     my @stopwords_removed;
752
753     # phrase and exact-qualified indexes shouldn't have stopwords removed
754     if ( $index !~ m/phr|ext/ ) {
755
756 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
757 #       we use IsAlpha unicode definition, to deal correctly with diacritics.
758 #       otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
759 #       is a stopword, we'd get "çon" and wouldn't find anything...
760 #
761                 foreach ( keys %{ C4::Context->stopwords } ) {
762                         next if ( $_ =~ /(and|or|not)/ );    # don't remove operators
763                         if ( my ($matched) = ($operand =~
764                                 /([^\X\p{isAlnum}]\Q$_\E[^\X\p{isAlnum}]|[^\X\p{isAlnum}]\Q$_\E$|^\Q$_\E[^\X\p{isAlnum}])/gi))
765                         {
766                                 $operand =~ s/\Q$matched\E/ /gi;
767                                 push @stopwords_removed, $_;
768                         }
769                 }
770         }
771     return ( $operand, \@stopwords_removed );
772 }
773
774 # TRUNCATION
775 sub _detect_truncation {
776     my ( $operand, $index ) = @_;
777     my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
778         @regexpr );
779     $operand =~ s/^ //g;
780     my @wordlist = split( /\s/, $operand );
781     foreach my $word (@wordlist) {
782         if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
783             push @rightlefttruncated, $word;
784         }
785         elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
786             push @lefttruncated, $word;
787         }
788         elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
789             push @righttruncated, $word;
790         }
791         elsif ( index( $word, "*" ) < 0 ) {
792             push @nontruncated, $word;
793         }
794         else {
795             push @regexpr, $word;
796         }
797     }
798     return (
799         \@nontruncated,       \@righttruncated, \@lefttruncated,
800         \@rightlefttruncated, \@regexpr
801     );
802 }
803
804 # STEMMING
805 sub _build_stemmed_operand {
806     my ($operand,$lang) = @_;
807     require Lingua::Stem::Snowball ;
808     my $stemmed_operand=q{};
809
810     # If operand contains a digit, it is almost certainly an identifier, and should
811     # not be stemmed.  This is particularly relevant for ISBNs and ISSNs, which
812     # can contain the letter "X" - for example, _build_stemmend_operand would reduce
813     # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
814     # results (e.g., "23 x 29 cm." from the 300$c).  Bug 2098.
815     return $operand if $operand =~ /\d/;
816
817 # FIXME: the locale should be set based on the user's language and/or search choice
818     #warn "$lang";
819     # Make sure we only use the first two letters from the language code
820     $lang = lc(substr($lang, 0, 2));
821     # The language codes for the two variants of Norwegian will now be "nb" and "nn",
822     # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
823     if ($lang eq 'nb' || $lang eq 'nn') {
824       $lang = 'no';
825     }
826     my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
827                                                encoding => "UTF-8" );
828
829     my @words = split( / /, $operand );
830     my @stems = $stemmer->stem(\@words);
831     for my $stem (@stems) {
832         $stemmed_operand .= "$stem";
833         $stemmed_operand .= "?"
834           unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
835         $stemmed_operand .= " ";
836     }
837     warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
838     return $stemmed_operand;
839 }
840
841 # FIELD WEIGHTING
842 sub _build_weighted_query {
843
844 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
845 # pretty well but could work much better if we had a smarter query parser
846     my ( $operand, $stemmed_operand, $index ) = @_;
847     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
848     my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
849     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy")        || 0;
850
851     my $weighted_query .= "(rk=(";    # Specifies that we're applying rank
852
853     # Keyword, or, no index specified
854     if ( ( $index eq 'kw' ) || ( !$index ) ) {
855         $weighted_query .=
856           "Title-cover,ext,r1=\"$operand\"";    # exact title-cover
857         $weighted_query .= " or ti,ext,r2=\"$operand\"";    # exact title
858         $weighted_query .= " or Title-cover,phr,r3=\"$operand\"";    # phrase title
859           #$weighted_query .= " or any,ext,r4=$operand";               # exact any
860           #$weighted_query .=" or kw,wrdl,r5=\"$operand\"";            # word list any
861         $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
862           if $fuzzy_enabled;    # add fuzzy, word list
863         $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
864           if ( $stemming and $stemmed_operand )
865           ;                     # add stemming, right truncation
866         $weighted_query .= " or wrdl,r9=\"$operand\"";
867
868         # embedded sorting: 0 a-z; 1 z-a
869         # $weighted_query .= ") or (sort1,aut=1";
870     }
871
872     # Barcode searches should skip this process
873     elsif ( $index eq 'bc' ) {
874         $weighted_query .= "bc=\"$operand\"";
875     }
876
877     # Authority-number searches should skip this process
878     elsif ( $index eq 'an' ) {
879         $weighted_query .= "an=\"$operand\"";
880     }
881
882     # If the index already has more than one qualifier, wrap the operand
883     # in quotes and pass it back (assumption is that the user knows what they
884     # are doing and won't appreciate us mucking up their query
885     elsif ( $index =~ ',' ) {
886         $weighted_query .= " $index=\"$operand\"";
887     }
888
889     #TODO: build better cases based on specific search indexes
890     else {
891         $weighted_query .= " $index,ext,r1=\"$operand\"";    # exact index
892           #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
893         $weighted_query .= " or $index,phr,r3=\"$operand\"";    # phrase index
894         $weighted_query .= " or $index,wrdl,r6=\"$operand\"";    # word list index
895         $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
896           if $fuzzy_enabled;    # add fuzzy, word list
897         $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
898           if ( $stemming and $stemmed_operand );    # add stemming, right truncation
899     }
900
901     $weighted_query .= "))";                       # close rank specification
902     return $weighted_query;
903 }
904
905 =head2 getIndexes
906
907 Return an array with available indexes.
908
909 =cut
910
911 sub getIndexes{
912     my @indexes = (
913                     # biblio indexes
914                     'ab',
915                     'Abstract',
916                     'acqdate',
917                     'allrecords',
918                     'an',
919                     'Any',
920                     'at',
921                     'au',
922                     'aub',
923                     'aud',
924                     'audience',
925                     'auo',
926                     'aut',
927                     'Author',
928                     'Author-in-order ',
929                     'Author-personal-bibliography',
930                     'Authority-Number',
931                     'authtype',
932                     'bc',
933                     'Bib-level',
934                     'biblionumber',
935                     'bio',
936                     'biography',
937                     'callnum',
938                     'cfn',
939                     'Chronological-subdivision',
940                     'cn-bib-source',
941                     'cn-bib-sort',
942                     'cn-class',
943                     'cn-item',
944                     'cn-prefix',
945                     'cn-suffix',
946                     'cpn',
947                     'Code-institution',
948                     'Conference-name',
949                     'Conference-name-heading',
950                     'Conference-name-see',
951                     'Conference-name-seealso',
952                     'Content-type',
953                     'Control-number',
954                     'copydate',
955                     'Corporate-name',
956                     'Corporate-name-heading',
957                     'Corporate-name-see',
958                     'Corporate-name-seealso',
959                     'ctype',
960                     'date-entered-on-file',
961                     'Date-of-acquisition',
962                     'Date-of-publication',
963                     'Dewey-classification',
964                     'EAN',
965                     'extent',
966                     'fic',
967                     'fiction',
968                     'Form-subdivision',
969                     'format',
970                     'Geographic-subdivision',
971                     'he',
972                     'Heading',
973                     'Heading-use-main-or-added-entry',
974                     'Heading-use-series-added-entry ',
975                     'Heading-use-subject-added-entry',
976                     'Host-item',
977                     'id-other',
978                     'Illustration-code',
979                     'ISBN',
980                     'isbn',
981                     'ISSN',
982                     'issn',
983                     'itemtype',
984                     'kw',
985                     'Koha-Auth-Number',
986                     'l-format',
987                     'language',
988                     'lc-card',
989                     'LC-card-number',
990                     'lcn',
991                     'llength',
992                     'ln',
993                     'Local-classification',
994                     'Local-number',
995                     'Match-heading',
996                     'Match-heading-see-from',
997                     'Material-type',
998                     'mc-itemtype',
999                     'mc-rtype',
1000                     'mus',
1001                     'name',
1002                     'Music-number',
1003                     'Name-geographic',
1004                     'Name-geographic-heading',
1005                     'Name-geographic-see',
1006                     'Name-geographic-seealso',
1007                     'nb',
1008                     'Note',
1009                     'notes',
1010                     'ns',
1011                     'nt',
1012                     'pb',
1013                     'Personal-name',
1014                     'Personal-name-heading',
1015                     'Personal-name-see',
1016                     'Personal-name-seealso',
1017                     'pl',
1018                     'Place-publication',
1019                     'pn',
1020                     'popularity',
1021                     'pubdate',
1022                     'Publisher',
1023                     'Record-control-number',
1024                     'rcn',
1025                     'Record-type',
1026                     'rtype',
1027                     'se',
1028                     'See',
1029                     'See-also',
1030                     'sn',
1031                     'Stock-number',
1032                     'su',
1033                     'Subject',
1034                     'Subject-heading-thesaurus',
1035                     'Subject-name-personal',
1036                     'Subject-subdivision',
1037                     'Summary',
1038                     'Suppress',
1039                     'su-geo',
1040                     'su-na',
1041                     'su-to',
1042                     'su-ut',
1043                     'ut',
1044                     'UPC',
1045                     'Term-genre-form',
1046                     'Term-genre-form-heading',
1047                     'Term-genre-form-see',
1048                     'Term-genre-form-seealso',
1049                     'ti',
1050                     'Title',
1051                     'Title-cover',
1052                     'Title-series',
1053                     'Title-host',
1054                     'Title-uniform',
1055                     'Title-uniform-heading',
1056                     'Title-uniform-see',
1057                     'Title-uniform-seealso',
1058                     'totalissues',
1059                     'yr',
1060
1061                     # items indexes
1062                     'acqsource',
1063                     'barcode',
1064                     'bc',
1065                     'branch',
1066                     'ccode',
1067                     'classification-source',
1068                     'cn-sort',
1069                     'coded-location-qualifier',
1070                     'copynumber',
1071                     'damaged',
1072                     'datelastborrowed',
1073                     'datelastseen',
1074                     'holdingbranch',
1075                     'homebranch',
1076                     'issues',
1077                     'item',
1078                     'itemnumber',
1079                     'itype',
1080                     'Local-classification',
1081                     'location',
1082                     'lost',
1083                     'materials-specified',
1084                     'mc-ccode',
1085                     'mc-itype',
1086                     'mc-loc',
1087                     'notforloan',
1088                     'onloan',
1089                     'price',
1090                     'renewals',
1091                     'replacementprice',
1092                     'replacementpricedate',
1093                     'reserves',
1094                     'restricted',
1095                     'stack',
1096                     'stocknumber',
1097                     'inv',
1098                     'uri',
1099                     'withdrawn',
1100
1101                     # subject related
1102                   );
1103
1104     return \@indexes;
1105 }
1106
1107 =head2 _handle_exploding_index
1108
1109     my $query = _handle_exploding_index($index, $term)
1110
1111 Callback routine to generate the search for "exploding" indexes (i.e.
1112 those indexes which are turned into multiple or-connected searches based
1113 on authority data).
1114
1115 =cut
1116
1117 sub _handle_exploding_index {
1118     my ($QParser, $filter, $params, $negate, $server) = @_;
1119     my $index = $filter;
1120     my $term = join(' ', @$params);
1121
1122     return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1123
1124     my $marcflavour = C4::Context->preference('marcflavour');
1125
1126     my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1127     my $wantedcodes = '';
1128     my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1129     my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1130     foreach my $auth (@$results) {
1131         my $record = MARC::Record->new_from_usmarc($auth);
1132         my @references = $record->field('5..');
1133         if (@references) {
1134             if ($index eq 'su-br') {
1135                 $wantedcodes = 'g';
1136             } elsif ($index eq 'su-na') {
1137                 $wantedcodes = 'h';
1138             } elsif ($index eq 'su-rl') {
1139                 $wantedcodes = '';
1140             }
1141             foreach my $reference (@references) {
1142                 my $codes = $reference->subfield($codesubfield);
1143                 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1144             }
1145         }
1146     }
1147     my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1148     return $query;
1149 }
1150
1151 =head2 parseQuery
1152
1153     ( $operators, $operands, $indexes, $limits,
1154       $sort_by, $scan, $lang ) =
1155             buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1156
1157 Shim function to ease the transition from buildQuery to a new QueryParser.
1158 This function is called at the beginning of buildQuery, and modifies
1159 buildQuery's input. If it can handle the input, it returns a query that
1160 buildQuery will not try to parse.
1161 =cut
1162
1163 sub parseQuery {
1164     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1165
1166     my @operators = $operators ? @$operators : ();
1167     my @indexes   = $indexes   ? @$indexes   : ();
1168     my @operands  = $operands  ? @$operands  : ();
1169     my @limits    = $limits    ? @$limits    : ();
1170     my @sort_by   = $sort_by   ? @$sort_by   : ();
1171
1172     my $query = $operands[0];
1173     my $index;
1174     my $term;
1175     my $query_desc;
1176
1177     my $QParser;
1178     $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1179     undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1180     undef $QParser if (scalar @limits > 0);
1181
1182     if ($QParser)
1183     {
1184         $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1185         $query = '';
1186         for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1187             next unless $operands[$ii];
1188             $query .= $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1189               if ($query);
1190             if ( $indexes[$ii] =~ m/su-/ ) {
1191                 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1192             }
1193             else {
1194                 $query .=
1195                   ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1196             }
1197         }
1198         foreach my $limit (@limits) {
1199         }
1200         if ( scalar(@sort_by) > 0 ) {
1201             my $modifier_re =
1202               '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1203             $query =~ s/$modifier_re//g;
1204             foreach my $modifier (@sort_by) {
1205                 $query .= " #$modifier";
1206             }
1207         }
1208
1209         $query_desc = $query;
1210         $query_desc =~ s/\s+/ /g;
1211         if ( C4::Context->preference("QueryWeightFields") ) {
1212         }
1213         $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1214               { 'target_syntax_callback' => \&_handle_exploding_index } );
1215         $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1216               { 'target_syntax_callback' => \&_handle_exploding_index } );
1217         $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1218               { 'target_syntax_callback' => \&_handle_exploding_index } );
1219         $QParser->parse($query);
1220         $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1221     }
1222     else {
1223         require Koha::QueryParser::Driver::PQF;
1224         my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1225         s/$modifier_re//g for @operands;
1226     }
1227
1228     return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1229 }
1230
1231 =head2 buildQuery
1232
1233 ( $error, $query,
1234 $simple_query, $query_cgi,
1235 $query_desc, $limit,
1236 $limit_cgi, $limit_desc,
1237 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1238
1239 Build queries and limits in CCL, CGI, Human,
1240 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
1241
1242 See verbose embedded documentation.
1243
1244
1245 =cut
1246
1247 sub buildQuery {
1248     my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1249
1250     warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1251
1252     my $query_desc;
1253     ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1254
1255     # dereference
1256     my @operators = $operators ? @$operators : ();
1257     my @indexes   = $indexes   ? @$indexes   : ();
1258     my @operands  = $operands  ? @$operands  : ();
1259     my @limits    = $limits    ? @$limits    : ();
1260     my @sort_by   = $sort_by   ? @$sort_by   : ();
1261
1262     my $stemming         = C4::Context->preference("QueryStemming")        || 0;
1263     my $auto_truncation  = C4::Context->preference("QueryAutoTruncate")    || 0;
1264     my $weight_fields    = C4::Context->preference("QueryWeightFields")    || 0;
1265     my $fuzzy_enabled    = C4::Context->preference("QueryFuzzy")           || 0;
1266     my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
1267
1268     my $query        = $operands[0];
1269     my $simple_query = $operands[0];
1270
1271     # initialize the variables we're passing back
1272     my $query_cgi;
1273     my $query_type;
1274
1275     my $limit;
1276     my $limit_cgi;
1277     my $limit_desc;
1278
1279     my $stopwords_removed;    # flag to determine if stopwords have been removed
1280
1281     my $cclq       = 0;
1282     my $cclindexes = getIndexes();
1283     if ( $query !~ /\s*ccl=/ ) {
1284         while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1285             my $dx = lc($1);
1286             $cclq = grep { lc($_) eq $dx } @$cclindexes;
1287         }
1288         $query = "ccl=$query" if $cclq;
1289     }
1290
1291 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1292 # DIAGNOSTIC ONLY!!
1293     if ( $query =~ /^ccl=/ ) {
1294         my $q=$';
1295         # This is needed otherwise ccl= and &limit won't work together, and
1296         # this happens when selecting a subject on the opac-detail page
1297         @limits = grep {!/^$/} @limits;
1298         if ( @limits ) {
1299             $q .= ' and '.join(' and ', @limits);
1300         }
1301         return ( undef, $q, $q, "q=ccl=".uri_escape($q), $q, '', '', '', '', 'ccl' );
1302     }
1303     if ( $query =~ /^cql=/ ) {
1304         return ( undef, $', $', "q=cql=".uri_escape($'), $', '', '', '', '', 'cql' );
1305     }
1306     if ( $query =~ /^pqf=/ ) {
1307         if ($query_desc) {
1308             $query_cgi = "q=".uri_escape($query_desc);
1309         } else {
1310             $query_desc = $';
1311             $query_cgi = "q=pqf=".uri_escape($');
1312         }
1313         return ( undef, $', $', $query_cgi, $query_desc, '', '', '', '', 'pqf' );
1314     }
1315
1316     # pass nested queries directly
1317     # FIXME: need better handling of some of these variables in this case
1318     # Nested queries aren't handled well and this implementation is flawed and causes users to be
1319     # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1320 #    if ( $query =~ /(\(|\))/ ) {
1321 #        return (
1322 #            undef,              $query, $simple_query, $query_cgi,
1323 #            $query,             $limit, $limit_cgi,    $limit_desc,
1324 #            $stopwords_removed, 'ccl'
1325 #        );
1326 #    }
1327
1328 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1329 # query operands and indexes and add stemming, truncation, field weighting, etc.
1330 # Once we do so, we'll end up with a value in $query, just like if we had an
1331 # incoming $query from the user
1332     else {
1333         $query = ""
1334           ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1335         my $previous_operand
1336           ;    # a flag used to keep track if there was a previous query
1337                # if there was, we can apply the current operator
1338                # for every operand
1339         for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1340
1341             # COMBINE OPERANDS, INDEXES AND OPERATORS
1342             if ( $operands[$i] ) {
1343                 $operands[$i]=~s/^\s+//;
1344
1345               # A flag to determine whether or not to add the index to the query
1346                 my $indexes_set;
1347
1348 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
1349                 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1350                     $weight_fields    = 0;
1351                     $stemming         = 0;
1352                     $remove_stopwords = 0;
1353                 } else {
1354                     $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1355                 }
1356                 my $operand = $operands[$i];
1357                 my $index   = $indexes[$i];
1358
1359                 # Add index-specific attributes
1360                 # Date of Publication
1361                 if ( $index eq 'yr' ) {
1362                     $index .= ",st-numeric";
1363                     $indexes_set++;
1364                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1365                 }
1366
1367                 # Date of Acquisition
1368                 elsif ( $index eq 'acqdate' ) {
1369                     $index .= ",st-date-normalized";
1370                     $indexes_set++;
1371                                         $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1372                 }
1373                 # ISBN,ISSN,Standard Number, don't need special treatment
1374                 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1375                     (
1376                         $stemming,      $auto_truncation,
1377                         $weight_fields, $fuzzy_enabled,
1378                         $remove_stopwords
1379                     ) = ( 0, 0, 0, 0, 0 );
1380
1381                 }
1382
1383                 if(not $index){
1384                     $index = 'kw';
1385                 }
1386
1387                 # Set default structure attribute (word list)
1388                 my $struct_attr = q{};
1389                 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl|nb|ns)/ ) {
1390                     $struct_attr = ",wrdl";
1391                 }
1392
1393                 # Some helpful index variants
1394                 my $index_plus       = $index . $struct_attr . ':';
1395                 my $index_plus_comma = $index . $struct_attr . ',';
1396
1397                 # Remove Stopwords
1398                 if ($remove_stopwords) {
1399                     ( $operand, $stopwords_removed ) =
1400                       _remove_stopwords( $operand, $index );
1401                     warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
1402                     warn "REMOVED STOPWORDS: @$stopwords_removed"
1403                       if ( $stopwords_removed && $DEBUG );
1404                 }
1405
1406                 if ($auto_truncation){
1407                                         unless ( $index =~ /(st-|phr|ext)/ ) {
1408                                                 #FIXME only valid with LTR scripts
1409                                                 $operand=join(" ",map{
1410                                                                                         (index($_,"*")>0?"$_":"$_*")
1411                                                                                          }split (/\s+/,$operand));
1412                                                 warn $operand if $DEBUG;
1413                                         }
1414                                 }
1415
1416                 # Detect Truncation
1417                 my $truncated_operand;
1418                 my( $nontruncated, $righttruncated, $lefttruncated,
1419                     $rightlefttruncated, $regexpr
1420                 ) = _detect_truncation( $operand, $index );
1421                 warn
1422 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1423                   if $DEBUG;
1424
1425                 # Apply Truncation
1426                 if (
1427                     scalar(@$righttruncated) + scalar(@$lefttruncated) +
1428                     scalar(@$rightlefttruncated) > 0 )
1429                 {
1430
1431                # Don't field weight or add the index to the query, we do it here
1432                     $indexes_set = 1;
1433                     undef $weight_fields;
1434                     my $previous_truncation_operand;
1435                     if (scalar @$nontruncated) {
1436                         $truncated_operand .= "$index_plus @$nontruncated ";
1437                         $previous_truncation_operand = 1;
1438                     }
1439                     if (scalar @$righttruncated) {
1440                         $truncated_operand .= "and " if $previous_truncation_operand;
1441                         $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1442                         $previous_truncation_operand = 1;
1443                     }
1444                     if (scalar @$lefttruncated) {
1445                         $truncated_operand .= "and " if $previous_truncation_operand;
1446                         $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1447                         $previous_truncation_operand = 1;
1448                     }
1449                     if (scalar @$rightlefttruncated) {
1450                         $truncated_operand .= "and " if $previous_truncation_operand;
1451                         $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1452                         $previous_truncation_operand = 1;
1453                     }
1454                 }
1455                 $operand = $truncated_operand if $truncated_operand;
1456                 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1457
1458                 # Handle Stemming
1459                 my $stemmed_operand;
1460                 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1461                                                                                 if $stemming;
1462
1463                 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1464
1465                 # Handle Field Weighting
1466                 my $weighted_operand;
1467                 if ($weight_fields) {
1468                     $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1469                     $operand = $weighted_operand;
1470                     $indexes_set = 1;
1471                 }
1472
1473                 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1474
1475                 # If there's a previous operand, we need to add an operator
1476                 if ($previous_operand) {
1477
1478                     # User-specified operator
1479                     if ( $operators[ $i - 1 ] ) {
1480                         $query     .= " $operators[$i-1] ";
1481                         $query     .= " $index_plus " unless $indexes_set;
1482                         $query     .= " $operand";
1483                         $query_cgi .= "&op=".uri_escape($operators[$i-1]);
1484                         $query_cgi .= "&idx=".uri_escape($index) if $index;
1485                         $query_cgi .= "&q=".uri_escape($operands[$i]) if $operands[$i];
1486                         $query_desc .=
1487                           " $operators[$i-1] $index_plus $operands[$i]";
1488                     }
1489
1490                     # Default operator is and
1491                     else {
1492                         $query      .= " and ";
1493                         $query      .= "$index_plus " unless $indexes_set;
1494                         $query      .= "$operand";
1495                         $query_cgi  .= "&op=and&idx=".uri_escape($index) if $index;
1496                         $query_cgi  .= "&q=".uri_escape($operands[$i]) if $operands[$i];
1497                         $query_desc .= " and $index_plus $operands[$i]";
1498                     }
1499                 }
1500
1501                 # There isn't a pervious operand, don't need an operator
1502                 else {
1503
1504                     # Field-weighted queries already have indexes set
1505                     $query .= " $index_plus " unless $indexes_set;
1506                     $query .= $operand;
1507                     $query_desc .= " $index_plus $operands[$i]";
1508                     $query_cgi  .= "&idx=".uri_escape($index) if $index;
1509                     $query_cgi  .= "&q=".uri_escape($operands[$i]) if $operands[$i];
1510                     $previous_operand = 1;
1511                 }
1512             }    #/if $operands
1513         }    # /for
1514     }
1515     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1516
1517     # add limits
1518     my %group_OR_limits;
1519     my $availability_limit;
1520     foreach my $this_limit (@limits) {
1521         next unless $this_limit;
1522         if ( $this_limit =~ /available/ ) {
1523 #
1524 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1525 ## In English:
1526 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1527             $availability_limit .=
1528 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1529             $limit_cgi  .= "&limit=available";
1530             $limit_desc .= "";
1531         }
1532
1533         # group_OR_limits, prefixed by mc-
1534         # OR every member of the group
1535         elsif ( $this_limit =~ /mc/ ) {
1536             my ($k,$v) = split(/:/, $this_limit,2);
1537             if ( $k !~ /mc-i(tem)?type/ ) {
1538                 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1539                 $this_limit =~ tr/"//d;
1540                 $this_limit = $k.":\"".$v."\"";
1541             }
1542
1543             $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1544             $limit_desc      .= " or " if $group_OR_limits{$k};
1545             $group_OR_limits{$k} .= "$this_limit";
1546             $limit_cgi       .= "&limit=$this_limit";
1547             $limit_desc      .= " $this_limit";
1548         }
1549
1550         # Regular old limits
1551         else {
1552             $limit .= " and " if $limit || $query;
1553             $limit      .= "$this_limit";
1554             $limit_cgi  .= "&limit=$this_limit";
1555             if ($this_limit =~ /^branch:(.+)/) {
1556                 my $branchcode = $1;
1557                 my $branchname = GetBranchName($branchcode);
1558                 if (defined $branchname) {
1559                     $limit_desc .= " branch:$branchname";
1560                 } else {
1561                     $limit_desc .= " $this_limit";
1562                 }
1563             } else {
1564                 $limit_desc .= " $this_limit";
1565             }
1566         }
1567     }
1568     foreach my $k (keys (%group_OR_limits)) {
1569         $limit .= " and " if ( $query || $limit );
1570         $limit .= "($group_OR_limits{$k})";
1571     }
1572     if ($availability_limit) {
1573         $limit .= " and " if ( $query || $limit );
1574         $limit .= "($availability_limit)";
1575     }
1576
1577     # Normalize the query and limit strings
1578     # This is flawed , means we can't search anything with : in it
1579     # if user wants to do ccl or cql, start the query with that
1580 #    $query =~ s/:/=/g;
1581     $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1582     $query =~ s/(?<=(wrdl)):/=/g;
1583     $query =~ s/(?<=(trn|phr)):/=/g;
1584     $limit =~ s/:/=/g;
1585     for ( $query, $query_desc, $limit, $limit_desc ) {
1586         s/  +/ /g;    # remove extra spaces
1587         s/^ //g;     # remove any beginning spaces
1588         s/ $//g;     # remove any ending spaces
1589         s/==/=/g;    # remove double == from query
1590     }
1591     $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1592
1593     for ($query_cgi,$simple_query) {
1594         s/"//g;
1595     }
1596     # append the limit to the query
1597     $query .= " " . $limit;
1598
1599     # Warnings if DEBUG
1600     if ($DEBUG) {
1601         warn "QUERY:" . $query;
1602         warn "QUERY CGI:" . $query_cgi;
1603         warn "QUERY DESC:" . $query_desc;
1604         warn "LIMIT:" . $limit;
1605         warn "LIMIT CGI:" . $limit_cgi;
1606         warn "LIMIT DESC:" . $limit_desc;
1607         warn "---------\nLeave buildQuery\n---------";
1608     }
1609     return (
1610         undef,              $query, $simple_query, $query_cgi,
1611         $query_desc,        $limit, $limit_cgi,    $limit_desc,
1612         $stopwords_removed, $query_type
1613     );
1614 }
1615
1616 =head2 searchResults
1617
1618   my @search_results = searchResults($search_context, $searchdesc, $hits, 
1619                                      $results_per_page, $offset, $scan, 
1620                                      @marcresults);
1621
1622 Format results in a form suitable for passing to the template
1623
1624 =cut
1625
1626 # IMO this subroutine is pretty messy still -- it's responsible for
1627 # building the HTML output for the template
1628 sub searchResults {
1629     my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1630     my $dbh = C4::Context->dbh;
1631     my @newresults;
1632
1633     require C4::Items;
1634
1635     $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1636     my ($is_opac, $hidelostitems);
1637     if ($search_context eq 'opac') {
1638         $hidelostitems = C4::Context->preference('hidelostitems');
1639         $is_opac       = 1;
1640     }
1641
1642     #Build branchnames hash
1643     #find branchname
1644     #get branch information.....
1645     my %branches;
1646     my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1647     $bsth->execute();
1648     while ( my $bdata = $bsth->fetchrow_hashref ) {
1649         $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1650     }
1651 # FIXME - We build an authorised values hash here, using the default framework
1652 # though it is possible to have different authvals for different fws.
1653
1654     my $shelflocations =GetKohaAuthorisedValues('items.location','');
1655
1656     # get notforloan authorised value list (see $shelflocations  FIXME)
1657     my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1658
1659     #Build itemtype hash
1660     #find itemtype & itemtype image
1661     my %itemtypes;
1662     $bsth =
1663       $dbh->prepare(
1664         "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1665       );
1666     $bsth->execute();
1667     while ( my $bdata = $bsth->fetchrow_hashref ) {
1668                 foreach (qw(description imageurl summary notforloan)) {
1669                 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1670                 }
1671     }
1672
1673     #search item field code
1674     my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1675
1676     ## find column names of items related to MARC
1677     my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1678     $sth2->execute;
1679     my %subfieldstosearch;
1680     while ( ( my $column ) = $sth2->fetchrow ) {
1681         my ( $tagfield, $tagsubfield ) =
1682           &GetMarcFromKohaField( "items." . $column, "" );
1683         $subfieldstosearch{$column} = $tagsubfield;
1684     }
1685
1686     # handle which records to actually retrieve
1687     my $times;
1688     if ( $hits && $offset + $results_per_page <= $hits ) {
1689         $times = $offset + $results_per_page;
1690     }
1691     else {
1692         $times = $hits;  # FIXME: if $hits is undefined, why do we want to equal it?
1693     }
1694
1695         my $marcflavour = C4::Context->preference("marcflavour");
1696     # We get the biblionumber position in MARC
1697     my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1698
1699     # loop through all of the records we've retrieved
1700     for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1701         my $marcrecord = MARC::File::USMARC::decode( $marcresults->[$i] );
1702         my $fw = $scan
1703              ? undef
1704              : $bibliotag < 10
1705                ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1706                : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1707         my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1708         $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1709         $oldbiblio->{result_number} = $i + 1;
1710
1711         # add imageurl to itemtype if there is one
1712         $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1713
1714         $oldbiblio->{'authorised_value_images'}  = ($search_context eq 'opac' && C4::Context->preference('AuthorisedValueImages')) || ($search_context eq 'intranet' && C4::Context->preference('StaffAuthorisedValueImages')) ? C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{'biblionumber'}, $marcrecord ) ) : [];
1715                 $oldbiblio->{normalized_upc}  = GetNormalizedUPC(       $marcrecord,$marcflavour);
1716                 $oldbiblio->{normalized_ean}  = GetNormalizedEAN(       $marcrecord,$marcflavour);
1717                 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1718                 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1719                 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1720
1721                 # edition information, if any
1722         $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1723                 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1724  # Build summary if there is one (the summary is defined in the itemtypes table)
1725  # FIXME: is this used anywhere, I think it can be commented out? -- JF
1726         if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1727             my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1728             my @fields  = $marcrecord->fields();
1729
1730             my $newsummary;
1731             foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1732                 my $tags = {};
1733                 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1734                     $tag =~ /(.{3})(.)/;
1735                     if($marcrecord->field($1)){
1736                         my @abc = $marcrecord->field($1)->subfield($2);
1737                         $tags->{$tag} = $#abc + 1 ;
1738                     }
1739                 }
1740
1741                 # We catch how many times to repeat this line
1742                 my $max = 0;
1743                 foreach my $tag (keys(%$tags)){
1744                     $max = $tags->{$tag} if($tags->{$tag} > $max);
1745                  }
1746
1747                 # we replace, and repeat each line
1748                 for (my $i = 0 ; $i < $max ; $i++){
1749                     my $newline = $line;
1750
1751                     foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1752                         $tag =~ /(.{3})(.)/;
1753
1754                         if($marcrecord->field($1)){
1755                             my @repl = $marcrecord->field($1)->subfield($2);
1756                             my $subfieldvalue = $repl[$i];
1757
1758                             if (! utf8::is_utf8($subfieldvalue)) {
1759                                 utf8::decode($subfieldvalue);
1760                             }
1761
1762                              $newline =~ s/\[$tag\]/$subfieldvalue/g;
1763                         }
1764                     }
1765                     $newsummary .= "$newline\n";
1766                 }
1767             }
1768
1769             $newsummary =~ s/\[(.*?)]//g;
1770             $newsummary =~ s/\n/<br\/>/g;
1771             $oldbiblio->{summary} = $newsummary;
1772         }
1773
1774         # Pull out the items fields
1775         my @fields = $marcrecord->field($itemtag);
1776         my $marcflavor = C4::Context->preference("marcflavour");
1777         # adding linked items that belong to host records
1778         my $analyticsfield = '773';
1779         if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1780             $analyticsfield = '773';
1781         } elsif ($marcflavor eq 'UNIMARC') {
1782             $analyticsfield = '461';
1783         }
1784         foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1785             my $hostbiblionumber = $hostfield->subfield("0");
1786             my $linkeditemnumber = $hostfield->subfield("9");
1787             if(!$hostbiblionumber eq undef){
1788                 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
1789                 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
1790                 if(!$hostbiblio eq undef){
1791                     my @hostitems = $hostbiblio->field($itemfield);
1792                     foreach my $hostitem (@hostitems){
1793                         if ($hostitem->subfield("9") eq $linkeditemnumber){
1794                             my $linkeditem =$hostitem;
1795                             # append linked items if they exist
1796                             if (!$linkeditem eq undef){
1797                                 push (@fields, $linkeditem);}
1798                         }
1799                     }
1800                 }
1801             }
1802         }
1803
1804         # Setting item statuses for display
1805         my @available_items_loop;
1806         my @onloan_items_loop;
1807         my @other_items_loop;
1808
1809         my $available_items;
1810         my $onloan_items;
1811         my $other_items;
1812
1813         my $ordered_count         = 0;
1814         my $available_count       = 0;
1815         my $onloan_count          = 0;
1816         my $longoverdue_count     = 0;
1817         my $other_count           = 0;
1818         my $wthdrawn_count        = 0;
1819         my $itemlost_count        = 0;
1820         my $hideatopac_count      = 0;
1821         my $itembinding_count     = 0;
1822         my $itemdamaged_count     = 0;
1823         my $item_in_transit_count = 0;
1824         my $can_place_holds       = 0;
1825         my $item_onhold_count     = 0;
1826         my $items_count           = scalar(@fields);
1827         my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
1828         my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
1829         my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
1830
1831         # loop through every item
1832         foreach my $field (@fields) {
1833             my $item;
1834
1835             # populate the items hash
1836             foreach my $code ( keys %subfieldstosearch ) {
1837                 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1838             }
1839             $item->{description} = $itemtypes{ $item->{itype} }{description};
1840
1841                 # OPAC hidden items
1842             if ($is_opac) {
1843                 # hidden because lost
1844                 if ($hidelostitems && $item->{itemlost}) {
1845                     $hideatopac_count++;
1846                     next;
1847                 }
1848                 # hidden based on OpacHiddenItems syspref
1849                 my @hi = C4::Items::GetHiddenItemnumbers($item);
1850                 if (scalar @hi) {
1851                     push @hiddenitems, @hi;
1852                     $hideatopac_count++;
1853                     next;
1854                 }
1855             }
1856
1857             my $hbranch     = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch'    : 'holdingbranch';
1858             my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1859
1860             # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1861             if ($item->{$hbranch}) {
1862                 $item->{'branchname'} = $branches{$item->{$hbranch}};
1863             }
1864             elsif ($item->{$otherbranch}) {     # Last resort
1865                 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1866             }
1867
1868                         my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1869 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1870             my $userenv = C4::Context->userenv;
1871             if ( $item->{onloan} && !(C4::Members::GetHideLostItemsPreference($userenv->{'number'}) && $item->{itemlost}) ) {
1872                 $onloan_count++;
1873                                 my $key = $prefix . $item->{onloan} . $item->{barcode};
1874                                 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1875                                 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1876                                 $onloan_items->{$key}->{branchname} = $item->{branchname};
1877                                 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1878                                 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1879                                 $onloan_items->{$key}->{description} = $item->{description};
1880                                 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1881                 # if something's checked out and lost, mark it as 'long overdue'
1882                 if ( $item->{itemlost} ) {
1883                     $onloan_items->{$prefix}->{longoverdue}++;
1884                     $longoverdue_count++;
1885                 } else {        # can place holds as long as item isn't lost
1886                     $can_place_holds = 1;
1887                 }
1888             }
1889
1890          # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1891             else {
1892
1893                 # item is on order
1894                 if ( $item->{notforloan} < 0 ) {
1895                     $ordered_count++;
1896                 }
1897
1898                 # is item in transit?
1899                 my $transfertwhen = '';
1900                 my ($transfertfrom, $transfertto);
1901
1902                 # is item on the reserve shelf?
1903                 my $reservestatus = '';
1904
1905                 unless ($item->{wthdrawn}
1906                         || $item->{itemlost}
1907                         || $item->{damaged}
1908                         || $item->{notforloan}
1909                         || $items_count > 20) {
1910
1911                     # A couple heuristics to limit how many times
1912                     # we query the database for item transfer information, sacrificing
1913                     # accuracy in some cases for speed;
1914                     #
1915                     # 1. don't query if item has one of the other statuses
1916                     # 2. don't check transit status if the bib has
1917                     #    more than 20 items
1918                     #
1919                     # FIXME: to avoid having the query the database like this, and to make
1920                     #        the in transit status count as unavailable for search limiting,
1921                     #        should map transit status to record indexed in Zebra.
1922                     #
1923                     ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1924                     $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber}, $oldbiblio->{biblionumber} );
1925                 }
1926
1927                 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
1928                 if (   $item->{wthdrawn}
1929                     || $item->{itemlost}
1930                     || $item->{damaged}
1931                     || $item->{notforloan}
1932                     || $reservestatus eq 'Waiting'
1933                     || ($transfertwhen ne ''))
1934                 {
1935                     $wthdrawn_count++        if $item->{wthdrawn};
1936                     $itemlost_count++        if $item->{itemlost};
1937                     $itemdamaged_count++     if $item->{damaged};
1938                     $item_in_transit_count++ if $transfertwhen ne '';
1939                     $item_onhold_count++     if $reservestatus eq 'Waiting';
1940                     $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1941
1942                     # can place hold on item ?
1943                     if ( !$item->{itemlost} ) {
1944                         if ( !$item->{wthdrawn} ){
1945                             if ( $item->{damaged} ){
1946                                 if ( C4::Context->preference('AllowHoldsOnDamagedItems') ){
1947                                     # can place a hold on a damaged item if AllowHoldsOnDamagedItems is true
1948                                     if ( ( !$item->{notforloan} || $item->{notforloan} < 0 ) ){
1949                                         # item is either for loan or has notforloan < 0
1950                                         $can_place_holds = 1;
1951                                     }
1952                                 }
1953                             } elsif ( $item->{notforloan} < 0 ) {
1954                                 # item is not damaged and notforloan is < 0
1955                                 $can_place_holds = 1;
1956                             }
1957                         }
1958                     }
1959
1960                     $other_count++;
1961
1962                     my $key = $prefix . $item->{status};
1963                     foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber)) {
1964                         $other_items->{$key}->{$_} = $item->{$_};
1965                     }
1966                     $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
1967                     $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
1968                     $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
1969                                         $other_items->{$key}->{count}++ if $item->{$hbranch};
1970                                         $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1971                                         $other_items->{$key}->{description} = $item->{description};
1972                                         $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1973                 }
1974                 # item is available
1975                 else {
1976                     $can_place_holds = 1;
1977                     $available_count++;
1978                                         $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1979                                         foreach (qw(branchname itemcallnumber description)) {
1980                         $available_items->{$prefix}->{$_} = $item->{$_};
1981                                         }
1982                                         $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1983                                         $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1984                 }
1985             }
1986         }    # notforloan, item level and biblioitem level
1987
1988         # if all items are hidden, do not show the record
1989         if ($items_count > 0 && $hideatopac_count == $items_count) {
1990             next;
1991         }
1992
1993         my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1994         for my $key ( sort keys %$onloan_items ) {
1995             (++$onloanitemscount > $maxitems) and last;
1996             push @onloan_items_loop, $onloan_items->{$key};
1997         }
1998         for my $key ( sort keys %$other_items ) {
1999             (++$otheritemscount > $maxitems) and last;
2000             push @other_items_loop, $other_items->{$key};
2001         }
2002         for my $key ( sort keys %$available_items ) {
2003             (++$availableitemscount > $maxitems) and last;
2004             push @available_items_loop, $available_items->{$key}
2005         }
2006
2007         # XSLT processing of some stuff
2008         use C4::Charset;
2009         SetUTF8Flag($marcrecord);
2010         warn $marcrecord->as_formatted if $DEBUG;
2011         my $interface = $search_context eq 'opac' ? 'OPAC' : '';
2012         if (!$scan && C4::Context->preference($interface . "XSLTResultsDisplay")) {
2013             $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $interface."XSLTResultsDisplay", 1, \@hiddenitems);
2014             # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2015         }
2016
2017         # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2018         if (!C4::Context->preference("item-level_itypes")) {
2019             if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2020                 $can_place_holds = 0;
2021             }
2022         }
2023         $oldbiblio->{norequests} = 1 unless $can_place_holds;
2024         $oldbiblio->{itemsplural}          = 1 if $items_count > 1;
2025         $oldbiblio->{items_count}          = $items_count;
2026         $oldbiblio->{available_items_loop} = \@available_items_loop;
2027         $oldbiblio->{onloan_items_loop}    = \@onloan_items_loop;
2028         $oldbiblio->{other_items_loop}     = \@other_items_loop;
2029         $oldbiblio->{availablecount}       = $available_count;
2030         $oldbiblio->{availableplural}      = 1 if $available_count > 1;
2031         $oldbiblio->{onloancount}          = $onloan_count;
2032         $oldbiblio->{onloanplural}         = 1 if $onloan_count > 1;
2033         $oldbiblio->{othercount}           = $other_count;
2034         $oldbiblio->{otherplural}          = 1 if $other_count > 1;
2035         $oldbiblio->{wthdrawncount}        = $wthdrawn_count;
2036         $oldbiblio->{itemlostcount}        = $itemlost_count;
2037         $oldbiblio->{damagedcount}         = $itemdamaged_count;
2038         $oldbiblio->{intransitcount}       = $item_in_transit_count;
2039         $oldbiblio->{onholdcount}          = $item_onhold_count;
2040         $oldbiblio->{orderedcount}         = $ordered_count;
2041
2042         if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2043             my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2044             my $subfields = substr $fieldspec, 3;
2045             my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2046             my @alternateholdingsinfo = ();
2047             my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2048             my $alternateholdingscount = 0;
2049
2050             for my $field (@holdingsfields) {
2051                 my %holding = ( holding => '' );
2052                 my $havesubfield = 0;
2053                 for my $subfield ($field->subfields()) {
2054                     if ((index $subfields, $$subfield[0]) >= 0) {
2055                         $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2056                         $holding{'holding'} .= $$subfield[1];
2057                         $havesubfield++;
2058                     }
2059                 }
2060                 if ($havesubfield) {
2061                     push(@alternateholdingsinfo, \%holding);
2062                     $alternateholdingscount++;
2063                 }
2064             }
2065
2066             $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2067             $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2068         }
2069
2070         push( @newresults, $oldbiblio );
2071     }
2072
2073     return @newresults;
2074 }
2075
2076 =head2 SearchAcquisitions
2077     Search for acquisitions
2078 =cut
2079
2080 sub SearchAcquisitions{
2081     my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
2082
2083     my $dbh=C4::Context->dbh;
2084     # Variable initialization
2085     my $str=qq|
2086     SELECT marcxml
2087     FROM biblio
2088     LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
2089     LEFT JOIN items ON items.biblionumber=biblio.biblionumber
2090     WHERE dateaccessioned BETWEEN ? AND ?
2091     |;
2092
2093     my (@params,@loopcriteria);
2094
2095     push @params, $datebegin->output("iso");
2096     push @params, $dateend->output("iso");
2097
2098     if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
2099         if(C4::Context->preference("item-level_itypes")){
2100             $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2101         }else{
2102             $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2103         }
2104         push @params, @$itemtypes;
2105     }
2106
2107     if ($criteria =~/itemtype/){
2108         if(C4::Context->preference("item-level_itypes")){
2109             $str .= "AND items.itype=? ";
2110         }else{
2111             $str .= "AND biblioitems.itemtype=? ";
2112         }
2113
2114         if(scalar(@$itemtypes) == 0){
2115             my $itypes = GetItemTypes();
2116             for my $key (keys %$itypes){
2117                 push @$itemtypes, $key;
2118             }
2119         }
2120
2121         @loopcriteria= @$itemtypes;
2122     }elsif ($criteria=~/itemcallnumber/){
2123         $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
2124                  OR items.itemcallnumber is NULL
2125                  OR items.itemcallnumber = '')";
2126
2127         @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
2128     }else {
2129         $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
2130         @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
2131     }
2132
2133     if ($orderby =~ /date_desc/){
2134         $str.=" ORDER BY dateaccessioned DESC";
2135     } else {
2136         $str.=" ORDER BY title";
2137     }
2138
2139     my $qdataacquisitions=$dbh->prepare($str);
2140
2141     my @loopacquisitions;
2142     foreach my $value(@loopcriteria){
2143         push @params,$value;
2144         my %cell;
2145         $cell{"title"}=$value;
2146         $cell{"titlecode"}=$value;
2147
2148         eval{$qdataacquisitions->execute(@params);};
2149
2150         if ($@){ warn "recentacquisitions Error :$@";}
2151         else {
2152             my @loopdata;
2153             while (my $data=$qdataacquisitions->fetchrow_hashref){
2154                 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
2155             }
2156             $cell{"loopdata"}=\@loopdata;
2157         }
2158         push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
2159         pop @params;
2160     }
2161     $qdataacquisitions->finish;
2162     return \@loopacquisitions;
2163 }
2164
2165 =head2 enabled_staff_search_views
2166
2167 %hash = enabled_staff_search_views()
2168
2169 This function returns a hash that contains three flags obtained from the system
2170 preferences, used to determine whether a particular staff search results view
2171 is enabled.
2172
2173 =over 2
2174
2175 =item C<Output arg:>
2176
2177     * $hash{can_view_MARC} is true only if the MARC view is enabled
2178     * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2179     * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2180
2181 =item C<usage in the script:>
2182
2183 =back
2184
2185 $template->param ( C4::Search::enabled_staff_search_views );
2186
2187 =cut
2188
2189 sub enabled_staff_search_views
2190 {
2191         return (
2192                 can_view_MARC                   => C4::Context->preference('viewMARC'),                 # 1 if the staff search allows the MARC view
2193                 can_view_ISBD                   => C4::Context->preference('viewISBD'),                 # 1 if the staff search allows the ISBD view
2194                 can_view_labeledMARC    => C4::Context->preference('viewLabeledMARC'),  # 1 if the staff search allows the Labeled MARC view
2195         );
2196 }
2197
2198 sub AddSearchHistory{
2199         my ($borrowernumber,$session,$query_desc,$query_cgi, $total)=@_;
2200     my $dbh = C4::Context->dbh;
2201
2202     # Add the request the user just made
2203     my $sql = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES(?, ?, ?, ?, ?, NOW())";
2204     my $sth   = $dbh->prepare($sql);
2205     $sth->execute($borrowernumber, $session, $query_desc, $query_cgi, $total);
2206         return $dbh->last_insert_id(undef, 'search_history', undef,undef,undef);
2207 }
2208
2209 sub GetSearchHistory{
2210         my ($borrowernumber,$session)=@_;
2211     my $dbh = C4::Context->dbh;
2212
2213     # Add the request the user just made
2214     my $query = "SELECT FROM search_history WHERE (userid=? OR sessionid=?)";
2215     my $sth   = $dbh->prepare($query);
2216         $sth->execute($borrowernumber, $session);
2217     return  $sth->fetchall_hashref({});
2218 }
2219
2220 =head2 z3950_search_args
2221
2222 $arrayref = z3950_search_args($matchpoints)
2223
2224 This function returns an array reference that contains the search parameters to be
2225 passed to the Z39.50 search script (z3950_search.pl). The array elements
2226 are hash refs whose keys are name, value and encvalue, and whose values are the
2227 name of a search parameter, the value of that search parameter and the URL encoded
2228 value of that parameter.
2229
2230 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2231
2232 The search parameter values are obtained from the bibliographic record whose
2233 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2234
2235 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2236 a general purpose search argument. In this case, the returned array contains only
2237 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2238
2239 If a search parameter value is undefined or empty, it is not included in the returned
2240 array.
2241
2242 The returned array reference may be passed directly to the template parameters.
2243
2244 =over 2
2245
2246 =item C<Output arg:>
2247
2248     * $array containing hash refs as described above
2249
2250 =item C<usage in the script:>
2251
2252 =back
2253
2254 $data = Biblio::GetBiblioData($bibno);
2255 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2256
2257 *OR*
2258
2259 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2260
2261 =cut
2262
2263 sub z3950_search_args {
2264     my $bibrec = shift;
2265     my $isbn = Business::ISBN->new($bibrec);
2266
2267     if (defined $isbn && $isbn->is_valid)
2268     {
2269         $bibrec = { isbn => $bibrec } if !ref $bibrec;
2270     }
2271     else {
2272         $bibrec = { title => $bibrec } if !ref $bibrec;
2273     }
2274     my $array = [];
2275     for my $field (qw/ lccn isbn issn title author dewey subject /)
2276     {
2277         my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2278         push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2279     }
2280     return $array;
2281 }
2282
2283 =head2 GetDistinctValues($field);
2284
2285 C<$field> is a reference to the fields array
2286
2287 =cut
2288
2289 sub GetDistinctValues {
2290     my ($fieldname,$string)=@_;
2291     # returns a reference to a hash of references to branches...
2292     if ($fieldname=~/\./){
2293                         my ($table,$column)=split /\./, $fieldname;
2294                         my $dbh = C4::Context->dbh;
2295                         warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2296                         my $sth = $dbh->prepare("select DISTINCT($column) as value, count(*) as cnt from $table ".($string?" where $column like \"$string%\"":"")."group by value order by $column ");
2297                         $sth->execute;
2298                         my $elements=$sth->fetchall_arrayref({});
2299                         return $elements;
2300    }
2301    else {
2302                 $string||= qq("");
2303                 my @servers=qw<biblioserver authorityserver>;
2304                 my (@zconns,@results);
2305         for ( my $i = 0 ; $i < @servers ; $i++ ) {
2306                 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2307                         $results[$i] =
2308                       $zconns[$i]->scan(
2309                         ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2310                       );
2311                 }
2312                 # The big moment: asynchronously retrieve results from all servers
2313                 my @elements;
2314         _ZOOM_event_loop(
2315             \@zconns,
2316             \@results,
2317             sub {
2318                 my ( $i, $size ) = @_;
2319                 for ( my $j = 0 ; $j < $size ; $j++ ) {
2320                     my %hashscan;
2321                     @hashscan{qw(value cnt)} =
2322                       $results[ $i - 1 ]->display_term($j);
2323                     push @elements, \%hashscan;
2324                 }
2325             }
2326         );
2327                 return \@elements;
2328    }
2329 }
2330
2331 =head2 _ZOOM_event_loop
2332
2333     _ZOOM_event_loop(\@zconns, \@results, sub {
2334         my ( $i, $size ) = @_;
2335         ....
2336     } );
2337
2338 Processes a ZOOM event loop and passes control to a closure for
2339 processing the results, and destroying the resultsets.
2340
2341 =cut
2342
2343 sub _ZOOM_event_loop {
2344     my ($zconns, $results, $callback) = @_;
2345     while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2346         my $ev = $zconns->[ $i - 1 ]->last_event();
2347         if ( $ev == ZOOM::Event::ZEND ) {
2348             next unless $results->[ $i - 1 ];
2349             my $size = $results->[ $i - 1 ]->size();
2350             if ( $size > 0 ) {
2351                 $callback->($i, $size);
2352             }
2353         }
2354     }
2355
2356     foreach my $result (@$results) {
2357         $result->destroy();
2358     }
2359 }
2360
2361
2362 END { }    # module clean-up code here (global destructor)
2363
2364 1;
2365 __END__
2366
2367 =head1 AUTHOR
2368
2369 Koha Development Team <http://koha-community.org/>
2370
2371 =cut