3 # This file is part of Koha.
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
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.
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
19 # use warnings; # FIXME
22 use C4::Biblio; # GetMarcFromKohaField, GetBiblioData
23 use C4::Koha; # getFacets
25 use C4::Search::PazPar2;
27 use C4::Dates qw(format_date);
34 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
36 # set the version for version checking
39 $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
44 C4::Search - Functions for searching the Koha catalog.
48 See opac/opac-search.pl or catalogue/search.pl for example of usage
52 This module provides searching functions for Koha's bibliographic databases
70 #FIXME: i had to add BiblioAddAuthorities here because in Biblios.pm it caused circular dependencies (C4::Search uses C4::Biblio, and BiblioAddAuthorities uses SimpleSearch from C4::Search)
72 # make all your functions, whether exported or not;
76 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
78 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
84 my $dbh = C4::Context->dbh;
85 my $result = TransformMarcToKoha( $dbh, $record, '' );
90 my ( $biblionumber, $title );
92 # search duplicate on ISBN, easy and fast..
94 if ( $result->{isbn} ) {
95 $result->{isbn} =~ s/\(.*$//;
96 $result->{isbn} =~ s/\s+$//;
97 $query = "isbn=$result->{isbn}";
100 $result->{title} =~ s /\\//g;
101 $result->{title} =~ s /\"//g;
102 $result->{title} =~ s /\(//g;
103 $result->{title} =~ s /\)//g;
105 # FIXME: instead of removing operators, could just do
106 # quotes around the value
107 $result->{title} =~ s/(and|or|not)//g;
108 $query = "ti,ext=$result->{title}";
109 $query .= " and itemtype=$result->{itemtype}"
110 if ( $result->{itemtype} );
111 if ( $result->{author} ) {
112 $result->{author} =~ s /\\//g;
113 $result->{author} =~ s /\"//g;
114 $result->{author} =~ s /\(//g;
115 $result->{author} =~ s /\)//g;
117 # remove valid operators
118 $result->{author} =~ s/(and|or|not)//g;
119 $query .= " and au,ext=$result->{author}";
123 # FIXME: add error handling
124 my ( $error, $searchresults ) = SimpleSearch($query); # FIXME :: hardcoded !
126 foreach my $possible_duplicate_record (@$searchresults) {
128 MARC::Record->new_from_usmarc($possible_duplicate_record);
129 my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
131 # FIXME :: why 2 $biblionumber ?
133 push @results, $result->{'biblionumber'};
134 push @results, $result->{'title'};
142 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
144 This function provides a simple search API on the bibliographic catalog
150 * $query can be a simple keyword or a complete CCL query
151 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
152 * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
153 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
158 * $error is a empty unless an error is detected
159 * \@results is an array of records.
160 * $total_hits is the number of hits that would have been returned with no limit
162 =item C<usage in the script:>
166 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
168 if (defined $error) {
169 $template->param(query_error => $error);
170 warn "error: ".$error;
171 output_html_with_http_headers $input, $cookie, $template->output;
175 my $hits = scalar @$marcresults;
178 for my $i (0..$hits) {
180 my $marcrecord = MARC::File::USMARC::decode($marcresults->[$i]);
181 my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,'');
183 #build the hash for the template.
184 $resultsloop{title} = $biblio->{'title'};
185 $resultsloop{subtitle} = $biblio->{'subtitle'};
186 $resultsloop{biblionumber} = $biblio->{'biblionumber'};
187 $resultsloop{author} = $biblio->{'author'};
188 $resultsloop{publishercode} = $biblio->{'publishercode'};
189 $resultsloop{publicationyear} = $biblio->{'publicationyear'};
191 push @results, \%resultsloop;
194 $template->param(result=>\@results);
199 my ( $query, $offset, $max_results, $servers ) = @_;
201 if ( C4::Context->preference('NoZebra') ) {
202 my $result = NZorder( NZanalyse($query) )->{'biblioserver'};
205 && $result->{hits} > 0 ? $result->{'RECORDS'} : [] );
206 return ( undef, $search_result, scalar($result->{hits}) );
209 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
210 my @servers = defined ( $servers ) ? @$servers : ( "biblioserver" );
216 return ( "No query entered", undef, undef ) unless $query;
218 # Initialize & Search Zebra
219 for ( my $i = 0 ; $i < @servers ; $i++ ) {
221 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
222 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
223 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
227 $zconns[$i]->errmsg() . " ("
228 . $zconns[$i]->errcode() . ") "
229 . $zconns[$i]->addinfo() . " "
230 . $zconns[$i]->diagset();
232 return ( $error, undef, undef ) if $zconns[$i]->errcode();
236 # caught a ZOOM::Exception
240 . $@->addinfo() . " "
243 return ( $error, undef, undef );
246 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
247 my $event = $zconns[ $i - 1 ]->last_event();
248 if ( $event == ZOOM::Event::ZEND ) {
250 my $first_record = defined( $offset ) ? $offset+1 : 1;
251 my $hits = $tmpresults[ $i - 1 ]->size();
252 $total_hits += $hits;
253 my $last_record = $hits;
254 if ( defined $max_results && $offset + $max_results < $hits ) {
255 $last_record = $offset + $max_results;
258 for my $j ( $first_record..$last_record ) {
259 my $record = $tmpresults[ $i - 1 ]->record( $j-1 )->raw(); # 0 indexed
260 push @results, $record;
265 foreach my $result (@tmpresults) {
268 foreach my $zoom_query (@zoom_queries) {
269 $zoom_query->destroy();
272 return ( undef, \@results, $total_hits );
278 ( undef, $results_hashref, \@facets_loop ) = getRecords (
280 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
281 $results_per_page, $offset, $expanded_facet, $branches,
285 The all singing, all dancing, multi-server, asynchronous, scanning,
286 searching, record nabbing, facet-building
288 See verbse embedded documentation.
294 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
295 $results_per_page, $offset, $expanded_facet, $branches,
299 my @servers = @$servers_ref;
300 my @sort_by = @$sort_by_ref;
302 # Initialize variables for the ZOOM connection and results object
306 my $results_hashref = ();
308 # Initialize variables for the faceted results objects
309 my $facets_counter = ();
310 my $facets_info = ();
311 my $facets = getFacets();
313 my @facets_loop; # stores the ref to array of hashes for template facets loop
315 ### LOOP THROUGH THE SERVERS
316 for ( my $i = 0 ; $i < @servers ; $i++ ) {
317 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
319 # perform the search, create the results objects
320 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
321 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
323 #$query_to_use = $simple_query if $scan;
324 warn $simple_query if ( $scan and $DEBUG );
326 # Check if we've got a query_type defined, if so, use it
329 if ($query_type =~ /^ccl/) {
330 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
331 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
332 } elsif ($query_type =~ /^cql/) {
333 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
334 } elsif ($query_type =~ /^pqf/) {
335 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
337 warn "Unknown query_type '$query_type'. Results undetermined.";
340 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
342 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
346 warn "WARNING: query problem with $query_to_use " . $@;
349 # Concatenate the sort_by limits and pass them to the results object
350 # Note: sort will override rank
352 foreach my $sort (@sort_by) {
353 if ( $sort eq "author_az" ) {
354 $sort_by .= "1=1003 <i ";
356 elsif ( $sort eq "author_za" ) {
357 $sort_by .= "1=1003 >i ";
359 elsif ( $sort eq "popularity_asc" ) {
360 $sort_by .= "1=9003 <i ";
362 elsif ( $sort eq "popularity_dsc" ) {
363 $sort_by .= "1=9003 >i ";
365 elsif ( $sort eq "call_number_asc" ) {
366 $sort_by .= "1=20 <i ";
368 elsif ( $sort eq "call_number_dsc" ) {
369 $sort_by .= "1=20 >i ";
371 elsif ( $sort eq "pubdate_asc" ) {
372 $sort_by .= "1=31 <i ";
374 elsif ( $sort eq "pubdate_dsc" ) {
375 $sort_by .= "1=31 >i ";
377 elsif ( $sort eq "acqdate_asc" ) {
378 $sort_by .= "1=32 <i ";
380 elsif ( $sort eq "acqdate_dsc" ) {
381 $sort_by .= "1=32 >i ";
383 elsif ( $sort eq "title_az" ) {
384 $sort_by .= "1=4 <i ";
386 elsif ( $sort eq "title_za" ) {
387 $sort_by .= "1=4 >i ";
390 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
394 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
395 warn "WARNING sort $sort_by failed";
398 } # finished looping through servers
400 # The big moment: asynchronously retrieve results from all servers
401 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
402 my $ev = $zconns[ $i - 1 ]->last_event();
403 if ( $ev == ZOOM::Event::ZEND ) {
404 next unless $results[ $i - 1 ];
405 my $size = $results[ $i - 1 ]->size();
409 # loop through the results
410 $results_hash->{'hits'} = $size;
412 if ( $offset + $results_per_page <= $size ) {
413 $times = $offset + $results_per_page;
418 for ( my $j = $offset ; $j < $times ; $j++ ) {
423 ## Check if it's an index scan
425 my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
427 # here we create a minimal MARC record and hand it off to the
428 # template just like a normal result ... perhaps not ideal, but
430 my $tmprecord = MARC::Record->new();
431 $tmprecord->encoding('UTF-8');
435 # the minimal record in author/title (depending on MARC flavour)
436 if (C4::Context->preference("marcflavour") eq "UNIMARC") {
437 $tmptitle = MARC::Field->new('200',' ',' ', a => $term, f => $occ);
438 $tmprecord->append_fields($tmptitle);
440 $tmptitle = MARC::Field->new('245',' ',' ', a => $term,);
441 $tmpauthor = MARC::Field->new('100',' ',' ', a => $occ,);
442 $tmprecord->append_fields($tmptitle);
443 $tmprecord->append_fields($tmpauthor);
445 $results_hash->{'RECORDS'}[$j] = $tmprecord->as_usmarc();
450 $record = $results[ $i - 1 ]->record($j)->raw();
452 # warn "RECORD $j:".$record;
453 $results_hash->{'RECORDS'}[$j] = $record;
455 # Fill the facets while we're looping, but only for the biblioserver
456 $facet_record = MARC::Record->new_from_usmarc($record)
457 if $servers[ $i - 1 ] =~ /biblioserver/;
459 #warn $servers[$i-1]."\n".$record; #.$facet_record->title();
461 for ( my $k = 0 ; $k <= @$facets ; $k++ ) {
462 ($facets->[$k]) or next;
463 my @fields = map {$facet_record->field($_)} @{$facets->[$k]->{'tags'}} ;
464 for my $field (@fields) {
465 my @subfields = $field->subfields();
466 for my $subfield (@subfields) {
467 my ( $code, $data ) = @$subfield;
468 ($code eq $facets->[$k]->{'subfield'}) or next;
469 $facets_counter->{ $facets->[$k]->{'link_value'} }->{$data}++;
472 $facets_info->{ $facets->[$k]->{'link_value'} }->{'label_value'} =
473 $facets->[$k]->{'label_value'};
474 $facets_info->{ $facets->[$k]->{'link_value'} }->{'expanded'} =
475 $facets->[$k]->{'expanded'};
480 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
483 # warn "connection ", $i-1, ": $size hits";
484 # warn $results[$i-1]->record(0)->render() if $size > 0;
487 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
489 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
490 keys %$facets_counter )
493 my $number_of_facets;
494 my @this_facets_array;
497 $facets_counter->{$link_value}->{$b}
498 <=> $facets_counter->{$link_value}->{$a}
499 } keys %{ $facets_counter->{$link_value} }
503 if ( ( $number_of_facets < 6 )
504 || ( $expanded_facet eq $link_value )
505 || ( $facets_info->{$link_value}->{'expanded'} ) )
508 # Sanitize the link value ), ( will cause errors with CCL,
509 my $facet_link_value = $one_facet;
510 $facet_link_value =~ s/(\(|\))/ /g;
512 # fix the length that will display in the label,
513 my $facet_label_value = $one_facet;
515 substr( $one_facet, 0, 20 ) . "..."
516 unless length($facet_label_value) <= 20;
518 # if it's a branch, label by the name, not the code,
519 if ( $link_value =~ /branch/ ) {
520 if (defined $branches
521 && ref($branches) eq "HASH"
522 && defined $branches->{$one_facet}
523 && ref ($branches->{$one_facet}) eq "HASH")
526 $branches->{$one_facet}->{'branchname'};
529 $facet_label_value = "*";
533 # but we're down with the whole label being in the link's title.
534 push @this_facets_array, {
535 facet_count => $facets_counter->{$link_value}->{$one_facet},
536 facet_label_value => $facet_label_value,
537 facet_title_value => $one_facet,
538 facet_link_value => $facet_link_value,
539 type_link_value => $link_value,
544 # handle expanded option
545 unless ( $facets_info->{$link_value}->{'expanded'} ) {
547 if ( ( $number_of_facets > 6 )
548 && ( $expanded_facet ne $link_value ) );
551 type_link_value => $link_value,
552 type_id => $link_value . "_id",
553 "type_label_" . $facets_info->{$link_value}->{'label_value'} => 1,
554 facets => \@this_facets_array,
555 expandable => $expandable,
556 expand => $link_value,
557 } unless ( ($facets_info->{$link_value}->{'label_value'} =~ /Libraries/) and (C4::Context->preference('singleBranchMode')) );
562 return ( undef, $results_hashref, \@facets_loop );
567 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
568 $results_per_page, $offset, $expanded_facet, $branches,
572 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
574 $paz->search($simple_query);
575 sleep 1; # FIXME: WHY?
578 my $results_hashref = {};
579 my $stats = XMLin($paz->stat);
580 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
582 # for a grouped search result, the number of hits
583 # is the number of groups returned; 'bib_hits' will have
584 # the total number of bibs.
585 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
586 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
588 HIT: foreach my $hit (@{ $results->{'hit'} }) {
589 my $recid = $hit->{recid}->[0];
591 my $work_title = $hit->{'md-work-title'}->[0];
593 if (exists $hit->{'md-work-author'}) {
594 $work_author = $hit->{'md-work-author'}->[0];
596 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
598 my $result_group = {};
599 $result_group->{'group_label'} = $group_label;
600 $result_group->{'group_merge_key'} = $recid;
603 if (exists $hit->{count}) {
604 $count = $hit->{count}->[0];
606 $result_group->{'group_count'} = $count;
608 for (my $i = 0; $i < $count; $i++) {
609 # FIXME -- may need to worry about diacritics here
610 my $rec = $paz->record($recid, $i);
611 push @{ $result_group->{'RECORDS'} }, $rec;
614 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
617 # pass through facets
618 my $termlist_xml = $paz->termlist('author,subject');
619 my $terms = XMLin($termlist_xml, forcearray => 1);
620 my @facets_loop = ();
621 #die Dumper($results);
622 # foreach my $list (sort keys %{ $terms->{'list'} }) {
624 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
626 # facet_label_value => $facet->{'name'}->[0],
629 # push @facets_loop, ( {
630 # type_label => $list,
631 # facets => \@facets,
635 return ( undef, $results_hashref, \@facets_loop );
639 sub _remove_stopwords {
640 my ( $operand, $index ) = @_;
641 my @stopwords_removed;
643 # phrase and exact-qualified indexes shouldn't have stopwords removed
644 if ( $index !~ m/phr|ext/ ) {
646 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
647 # we use IsAlpha unicode definition, to deal correctly with diacritics.
648 # otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
649 # is a stopword, we'd get "çon" and wouldn't find anything...
651 foreach ( keys %{ C4::Context->stopwords } ) {
652 next if ( $_ =~ /(and|or|not)/ ); # don't remove operators
653 $debug && warn "$_ Dump($operand)";
654 if ( my ($matched) = ($operand =~
655 /([^\X\p{isAlnum}]\Q$_\E[^\X\p{isAlnum}]|[^\X\p{isAlnum}]\Q$_\E$|^\Q$_\E[^\X\p{isAlnum}])/gi))
657 $operand =~ s/\Q$matched\E/ /gi;
658 push @stopwords_removed, $_;
662 return ( $operand, \@stopwords_removed );
666 sub _detect_truncation {
667 my ( $operand, $index ) = @_;
668 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
671 my @wordlist = split( /\s/, $operand );
672 foreach my $word (@wordlist) {
673 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
674 push @rightlefttruncated, $word;
676 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
677 push @lefttruncated, $word;
679 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
680 push @righttruncated, $word;
682 elsif ( index( $word, "*" ) < 0 ) {
683 push @nontruncated, $word;
686 push @regexpr, $word;
690 \@nontruncated, \@righttruncated, \@lefttruncated,
691 \@rightlefttruncated, \@regexpr
696 sub _build_stemmed_operand {
697 my ($operand,$lang) = @_;
698 require Lingua::Stem::Snowball ;
701 # If operand contains a digit, it is almost certainly an identifier, and should
702 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
703 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
704 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
705 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
706 return $operand if $operand =~ /\d/;
708 # FIXME: the locale should be set based on the user's language and/or search choice
710 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
711 encoding => "UTF-8" );
713 my @words = split( / /, $operand );
714 my @stems = $stemmer->stem(\@words);
715 for my $stem (@stems) {
716 $stemmed_operand .= "$stem";
717 $stemmed_operand .= "?"
718 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
719 $stemmed_operand .= " ";
721 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
722 return $stemmed_operand;
726 sub _build_weighted_query {
728 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
729 # pretty well but could work much better if we had a smarter query parser
730 my ( $operand, $stemmed_operand, $index ) = @_;
731 my $stemming = C4::Context->preference("QueryStemming") || 0;
732 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
733 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
735 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
737 # Keyword, or, no index specified
738 if ( ( $index eq 'kw' ) || ( !$index ) ) {
740 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
741 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
742 $weighted_query .= " or ti,phr,r3=\"$operand\""; # phrase title
743 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
744 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
745 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
746 if $fuzzy_enabled; # add fuzzy, word list
747 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
748 if ( $stemming and $stemmed_operand )
749 ; # add stemming, right truncation
750 $weighted_query .= " or wrdl,r9=\"$operand\"";
752 # embedded sorting: 0 a-z; 1 z-a
753 # $weighted_query .= ") or (sort1,aut=1";
756 # Barcode searches should skip this process
757 elsif ( $index eq 'bc' ) {
758 $weighted_query .= "bc=\"$operand\"";
761 # Authority-number searches should skip this process
762 elsif ( $index eq 'an' ) {
763 $weighted_query .= "an=\"$operand\"";
766 # If the index already has more than one qualifier, wrap the operand
767 # in quotes and pass it back (assumption is that the user knows what they
768 # are doing and won't appreciate us mucking up their query
769 elsif ( $index =~ ',' ) {
770 $weighted_query .= " $index=\"$operand\"";
773 #TODO: build better cases based on specific search indexes
775 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
776 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
777 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
779 " or $index,rt,wrdl,r3=\"$operand\""; # word list index
782 $weighted_query .= "))"; # close rank specification
783 return $weighted_query;
789 $simple_query, $query_cgi,
791 $limit_cgi, $limit_desc,
792 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
794 Build queries and limits in CCL, CGI, Human,
795 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
797 See verbose embedded documentation.
803 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
805 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
808 my @operators = $operators ? @$operators : ();
809 my @indexes = $indexes ? @$indexes : ();
810 my @operands = $operands ? @$operands : ();
811 my @limits = $limits ? @$limits : ();
812 my @sort_by = $sort_by ? @$sort_by : ();
814 my $stemming = C4::Context->preference("QueryStemming") || 0;
815 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
816 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
817 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
818 my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
820 # no stemming/weight/fuzzy in NoZebra
821 if ( C4::Context->preference("NoZebra") ) {
827 my $query = $operands[0];
828 my $simple_query = $operands[0];
830 # initialize the variables we're passing back
839 my $stopwords_removed; # flag to determine if stopwords have been removed
841 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
843 if ( $query =~ /^ccl=/ ) {
844 return ( undef, $', $', "q=ccl=$'", $', '', '', '', '', 'ccl' );
846 if ( $query =~ /^cql=/ ) {
847 return ( undef, $', $', "q=cql=$'", $', '', '', '', '', 'cql' );
849 if ( $query =~ /^pqf=/ ) {
850 return ( undef, $', $', "q=pqf=$'", $', '', '', '', '', 'pqf' );
853 # pass nested queries directly
854 # FIXME: need better handling of some of these variables in this case
855 # Nested queries aren't handled well and this implementation is flawed and causes users to be
856 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
857 # if ( $query =~ /(\(|\))/ ) {
859 # undef, $query, $simple_query, $query_cgi,
860 # $query, $limit, $limit_cgi, $limit_desc,
861 # $stopwords_removed, 'ccl'
865 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
866 # query operands and indexes and add stemming, truncation, field weighting, etc.
867 # Once we do so, we'll end up with a value in $query, just like if we had an
868 # incoming $query from the user
871 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
873 ; # a flag used to keep track if there was a previous query
874 # if there was, we can apply the current operator
876 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
878 # COMBINE OPERANDS, INDEXES AND OPERATORS
879 if ( $operands[$i] ) {
881 # A flag to determine whether or not to add the index to the query
884 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
885 if ( $operands[$i] =~ /(:|=)/ || $scan ) {
888 $remove_stopwords = 0;
890 my $operand = $operands[$i];
891 my $index = $indexes[$i];
893 # Add index-specific attributes
894 # Date of Publication
895 if ( $index eq 'yr' ) {
896 $index .= ",st-numeric";
898 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
901 # Date of Acquisition
902 elsif ( $index eq 'acqdate' ) {
903 $index .= ",st-date-normalized";
905 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
907 # ISBN,ISSN,Standard Number, don't need special treatment
908 elsif ( $index eq 'nb' || $index eq 'ns' ) {
911 $stemming, $auto_truncation,
912 $weight_fields, $fuzzy_enabled,
914 ) = ( 0, 0, 0, 0, 0 );
917 # Set default structure attribute (word list)
919 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl)/ ) {
920 $struct_attr = ",wrdl";
923 # Some helpful index variants
924 my $index_plus = $index . $struct_attr . ":" if $index;
925 my $index_plus_comma = $index . $struct_attr . "," if $index;
928 if ($remove_stopwords) {
929 ( $operand, $stopwords_removed ) =
930 _remove_stopwords( $operand, $index );
931 warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
932 warn "REMOVED STOPWORDS: @$stopwords_removed"
933 if ( $stopwords_removed && $DEBUG );
936 if ($auto_truncation){
937 # join throws an error if there is a leading space
938 $operand =~ s/^\s+//;
939 $operand=~join(" ",map{ "$_*" }split (/\s+/,$operand));
943 my $truncated_operand;
944 my( $nontruncated, $righttruncated, $lefttruncated,
945 $rightlefttruncated, $regexpr
946 ) = _detect_truncation( $operand, $index );
948 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
953 scalar(@$righttruncated) + scalar(@$lefttruncated) +
954 scalar(@$rightlefttruncated) > 0 )
957 # Don't field weight or add the index to the query, we do it here
959 undef $weight_fields;
960 my $previous_truncation_operand;
961 if (scalar @$nontruncated) {
962 $truncated_operand .= "$index_plus @$nontruncated ";
963 $previous_truncation_operand = 1;
965 if (scalar @$righttruncated) {
966 $truncated_operand .= "and " if $previous_truncation_operand;
967 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
968 $previous_truncation_operand = 1;
970 if (scalar @$lefttruncated) {
971 $truncated_operand .= "and " if $previous_truncation_operand;
972 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
973 $previous_truncation_operand = 1;
975 if (scalar @$rightlefttruncated) {
976 $truncated_operand .= "and " if $previous_truncation_operand;
977 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
978 $previous_truncation_operand = 1;
981 $operand = $truncated_operand if $truncated_operand;
982 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
986 $stemmed_operand = _build_stemmed_operand($operand, $lang)
989 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
991 # Handle Field Weighting
992 my $weighted_operand;
993 if ($weight_fields) {
994 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
995 $operand = $weighted_operand;
999 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1001 # If there's a previous operand, we need to add an operator
1002 if ($previous_operand) {
1004 # User-specified operator
1005 if ( $operators[ $i - 1 ] ) {
1006 $query .= " $operators[$i-1] ";
1007 $query .= " $index_plus " unless $indexes_set;
1008 $query .= " $operand";
1009 $query_cgi .= "&op=$operators[$i-1]";
1010 $query_cgi .= "&idx=$index" if $index;
1011 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1013 " $operators[$i-1] $index_plus $operands[$i]";
1016 # Default operator is and
1019 $query .= "$index_plus " unless $indexes_set;
1020 $query .= "$operand";
1021 $query_cgi .= "&op=and&idx=$index" if $index;
1022 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1023 $query_desc .= " and $index_plus $operands[$i]";
1027 # There isn't a pervious operand, don't need an operator
1030 # Field-weighted queries already have indexes set
1031 $query .= " $index_plus " unless $indexes_set;
1033 $query_desc .= " $index_plus $operands[$i]";
1034 $query_cgi .= "&idx=$index" if $index;
1035 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1036 $previous_operand = 1;
1041 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1044 my $group_OR_limits;
1045 my $availability_limit;
1046 foreach my $this_limit (@limits) {
1047 # if ( $this_limit =~ /available/ ) {
1049 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1051 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1052 # $availability_limit .=
1053 #"( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1054 # $limit_cgi .= "&limit=available";
1055 # $limit_desc .= "";
1058 # group_OR_limits, prefixed by mc-
1059 # OR every member of the group
1060 # elsif ( $this_limit =~ /mc/ ) {
1061 if ( $this_limit =~ /mc/ ) {
1062 $group_OR_limits .= " or " if $group_OR_limits;
1063 $limit_desc .= " or " if $group_OR_limits;
1064 $group_OR_limits .= "$this_limit";
1065 $limit_cgi .= "&limit=$this_limit";
1066 $limit_desc .= " $this_limit";
1069 # Regular old limits
1071 $limit .= " and " if $limit || $query;
1072 $limit .= "$this_limit";
1073 $limit_cgi .= "&limit=$this_limit";
1074 if ($this_limit =~ /^branch:(.+)/) {
1075 my $branchcode = $1;
1076 my $branchname = GetBranchName($branchcode);
1077 if (defined $branchname) {
1078 $limit_desc .= " branch:$branchname";
1080 $limit_desc .= " $this_limit";
1083 $limit_desc .= " $this_limit";
1087 if ($group_OR_limits) {
1088 $limit .= " and " if ( $query || $limit );
1089 $limit .= "($group_OR_limits)";
1091 if ($availability_limit) {
1092 $limit .= " and " if ( $query || $limit );
1093 $limit .= "($availability_limit)";
1096 # Normalize the query and limit strings
1099 for ( $query, $query_desc, $limit, $limit_desc ) {
1100 s/ / /g; # remove extra spaces
1101 s/^ //g; # remove any beginning spaces
1102 s/ $//g; # remove any ending spaces
1103 s/==/=/g; # remove double == from query
1105 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1107 for ($query_cgi,$simple_query) {
1110 # append the limit to the query
1111 $query .= " " . $limit;
1115 warn "QUERY:" . $query;
1116 warn "QUERY CGI:" . $query_cgi;
1117 warn "QUERY DESC:" . $query_desc;
1118 warn "LIMIT:" . $limit;
1119 warn "LIMIT CGI:" . $limit_cgi;
1120 warn "LIMIT DESC:" . $limit_desc;
1121 warn "---------\nLeave buildQuery\n---------";
1124 undef, $query, $simple_query, $query_cgi,
1125 $query_desc, $limit, $limit_cgi, $limit_desc,
1126 $stopwords_removed, $query_type
1130 =head2 searchResults
1132 Format results in a form suitable for passing to the template
1136 # IMO this subroutine is pretty messy still -- it's responsible for
1137 # building the HTML output for the template
1139 my ( $searchdesc, $hits, $results_per_page, $offset, $scan, @marcresults, $hidelostitems ) = @_;
1140 my $dbh = C4::Context->dbh;
1143 #Build branchnames hash
1145 #get branch information.....
1147 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1149 while ( my $bdata = $bsth->fetchrow_hashref ) {
1150 $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1152 # FIXME - We build an authorised values hash here, using the default framework
1153 # though it is possible to have different authvals for different fws.
1155 my $shelflocations =GetKohaAuthorisedValues('items.location','');
1157 # get notforloan authorised value list (see $shelflocations FIXME)
1158 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1160 #Build itemtype hash
1161 #find itemtype & itemtype image
1165 "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1168 while ( my $bdata = $bsth->fetchrow_hashref ) {
1169 foreach (qw(description imageurl summary notforloan)) {
1170 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1174 #search item field code
1177 "SELECT tagfield FROM marc_subfield_structure WHERE kohafield LIKE 'items.itemnumber'"
1180 my ($itemtag) = $sth->fetchrow;
1182 ## find column names of items related to MARC
1183 my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1185 my %subfieldstosearch;
1186 while ( ( my $column ) = $sth2->fetchrow ) {
1187 my ( $tagfield, $tagsubfield ) =
1188 &GetMarcFromKohaField( "items." . $column, "" );
1189 $subfieldstosearch{$column} = $tagsubfield;
1192 # handle which records to actually retrieve
1194 if ( $hits && $offset + $results_per_page <= $hits ) {
1195 $times = $offset + $results_per_page;
1198 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1201 my $marcflavour = C4::Context->preference("marcflavour");
1202 # We get the biblionumber position in MARC
1203 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1206 # loop through all of the records we've retrieved
1207 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1208 my $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
1211 $fw = GetFrameworkCode($marcrecord->field($bibliotag)->data);
1213 $fw = GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1216 my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1217 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1218 $oldbiblio->{result_number} = $i + 1;
1220 # add imageurl to itemtype if there is one
1221 $oldbiblio->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1223 $oldbiblio->{'authorised_value_images'} = C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{'biblionumber'}, $marcrecord ) );
1224 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1225 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1226 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1227 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1228 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1230 # edition information, if any
1231 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1232 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1233 # Build summary if there is one (the summary is defined in the itemtypes table)
1234 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1235 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1236 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1237 my @fields = $marcrecord->fields();
1240 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1242 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1243 $tag =~ /(.{3})(.)/;
1244 if($marcrecord->field($1)){
1245 my @abc = $marcrecord->field($1)->subfield($2);
1246 $tags->{$tag} = $#abc + 1 ;
1250 # We catch how many times to repeat this line
1252 foreach my $tag (keys(%$tags)){
1253 $max = $tags->{$tag} if($tags->{$tag} > $max);
1256 # we replace, and repeat each line
1257 for (my $i = 0 ; $i < $max ; $i++){
1258 my $newline = $line;
1260 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1261 $tag =~ /(.{3})(.)/;
1263 if($marcrecord->field($1)){
1264 my @repl = $marcrecord->field($1)->subfield($2);
1265 my $subfieldvalue = $repl[$i];
1267 if (! utf8::is_utf8($subfieldvalue)) {
1268 utf8::decode($subfieldvalue);
1271 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1274 $newsummary .= "$newline\n";
1278 $newsummary =~ s/\[(.*?)]//g;
1279 $newsummary =~ s/\n/<br\/>/g;
1280 $oldbiblio->{summary} = $newsummary;
1283 # Pull out the items fields
1284 my @fields = $marcrecord->field($itemtag);
1286 # Setting item statuses for display
1287 my @available_items_loop;
1288 my @onloan_items_loop;
1289 my @other_items_loop;
1291 my $available_items;
1295 my $ordered_count = 0;
1296 my $available_count = 0;
1297 my $onloan_count = 0;
1298 my $longoverdue_count = 0;
1299 my $other_count = 0;
1300 my $wthdrawn_count = 0;
1301 my $itemlost_count = 0;
1302 my $itembinding_count = 0;
1303 my $itemdamaged_count = 0;
1304 my $item_in_transit_count = 0;
1305 my $can_place_holds = 0;
1306 my $items_count = scalar(@fields);
1308 ( C4::Context->preference('maxItemsinSearchResults') )
1309 ? C4::Context->preference('maxItemsinSearchResults') - 1
1312 # loop through every item
1313 foreach my $field (@fields) {
1316 # populate the items hash
1317 foreach my $code ( keys %subfieldstosearch ) {
1318 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1321 my $hbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch' : 'holdingbranch';
1322 my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1323 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1324 if ($item->{$hbranch}) {
1325 $item->{'branchname'} = $branches{$item->{$hbranch}};
1327 elsif ($item->{$otherbranch}) { # Last resort
1328 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1331 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1332 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1333 if ( $item->{onloan} ) {
1335 my $key = $prefix . $item->{onloan} . $item->{barcode};
1336 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1337 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1338 $onloan_items->{$key}->{branchname} = $item->{branchname};
1339 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1340 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1341 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1342 # if something's checked out and lost, mark it as 'long overdue'
1343 if ( $item->{itemlost} ) {
1344 $onloan_items->{$prefix}->{longoverdue}++;
1345 $longoverdue_count++;
1346 } else { # can place holds as long as item isn't lost
1347 $can_place_holds = 1;
1351 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1355 if ( $item->{notforloan} == -1 ) {
1359 # is item in transit?
1360 my $transfertwhen = '';
1361 my ($transfertfrom, $transfertto);
1363 unless ($item->{wthdrawn}
1364 || $item->{itemlost}
1366 || $item->{notforloan}
1367 || $items_count > 20) {
1369 # A couple heuristics to limit how many times
1370 # we query the database for item transfer information, sacrificing
1371 # accuracy in some cases for speed;
1373 # 1. don't query if item has one of the other statuses
1374 # 2. don't check transit status if the bib has
1375 # more than 20 items
1377 # FIXME: to avoid having the query the database like this, and to make
1378 # the in transit status count as unavailable for search limiting,
1379 # should map transit status to record indexed in Zebra.
1381 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1384 # item is withdrawn, lost or damaged
1385 if ( $item->{wthdrawn}
1386 || $item->{itemlost}
1388 || $item->{notforloan}
1389 || ($transfertwhen ne ''))
1391 $wthdrawn_count++ if $item->{wthdrawn};
1392 $itemlost_count++ if $item->{itemlost};
1393 $itemdamaged_count++ if $item->{damaged};
1394 $item_in_transit_count++ if $transfertwhen ne '';
1395 $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1398 my $key = $prefix . $item->{status};
1399 foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber)) {
1400 $other_items->{$key}->{$_} = $item->{$_};
1402 $other_items->{$key}->{intransit} = ($transfertwhen ne '') ? 1 : 0;
1403 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value;
1404 $other_items->{$key}->{count}++ if $item->{$hbranch};
1405 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1406 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1410 $can_place_holds = 1;
1412 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1413 foreach (qw(branchname itemcallnumber)) {
1414 $available_items->{$prefix}->{$_} = $item->{$_};
1416 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1417 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1420 } # notforloan, item level and biblioitem level
1421 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1423 ( C4::Context->preference('maxItemsinSearchResults') )
1424 ? C4::Context->preference('maxItemsinSearchResults') - 1
1426 for my $key ( sort keys %$onloan_items ) {
1427 (++$onloanitemscount > $maxitems) and last;
1428 push @onloan_items_loop, $onloan_items->{$key};
1430 for my $key ( sort keys %$other_items ) {
1431 (++$otheritemscount > $maxitems) and last;
1432 push @other_items_loop, $other_items->{$key};
1434 for my $key ( sort keys %$available_items ) {
1435 (++$availableitemscount > $maxitems) and last;
1436 push @available_items_loop, $available_items->{$key}
1439 # XSLT processing of some stuff
1440 if (C4::Context->preference("XSLTResultsDisplay") && !$scan) {
1441 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display(
1442 $oldbiblio->{biblionumber}, $marcrecord, 'Results' );
1445 # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1446 $can_place_holds = 0
1447 if $itemtypes{ $oldbiblio->{itemtype} }->{notforloan};
1448 $oldbiblio->{norequests} = 1 unless $can_place_holds;
1449 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
1450 $oldbiblio->{items_count} = $items_count;
1451 $oldbiblio->{available_items_loop} = \@available_items_loop;
1452 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
1453 $oldbiblio->{other_items_loop} = \@other_items_loop;
1454 $oldbiblio->{availablecount} = $available_count;
1455 $oldbiblio->{availableplural} = 1 if $available_count > 1;
1456 $oldbiblio->{onloancount} = $onloan_count;
1457 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
1458 $oldbiblio->{othercount} = $other_count;
1459 $oldbiblio->{otherplural} = 1 if $other_count > 1;
1460 $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1461 $oldbiblio->{itemlostcount} = $itemlost_count;
1462 $oldbiblio->{damagedcount} = $itemdamaged_count;
1463 $oldbiblio->{intransitcount} = $item_in_transit_count;
1464 $oldbiblio->{orderedcount} = $ordered_count;
1465 $oldbiblio->{isbn} =~
1466 s/-//g; # deleting - in isbn to enable amazon content
1467 push( @newresults, $oldbiblio )
1468 if(not $hidelostitems
1469 or (($items_count > $itemlost_count )
1470 && $hidelostitems));
1476 =head2 SearchAcquisitions
1477 Search for acquisitions
1480 sub SearchAcquisitions{
1481 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
1483 my $dbh=C4::Context->dbh;
1484 # Variable initialization
1488 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1489 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
1490 WHERE dateaccessioned BETWEEN ? AND ?
1493 my (@params,@loopcriteria);
1495 push @params, $datebegin->output("iso");
1496 push @params, $dateend->output("iso");
1498 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
1499 if(C4::Context->preference("item-level_itypes")){
1500 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1502 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1504 push @params, @$itemtypes;
1507 if ($criteria =~/itemtype/){
1508 if(C4::Context->preference("item-level_itypes")){
1509 $str .= "AND items.itype=? ";
1511 $str .= "AND biblioitems.itemtype=? ";
1514 if(scalar(@$itemtypes) == 0){
1515 my $itypes = GetItemTypes();
1516 for my $key (keys %$itypes){
1517 push @$itemtypes, $key;
1521 @loopcriteria= @$itemtypes;
1522 }elsif ($criteria=~/itemcallnumber/){
1523 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
1524 OR items.itemcallnumber is NULL
1525 OR items.itemcallnumber = '')";
1527 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
1529 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
1530 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
1533 if ($orderby =~ /date_desc/){
1534 $str.=" ORDER BY dateaccessioned DESC";
1536 $str.=" ORDER BY title";
1539 my $qdataacquisitions=$dbh->prepare($str);
1541 my @loopacquisitions;
1542 foreach my $value(@loopcriteria){
1543 push @params,$value;
1545 $cell{"title"}=$value;
1546 $cell{"titlecode"}=$value;
1548 eval{$qdataacquisitions->execute(@params);};
1550 if ($@){ warn "recentacquisitions Error :$@";}
1553 while (my $data=$qdataacquisitions->fetchrow_hashref){
1554 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
1556 $cell{"loopdata"}=\@loopdata;
1558 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
1561 $qdataacquisitions->finish;
1562 return \@loopacquisitions;
1564 #----------------------------------------------------------------------
1566 # Non-Zebra GetRecords#
1567 #----------------------------------------------------------------------
1571 NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1577 $query, $simple_query, $sort_by_ref, $servers_ref,
1578 $results_per_page, $offset, $expanded_facet, $branches,
1581 warn "query =$query" if $DEBUG;
1582 my $result = NZanalyse($query);
1583 warn "results =$result" if $DEBUG;
1585 NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1591 NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1592 the list is built from an inverted index in the nozebra SQL table
1593 note that title is here only for convenience : the sorting will be very fast when requested on title
1594 if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1599 my ( $string, $server ) = @_;
1600 # warn "---------" if $DEBUG;
1601 warn " NZanalyse" if $DEBUG;
1602 # warn "---------" if $DEBUG;
1604 # $server contains biblioserver or authorities, depending on what we search on.
1605 #warn "querying : $string on $server";
1606 $server = 'biblioserver' unless $server;
1608 # if we have a ", replace the content to discard temporarily any and/or/not inside
1610 if ( $string =~ /"/ ) {
1611 $string =~ s/"(.*?)"/__X__/;
1613 warn "commacontent : $commacontent" if $DEBUG;
1616 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1617 # then, call again NZanalyse with $left and $right
1618 # (recursive until we find a leaf (=> something without and/or/not)
1619 # delete repeated operator... Would then go in infinite loop
1620 while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
1623 #process parenthesis before.
1624 if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
1627 my $operator = lc($3); # FIXME: and/or/not are operators, not operands
1629 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
1631 my $leftresult = NZanalyse( $left, $server );
1633 my $rightresult = NZanalyse( $right, $server );
1635 # OK, we have the results for right and left part of the query
1636 # depending of operand, intersect, union or exclude both lists
1637 # to get a result list
1638 if ( $operator eq ' and ' ) {
1639 return NZoperatorAND($leftresult,$rightresult);
1641 elsif ( $operator eq ' or ' ) {
1643 # just merge the 2 strings
1644 return $leftresult . $rightresult;
1646 elsif ( $operator eq ' not ' ) {
1647 return NZoperatorNOT($leftresult,$rightresult);
1651 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1655 warn "string :" . $string if $DEBUG;
1659 if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
1662 $operator = lc($2); # FIXME: and/or/not are operators, not operands
1664 warn "no parenthesis. left : $left operator: $operator right: $right"
1667 # it's not a leaf, we have a and/or/not
1670 # reintroduce comma content if needed
1671 $right =~ s/__X__/"$commacontent"/ if $commacontent;
1672 $left =~ s/__X__/"$commacontent"/ if $commacontent;
1673 warn "node : $left / $operator / $right\n" if $DEBUG;
1674 my $leftresult = NZanalyse( $left, $server );
1675 my $rightresult = NZanalyse( $right, $server );
1676 warn " leftresult : $leftresult" if $DEBUG;
1677 warn " rightresult : $rightresult" if $DEBUG;
1678 # OK, we have the results for right and left part of the query
1679 # depending of operand, intersect, union or exclude both lists
1680 # to get a result list
1681 if ( $operator eq ' and ' ) {
1683 return NZoperatorAND($leftresult,$rightresult);
1685 elsif ( $operator eq ' or ' ) {
1687 # just merge the 2 strings
1688 return $leftresult . $rightresult;
1690 elsif ( $operator eq ' not ' ) {
1691 return NZoperatorNOT($leftresult,$rightresult);
1695 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1696 die "error : operand unknown : $operator for $string";
1699 # it's a leaf, do the real SQL query and return the result
1702 $string =~ s/__X__/"$commacontent"/ if $commacontent;
1703 $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1704 #remove trailing blank at the beginning
1706 warn "leaf:$string" if $DEBUG;
1708 # parse the string in in operator/operand/value again
1712 if ($string =~ /(.*)(>=|<=)(.*)/) {
1719 # warn "handling leaf... left:$left operator:$operator right:$right"
1721 unless ($operator) {
1722 if ($string =~ /(.*)(>|<|=)(.*)/) {
1727 "handling unless (operator)... left:$left operator:$operator right:$right"
1735 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
1738 # automatic replace for short operators
1739 $left = 'title' if $left =~ '^ti$';
1740 $left = 'author' if $left =~ '^au$';
1741 $left = 'publisher' if $left =~ '^pb$';
1742 $left = 'subject' if $left =~ '^su$';
1743 $left = 'koha-Auth-Number' if $left =~ '^an$';
1744 $left = 'keyword' if $left =~ '^kw$';
1745 $left = 'itemtype' if $left =~ '^mc$'; # Fix for Bug 2599 - Search limits not working for NoZebra
1746 warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
1747 my $dbh = C4::Context->dbh;
1748 if ( $operator && $left ne 'keyword' ) {
1749 #do a specific search
1750 $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
1751 my $sth = $dbh->prepare(
1752 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
1754 warn "$left / $operator / $right\n" if $DEBUG;
1756 # split each word, query the DB and build the biblionumbers result
1757 #sanitizing leftpart
1758 $left =~ s/^\s+|\s+$//;
1759 foreach ( split / /, $right ) {
1761 $_ =~ s/^\s+|\s+$//;
1763 warn "EXECUTE : $server, $left, $_" if $DEBUG;
1764 $sth->execute( $server, $left, $_ )
1765 or warn "execute failed: $!";
1766 while ( my ( $line, $value ) = $sth->fetchrow ) {
1768 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1769 # otherwise, fill the result
1770 $biblionumbers .= $line
1771 unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
1772 warn "result : $value "
1773 . ( $right =~ /\d/ ) . "=="
1774 . ( $value =~ /\D/?$line:"" ) if $DEBUG; #= $line";
1777 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1779 warn "NZAND" if $DEBUG;
1780 $results = NZoperatorAND($biblionumbers,$results);
1782 $results = $biblionumbers;
1787 #do a complete search (all indexes), if index='kw' do complete search too.
1788 my $sth = $dbh->prepare(
1789 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
1792 # split each word, query the DB and build the biblionumbers result
1793 foreach ( split / /, $string ) {
1794 next if C4::Context->stopwords->{ uc($_) }; # skip if stopword
1795 warn "search on all indexes on $_" if $DEBUG;
1798 $sth->execute( $server, $_ );
1799 while ( my $line = $sth->fetchrow ) {
1800 $biblionumbers .= $line;
1803 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1805 $results = NZoperatorAND($biblionumbers,$results);
1808 warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
1809 $results = $biblionumbers;
1813 warn "return : $results for LEAF : $string" if $DEBUG;
1816 warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
1820 my ($rightresult, $leftresult)=@_;
1822 my @leftresult = split /;/, $leftresult;
1823 warn " @leftresult / $rightresult \n" if $DEBUG;
1825 # my @rightresult = split /;/,$leftresult;
1828 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
1829 # the result is stored twice, to have the same weight for AND than OR.
1830 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
1831 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
1832 foreach (@leftresult) {
1835 ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
1836 if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
1837 $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
1839 "$value-$countvalue;$value-$countvalue;";
1842 warn "NZAND DONE : $finalresult \n" if $DEBUG;
1843 return $finalresult;
1847 my ($rightresult, $leftresult)=@_;
1848 return $rightresult.$leftresult;
1852 my ($leftresult, $rightresult)=@_;
1854 my @leftresult = split /;/, $leftresult;
1856 # my @rightresult = split /;/,$leftresult;
1858 foreach (@leftresult) {
1860 $value=$1 if $value=~m/(.*)-\d+$/;
1861 unless ($rightresult =~ "$value-") {
1862 $finalresult .= "$_;";
1865 return $finalresult;
1870 $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
1877 my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
1878 warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
1880 # order title asc by default
1881 # $ordering = '1=36 <i' unless $ordering;
1882 $results_per_page = 20 unless $results_per_page;
1883 $offset = 0 unless $offset;
1884 my $dbh = C4::Context->dbh;
1887 # order by POPULARITY
1889 if ( $ordering =~ /popularity/ ) {
1893 # popularity is not in MARC record, it's builded from a specific query
1895 $dbh->prepare("select sum(issues) from items where biblionumber=?");
1896 foreach ( split /;/, $biblionumbers ) {
1897 my ( $biblionumber, $title ) = split /,/, $_;
1898 $result{$biblionumber} = GetMarcBiblio($biblionumber);
1899 $sth->execute($biblionumber);
1900 my $popularity = $sth->fetchrow || 0;
1902 # hint : the key is popularity.title because we can have
1903 # many results with the same popularity. In this case, sub-ordering is done by title
1904 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
1905 # (un-frequent, I agree, but we won't forget anything that way ;-)
1906 $popularity{ sprintf( "%10d", $popularity ) . $title
1907 . $biblionumber } = $biblionumber;
1910 # sort the hash and return the same structure as GetRecords (Zebra querying)
1913 if ( $ordering eq 'popularity_dsc' ) { # sort popularity DESC
1914 foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
1915 $result_hash->{'RECORDS'}[ $numbers++ ] =
1916 $result{ $popularity{$key} }->as_usmarc();
1919 else { # sort popularity ASC
1920 foreach my $key ( sort ( keys %popularity ) ) {
1921 $result_hash->{'RECORDS'}[ $numbers++ ] =
1922 $result{ $popularity{$key} }->as_usmarc();
1925 my $finalresult = ();
1926 $result_hash->{'hits'} = $numbers;
1927 $finalresult->{'biblioserver'} = $result_hash;
1928 return $finalresult;
1934 elsif ( $ordering =~ /author/ ) {
1936 foreach ( split /;/, $biblionumbers ) {
1937 my ( $biblionumber, $title ) = split /,/, $_;
1938 my $record = GetMarcBiblio($biblionumber);
1940 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1941 $author = $record->subfield( '200', 'f' );
1942 $author = $record->subfield( '700', 'a' ) unless $author;
1945 $author = $record->subfield( '100', 'a' );
1948 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1949 # and we don't want to get only 1 result for each of them !!!
1950 $result{ $author . $biblionumber } = $record;
1953 # sort the hash and return the same structure as GetRecords (Zebra querying)
1956 if ( $ordering eq 'author_za' ) { # sort by author desc
1957 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
1958 $result_hash->{'RECORDS'}[ $numbers++ ] =
1959 $result{$key}->as_usmarc();
1962 else { # sort by author ASC
1963 foreach my $key ( sort ( keys %result ) ) {
1964 $result_hash->{'RECORDS'}[ $numbers++ ] =
1965 $result{$key}->as_usmarc();
1968 my $finalresult = ();
1969 $result_hash->{'hits'} = $numbers;
1970 $finalresult->{'biblioserver'} = $result_hash;
1971 return $finalresult;
1974 # ORDER BY callnumber
1977 elsif ( $ordering =~ /callnumber/ ) {
1979 foreach ( split /;/, $biblionumbers ) {
1980 my ( $biblionumber, $title ) = split /,/, $_;
1981 my $record = GetMarcBiblio($biblionumber);
1983 my $frameworkcode = GetFrameworkCode($biblionumber);
1984 my ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField( 'items.itemcallnumber', $frameworkcode);
1985 ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField('biblioitems.callnumber', $frameworkcode)
1986 unless $callnumber_tag;
1987 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
1988 $callnumber = $record->subfield( '200', 'f' );
1990 $callnumber = $record->subfield( '100', 'a' );
1993 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
1994 # and we don't want to get only 1 result for each of them !!!
1995 $result{ $callnumber . $biblionumber } = $record;
1998 # sort the hash and return the same structure as GetRecords (Zebra querying)
2001 if ( $ordering eq 'call_number_dsc' ) { # sort by title desc
2002 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2003 $result_hash->{'RECORDS'}[ $numbers++ ] =
2004 $result{$key}->as_usmarc();
2007 else { # sort by title ASC
2008 foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
2009 $result_hash->{'RECORDS'}[ $numbers++ ] =
2010 $result{$key}->as_usmarc();
2013 my $finalresult = ();
2014 $result_hash->{'hits'} = $numbers;
2015 $finalresult->{'biblioserver'} = $result_hash;
2016 return $finalresult;
2018 elsif ( $ordering =~ /pubdate/ ) { #pub year
2020 foreach ( split /;/, $biblionumbers ) {
2021 my ( $biblionumber, $title ) = split /,/, $_;
2022 my $record = GetMarcBiblio($biblionumber);
2023 my ( $publicationyear_tag, $publicationyear_subfield ) =
2024 GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
2025 my $publicationyear =
2026 $record->subfield( $publicationyear_tag,
2027 $publicationyear_subfield );
2029 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2030 # and we don't want to get only 1 result for each of them !!!
2031 $result{ $publicationyear . $biblionumber } = $record;
2034 # sort the hash and return the same structure as GetRecords (Zebra querying)
2037 if ( $ordering eq 'pubdate_dsc' ) { # sort by pubyear desc
2038 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2039 $result_hash->{'RECORDS'}[ $numbers++ ] =
2040 $result{$key}->as_usmarc();
2043 else { # sort by pub year ASC
2044 foreach my $key ( sort ( keys %result ) ) {
2045 $result_hash->{'RECORDS'}[ $numbers++ ] =
2046 $result{$key}->as_usmarc();
2049 my $finalresult = ();
2050 $result_hash->{'hits'} = $numbers;
2051 $finalresult->{'biblioserver'} = $result_hash;
2052 return $finalresult;
2058 elsif ( $ordering =~ /title/ ) {
2060 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
2062 foreach ( split /;/, $biblionumbers ) {
2063 my ( $biblionumber, $title ) = split /,/, $_;
2065 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2066 # and we don't want to get only 1 result for each of them !!!
2067 # hint & speed improvement : we can order without reading the record
2068 # so order, and read records only for the requested page !
2069 $result{ $title . $biblionumber } = $biblionumber;
2072 # sort the hash and return the same structure as GetRecords (Zebra querying)
2075 if ( $ordering eq 'title_az' ) { # sort by title desc
2076 foreach my $key ( sort ( keys %result ) ) {
2077 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2080 else { # sort by title ASC
2081 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2082 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2086 # limit the $results_per_page to result size if it's more
2087 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2089 # for the requested page, replace biblionumber by the complete record
2090 # speed improvement : avoid reading too much things
2092 my $counter = $offset ;
2093 $counter <= $offset + $results_per_page ;
2097 $result_hash->{'RECORDS'}[$counter] =
2098 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2100 my $finalresult = ();
2101 $result_hash->{'hits'} = $numbers;
2102 $finalresult->{'biblioserver'} = $result_hash;
2103 return $finalresult;
2110 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2113 foreach ( split /;/, $biblionumbers ) {
2114 my ( $biblionumber, $title ) = split /,/, $_;
2115 $title =~ /(.*)-(\d)/;
2120 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2121 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2122 # biblio N has ranking = 6
2123 $count_ranking{$biblionumber} += $ranking;
2126 # build the result by "inverting" the count_ranking hash
2127 # hing : as usual, we don't order by ranking only, to avoid having only 1 result for each rank. We build an hash on concat(ranking,biblionumber) instead
2129 foreach ( keys %count_ranking ) {
2130 $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2133 # sort the hash and return the same structure as GetRecords (Zebra querying)
2136 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2137 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2140 # limit the $results_per_page to result size if it's more
2141 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2143 # for the requested page, replace biblionumber by the complete record
2144 # speed improvement : avoid reading too much things
2146 my $counter = $offset ;
2147 $counter <= $offset + $results_per_page ;
2151 $result_hash->{'RECORDS'}[$counter] =
2152 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2153 if $result_hash->{'RECORDS'}[$counter];
2155 my $finalresult = ();
2156 $result_hash->{'hits'} = $numbers;
2157 $finalresult->{'biblioserver'} = $result_hash;
2158 return $finalresult;
2162 =head2 enabled_staff_search_views
2164 %hash = enabled_staff_search_views()
2166 This function returns a hash that contains three flags obtained from the system
2167 preferences, used to determine whether a particular staff search results view
2172 =item C<Output arg:>
2174 * $hash{can_view_MARC} is true only if the MARC view is enabled
2175 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2176 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2178 =item C<usage in the script:>
2182 $template->param ( C4::Search::enabled_staff_search_views );
2186 sub enabled_staff_search_views
2189 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2190 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2191 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2195 sub AddSearchHistory{
2196 my ($borrowernumber,$session,$query_desc,$query_cgi, $total)=@_;
2197 my $dbh = C4::Context->dbh;
2199 # Add the request the user just made
2200 my $sql = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES(?, ?, ?, ?, ?, NOW())";
2201 my $sth = $dbh->prepare($sql);
2202 $sth->execute($borrowernumber, $session, $query_desc, $query_cgi, $total);
2203 return $dbh->last_insert_id(undef, 'search_history', undef,undef,undef);
2206 sub GetSearchHistory{
2207 my ($borrowernumber,$session)=@_;
2208 my $dbh = C4::Context->dbh;
2210 # Add the request the user just made
2211 my $query = "SELECT FROM search_history WHERE (userid=? OR sessionid=?)";
2212 my $sth = $dbh->prepare($query);
2213 $sth->execute($borrowernumber, $session);
2214 return $sth->fetchall_hashref({});
2217 =head2 z3950_search_args
2219 $arrayref = z3950_search_args($matchpoints)
2221 This function returns an array reference that contains the search parameters to be
2222 passed to the Z39.50 search script (z3950_search.pl). The array elements
2223 are hash refs whose keys are name, value and encvalue, and whose values are the
2224 name of a search parameter, the value of that search parameter and the URL encoded
2225 value of that parameter.
2227 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2229 The search parameter values are obtained from the bibliographic record whose
2230 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2232 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2233 a general purpose search argument. In this case, the returned array contains only
2234 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2236 If a search parameter value is undefined or empty, it is not included in the returned
2239 The returned array reference may be passed directly to the template parameters.
2243 =item C<Output arg:>
2245 * $array containing hash refs as described above
2247 =item C<usage in the script:>
2251 $data = Biblio::GetBiblioData($bibno);
2252 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2256 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2260 sub z3950_search_args {
2262 $bibrec = { title => $bibrec } if !ref $bibrec;
2264 for my $field (qw/ lccn isbn issn title author dewey subject /)
2266 my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2267 push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2272 =head2 BiblioAddAuthorities
2274 ( $countlinked, $countcreated ) = BiblioAddAuthorities($record, $frameworkcode);
2276 this function finds the authorities linked to the biblio
2277 * search in the authority DB for the same authid (in $9 of the biblio)
2278 * search in the authority DB for the same 001 (in $3 of the biblio in UNIMARC)
2279 * search in the authority DB for the same values (exactly) (in all subfields of the biblio)
2280 OR adds a new authority record
2286 * $record is the MARC record in question (marc blob)
2287 * $frameworkcode is the bibliographic framework to use (if it is "" it uses the default framework)
2289 =item C<Output arg:>
2291 * $countlinked is the number of authorities records that are linked to this authority
2295 * I had to add this to Search.pm (instead of the logical Biblio.pm) because of a circular dependency (this sub uses SimpleSearch, and Search.pm uses Biblio.pm)
2301 sub BiblioAddAuthorities{
2302 my ( $record, $frameworkcode ) = @_;
2303 my $dbh=C4::Context->dbh;
2304 my $query=$dbh->prepare(qq|
2305 SELECT authtypecode,tagfield
2306 FROM marc_subfield_structure
2307 WHERE frameworkcode=?
2308 AND (authtypecode IS NOT NULL AND authtypecode<>\"\")|);
2309 # SELECT authtypecode,tagfield
2310 # FROM marc_subfield_structure
2311 # WHERE frameworkcode=?
2312 # AND (authtypecode IS NOT NULL OR authtypecode<>\"\")|);
2313 $query->execute($frameworkcode);
2314 my ($countcreated,$countlinked);
2315 while (my $data=$query->fetchrow_hashref){
2316 foreach my $field ($record->field($data->{tagfield})){
2317 next if ($field->subfield('3')||$field->subfield('9'));
2318 # No authorities id in the tag.
2319 # Search if there is any authorities to link to.
2320 my $query='at='.$data->{authtypecode}.' ';
2321 map {$query.= ' and he,ext="'.$_->[1].'"' if ($_->[0]=~/[A-z]/)} $field->subfields();
2322 my ($error, $results, $total_hits)=SimpleSearch( $query, undef, undef, [ "authorityserver" ] );
2323 # there is only 1 result
2325 warn "BIBLIOADDSAUTHORITIES: $error";
2328 if ($results && scalar(@$results)==1) {
2329 my $marcrecord = MARC::File::USMARC::decode($results->[0]);
2330 $field->add_subfields('9'=>$marcrecord->field('001')->data);
2332 } elsif (scalar(@$results)>1) {
2333 #More than One result
2334 #This can comes out of a lack of a subfield.
2335 # my $marcrecord = MARC::File::USMARC::decode($results->[0]);
2336 # $record->field($data->{tagfield})->add_subfields('9'=>$marcrecord->field('001')->data);
2339 #There are no results, build authority record, add it to Authorities, get authid and add it to 9
2340 ###NOTICE : This is only valid if a subfield is linked to one and only one authtypecode
2341 ###NOTICE : This can be a problem. We should also look into other types and rejected forms.
2342 my $authtypedata=C4::AuthoritiesMarc->GetAuthType($data->{authtypecode});
2343 next unless $authtypedata;
2344 my $marcrecordauth=MARC::Record->new();
2345 my $authfield=MARC::Field->new($authtypedata->{auth_tag_to_report},'','',"a"=>"".$field->subfield('a'));
2346 map { $authfield->add_subfields($_->[0]=>$_->[1]) if ($_->[0]=~/[A-z]/ && $_->[0] ne "a" )} $field->subfields();
2347 $marcrecordauth->insert_fields_ordered($authfield);
2349 # bug 2317: ensure new authority knows it's using UTF-8; currently
2350 # only need to do this for MARC21, as MARC::Record->as_xml_record() handles
2351 # automatically for UNIMARC (by not transcoding)
2352 # FIXME: AddAuthority() instead should simply explicitly require that the MARC::Record
2353 # use UTF-8, but as of 2008-08-05, did not want to introduce that kind
2354 # of change to a core API just before the 3.0 release.
2355 if (C4::Context->preference('marcflavour') eq 'MARC21') {
2356 SetMarcUnicodeFlag($marcrecordauth, 'MARC21');
2359 # warn "AUTH RECORD ADDED : ".$marcrecordauth->as_formatted;
2361 my $authid=AddAuthority($marcrecordauth,'',$data->{authtypecode});
2363 $field->add_subfields('9'=>$authid);
2367 return ($countlinked,$countcreated);
2370 =head2 GetDistinctValues($field);
2372 C<$field> is a reference to the fields array
2376 sub GetDistinctValues {
2377 my ($fieldname,$string)=@_;
2378 # returns a reference to a hash of references to branches...
2379 if ($fieldname=~/\./){
2380 my ($table,$column)=split /\./, $fieldname;
2381 my $dbh = C4::Context->dbh;
2382 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column ";
2383 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 ");
2385 my $elements=$sth->fetchall_arrayref({});
2390 my @servers=qw<biblioserver authorityserver>;
2391 my (@zconns,@results);
2392 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2393 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2396 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2399 # The big moment: asynchronously retrieve results from all servers
2401 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
2402 my $ev = $zconns[ $i - 1 ]->last_event();
2403 if ( $ev == ZOOM::Event::ZEND ) {
2404 next unless $results[ $i - 1 ];
2405 my $size = $results[ $i - 1 ]->size();
2407 for (my $j=0;$j<$size;$j++){
2409 @hashscan{qw(value cnt)}=$results[ $i - 1 ]->display_term($j);
2410 push @elements, \%hashscan;
2420 END { } # module clean-up code here (global destructor)
2427 Koha Developement team <info@koha.org>