bug 8215: (followup) make sure C4::CourseReserves doesn't export anything
[koha.git] / C4 / Breeding.pm
1 package C4::Breeding;
2
3 # Copyright 2000-2002 Katipo Communications
4 #
5 # This file is part of Koha.
6 #
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
10 # version.
11 #
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.
15 #
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20 use strict;
21 use warnings;
22
23 use C4::Biblio;
24 use C4::Koha;
25 use C4::Charset;
26 use MARC::File::USMARC;
27 use C4::ImportBatch;
28
29 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
30
31 BEGIN {
32         # set the version for version checking
33     $VERSION = 3.07.00.049;
34         require Exporter;
35         @ISA = qw(Exporter);
36     @EXPORT = qw(&ImportBreeding &BreedingSearch &Z3950Search);
37 }
38
39 =head1 NAME
40
41 C4::Breeding : module to add biblios to import_records via
42                the breeding/reservoir API.
43
44 =head1 SYNOPSIS
45
46     use C4::Scan;
47     &ImportBreeding($marcrecords,$overwrite_biblio,$filename,$z3950random,$batch_type);
48
49     C<$marcrecord> => the MARC::Record
50     C<$overwrite_biblio> => if set to 1 a biblio with the same ISBN will be overwritted.
51                                 if set to 0 a biblio with the same isbn will be ignored (the previous will be kept)
52                                 if set to -1 the biblio will be added anyway (more than 1 biblio with the same ISBN 
53                                 possible in the breeding
54     C<$encoding> => USMARC
55                         or UNIMARC. used for char_decoding.
56                         If not present, the parameter marcflavour is used instead
57     C<$z3950random> => the random value created during a z3950 search result.
58
59 =head1 DESCRIPTION
60
61     ImportBreeding import MARC records in the reservoir (import_records/import_batches tables).
62     the records can be properly encoded or not, we try to reencode them in utf-8 if needed.
63     works perfectly with BNF server, that sends UNIMARC latin1 records. Should work with other servers too.
64
65 =head2 ImportBreeding
66
67         ImportBreeding($marcrecords,$overwrite_biblio,$filename,$encoding,$z3950random,$batch_type);
68
69         TODO description
70
71 =cut
72
73 sub ImportBreeding {
74     my ($marcrecords,$overwrite_biblio,$filename,$encoding,$z3950random,$batch_type) = @_;
75     my @marcarray = split /\x1D/, $marcrecords;
76     
77     my $dbh = C4::Context->dbh;
78     
79     my $batch_id = GetZ3950BatchId($filename);
80     my $searchisbn = $dbh->prepare("select biblioitemnumber from biblioitems where isbn=?");
81     my $searchissn = $dbh->prepare("select biblioitemnumber from biblioitems where issn=?");
82     # FIXME -- not sure that this kind of checking is actually needed
83     my $searchbreeding = $dbh->prepare("select import_record_id from import_biblios where isbn=? and title=?");
84     
85 #     $encoding = C4::Context->preference("marcflavour") unless $encoding;
86     # fields used for import results
87     my $imported=0;
88     my $alreadyindb = 0;
89     my $alreadyinfarm = 0;
90     my $notmarcrecord = 0;
91     my $breedingid;
92     for (my $i=0;$i<=$#marcarray;$i++) {
93         my ($marcrecord, $charset_result, $charset_errors);
94         ($marcrecord, $charset_result, $charset_errors) = 
95             MarcToUTF8Record($marcarray[$i]."\x1D", C4::Context->preference("marcflavour"), $encoding);
96         
97         # Normalize the record so it doesn't have separated diacritics
98         SetUTF8Flag($marcrecord);
99
100 #         warn "$i : $marcarray[$i]";
101         # FIXME - currently this does nothing 
102         my @warnings = $marcrecord->warnings();
103         
104         if (scalar($marcrecord->fields()) == 0) {
105             $notmarcrecord++;
106         } else {
107             my $oldbiblio = TransformMarcToKoha($dbh,$marcrecord,'');
108             # if isbn found and biblio does not exist, add it. If isbn found and biblio exists, 
109             # overwrite or ignore depending on user choice
110             # drop every "special" char : spaces, - ...
111             $oldbiblio->{isbn} = C4::Koha::_isbn_cleanup($oldbiblio->{isbn}); # FIXME C4::Koha::_isbn_cleanup should be public
112             # search if biblio exists
113             my $biblioitemnumber;
114             if ($oldbiblio->{isbn}) {
115                 $searchisbn->execute($oldbiblio->{isbn});
116                 ($biblioitemnumber) = $searchisbn->fetchrow;
117             } else {
118                 if ($oldbiblio->{issn}) {
119                     $searchissn->execute($oldbiblio->{issn});
120                         ($biblioitemnumber) = $searchissn->fetchrow;
121                 }
122             }
123             if ($biblioitemnumber && $overwrite_biblio ne 2) {
124                 $alreadyindb++;
125             } else {
126                 # FIXME - in context of batch load,
127                 # rejecting records because already present in the reservoir
128                 # not correct in every case.
129                 # search in breeding farm
130                 if ($oldbiblio->{isbn}) {
131                     $searchbreeding->execute($oldbiblio->{isbn},$oldbiblio->{title});
132                     ($breedingid) = $searchbreeding->fetchrow;
133                 } elsif ($oldbiblio->{issn}){
134                     $searchbreeding->execute($oldbiblio->{issn},$oldbiblio->{title});
135                     ($breedingid) = $searchbreeding->fetchrow;
136                 }
137                 if ($breedingid && $overwrite_biblio eq '0') {
138                     $alreadyinfarm++;
139                 } else {
140                     if ($breedingid && $overwrite_biblio eq '1') {
141                         ModBiblioInBatch($breedingid, $marcrecord);
142                     } else {
143                         my $import_id = AddBiblioToBatch($batch_id, $imported, $marcrecord, $encoding, $z3950random);
144                         $breedingid = $import_id;
145                     }
146                     $imported++;
147                 }
148             }
149         }
150     }
151     return ($notmarcrecord,$alreadyindb,$alreadyinfarm,$imported,$breedingid);
152 }
153
154
155 =head2 BreedingSearch
156
157 ($count, @results) = &BreedingSearch($title,$isbn,$random);
158 C<$title> contains the title,
159 C<$isbn> contains isbn or issn,
160 C<$random> contains the random seed from a z3950 search.
161
162 C<$count> is the number of items in C<@results>. C<@results> is an
163 array of references-to-hash; the keys are the items from the C<import_records> and
164 C<import_biblios> tables of the Koha database.
165
166 =cut
167
168 sub BreedingSearch {
169     my ($search,$isbn,$z3950random) = @_;
170     my $dbh   = C4::Context->dbh;
171     my $count = 0;
172     my ($query,@bind);
173     my $sth;
174     my @results;
175
176     $query = "SELECT import_record_id, file_name, isbn, title, author
177               FROM  import_biblios 
178               JOIN import_records USING (import_record_id)
179               JOIN import_batches USING (import_batch_id)
180               WHERE ";
181     if ($z3950random) {
182         $query .= "z3950random = ?";
183         @bind=($z3950random);
184     } else {
185         @bind=();
186         if (defined($search) && length($search)>0) {
187             $search =~ s/(\s+)/\%/g;
188             $query .= "title like ? OR author like ?";
189             push(@bind,"%$search%", "%$search%");
190         }
191         if ($#bind!=-1 && defined($isbn) && length($isbn)>0) {
192             $query .= " and ";
193         }
194         if (defined($isbn) && length($isbn)>0) {
195             $query .= "isbn like ?";
196             push(@bind,"$isbn%");
197         }
198     }
199     $sth   = $dbh->prepare($query);
200     $sth->execute(@bind);
201     while (my $data = $sth->fetchrow_hashref) {
202             $results[$count] = $data;
203             # FIXME - hack to reflect difference in name 
204             # of columns in old marc_breeding and import_records
205             # There needs to be more separation between column names and 
206             # field names used in the templates </soapbox>
207             $data->{'file'} = $data->{'file_name'};
208             $data->{'id'} = $data->{'import_record_id'};
209             $count++;
210     } # while
211
212     $sth->finish;
213     return($count, @results);
214 } # sub breedingsearch
215
216
217 =head2 Z3950Search
218
219 Z3950Search($pars, $template);
220
221 Parameters for Z3950 search are all passed via the $pars hash. It may contain isbn, title, author, dewey, subject, lccall, controlnumber, stdid, srchany.
222 Also it should contain an arrayref id that points to a list of id's of the z3950 targets to be queried (see z3950servers table).
223 This code is used in acqui/z3950_search and cataloging/z3950_search.
224 The second parameter $template is a Template object. The routine uses this parameter to store the found values into the template.
225
226 =cut
227
228 sub Z3950Search {
229     my ($pars, $template)= @_;
230
231     my $dbh   = C4::Context->dbh;
232     my @id= @{$pars->{id}};
233     my $random= $pars->{random};
234     my $page= $pars->{page};
235     my $biblionumber= $pars->{biblionumber};
236
237     my $isbn= $pars->{isbn};
238     my $issn= $pars->{issn};
239     my $title= $pars->{title};
240     my $author= $pars->{author};
241     my $dewey= $pars->{dewey};
242     my $subject= $pars->{subject};
243     my $lccn= $pars->{lccn};
244     my $lccall= $pars->{lccall};
245     my $controlnumber= $pars->{controlnumber};
246     my $srchany= $pars->{srchany};
247     my $stdid= $pars->{stdid};
248
249     my $show_next       = 0;
250     my $total_pages     = 0;
251
252     my $attr = '';
253     my $term;
254     my $host;
255     my $server;
256     my $database;
257     my $port;
258     my $marcdata;
259     my @encoding;
260     my @results;
261     my $count;
262     my $record;
263     my $oldbiblio;
264     my @serverhost;
265     my @servername;
266     my @breeding_loop = ();
267
268     my @oConnection;
269     my @oResult;
270     my @errconn;
271     my $s = 0;
272     my $query;
273     my $nterms=0;
274     if ($isbn) {
275         $term=$isbn;
276         $query .= " \@attr 1=7 \@attr 5=1 \"$term\" ";
277         $nterms++;
278     }
279     if ($issn) {
280         $term=$issn;
281         $query .= " \@attr 1=8 \@attr 5=1 \"$term\" ";
282         $nterms++;
283     }
284     if ($title) {
285         $query .= " \@attr 1=4 \"$title\" ";
286         $nterms++;
287     }
288     if ($author) {
289         $query .= " \@attr 1=1003 \"$author\" ";
290         $nterms++;
291     }
292     if ($dewey) {
293         $query .= " \@attr 1=16 \"$dewey\" ";
294         $nterms++;
295     }
296     if ($subject) {
297         $query .= " \@attr 1=21 \"$subject\" ";
298         $nterms++;
299     }
300     if ($lccn) {
301         $query .= " \@attr 1=9 $lccn ";
302         $nterms++;
303     }
304     if ($lccall) {
305         $query .= " \@attr 1=16 \@attr 2=3 \@attr 3=1 \@attr 4=1 \@attr 5=1 \@attr 6=1 \"$lccall\" ";
306         $nterms++;
307     }
308     if ($controlnumber) {
309         $query .= " \@attr 1=12 \"$controlnumber\" ";
310         $nterms++;
311     }
312     if($srchany) {
313         $query .= " \@attr 1=1016 \"$srchany\" ";
314         $nterms++;
315     }
316     if($stdid) {
317         $query .= " \@attr 1=1007 \"$stdid\" ";
318         $nterms++;
319     }
320     for my $i (1..$nterms-1) {
321         $query = "\@and " . $query;
322     }
323
324     foreach my $servid (@id) {
325         my $sth = $dbh->prepare("select * from z3950servers where id=?");
326         $sth->execute($servid);
327         while ( $server = $sth->fetchrow_hashref ) {
328             my $option1      = new ZOOM::Options();
329             $option1->option( 'async' => 1 );
330             $option1->option( 'elementSetName', 'F' );
331             $option1->option( 'databaseName',   $server->{db} );
332             $option1->option( 'user', $server->{userid} ) if $server->{userid};
333             $option1->option( 'password', $server->{password} )
334               if $server->{password};
335             $option1->option( 'preferredRecordSyntax', $server->{syntax} );
336             $option1->option( 'timeout', $server->{timeout} ) if $server->{timeout};
337             $oConnection[$s] = create ZOOM::Connection($option1);
338             $oConnection[$s]->connect( $server->{host}, $server->{port} );
339             $serverhost[$s] = $server->{host};
340             $servername[$s] = $server->{name};
341             $encoding[$s]   = ($server->{encoding}?$server->{encoding}:"iso-5426");
342             $s++;
343         }    ## while fetch
344     }    # foreach
345     my $nremaining  = $s;
346
347     for ( my $z = 0 ; $z < $s ; $z++ ) {
348         $oResult[$z] = $oConnection[$z]->search_pqf($query);
349     }
350
351     while ( $nremaining-- ) {
352         my $k;
353         my $event;
354         while ( ( $k = ZOOM::event( \@oConnection ) ) != 0 ) {
355             $event = $oConnection[ $k - 1 ]->last_event();
356             last if $event == ZOOM::Event::ZEND;
357         }
358
359         if ( $k != 0 ) {
360             $k--;
361             my ($error, $errmsg, $addinfo, $diagset)= $oConnection[$k]->error_x();
362             if ($error) {
363                 if ($error =~ m/^(10000|10007)$/ ) {
364                     push(@errconn, {'server' => $serverhost[$k]});
365                 }
366             }
367             else {
368                 my $numresults = $oResult[$k]->size();
369                 my $i;
370                 my $result = '';
371                 if ( $numresults > 0  and $numresults >= (($page-1)*20)) {
372                     $show_next = 1 if $numresults >= ($page*20);
373                     $total_pages = int($numresults/20)+1 if $total_pages < ($numresults/20);
374                     for ($i = ($page-1)*20; $i < (($numresults < ($page*20)) ? $numresults : ($page*20)); $i++) {
375                         my $rec = $oResult[$k]->record($i);
376                         if ($rec) {
377                             my $marcrecord;
378                             $marcdata   = $rec->raw();
379                             my ($charset_result, $charset_errors);
380                             ($marcrecord, $charset_result, $charset_errors)= MarcToUTF8Record($marcdata, C4::Context->preference('marcflavour'), $encoding[$k]);
381                             # Normalize the record so it doesn't have separated diacritics
382                             SetUTF8Flag($marcrecord);
383                             my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, "" );
384                             $oldbiblio->{isbn}   =~ s/ |-|\.//g if $oldbiblio->{isbn};
385                             # pad | and ( with spaces to allow line breaks in the HTML
386                             $oldbiblio->{isbn} =~ s/\|/ \| /g if $oldbiblio->{isbn};
387                             $oldbiblio->{isbn} =~ s/\(/ \(/g if $oldbiblio->{isbn};
388                             $oldbiblio->{issn} =~ s/ |-|\.//g if $oldbiblio->{issn};
389                             # pad | and ( with spaces to allow line breaks in the HTML
390                             $oldbiblio->{issn} =~ s/\|/ \| /g if $oldbiblio->{issn};
391                             $oldbiblio->{issn} =~ s/\(/ \(/g if $oldbiblio->{issn};
392                             my ($notmarcrecord, $alreadyindb, $alreadyinfarm, $imported, $breedingid)= ImportBreeding( $marcdata, 2, $serverhost[$k], $encoding[$k], $random, 'z3950' );
393                             my %row_data;
394                             $row_data{server}       = $servername[$k];
395                             $row_data{isbn}         = $oldbiblio->{isbn};
396                             $row_data{lccn}         = $oldbiblio->{lccn};
397                             $row_data{title}        = $oldbiblio->{title};
398                             $row_data{author}       = $oldbiblio->{author};
399                             $row_data{date}         = $oldbiblio->{copyrightdate};
400                             $row_data{edition}      = $oldbiblio->{editionstatement};
401                             $row_data{breedingid}   = $breedingid;
402                             $row_data{biblionumber} = $biblionumber;
403                             push( @breeding_loop, \%row_data );
404                         }
405                         else {
406                             push(@breeding_loop,{'server'=>$servername[$k],'title'=>join(': ',$oConnection[$k]->error_x()),'breedingid'=>-1,'biblionumber'=>-1});
407                         }
408                     }
409                 }    #if $numresults
410             }
411         }    # if $k !=0
412
413         $template->param(
414             numberpending => $nremaining,
415             current_page => $page,
416             total_pages => $total_pages,
417             show_nextbutton => $show_next?1:0,
418             show_prevbutton => $page!=1,
419         );
420     } # while nremaining
421
422     #close result sets and connections
423     foreach(0..$s-1) {
424         $oResult[$_]->destroy();
425         $oConnection[$_]->destroy();
426     }
427
428     my @servers = ();
429     foreach my $id (@id) {
430         push @servers, {id => $id};
431     }
432     $template->param(
433         breeding_loop => \@breeding_loop,
434         servers => \@servers,
435         errconn       => \@errconn
436     );
437 }
438
439 1;
440 __END__
441