3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
25 # FIXME - C4::Search uses C4::Reserves2, which uses C4::Search.
26 # So Perl complains that all of the functions here get redefined.
28 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
30 # set the version for version checking
35 C4::Search - Functions for searching the Koha catalog and other databases
41 my ($count, @results) = catalogsearch($env, $type, $search, $num, $offset);
45 This module provides the searching facilities for the Koha catalog and
48 C<&catalogsearch> is a front end to all the other searches. Depending
49 on what is passed to it, it calls the appropriate search function.
58 @EXPORT = qw(&CatSearch &BornameSearch &ItemInfo &KeywordSearch &subsearch
59 &itemdata &bibdata &GetItems &borrdata &itemnodata &itemcount
60 &borrdata2 &NewBorrowerNumber &bibitemdata &borrissues
61 &getboracctrecord &ItemType &itemissues &subject &subtitle
62 &addauthor &bibitems &barcodes &findguarantees &allissues
63 &findguarantor &getwebsites &getwebbiblioitems &catalogsearch &itemcount2);
64 # make all your functions, whether exported or not;
68 ($num_children, $children_arrayref) = &findguarantees($parent_borrno);
69 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
70 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
72 C<&findguarantees> takes a borrower number (e.g., that of a patron
73 with children) and looks up the borrowers who are guaranteed by that
74 borrower (i.e., the patron's children).
76 C<&findguarantees> returns two values: an integer giving the number of
77 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
78 of references to hash, which gives the actual results.
84 my $dbh = C4::Context->dbh;
85 my $query="select cardnumber,borrowernumber from borrowers where
87 my $sth=$dbh->prepare($query);
91 while (my $data = $sth->fetchrow_hashref)
96 return (scalar(@dat), \@dat);
101 $guarantor = &findguarantor($borrower_no);
102 $guarantor_cardno = $guarantor->{"cardnumber"};
103 $guarantor_surname = $guarantor->{"surname"};
106 C<&findguarantor> takes a borrower number (presumably that of a child
107 patron), finds the guarantor for C<$borrower_no> (the child's parent),
108 and returns the record for the guarantor.
110 C<&findguarantor> returns a reference-to-hash. Its keys are the fields
111 from the C<borrowers> database table;
117 my $dbh = C4::Context->dbh;
118 my $query="select guarantor from borrowers where
119 borrowernumber='$bornum'";
120 my $sth=$dbh->prepare($query);
122 my $data=$sth->fetchrow_hashref;
124 $query="Select * from borrowers where
125 borrowernumber='$data->{'guarantor'}'";
126 $sth=$dbh->prepare($query);
128 $data=$sth->fetchrow_hashref;
133 =item NewBorrowerNumber
135 $num = &NewBorrowerNumber();
137 Allocates a new, unused borrower number, and returns it.
141 # FIXME - This is identical to C4::Circulation::Borrower::NewBorrowerNumber.
142 # Pick one and stick with it. Preferably use the other one. This function
143 # doesn't belong in C4::Search.
144 sub NewBorrowerNumber {
145 my $dbh = C4::Context->dbh;
146 my $sth=$dbh->prepare("Select max(borrowernumber) from borrowers");
148 my $data=$sth->fetchrow_hashref;
150 $data->{'max(borrowernumber)'}++;
151 return($data->{'max(borrowernumber)'});
156 ($count, @results) = &catalogsearch($env, $type, $search, $num, $offset);
158 This is primarily a front-end to other, more specialized catalog
159 search functions: if C<$search-E<gt>{itemnumber}> or
160 C<$search-E<gt>{isbn}> is given, C<&catalogsearch> uses a precise
161 C<&CatSearch>. If $search->{subject} is given, it runs a subject
162 C<&CatSearch>. If C<$search-E<gt>{keyword}> is given, it runs a
163 C<&KeywordSearch>. Otherwise, it runs a loose C<&CatSearch>.
165 If C<$env-E<gt>{itemcount}> is 1, then C<&catalogsearch> also counts
166 the items for each result, and adds several keys:
172 The total number of copies of this book.
174 =item C<locationhash>
176 This is a reference-to-hash; the keys are the names of branches where
177 this book may be found, and the values are the number of copies at
182 A descriptive string saying where the book is located, and how many
183 copies there are, if greater than 1.
187 The book's subject, with spaces replaced with C<%20>, presumably for
195 my ($env,$type,$search,$num,$offset)=@_;
196 my $dbh = C4::Context->dbh;
197 # foreach my $key (%$search){
198 # $search->{$key}=$dbh->quote($search->{$key});
200 my ($count,@results);
201 # print STDERR "Doing a search \n";
202 # FIXME - Use "elsif" to avoid this sort of deep nesting
203 if ($search->{'itemnumber'} ne '' || $search->{'isbn'} ne ''){
204 print STDERR "Doing a precise search\n";
205 ($count,@results)=CatSearch($env,'precise',$search,$num,$offset);
208 if ($search->{'subject'} ne ''){
209 ($count,@results)=CatSearch($env,'subject',$search,$num,$offset);
211 if ($search->{'keyword'} ne ''){
212 ($count,@results)=&KeywordSearch($env,'keyword',$search,$num,$offset);
214 ($count,@results)=CatSearch($env,'loose',$search,$num,$offset);
219 if ($env->{itemcount} eq '1') {
220 foreach my $data (@results){
221 my ($counts) = itemcount2($env, $data->{'biblionumber'}, 'intra');
222 my $subject2=$data->{'subject'};
223 $subject2=~ s/ /%20/g;
224 $data->{'itemcount'}=$counts->{'total'};
225 my $totalitemcounts=0;
226 foreach my $key (keys %$counts){
227 if ($key ne 'total'){ # FIXME - Should ignore 'order', too.
228 #$data->{'location'}.="$key $counts->{$key} ";
229 $totalitemcounts+=$counts->{$key};
230 $data->{'locationhash'}->{$key}=$counts->{$key};
234 my $notavailabletext='';
235 foreach (sort keys %{$data->{'locationhash'}}) {
236 if ($_ eq 'notavailable') {
237 $notavailabletext="Not available";
238 my $c=$data->{'locationhash'}->{$_};
239 if ($totalitemcounts>1) {
240 $notavailabletext.=" ($c)";
244 my $c=$data->{'locationhash'}->{$_};
245 if ($totalitemcounts>1) {
246 $locationtext.=" ($c), ";
250 if ($notavailabletext) {
251 $locationtext.=$notavailabletext;
253 $locationtext=~s/, $//;
255 $data->{'location'}=$locationtext;
256 $data->{'subject2'}=$subject2;
259 return ($count,@results);
264 $search = { "keyword" => "One or more keywords",
265 "class" => "VID|CD", # Limit search to fiction and CDs
268 ($count, @results) = &KeywordSearch($env, $type, $search, $num, $offset);
270 C<&KeywordSearch> searches the catalog by keyword: given a string
271 (C<$search-E<gt>{"keyword"}> consisting of a space-separated list of
272 keywords, it looks for books that contain any of those keywords in any
273 of a number of places.
275 C<&KeywordSearch> looks for keywords in the book title (and subtitle),
276 series name, notes (both C<biblio.notes> and C<biblioitems.notes>),
279 C<$search-E<gt>{"class"}> can be set to a C<|> (pipe)-separated list of
280 item class codes (e.g., "F" for fiction, "JNF" for junior nonfiction,
281 etc.). In this case, the search will be restricted to just those
284 If C<$search-E<gt>{"class"}> is not specified, you may specify
285 C<$search-E<gt>{"dewey"}>. This will restrict the search to that
286 particular Dewey Decimal Classification category. Setting
287 C<$search-E<gt>{"dewey"}> to "513" will return books about arithmetic,
288 whereas setting it to "5" will return all books with Dewey code 5I<xx>
289 (Science and Mathematics).
291 C<$env> and C<$type> are ignored.
293 C<$offset> and C<$num> specify the subset of results to return.
294 C<$num> specifies the number of results to return, and C<$offset> is
295 the number of the first result. Thus, setting C<$offset> to 100 and
296 C<$num> to 5 will return results 100 through 104 inclusive.
301 my ($env,$type,$search,$num,$offset)=@_;
302 my $dbh = C4::Context->dbh;
303 $search->{'keyword'}=~ s/ +$//;
304 $search->{'keyword'}=~ s/'/\\'/;
305 my @key=split(' ',$search->{'keyword'});
306 # FIXME - Naive users might enter comma-separated
307 # words, e.g., "training, animal". Ought to cope with
311 my %biblionumbers; # Set of biblionumbers returned by the
314 # FIXME - Ought to filter the stopwords out of the list of keywords.
315 # @key = map { !defined($stopwords{$_}) } @key;
317 # FIXME - The way this code is currently set up, it looks for all of
318 # the keywords first in (title, notes, seriestitle), then in the
319 # subtitle, then in the subject. Thus, if you look for keywords
320 # "science fiction", this search won't find a book with
321 # title = "How to write fiction"
322 # subtitle = "A science-based approach"
323 # Is this the desired effect? If not, then the first SQL query
324 # should look in the biblio, subtitle, and subject tables all at
325 # once. The way the first query is built can accomodate this easily.
327 # Look for keywords in table 'biblio'.
329 # Build an SQL query that finds each of the keywords in any of the
330 # title, biblio.notes, or seriestitle. To do this, we'll build up an
331 # array of clauses, one for each keyword.
332 my $query; # The SQL query
333 my @clauses = (); # The search clauses
335 $query = <<EOT; # Beginning of the query
340 foreach my $keyword (@key)
342 my @subclauses = (); # Subclauses, one for each field we're
345 # For each field we're searching on, create a subclause that'll
346 # match the current keyword in the current field.
347 foreach my $field (qw(title notes seriestitle))
350 "$field LIKE '\Q$keyword\E%' OR $field LIKE '% \Q$keyword\E%'";
352 # (Yes, this could have been done as
353 # @subclauses = map {...} qw(field1 field2 ...)
354 # )but I think this way is more readable.
356 # Construct the current clause by joining the subclauses.
357 push @clauses, "(" . join(")\n\tOR (", @subclauses) . ")";
359 # Now join all of the clauses together and append to the query.
360 $query .= "(" . join(")\nAND (", @clauses) . ")";
362 # FIXME - Perhaps use $sth->bind_columns() ? Documented as the most
363 # efficient way to fetch data.
364 my $sth=$dbh->prepare($query);
366 while (my @res = $sth->fetchrow_array) {
369 $biblionumbers{$_} = 1; # Add these results to the set
374 # Now look for keywords in the 'bibliosubtitle' table.
376 # Again, we build a list of clauses from the keywords.
378 $query = "SELECT biblionumber FROM bibliosubtitle WHERE ";
379 foreach my $keyword (@key)
382 "subtitle LIKE '\Q$keyword\E%' OR subtitle like '% \Q$keyword\E%'";
384 $query .= "(" . join(") AND (", @clauses) . ")";
386 $sth=$dbh->prepare($query);
388 while (my @res = $sth->fetchrow_array) {
391 $biblionumbers{$_} = 1; # Add these results to the set
396 # Look for the keywords in the notes for individual items
397 # ('biblioitems.notes')
399 # Again, we build a list of clauses from the keywords.
401 $query = "SELECT biblionumber FROM biblioitems WHERE ";
402 foreach my $keyword (@key)
405 "notes LIKE '\Q$keyword\E%' OR notes like '% \Q$keyword\E%'";
407 $query .= "(" . join(") AND (", @clauses) . ")";
409 $sth=$dbh->prepare($query);
411 while (my @res = $sth->fetchrow_array) {
414 $biblionumbers{$_} = 1; # Add these results to the set
419 # Look for keywords in the 'bibliosubject' table.
421 # FIXME - The other queries look for words in the desired field that
422 # begin with the individual keywords the user entered. This one
423 # searches for the literal string the user entered. Is this the
425 # Note in particular that spaces are retained: if the user typed
427 # (with two spaces), this won't find the subject "science fiction"
428 # (one space). Likewise, a search for "%" will return absolutely
430 # If this isn't the desired effect, see the previous searches for
433 $sth=$dbh->prepare("Select biblionumber from bibliosubject where subject
434 like '%$search->{'keyword'}%' group by biblionumber");
437 while (my @res = $sth->fetchrow_array) {
440 $biblionumbers{$_} = 1; # Add these results to the set
450 my @res = keys %biblionumbers;
454 # print "count $count";
455 if ($search->{'class'} ne ''){
457 my $query="select * from biblio,biblioitems where
458 biblio.biblionumber='$res[$i2]' and
459 biblio.biblionumber=biblioitems.biblionumber ";
460 if ($search->{'class'} ne ''){ # FIXME - Redundant
461 my @temp=split(/\|/,$search->{'class'});
463 $query.= "and ( itemtype='$temp[0]'";
464 for (my $i=1;$i<$count;$i++){
465 $query.=" or itemtype='$temp[$i]'";
469 my $sth=$dbh->prepare($query);
472 if (my $data2=$sth->fetchrow_hashref){
473 my $dewey= $data2->{'dewey'};
474 my $subclass=$data2->{'subclass'};
475 # FIXME - This next bit is bogus, because it assumes that the
476 # Dewey code is a floating-point number. It isn't. It's
477 # actually a string that mainly consists of numbers. In
478 # particular, "4" is not a valid Dewey code, although "004"
479 # is ("Data processing; Computer science"). Likewise, zeros
480 # after the decimal are significant ("575" is not the same as
481 # "575.0"; the latter is more specific). And "000" is a
482 # perfectly good Dewey code ("General works; computer
483 # science") and should not be interpreted to mean "this
484 # database entry does not have a Dewey code". That's what
487 ($dewey == 0) && ($dewey='');
488 ($dewey) && ($dewey.=" $subclass") ;
490 my $end=$offset +$num;
495 if ($i4 <=$end && $i4 > $offset){
496 $data2->{'dewey'}=$dewey;
499 # $res2[$i3]="$data2->{'author'}\t$data2->{'title'}\t$data2->{'biblionumber'}\t$data2->{'copyrightdate'}\t$dewey";
502 # print "in here $i3<br>";
513 # $search->{'class'} was not specified
515 # FIXME - This is bogus: it makes a separate query for each
516 # biblioitem, and returns results in apparently random order. It'd
517 # be much better to combine all of the previous queries into one big
518 # one (building it up a little at a time, of course), and have that
519 # big query select all of the desired fields, instead of just
522 while ($i2 < $num && $i2 < $count){
523 my $query="select * from biblio,biblioitems where
524 biblio.biblionumber='$res[$i2+$offset]' and
525 biblio.biblionumber=biblioitems.biblionumber ";
527 if ($search->{'dewey'} ne ''){
528 $query.= "and (dewey like '$search->{'dewey'}%') ";
531 my $sth=$dbh->prepare($query);
534 if (my $data2=$sth->fetchrow_hashref){
535 my $dewey= $data2->{'dewey'};
536 my $subclass=$data2->{'subclass'};
538 ($dewey == 0) && ($dewey='');
539 ($dewey) && ($dewey.=" $subclass") ;
541 $data2->{'dewey'}=$dewey;
544 # $res2[$i]="$data2->{'author'}\t$data2->{'title'}\t$data2->{'biblionumber'}\t$data2->{'copyrightdate'}\t$dewey";
553 return($count,@res2);
557 my ($env,$type,$search,$num,$offset)=@_;
558 my $dbh = C4::Context->dbh;
559 $search->{'keyword'}=~ s/ +$//;
560 $search->{'keyword'}=~ s/'/\\'/;
561 my @key=split(' ',$search->{'keyword'});
565 my $query ="Select * from biblio,bibliosubtitle,biblioitems where
566 biblio.biblionumber=biblioitems.biblionumber and
567 biblio.biblionumber=bibliosubtitle.biblionumber and
568 (((title like '$key[0]%' or title like '% $key[0]%')";
570 $query=$query." and (title like '$key[$i]%' or title like '% $key[$i]%')";
574 $query.= ") or ((subtitle like '$key[0]%' or subtitle like '% $key[0]%')";
575 for ($i=1;$i<$count;$i++){
576 $query.= " and (subtitle like '$key[$i]%' or subtitle like '% $key[$i]%')";
578 $query.= ") or ((seriestitle like '$key[0]%' or seriestitle like '% $key[0]%')";
579 for ($i=1;$i<$count;$i++){
580 $query.=" and (seriestitle like '$key[$i]%' or seriestitle like '% $key[$i]%')";
582 $query.= ") or ((biblio.notes like '$key[0]%' or biblio.notes like '% $key[0]%')";
583 for ($i=1;$i<$count;$i++){
584 $query.=" and (biblio.notes like '$key[$i]%' or biblio.notes like '% $key[$i]%')";
586 $query.= ") or ((biblioitems.notes like '$key[0]%' or biblioitems.notes like '% $key[0]%')";
587 for ($i=1;$i<$count;$i++){
588 $query.=" and (biblioitems.notes like '$key[$i]%' or biblioitems.notes like '% $key[$i]%')";
590 if ($search->{'keyword'} =~ /new zealand/i){
591 $query.= "or (title like 'nz%' or title like '% nz %' or title like '% nz' or subtitle like 'nz%'
592 or subtitle like '% nz %' or subtitle like '% nz' or author like 'nz %'
593 or author like '% nz %' or author like '% nz')"
595 if ($search->{'keyword'} eq 'nz' || $search->{'keyword'} eq 'NZ' ||
596 $search->{'keyword'} =~ /nz /i || $search->{'keyword'} =~ / nz /i ||
597 $search->{'keyword'} =~ / nz/i){
598 $query.= "or (title like 'new zealand%' or title like '% new zealand %'
599 or title like '% new zealand' or subtitle like 'new zealand%' or
600 subtitle like '% new zealand %'
601 or subtitle like '% new zealand' or author like 'new zealand%'
602 or author like '% new zealand %' or author like '% new zealand' or
603 seriestitle like 'new zealand%' or seriestitle like '% new zealand %'
604 or seriestitle like '% new zealand')"
606 $query=$query."))"; # FIXME - .=
607 if ($search->{'class'} ne ''){
608 my @temp=split(/\|/,$search->{'class'});
610 $query.= "and ( itemtype='$temp[0]'";
611 for (my $i=1;$i<$count;$i++){
612 $query.=" or itemtype='$temp[$i]'";
616 if ($search->{'dewey'} ne ''){
617 $query.= "and (dewey like '$search->{'dewey'}%') ";
619 $query.="group by biblio.biblionumber";
620 #$query.=" order by author,title";
622 my $sth=$dbh->prepare($query);
625 while (my $data=$sth->fetchrow_hashref){
626 # my $sti=$dbh->prepare("select dewey,subclass from biblioitems where biblionumber=$data->{'biblionumber'}
629 # my ($dewey, $subclass) = $sti->fetchrow;
630 my $dewey=$data->{'dewey'};
631 my $subclass=$data->{'subclass'};
633 ($dewey == 0) && ($dewey='');
634 ($dewey) && ($dewey.=" $subclass");
636 $results[$i]="$data->{'author'}\t$data->{'title'}\t$data->{'biblionumber'}\t$data->{'copyrightdate'}\t$dewey";
637 # print $results[$i];
641 $sth=$dbh->prepare("Select biblionumber from bibliosubject where subject
642 like '%$search->{'keyword'}%' group by biblionumber");
644 while (my $data=$sth->fetchrow_hashref){
645 $query="Select * from biblio,biblioitems where
646 biblio.biblionumber=$data->{'biblionumber'} and
647 biblio.biblionumber=biblioitems.biblionumber ";
648 if ($search->{'class'} ne ''){
649 my @temp=split(/\|/,$search->{'class'});
651 $query.= " and ( itemtype='$temp[0]'";
652 for (my $i=1;$i<$count;$i++){
653 $query.=" or itemtype='$temp[$i]'";
658 if ($search->{'dewey'} ne ''){
659 $query.= "and (dewey like '$search->{'dewey'}%') ";
661 my $sth2=$dbh->prepare($query);
664 while (my $data2=$sth2->fetchrow_hashref){
665 my $dewey= $data2->{'dewey'};
666 my $subclass=$data2->{'subclass'};
668 ($dewey == 0) && ($dewey='');
669 ($dewey) && ($dewey.=" $subclass") ;
671 $results[$i]="$data2->{'author'}\t$data2->{'title'}\t$data2->{'biblionumber'}\t$data2->{'copyrightdate'}\t$dewey";
672 # print $results[$i];
678 @results=sort @results;
685 while ($i2 < $count){
686 if ($results[$i2] ne $res[$i-1]){
687 $res[$i]=$results[$i2];
695 while ($i2 < $num && $i2 < $count){
696 $res2[$i2]=$res[$i2+$offset];
708 ($count, @results) = &CatSearch($env, $type, $search, $num, $offset);
710 C<&CatSearch> searches the Koha catalog. It returns a list whose first
711 element is the number of returned results, and whose subsequent
712 elements are the results themselves.
714 Each returned element is a reference-to-hash. Most of the keys are
715 simply the fields from the C<biblio> table in the Koha database, but
716 the following keys may also be present:
722 The book's illustrator.
732 C<$type> may be C<subject>, C<loose>, or C<precise>. This controls the
733 high-level behavior of C<&CatSearch>, as described below.
735 In many cases, the description below says that a certain field in the
736 database must match the search string. In these cases, it means that
737 the beginning of some word in the field must match the search string.
738 Thus, an author search for "sm" will return books whose author is
739 "John Smith" or "Mike Smalls", but not "Paul Grossman", since the "sm"
740 does not occur at the beginning of a word.
742 Note that within each search mode, the criteria are and-ed together.
743 That is, if you perform a loose search on the author "Jerome" and the
744 title "Boat", the search will only return books by Jerome containing
747 It is not possible to cross modes, e.g., set the author to "Asimov"
748 and the subject to "Math" in hopes of finding books on math by Asimov.
752 If C<$type> is set to C<loose>, the following search criteria may be
757 =item C<$search-E<gt>{author}>
759 The search string is a space-separated list of words. Each word must
760 match either the C<author> or C<additionalauthors> field.
762 =item C<$search-E<gt>{title}>
764 Each word in the search string must match the book title. If no author
765 is specified, the book subtitle will also be searched.
767 =item C<$search-E<gt>{abstract}>
769 Searches for the given search string in the book's abstract.
771 =item C<$search-E<gt>{'date-before'}>
773 Searches for books whose copyright date matches the search string.
774 That is, setting C<$search-E<gt>{'date-before'}> to "1985" will find
775 books written in 1985, and setting it to "198" will find books written
776 between 1980 and 1989.
778 =item C<$search-E<gt>{title}>
780 Searches by title are also affected by the value of
781 C<$search-E<gt>{"ttype"}>; if it is set to C<exact>, then the book
782 title, (one of) the series titleZ<>(s), or (one of) the unititleZ<>(s) must
783 match the search string exactly (the subtitle is not searched).
785 If C<$search-E<gt>{"ttype"}> is set to anything other than C<exact>,
786 each word in the search string must match the title, subtitle,
787 unititle, or series title.
789 =item C<$search-E<gt>{class}>
791 Restricts the search to certain item classes. The value of
792 C<$search-E<gt>{"class"}> is a | (pipe)-separated list of item types.
793 Thus, setting it to "F" restricts the search to fiction, and setting
794 it to "CD|CAS" will only look in compact disks and cassettes.
796 =item C<$search-E<gt>{dewey}>
798 Searches for books whose Dewey Decimal Classification code matches the
799 search string. That is, setting C<$search-E<gt>{"dewey"}> to "5" will
800 search for all books in 5I<xx> (Science and mathematics), setting it
801 to "54" will search for all books in 54I<x> (Chemistry), and setting
802 it to "546" will search for books on inorganic chemistry.
804 =item C<$search-E<gt>{publisher}>
806 Searches for books whose publisher contains the search string (unlike
807 other search criteria, C<$search-E<gt>{publisher}> is a string, not a
812 =head2 Subject search
814 If C<$type> is set to C<subject>, the following search criterion may
819 =item C<$search-E<gt>{subject}>
821 The search string is a space-separated list of words, each of which
822 must match the book's subject.
824 Special case: if C<$search-E<gt>{subject}> is set to C<nz>,
825 C<&CatSearch> will search for books whose subject is "New Zealand".
826 However, setting C<$search-E<gt>{subject}> to C<"nz football"> will
827 search for books on "nz" and "football", not books on "New Zealand"
832 =head2 Precise search
834 If C<$type> is set to C<precise>, the following search criteria may be
839 =item C<$search-E<gt>{item}>
841 Searches for books whose barcode exactly matches the search string.
843 =item C<$search-E<gt>{isbn}>
845 Searches for books whose ISBN exactly matches the search string.
849 For a loose search, if an author was specified, the results are
850 ordered by author and title. If no author was specified, the results
851 are ordered by title.
853 For other (non-loose) searches, if a subject was specified, the
854 results are ordered alphabetically by subject.
856 In all other cases (e.g., loose search by keyword), the results are
862 my ($env,$type,$search,$num,$offset)=@_;
863 my $dbh = C4::Context->dbh;
866 # FIXME - Why not just
867 # $search->{'title'} = quotemeta($search->{'title'})
868 # to escape all questionable characters, not just single-quotes?
869 $search->{'title'}=~ s/'/\\'/g;
870 $search->{'author'}=~ s/'/\\'/g;
871 $search->{'illustrator'}=~ s/'/\\'/g;
872 my $title = lc($search->{'title'});
874 if ($type eq 'loose') {
875 if ($search->{'author'} ne ''){
876 my @key=split(' ',$search->{'author'});
879 $query="select *,biblio.author,biblio.biblionumber from
881 left join additionalauthors
882 on additionalauthors.biblionumber =biblio.biblionumber
884 ((biblio.author like '$key[0]%' or biblio.author like '% $key[0]%' or
885 additionalauthors.author like '$key[0]%' or additionalauthors.author
889 $query=$query." and (
890 biblio.author like '$key[$i]%' or biblio.author like '% $key[$i]%' or
891 additionalauthors.author like '$key[$i]%' or additionalauthors.author like '% $key[$i]%'
896 $query=$query.")"; # FIXME - .=
897 if ($search->{'title'} ne ''){
898 my @key=split(' ',$search->{'title'});
901 $query.= " and (((title like '$key[0]%' or title like '% $key[0]%' or title like '% $key[0]')";
903 $query=$query." and (title like '$key[$i]%' or title like '% $key[$i]%' or title like '% $key[$i]')";
907 # $query.=") or ((subtitle like '$key[0]%' or subtitle like '% $key[0] %' or subtitle like '% $key[0]')";
908 # for ($i=1;$i<$count;$i++){
909 # $query.=" and (subtitle like '$key[$i]%' or subtitle like '% $key[$i] %' or subtitle like '% $key[$i]')";
911 $query.=") or ((seriestitle like '$key[0]%' or seriestitle like '% $key[0]%' or seriestitle like '% $key[0]')";
912 for ($i=1;$i<$count;$i++){
913 $query.=" and (seriestitle like '$key[$i]%' or seriestitle like '% $key[$i]%')";
915 $query.=") or ((unititle like '$key[0]%' or unititle like '% $key[0]%' or unititle like '% $key[0]')";
916 for ($i=1;$i<$count;$i++){
917 $query.=" and (unititle like '$key[$i]%' or unititle like '% $key[$i]%')";
919 $query=$query."))"; # FIXME - .=
920 #$query=$query. " and (title like '%$search->{'title'}%'
921 #or seriestitle like '%$search->{'title'}%')";
923 if ($search->{'abstract'} ne ''){
924 $query.= " and (abstract like '%$search->{'abstract'}%')";
926 if ($search->{'date-before'} ne ''){
927 $query.= " and (copyrightdate like '%$search->{'date-before'}%')";
930 $query.=" group by biblio.biblionumber";
932 if ($search->{'title'} ne '') {
933 if ($search->{'ttype'} eq 'exact'){
934 $query="select * from biblio
936 (biblio.title='$search->{'title'}' or (biblio.unititle = '$search->{'title'}'
937 or biblio.unititle like '$search->{'title'} |%' or
938 biblio.unititle like '%| $search->{'title'} |%' or
939 biblio.unititle like '%| $search->{'title'}') or
940 (biblio.seriestitle = '$search->{'title'}' or
941 biblio.seriestitle like '$search->{'title'} |%' or
942 biblio.seriestitle like '%| $search->{'title'} |%' or
943 biblio.seriestitle like '%| $search->{'title'}')
946 my @key=split(' ',$search->{'title'});
949 $query="select * from biblio
950 left join bibliosubtitle on
951 biblio.biblionumber=bibliosubtitle.biblionumber
953 (((title like '$key[0]%' or title like '% $key[0]%' or title like '% $key[0]')";
955 $query=$query." and (title like '$key[$i]%' or title like '% $key[$i]%' or title like '% $key[$i]')";
959 $query.=") or ((subtitle like '$key[0]%' or subtitle like '% $key[0]%' or subtitle like '% $key[0]')";
960 for ($i=1;$i<$count;$i++){
961 $query.=" and (subtitle like '$key[$i]%' or subtitle like '% $key[$i]%' or subtitle like '% $key[$i]')";
963 $query.=") or ((seriestitle like '$key[0]%' or seriestitle like '% $key[0]%' or seriestitle like '% $key[0]')";
964 for ($i=1;$i<$count;$i++){
965 $query.=" and (seriestitle like '$key[$i]%' or seriestitle like '% $key[$i]%')";
967 $query.=") or ((unititle like '$key[0]%' or unititle like '% $key[0]%' or unititle like '% $key[0]')";
968 for ($i=1;$i<$count;$i++){
969 $query.=" and (unititle like '$key[$i]%' or unititle like '% $key[$i]%')";
971 $query=$query."))"; # FIXME - .=
973 if ($search->{'abstract'} ne ''){
974 $query.= " and (abstract like '%$search->{'abstract'}%')";
976 if ($search->{'date-before'} ne ''){
977 $query.= " and (copyrightdate like '%$search->{'date-before'}%')";
979 } elsif ($search->{'class'} ne ''){
980 $query="select * from biblioitems,biblio where biblio.biblionumber=biblioitems.biblionumber";
981 my @temp=split(/\|/,$search->{'class'});
983 $query.= " and ( itemtype='$temp[0]'";
984 for (my $i=1;$i<$count;$i++){
985 $query.=" or itemtype='$temp[$i]'";
988 if ($search->{'illustrator'} ne ''){
989 $query.=" and illus like '%".$search->{'illustrator'}."%' ";
991 if ($search->{'dewey'} ne ''){
992 $query.=" and biblioitems.dewey like '$search->{'dewey'}%'";
994 } elsif ($search->{'dewey'} ne ''){
995 $query="select * from biblioitems,biblio
996 where biblio.biblionumber=biblioitems.biblionumber
997 and biblioitems.dewey like '$search->{'dewey'}%'";
998 } elsif ($search->{'illustrator'} ne '') {
999 $query="select * from biblioitems,biblio
1000 where biblio.biblionumber=biblioitems.biblionumber
1001 and biblioitems.illus like '%".$search->{'illustrator'}."%'";
1002 } elsif ($search->{'publisher'} ne ''){
1003 $query.= "Select * from biblio,biblioitems where biblio.biblionumber
1004 =biblioitems.biblionumber and (publishercode like '%$search->{'publisher'}%')";
1005 } elsif ($search->{'abstract'} ne ''){
1006 $query.= "Select * from biblio where abstract like '%$search->{'abstract'}%'";
1008 } elsif ($search->{'date-before'} ne ''){
1009 $query.= "Select * from biblio where copyrightdate like '%$search->{'date-before'}%'";
1011 $query .=" group by biblio.biblionumber";
1014 if ($type eq 'subject'){
1015 # FIXME - Subject search is badly broken. The query defined by
1016 # $query returns a single item (the subject), but later code
1017 # expects a ref-to-hash with all sorts of stuff in it.
1018 # Also, the count of items (biblios?) with the given subject is
1021 my @key=split(' ',$search->{'subject'});
1024 $query="select distinct(subject) from bibliosubject where( subject like
1025 '$key[0]%' or subject like '% $key[0]%' or subject like '% $key[0]' or subject like '%($key[0])%')";
1027 $query.=" and (subject like '$key[$i]%' or subject like '% $key[$i]%'
1028 or subject like '% $key[$i]'
1029 or subject like '%($key[$i])%')";
1033 # FIXME - Wouldn't it be better to fix the database so that if a
1034 # book has a subject "NZ", then it also gets added the subject
1036 # This can also be generalized by adding a table of subject
1037 # synonyms to the database: just declare "NZ" to be a synonym for
1038 # "New Zealand", "SF" a synonym for both "Science fiction" and
1039 # "Fantastic fiction", etc.
1041 # FIXME - This can be rewritten as
1042 # if (lc($search->{"subject"}) eq "nz") {
1043 if ($search->{'subject'} eq 'NZ' || $search->{'subject'} eq 'nz'){
1044 $query.= " or (subject like 'NEW ZEALAND %' or subject like '% NEW ZEALAND %'
1045 or subject like '% NEW ZEALAND' or subject like '%(NEW ZEALAND)%' ) ";
1046 } elsif ( $search->{'subject'} =~ /^nz /i || $search->{'subject'} =~ / nz /i || $search->{'subject'} =~ / nz$/i){
1047 $query=~ s/ nz/ NEW ZEALAND/ig;
1048 $query=~ s/nz /NEW ZEALAND /ig;
1049 $query=~ s/\(nz\)/\(NEW ZEALAND\)/gi;
1052 if ($type eq 'precise'){
1054 if ($search->{'item'} ne ''){
1055 $query="select * from items,biblio ";
1056 my $search2=uc $search->{'item'};
1057 $query=$query." where
1058 items.biblionumber=biblio.biblionumber
1059 and barcode='$search2'";
1062 if ($search->{'isbn'} ne ''){
1063 my $search2=uc $search->{'isbn'};
1064 my $query1 = "select * from biblioitems where isbn='$search2'";
1065 my $sth1=$dbh->prepare($query1);
1066 # print STDERR "$query1\n";
1069 while (my $data=$sth1->fetchrow_hashref) {
1070 $query="select * from biblioitems,biblio where
1071 biblio.biblionumber = $data->{'biblionumber'}
1072 and biblioitems.biblionumber = biblio.biblionumber";
1073 my $sth=$dbh->prepare($query);
1075 # FIXME - There's already a $data in this scope.
1076 my $data=$sth->fetchrow_hashref;
1077 my ($dewey, $subclass) = ($data->{'dewey'}, $data->{'subclass'});
1078 # FIXME - The following assumes that the Dewey code is a
1079 # floating-point number. It isn't: it's a string.
1081 ($dewey == 0) && ($dewey='');
1082 ($dewey) && ($dewey.=" $subclass");
1083 $data->{'dewey'}=$dewey;
1084 $results[$i2]=$data;
1085 # $results[$i2]="$data->{'author'}\t$data->{'title'}\t$data->{'biblionumber'}\t$data->{'copyrightdate'}\t$dewey\t$data->{'isbn'}\t$data->{'itemtype'}";
1093 if ($type ne 'precise' && $type ne 'subject'){
1094 if ($search->{'author'} ne ''){
1095 $query=$query." order by biblio.author,title"; # FIXME - .=
1097 $query=$query." order by title"; # FIXME - .=
1100 if ($type eq 'subject'){
1101 $query=$query." order by subject"; # FIXME - .=
1104 #print STDERR "$query\n";
1105 my $sth=$dbh->prepare($query);
1109 my $limit= $num+$offset;
1110 while (my $data=$sth->fetchrow_hashref){
1111 my $query="select dewey,subclass,publishercode from biblioitems where biblionumber=$data->{'biblionumber'}";
1112 if ($search->{'class'} ne ''){
1113 my @temp=split(/\|/,$search->{'class'});
1115 $query.= " and ( itemtype='$temp[0]'";
1116 for (my $i=1;$i<$count;$i++){
1117 $query.=" or itemtype='$temp[$i]'";
1121 if ($search->{'dewey'} ne ''){
1122 $query.=" and dewey='$search->{'dewey'}' ";
1124 if ($search->{'illustrator'} ne ''){
1125 $query.=" and illus like '%".$search->{'illustrator'}."%' ";
1127 if ($search->{'publisher'} ne ''){
1128 $query.= " and (publishercode like '%$search->{'publisher'}%')";
1131 my $sti=$dbh->prepare($query);
1138 if ($bibitemdata = $sti->fetchrow_hashref() || $type eq 'subject'){
1140 $dewey=$bibitemdata->{'dewey'};
1141 $subclass=$bibitemdata->{'subclass'};
1142 $publishercode=$bibitemdata->{'publishercode'};
1144 # print STDERR "$dewey $subclass $publishercode\n";
1145 # FIXME - The Dewey code is a string, not a number.
1147 ($dewey == 0) && ($dewey='');
1148 ($dewey) && ($dewey.=" $subclass");
1149 $data->{'dewey'}=$dewey;
1150 $data->{'publishercode'}=$publishercode;
1153 if ($count > $offset && $count <= $limit){
1161 #if ($type ne 'precise'){
1165 return($count,@results);
1168 sub updatesearchstats{
1169 my ($dbh,$query)=@_;
1175 @results = &subsearch($env, $subject);
1177 Searches for books that have a subject that exactly matches
1180 C<&subsearch> returns an array of results. Each element of this array
1181 is a string, containing the book's title, author, and biblionumber,
1189 my ($env,$subject)=@_;
1190 my $dbh = C4::Context->dbh;
1191 $subject=$dbh->quote($subject);
1192 my $query="Select * from biblio,bibliosubject where
1193 biblio.biblionumber=bibliosubject.biblionumber and
1194 bibliosubject.subject=$subject group by biblio.biblionumber
1195 order by biblio.title";
1196 my $sth=$dbh->prepare($query);
1201 while (my $data=$sth->fetchrow_hashref){
1202 $results[$i]="$data->{'title'}\t$data->{'author'}\t$data->{'biblionumber'}";
1211 @results = &ItemInfo($env, $biblionumber, $type);
1213 Returns information about books with the given biblionumber.
1215 C<$type> may be either C<intra> or anything else. If it is not set to
1216 C<intra>, then the search will exclude lost, very overdue, and
1221 C<&ItemInfo> returns a list of references-to-hash. Each element
1222 contains a number of keys. Most of them are table items from the
1223 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1224 Koha database. Other keys include:
1228 =item C<$data-E<gt>{branchname}>
1230 The name (not the code) of the branch to which the book belongs.
1232 =item C<$data-E<gt>{datelastseen}>
1234 This is simply C<items.datelastseen>, except that while the date is
1235 stored in YYYY-MM-DD format in the database, here it is converted to
1236 DD/MM/YYYY format. A NULL date is returned as C<//>.
1238 =item C<$data-E<gt>{datedue}>
1240 =item C<$data-E<gt>{class}>
1242 This is the concatenation of C<biblioitems.classification>, the book's
1243 Dewey code, and C<biblioitems.subclass>.
1245 =item C<$data-E<gt>{ocount}>
1247 I think this is the number of copies of the book available.
1249 =item C<$data-E<gt>{order}>
1251 If this is set, it is set to C<One Order>.
1258 my ($env,$biblionumber,$type) = @_;
1259 my $dbh = C4::Context->dbh;
1260 my $query = "SELECT * FROM items, biblio, biblioitems, itemtypes
1261 WHERE items.biblionumber = ?
1262 AND biblioitems.biblioitemnumber = items.biblioitemnumber
1263 AND biblioitems.itemtype = itemtypes.itemtype
1264 AND biblio.biblionumber = items.biblionumber";
1265 if ($type ne 'intra'){
1266 $query .= " and ((items.itemlost<>1 and items.itemlost <> 2)
1267 or items.itemlost is NULL)
1268 and (wthdrawn <> 1 or wthdrawn is NULL)";
1270 $query .= " order by items.dateaccessioned desc";
1272 my $sth=$dbh->prepare($query);
1273 $sth->execute($biblionumber);
1277 while (my $data=$sth->fetchrow_hashref){
1278 my $iquery = "Select * from issues
1279 where itemnumber = '$data->{'itemnumber'}'
1280 and returndate is null";
1282 my $isth=$dbh->prepare($iquery);
1284 if (my $idata=$isth->fetchrow_hashref){
1285 # FIXME - The date ought to be properly parsed, and printed
1286 # according to local convention.
1287 my @temp=split('-',$idata->{'date_due'});
1288 $datedue = "$temp[2]/$temp[1]/$temp[0]";
1290 if ($data->{'itemlost'} eq '2'){
1291 $datedue='Very Overdue';
1293 if ($data->{'itemlost'} eq '1'){
1296 if ($data->{'wthdrawn'} eq '1'){
1297 $datedue="Cancelled";
1299 if ($datedue eq ''){
1300 $datedue="Available";
1301 my ($restype,$reserves)=CheckReserves($data->{'itemnumber'});
1307 #get branch information.....
1308 my $bquery = "SELECT * FROM branches
1309 WHERE branchcode = '$data->{'holdingbranch'}'";
1310 my $bsth=$dbh->prepare($bquery);
1312 if (my $bdata=$bsth->fetchrow_hashref){
1313 $data->{'branchname'} = $bdata->{'branchname'};
1316 my $class = $data->{'classification'};
1317 my $dewey = $data->{'dewey'};
1319 if ($dewey eq "000.") { $dewey = "";}; # FIXME - "000" is general
1320 # books about computer science
1321 if ($dewey < 10){$dewey='00'.$dewey;}
1322 if ($dewey < 100 && $dewey > 10){$dewey='0'.$dewey;}
1327 $class = $class.$dewey; # FIXME - .=
1329 $class = $class.$data->{'subclass'}; # FIXME - .=
1331 # $results[$i]="$data->{'title'}\t$data->{'barcode'}\t$datedue\t$data->{'branchname'}\t$data->{'dewey'}";
1332 # FIXME - If $data->{'datelastseen'} is NULL, perhaps it'd be prettier
1333 # to leave it empty, rather than convert it to "//".
1334 # Also ideally this should use the local format for displaying dates.
1335 my @temp=split('-',$data->{'datelastseen'});
1336 my $date="$temp[2]/$temp[1]/$temp[0]";
1337 $data->{'datelastseen'}=$date;
1338 $data->{'datedue'}=$datedue;
1339 $data->{'class'}=$class;
1344 my $query2="Select * from aqorders where biblionumber=$biblionumber";
1345 my $sth2=$dbh->prepare($query2);
1349 if ($data=$sth2->fetchrow_hashref){
1350 $ocount=$data->{'quantity'} - $data->{'quantityreceived'};
1352 $data->{'ocount'}=$ocount;
1353 $data->{'order'}="One Order";
1364 @results = &GetItems($env, $biblionumber);
1366 Returns information about books with the given biblionumber.
1370 C<&GetItems> returns an array of strings. Each element is a
1371 tab-separated list of values: biblioitemnumber, itemtype,
1372 classification, Dewey number, subclass, ISBN, volume, number, and
1375 Itemdata, in turn, is a string of the form
1376 "I<barcode>C<[>I<holdingbranch>C<[>I<flags>" where I<flags> contains
1377 the string C<NFL> if the item is not for loan, and C<LOST> if the item
1383 my ($env,$biblionumber)=@_;
1384 #debug_msg($env,"GetItems");
1385 my $dbh = C4::Context->dbh;
1386 my $query = "Select * from biblioitems where (biblionumber = $biblionumber)";
1387 #debug_msg($env,$query);
1388 my $sth=$dbh->prepare($query);
1390 #debug_msg($env,"executed query");
1393 while (my $data=$sth->fetchrow_hashref) {
1394 #debug_msg($env,$data->{'biblioitemnumber'});
1395 my $dewey = $data->{'dewey'};
1397 my $line = $data->{'biblioitemnumber'}."\t".$data->{'itemtype'};
1398 $line = $line."\t$data->{'classification'}\t$dewey"; # FIXME - .=
1399 $line = $line."\t$data->{'subclass'}\t$data->{isbn}"; # FIXME - .=
1400 $line = $line."\t$data->{'volume'}\t$data->{number}"; # FIXME - .=
1401 my $isth= $dbh->prepare("select * from items where biblioitemnumber = $data->{'biblioitemnumber'}");
1403 while (my $idata = $isth->fetchrow_hashref) {
1404 my $iline = $idata->{'barcode'}."[".$idata->{'holdingbranch'}."[";
1405 if ($idata->{'notforloan'} == 1) {
1406 $iline = $iline."NFL "; # FIXME - .=
1408 if ($idata->{'itemlost'} == 1) {
1409 $iline = $iline."LOST "; # FIXME - .=
1411 $line = $line."\t$iline"; # FIXME - .=
1414 $results[$i] = $line;
1423 $item = &itemdata($barcode);
1425 Looks up the item with the given barcode, and returns a
1426 reference-to-hash containing information about that item. The keys of
1427 the hash are the fields from the C<items> and C<biblioitems> tables in
1434 my $dbh = C4::Context->dbh;
1435 my $query="Select * from items,biblioitems where barcode='$barcode'
1436 and items.biblioitemnumber=biblioitems.biblioitemnumber";
1438 my $sth=$dbh->prepare($query);
1440 my $data=$sth->fetchrow_hashref;
1447 $data = &bibdata($biblionumber, $type);
1449 Returns information about the book with the given biblionumber.
1451 C<$type> is ignored.
1453 C<&bibdata> returns a reference-to-hash. The keys are the fields in
1454 the C<biblio>, C<biblioitems>, and C<bibliosubtitle> tables in the
1457 In addition, C<$data-E<gt>{subject}> is the list of the book's
1458 subjects, separated by C<" , "> (space, comma, space).
1460 If there are multiple biblioitems with the given biblionumber, only
1461 the first one is considered.
1466 my ($bibnum, $type) = @_;
1467 my $dbh = C4::Context->dbh;
1468 my $query = "Select *, biblio.notes
1469 from biblio, biblioitems
1470 left join bibliosubtitle on
1471 biblio.biblionumber = bibliosubtitle.biblionumber
1472 where biblio.biblionumber = $bibnum
1473 and biblioitems.biblionumber = $bibnum";
1474 my $sth = $dbh->prepare($query);
1478 $data = $sth->fetchrow_hashref;
1481 $query = "Select * from bibliosubject where biblionumber = '$bibnum'";
1482 $sth = $dbh->prepare($query);
1484 while (my $dat = $sth->fetchrow_hashref){
1485 $data->{'subject'} .= " , $dat->{'subject'}";
1494 $itemdata = &bibitemdata($biblioitemnumber);
1496 Looks up the biblioitem with the given biblioitemnumber. Returns a
1497 reference-to-hash. The keys are the fields from the C<biblio>,
1498 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
1499 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
1505 my $dbh = C4::Context->dbh;
1506 my $query = "Select *,biblioitems.notes as bnotes from biblio, biblioitems,itemtypes
1507 where biblio.biblionumber = biblioitems.biblionumber
1508 and biblioitemnumber = $bibitem
1509 and biblioitems.itemtype = itemtypes.itemtype";
1510 my $sth = $dbh->prepare($query);
1515 $data = $sth->fetchrow_hashref;
1523 ($count, $subjects) = &subject($biblionumber);
1525 Looks up the subjects of the book with the given biblionumber. Returns
1526 a two-element list. C<$subjects> is a reference-to-array, where each
1527 element is a subject of the book, and C<$count> is the number of
1528 elements in C<$subjects>.
1534 my $dbh = C4::Context->dbh;
1535 my $query="Select * from bibliosubject where biblionumber=$bibnum";
1536 my $sth=$dbh->prepare($query);
1540 while (my $data=$sth->fetchrow_hashref){
1545 return($i,\@results);
1550 ($count, $authors) = &addauthors($biblionumber);
1552 Looks up the additional authors for the book with the given
1555 Returns a two-element list. C<$authors> is a reference-to-array, where
1556 each element is an additional author, and C<$count> is the number of
1557 elements in C<$authors>.
1563 my $dbh = C4::Context->dbh;
1564 my $query="Select * from additionalauthors where biblionumber=$bibnum";
1565 my $sth=$dbh->prepare($query);
1569 while (my $data=$sth->fetchrow_hashref){
1574 return($i,\@results);
1579 ($count, $subtitles) = &subtitle($biblionumber);
1581 Looks up the subtitles for the book with the given biblionumber.
1583 Returns a two-element list. C<$subtitles> is a reference-to-array,
1584 where each element is a subtitle, and C<$count> is the number of
1585 elements in C<$subtitles>.
1591 my $dbh = C4::Context->dbh;
1592 my $query="Select * from bibliosubtitle where biblionumber=$bibnum";
1593 my $sth=$dbh->prepare($query);
1597 while (my $data=$sth->fetchrow_hashref){
1602 return($i,\@results);
1607 @issues = &itemissues($biblioitemnumber, $biblio);
1609 Looks up information about who has borrowed the bookZ<>(s) with the
1610 given biblioitemnumber.
1612 C<$biblio> is ignored.
1614 C<&itemissues> returns an array of references-to-hash. The keys
1615 include the fields from the C<items> table in the Koha database.
1616 Additional keys include:
1622 If the item is currently on loan, this gives the due date.
1624 If the item is not on loan, then this is either "Available" or
1625 "Cancelled", if the item has been withdrawn.
1629 If the item is currently on loan, this gives the card number of the
1630 patron who currently has the item.
1632 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
1634 These give the timestamp for the last three times the item was
1637 =item C<card0>, C<card1>, C<card2>
1639 The card number of the last three patrons who borrowed this item.
1641 =item C<borrower0>, C<borrower1>, C<borrower2>
1643 The borrower number of the last three patrons who borrowed this item.
1650 my ($bibitem, $biblio)=@_;
1651 my $dbh = C4::Context->dbh;
1652 my $query = "Select * from items where
1653 items.biblioitemnumber = '$bibitem'";
1654 # FIXME - If this function die()s, the script will abort, and the
1655 # user won't get anything; depending on how far the script has
1656 # gotten, the user might get a blank page. It would be much better
1657 # to at least print an error message. The easiest way to do this
1658 # is to set $SIG{__DIE__}.
1659 my $sth = $dbh->prepare($query)
1660 || die $dbh->errstr;
1665 || die $sth->errstr;
1667 while (my $data = $sth->fetchrow_hashref) {
1668 # Find out who currently has this item.
1669 # FIXME - Wouldn't it be better to do this as a left join of
1670 # some sort? Currently, this code assumes that if
1671 # fetchrow_hashref() fails, then the book is on the shelf.
1672 # fetchrow_hashref() can fail for any number of reasons (e.g.,
1673 # database server crash), not just because no items match the
1675 my $query2 = "select * from issues,borrowers
1676 where itemnumber = $data->{'itemnumber'}
1677 and returndate is NULL
1678 and issues.borrowernumber = borrowers.borrowernumber";
1679 my $sth2 = $dbh->prepare($query2);
1682 if (my $data2 = $sth2->fetchrow_hashref) {
1683 $data->{'date_due'} = $data2->{'date_due'};
1684 $data->{'card'} = $data2->{'cardnumber'};
1686 if ($data->{'wthdrawn'} eq '1') {
1687 $data->{'date_due'} = 'Cancelled';
1689 $data->{'date_due'} = 'Available';
1695 # Find the last 3 people who borrowed this item.
1696 $query2 = "select * from issues, borrowers
1697 where itemnumber = '$data->{'itemnumber'}'
1698 and issues.borrowernumber = borrowers.borrowernumber
1699 and returndate is not NULL
1700 order by returndate desc,timestamp desc";
1701 $sth2 = $dbh->prepare($query2)
1702 || die $dbh->errstr;
1704 || die $sth2->errstr;
1706 for (my $i2 = 0; $i2 < 2; $i2++) {
1707 if (my $data2 = $sth2->fetchrow_hashref) {
1708 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1709 $data->{"card$i2"} = $data2->{'cardnumber'};
1710 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1715 $results[$i] = $data;
1725 $item = &itemnodata($env, $dbh, $biblioitemnumber);
1727 Looks up the item with the given biblioitemnumber.
1729 C<$env> and C<$dbh> are ignored.
1731 C<&itemnodata> returns a reference-to-hash whose keys are the fields
1732 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
1738 my ($env,$dbh,$itemnumber) = @_;
1739 $dbh = C4::Context->dbh;
1740 my $query="Select * from biblio,items,biblioitems
1741 where items.itemnumber = '$itemnumber'
1742 and biblio.biblionumber = items.biblionumber
1743 and biblioitems.biblioitemnumber = items.biblioitemnumber";
1744 my $sth=$dbh->prepare($query);
1747 my $data=$sth->fetchrow_hashref;
1754 ($count, $borrowers) = &BornameSearch($env, $searchstring, $type);
1756 Looks up patrons (borrowers) by name.
1758 C<$env> and C<$type> are ignored.
1760 C<$searchstring> is a space-separated list of search terms. Each term
1761 must match the beginning a borrower's surname, first name, or other
1764 C<&BornameSearch> returns a two-element list. C<$borrowers> is a
1765 reference-to-array; each element is a reference-to-hash, whose keys
1766 are the fields of the C<borrowers> table in the Koha database.
1767 C<$count> is the number of elements in C<$borrowers>.
1771 #used by member enquiries from the intranet
1772 #called by member.pl
1774 my ($env,$searchstring,$type)=@_;
1775 my $dbh = C4::Context->dbh;
1776 $searchstring=~ s/\'/\\\'/g;
1777 my @data=split(' ',$searchstring);
1779 my $query="Select * from borrowers
1780 where ((surname like \"$data[0]%\" or surname like \"% $data[0]%\"
1781 or firstname like \"$data[0]%\" or firstname like \"% $data[0]%\"
1782 or othernames like \"$data[0]%\" or othernames like \"% $data[0]%\")
1784 for (my $i=1;$i<$count;$i++){
1785 $query=$query." and (surname like \"$data[$i]%\" or surname like \"% $data[$i]%\"
1786 or firstname like \"$data[$i]%\" or firstname like \"% $data[$i]%\"
1787 or othernames like \"$data[$i]%\" or othernames like \"% $data[$i]%\")";
1790 $query=$query.") or cardnumber = \"$searchstring\"
1791 order by surname,firstname";
1793 # print $query,"\n";
1794 my $sth=$dbh->prepare($query);
1798 while (my $data=$sth->fetchrow_hashref){
1799 push(@results,$data);
1804 return ($cnt,\@results);
1809 $borrower = &borrdata($cardnumber, $borrowernumber);
1811 Looks up information about a patron (borrower) by either card number
1812 or borrower number. If $borrowernumber is specified, C<&borrdata>
1813 searches by borrower number; otherwise, it searches by card number.
1815 C<&borrdata> returns a reference-to-hash whose keys are the fields of
1816 the C<borrowers> table in the Koha database.
1821 my ($cardnumber,$bornum)=@_;
1822 $cardnumber = uc $cardnumber;
1823 my $dbh = C4::Context->dbh;
1826 $query="Select * from borrowers where cardnumber='$cardnumber'";
1828 $query="Select * from borrowers where borrowernumber='$bornum'";
1831 my $sth=$dbh->prepare($query);
1833 my $data=$sth->fetchrow_hashref;
1840 ($count, $issues) = &borrissues($borrowernumber);
1842 Looks up what the patron with the given borrowernumber has borrowed.
1844 C<&borrissues> returns a two-element array. C<$issues> is a
1845 reference-to-array, where each element is a reference-to-hash; the
1846 keys are the fields from the C<issues>, C<biblio>, and C<items> tables
1847 in the Koha database. C<$count> is the number of elements in
1854 my $dbh = C4::Context->dbh;
1856 $query="Select * from issues,biblio,items where borrowernumber='$bornum' and
1857 items.itemnumber=issues.itemnumber and
1858 items.biblionumber=biblio.biblionumber and issues.returndate is NULL order
1861 my $sth=$dbh->prepare($query);
1864 while (my $data = $sth->fetchrow_hashref) {
1865 push @result, $data;
1868 return(scalar(@result), \@result);
1873 ($count, $issues) = &allissues($borrowernumber, $sortkey, $limit);
1875 Looks up what the patron with the given borrowernumber has borrowed,
1876 and sorts the results.
1878 C<$sortkey> is the name of a field on which to sort the results. This
1879 should be the name of a field in the C<issues>, C<biblio>,
1880 C<biblioitems>, or C<items> table in the Koha database.
1882 C<$limit> is the maximum number of results to return.
1884 C<&allissues> returns a two-element array. C<$issues> is a
1885 reference-to-array, where each element is a reference-to-hash; the
1886 keys are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1887 C<items> tables of the Koha database. C<$count> is the number of
1888 elements in C<$issues>
1893 my ($bornum,$order,$limit)=@_;
1894 my $dbh = C4::Context->dbh;
1896 $query="Select * from issues,biblio,items,biblioitems
1897 where borrowernumber='$bornum' and
1898 items.biblioitemnumber=biblioitems.biblioitemnumber and
1899 items.itemnumber=issues.itemnumber and
1900 items.biblionumber=biblio.biblionumber";
1901 $query.=" order by $order";
1903 $query.=" limit $limit";
1906 my $sth=$dbh->prepare($query);
1910 while (my $data=$sth->fetchrow_hashref){
1915 return($i,\@result);
1920 ($borrowed, $due, $fine) = &borrdata2($env, $borrowernumber);
1922 Returns aggregate data about items borrowed by the patron with the
1923 given borrowernumber.
1927 C<&borrdata2> returns a three-element array. C<$borrowed> is the
1928 number of books the patron currently has borrowed. C<$due> is the
1929 number of overdue items the patron currently has borrowed. C<$fine> is
1930 the total fine currently due by the borrower.
1935 my ($env,$bornum)=@_;
1936 my $dbh = C4::Context->dbh;
1937 my $query="Select count(*) from issues where borrowernumber='$bornum' and
1938 returndate is NULL";
1940 my $sth=$dbh->prepare($query);
1942 my $data=$sth->fetchrow_hashref;
1944 $sth=$dbh->prepare("Select count(*) from issues where
1945 borrowernumber='$bornum' and date_due < now() and returndate is NULL");
1947 my $data2=$sth->fetchrow_hashref;
1949 $sth=$dbh->prepare("Select sum(amountoutstanding) from accountlines where
1950 borrowernumber='$bornum'");
1952 my $data3=$sth->fetchrow_hashref;
1955 return($data2->{'count(*)'},$data->{'count(*)'},$data3->{'sum(amountoutstanding)'});
1958 =item getboracctrecord
1960 ($count, $acctlines, $total) = &getboracctrecord($env, $borrowernumber);
1962 Looks up accounting data for the patron with the given borrowernumber.
1966 (FIXME - I'm not at all sure what this is about.)
1968 C<&getboracctrecord> returns a three-element array. C<$acctlines> is a
1969 reference-to-array, where each element is a reference-to-hash; the
1970 keys are the fields of the C<accountlines> table in the Koha database.
1971 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1972 total amount outstanding for all of the account lines.
1976 sub getboracctrecord {
1977 my ($env,$params) = @_;
1978 my $dbh = C4::Context->dbh;
1981 my $query= "Select * from accountlines where
1982 borrowernumber=$params->{'borrowernumber'} order by date desc,timestamp desc";
1983 my $sth=$dbh->prepare($query);
1987 while (my $data=$sth->fetchrow_hashref){
1988 # if ($data->{'itemnumber'} ne ''){
1989 # $query="Select * from items,biblio where items.itemnumber=
1990 # '$data->{'itemnumber'}' and biblio.biblionumber=items.biblionumber";
1991 # my $sth2=$dbh->prepare($query);
1993 # my $data2=$sth2->fetchrow_hashref;
1997 $acctlines[$numlines] = $data;
1999 $total = $total+ $data->{'amountoutstanding'}; # FIXME - +=
2002 return ($numlines,\@acctlines,$total);
2007 ($count, $lcount, $nacount, $fcount, $scount, $lostcount,
2008 $mending, $transit,$ocount) =
2009 &itemcount($env, $biblionumber, $type);
2011 Counts the number of items with the given biblionumber, broken down by
2016 If C<$type> is not set to C<intra>, lost, very overdue, and withdrawn
2017 items will not be counted.
2019 C<&itemcount> returns a nine-element list:
2021 C<$count> is the total number of items with the given biblionumber.
2023 C<$lcount> is the number of items at the Levin branch.
2025 C<$nacount> is the number of items that are neither borrowed, lost,
2026 nor withdrawn (and are therefore presumably on a shelf somewhere).
2028 C<$fcount> is the number of items at the Foxton branch.
2030 C<$scount> is the number of items at the Shannon branch.
2032 C<$lostcount> is the number of lost and very overdue items.
2034 C<$mending> is the number of items at the Mending branch (being
2037 C<$transit> is the number of items at the Transit branch (in transit
2040 C<$ocount> is the number of items that haven't arrived yet
2041 (aqorders.quantity - aqorders.quantityreceived).
2046 # FIXME - There's also a &C4::Acquisitions::itemcount and
2047 # &C4::Biblio::itemcount.
2048 # Since they're all exported, acqui/acquire.pl doesn't compile with -w.
2050 my ($env,$bibnum,$type)=@_;
2051 my $dbh = C4::Context->dbh;
2052 my $query="Select * from items where
2053 biblionumber=$bibnum ";
2054 if ($type ne 'intra'){
2055 $query.=" and ((itemlost <>1 and itemlost <> 2) or itemlost is NULL) and
2056 (wthdrawn <> 1 or wthdrawn is NULL)";
2058 my $sth=$dbh->prepare($query);
2070 while (my $data=$sth->fetchrow_hashref){
2072 my $query2="select * from issues,items where issues.itemnumber=
2073 '$data->{'itemnumber'}' and returndate is NULL
2074 and items.itemnumber=issues.itemnumber and ((items.itemlost <>1 and
2075 items.itemlost <> 2) or items.itemlost is NULL)
2076 and (wthdrawn <> 1 or wthdrawn is NULL)";
2078 my $sth2=$dbh->prepare($query2);
2080 if (my $data2=$sth2->fetchrow_hashref){
2083 if ($data->{'holdingbranch'} eq 'C' || $data->{'holdingbranch'} eq 'LT'){
2086 if ($data->{'holdingbranch'} eq 'F' || $data->{'holdingbranch'} eq 'FP'){
2089 if ($data->{'holdingbranch'} eq 'S' || $data->{'holdingbranch'} eq 'SP'){
2092 if ($data->{'itemlost'} eq '1'){
2095 if ($data->{'itemlost'} eq '2'){
2098 if ($data->{'holdingbranch'} eq 'FM'){
2101 if ($data->{'holdingbranch'} eq 'TR'){
2108 my $query2="Select * from aqorders where biblionumber=$bibnum";
2109 my $sth2=$dbh->prepare($query2);
2111 if (my $data=$sth2->fetchrow_hashref){
2112 $ocount=$data->{'quantity'} - $data->{'quantityreceived'};
2117 return ($count,$lcount,$nacount,$fcount,$scount,$lostcount,$mending,$transit,$ocount);
2122 $counts = &itemcount2($env, $biblionumber, $type);
2124 Counts the number of items with the given biblionumber, broken down by
2129 C<$type> may be either C<intra> or anything else. If it is not set to
2130 C<intra>, then the search will exclude lost, very overdue, and
2133 C<$&itemcount2> returns a reference-to-hash, with the following fields:
2139 The total number of items with this biblionumber.
2143 The number of items on order (aqorders.quantity -
2144 aqorders.quantityreceived).
2148 For each branch that has at least one copy of the book, C<$counts>
2149 will have a key with the branch name, giving the number of copies at
2157 my ($env,$bibnum,$type)=@_;
2158 my $dbh = C4::Context->dbh;
2159 my $query="Select * from items,branches where
2160 biblionumber=$bibnum and items.holdingbranch=branches.branchcode";
2161 if ($type ne 'intra'){
2162 $query.=" and ((itemlost <>1 and itemlost <> 2) or itemlost is NULL) and
2163 (wthdrawn <> 1 or wthdrawn is NULL)";
2165 my $sth=$dbh->prepare($query);
2170 while (my $data=$sth->fetchrow_hashref){
2172 my $query2="select * from issues,items where issues.itemnumber=
2173 '$data->{'itemnumber'}' and returndate is NULL
2174 and items.itemnumber=issues.itemnumber and ((items.itemlost <>1 and
2175 items.itemlost <> 2) or items.itemlost is NULL)
2176 and (wthdrawn <> 1 or wthdrawn is NULL)";
2178 my $sth2=$dbh->prepare($query2);
2180 # FIXME - fetchrow_hashref() can fail for any number of reasons
2181 # (e.g., a database server crash). Perhaps use a left join of some
2183 if (my $data2=$sth2->fetchrow_hashref){
2184 $counts{'not available'}++;
2186 $counts{$data->{'branchname'}}++;
2190 my $query2="Select * from aqorders where biblionumber=$bibnum and
2191 datecancellationprinted is NULL and quantity > quantityreceived";
2192 my $sth2=$dbh->prepare($query2);
2194 if (my $data=$sth2->fetchrow_hashref){
2195 $counts{'order'}=$data->{'quantity'} - $data->{'quantityreceived'};
2204 $description = &ItemType($itemtype);
2206 Given an item type code, returns the description for that type.
2211 # FIXME - I'm pretty sure that after the initial setup, the list of
2212 # item types doesn't change very often. Hence, it seems slow and
2213 # inefficient to make yet another database call to look up information
2214 # that'll only change every few months or years.
2216 # Much better, I think, to automatically build a Perl file that can be
2217 # included in those scripts that require it, e.g.:
2218 # @itemtypes = qw( ART BCD CAS CD F ... );
2220 # ART => "Art Prints",
2221 # BCD => "CD-ROM from book",
2222 # CD => "Compact disc (WN)",
2223 # F => "Free Fiction",
2226 # The web server can then run a cron job to rebuild this file from the
2227 # database every hour or so.
2229 # The same thing goes for branches, book funds, book sellers, currency
2230 # rates, printers, stopwords, and perhaps others.
2233 my $dbh = C4::Context->dbh;
2234 my $query="select description from itemtypes where itemtype='$type'";
2235 my $sth=$dbh->prepare($query);
2237 my $dat=$sth->fetchrow_hashref;
2239 return ($dat->{'description'});
2244 ($count, @results) = &bibitems($biblionumber);
2246 Given the biblionumber for a book, C<&bibitems> looks up that book's
2247 biblioitems (different publications of the same book, the audio book
2248 and film versions, etc.).
2250 C<$count> is the number of elements in C<@results>.
2252 C<@results> is an array of references-to-hash; the keys are the fields
2253 of the C<biblioitems> and C<itemtypes> tables of the Koha database. In
2254 addition, C<itemlost> indicates the availability of the item: if it is
2255 "2", then all copies of the item are long overdue; if it is "1", then
2256 all copies are lost; otherwise, there is at least one copy available.
2262 my $dbh = C4::Context->dbh;
2263 my $query = "SELECT biblioitems.*,
2265 MIN(items.itemlost) as itemlost,
2266 MIN(items.dateaccessioned) as dateaccessioned
2267 FROM biblioitems, itemtypes, items
2268 WHERE biblioitems.biblionumber = ?
2269 AND biblioitems.itemtype = itemtypes.itemtype
2270 AND biblioitems.biblioitemnumber = items.biblioitemnumber
2271 GROUP BY items.biblioitemnumber";
2272 my $sth = $dbh->prepare($query);
2275 $sth->execute($bibnum);
2276 while (my $data = $sth->fetchrow_hashref) {
2277 $results[$count] = $data;
2281 return($count, @results);
2286 @barcodes = &barcodes($biblioitemnumber);
2288 Given a biblioitemnumber, looks up the corresponding items.
2290 Returns an array of references-to-hash; the keys are C<barcode> and
2293 The returned items include very overdue items, but not lost ones.
2298 #called from request.pl
2299 my ($biblioitemnumber)=@_;
2300 my $dbh = C4::Context->dbh;
2301 my $query="SELECT barcode, itemlost, holdingbranch FROM items
2302 WHERE biblioitemnumber = ?
2303 AND (wthdrawn <> 1 OR wthdrawn IS NULL)";
2304 my $sth=$dbh->prepare($query);
2305 $sth->execute($biblioitemnumber);
2308 while (my $data=$sth->fetchrow_hashref){
2309 $barcodes[$i]=$data;
2318 ($count, @websites) = &getwebsites($biblionumber);
2320 Looks up the web sites pertaining to the book with the given
2323 C<$count> is the number of elements in C<@websites>.
2325 C<@websites> is an array of references-to-hash; the keys are the
2326 fields from the C<websites> table in the Koha database.
2331 my ($biblionumber) = @_;
2332 my $dbh = C4::Context->dbh;
2333 my $query = "Select * from websites where biblionumber = $biblionumber";
2334 my $sth = $dbh->prepare($query);
2339 while (my $data = $sth->fetchrow_hashref) {
2340 # FIXME - The URL scheme shouldn't be stripped off, at least
2341 # not here, since it's part of the URL, and will be useful in
2342 # constructing a link to the site. If you don't want the user
2343 # to see the "http://" part, strip that off when building the
2345 $data->{'url'} =~ s/^http:\/\///; # FIXME - Leaning toothpick
2347 $results[$count] = $data;
2352 return($count, @results);
2355 =item getwebbiblioitems
2357 ($count, @results) = &getwebbiblioitems($biblionumber);
2359 Given a book's biblionumber, looks up the web versions of the book
2360 (biblioitems with itemtype C<WEB>).
2362 C<$count> is the number of items in C<@results>. C<@results> is an
2363 array of references-to-hash; the keys are the items from the
2364 C<biblioitems> table of the Koha database.
2368 sub getwebbiblioitems {
2369 my ($biblionumber) = @_;
2370 my $dbh = C4::Context->dbh;
2371 my $query = "Select * from biblioitems where biblionumber = $biblionumber
2372 and itemtype = 'WEB'";
2373 my $sth = $dbh->prepare($query);
2378 while (my $data = $sth->fetchrow_hashref) {
2379 $data->{'url'} =~ s/^http:\/\///;
2380 $results[$count] = $data;
2385 return($count, @results);
2386 } # sub getwebbiblioitems
2389 END { } # module clean-up code here (global destructor)
2398 Koha Developement team <info@koha.org>