C4/Z3950.pm

   1 package C4::Z3950;
   2
   3 # $Id$
   4
   5 # Routines for handling Z39.50 lookups
   6
   7 # Koha library project  www.koha.org
   8
   9 # Licensed under the GPL
  10
  11
  12 # Copyright 2000-2002 Katipo Communications
  13 #
  14 # This file is part of Koha.
  15 #
  16 # Koha is free software; you can redistribute it and/or modify it under the
  17 # terms of the GNU General Public License as published by the Free Software
  18 # Foundation; either version 2 of the License, or (at your option) any later
  19 # version.
  20 #
  21 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  22 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  23 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  24 #
  25 # You should have received a copy of the GNU General Public License along with
  26 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  27 # Suite 330, Boston, MA  02111-1307 USA
  28
  29 use strict;
  30
  31 # standard or CPAN modules used
  32 use DBI;
  33
  34 # Koha modules used
  35 use C4::Input;
  36 use C4::Biblio;
  37
  38 #------------------
  39
  40 require Exporter;
  41
  42 use vars qw($VERSION @ISA @EXPORT);
  43
  44 # set the version for version checking
  45 $VERSION = do { my @v = '$Revision$' =~ /\d+/g; shift(@v).".".join( "_", map { sprintf "%03d", $_ } @v ); };
  46
  47 =head1 NAME
  48
  49 C4::Z3950 - Functions dealing with Z39.50 queries
  50
  51 =head1 SYNOPSIS
  52
  53   use C4::Z3950;
  54
  55 =head1 DESCRIPTION
  56
  57 This module contains functions for looking up Z39.50 servers, and for
  58 entering Z39.50 lookup requests.
  59
  60 =head1 FUNCTIONS
  61
  62 =over 2
  63
  64 =cut
  65
  66 @ISA = qw(Exporter);
  67 @EXPORT = qw(
  68         &getz3950servers
  69         &z3950servername
  70         &addz3950queue
  71         &checkz3950searchdone
  72 );
  73
  74 #------------------------------------------------
  75 =item getz3950servers
  76
  77   @servers= &getz3950servers(checked);
  78
  79 Returns the list of declared z3950 servers
  80
  81 C<$checked> should always be true (1) => returns only active servers.
  82 If 0 => returns all servers
  83
  84 =cut
  85 sub getz3950servers {
  86         my ($checked) = @_;
  87         my $dbh = C4::Context->dbh;
  88         my $sth;
  89         if ($checked) {
  90                 $sth = $dbh->prepare("select * from z3950servers where checked=1");
  91         } else {
  92                 $sth = $dbh->prepare("select * from z3950servers");
  93         }
  94         my @result;
  95         while ( my ($host, $port, $db, $userid, $password,$servername) = $sth->fetchrow ) {
  96                 push @result, "$servername/$host\:$port/$db/$userid/$password";
  97         } # while
  98         return @result;
  99 }
 100
 101 =item z3950servername
 102
 103   $name = &z3950servername($dbh, $server_id, $default_name);
 104
 105 Looks up a Z39.50 server by ID number, and returns its full name. If
 106 the server is not found, returns C<$default_name>.
 107
 108 C<$server_id> is the Z39.50 server ID to look up.
 109
 110 C<$dbh> is ignored.
 111
 112 =cut
 113 #'
 114
 115 sub z3950servername {
 116         # inputs
 117         my ($srvid,             # server id number
 118                 $default,)=@_;
 119         # return
 120         my $longname;
 121         #----
 122
 123         my $dbh = C4::Context->dbh;
 124
 125         my $sti=$dbh->prepare("select name from z3950servers where id=?");
 126
 127         $sti->execute($srvid);
 128         if ( ! $sti->err ) {
 129                 ($longname)=$sti->fetchrow;
 130         }
 131         if (! $longname) {
 132                 $longname="$default";
 133         }
 134                 return $longname;
 135 } # sub z3950servername
 136
 137 #---------------------------------------
 138
 139 =item addz3950queue
 140
 141   $errmsg = &addz3950queue($query, $type, $request_id, @servers);
 142
 143 Adds a Z39.50 search query for the Z39.50 server to look up.
 144
 145 C<$query> is the term to search for.
 146
 147 C<$type> is the query type, e.g. C<isbn>, C<lccn>, etc.
 148
 149 C<$request_id> is a unique string that will identify this query.
 150
 151 C<@servers> is a list of servers to query (obviously, this can be
 152 given either as an array, or as a list of scalars). Each element may
 153 be either a Z39.50 server ID from the z3950server table of the Koha
 154 database, the string C<DEFAULT> or C<CHECKED>, or a complete server
 155 specification containing a colon.
 156
 157 C<DEFAULT> and C<CHECKED> are synonymous, and refer to those servers
 158 in the z3950servers table whose 'checked' field is set and non-NULL.
 159
 160 Once the query has been submitted to the Z39.50 daemon,
 161 C<&addz3950queue> sends a SIGHUP to the daemon to tell it to process
 162 this new request.
 163
 164 C<&addz3950queue> returns an error message. If it was successful, the
 165 error message is the empty string.
 166
 167 =cut
 168 #'
 169 sub addz3950queue {
 170         use strict;
 171         # input
 172         my (
 173                 $query,         # value to look up
 174                 $type,                  # type of value ("isbn", "lccn", "title", "author", "keyword")
 175                 $requestid,     # Unique value to prevent duplicate searches from multiple HTML form submits
 176                 @z3950list,     # list of z3950 servers to query
 177         )=@_;
 178         # Returns:
 179         my $error;
 180
 181         my (
 182                 $sth,
 183                 @serverlist,
 184                 $server,
 185                 $failed,
 186                 $servername,
 187         );
 188
 189         # FIXME - Should be configurable, probably in /etc/koha.conf.
 190         my $pidfile='/var/log/koha/processz3950queue.pid';
 191
 192         $error="";
 193
 194         my $dbh = C4::Context->dbh;
 195         # list of servers: entry can be a fully qualified URL-type entry
 196         #   or simply just a server ID number.
 197         foreach $server (@z3950list) {
 198                 if ($server =~ /:/ ) {
 199                         push @serverlist, $server;
 200                 } elsif ($server eq 'DEFAULT' || $server eq 'CHECKED' ) {
 201                         $sth=$dbh->prepare("select host,port,db,userid,password ,name,syntax from z3950servers where checked <> 0 ");
 202                         $sth->execute;
 203                         while ( my ($host, $port, $db, $userid, $password,$servername,$syntax) = $sth->fetchrow ) {
 204                                 push @serverlist, "$servername/$host\:$port/$db/$userid/$password/$syntax";
 205                         } # while
 206                 } else {
 207                         $sth=$dbh->prepare("select host,port,db,userid,password,syntax from z3950servers where id=? ");
 208                         $sth->execute($server);
 209                         my ($host, $port, $db, $userid, $password,$syntax) = $sth->fetchrow;
 210                         push @serverlist, "$server/$host\:$port/$db/$userid/$password/$syntax";
 211                 }
 212         }
 213
 214         my $serverlist='';
 215
 216         $serverlist = join("|", @serverlist);
 217 #       chop $serverlist;
 218
 219         # FIXME - Is this test supposed to test whether @serverlist is
 220         # empty? If so, then a) there are better ways to do that in
 221         # Perl (e.g., "if (@serverlist eq ())"), and b) it doesn't
 222         # work anyway, since it checks whether $serverlist is composed
 223         # of one or more spaces, which is never the case, not even
 224         # when there are 0 or 1 elements in @serverlist.
 225         if ( $serverlist !~ /^ +$/ ) {
 226                 # Don't allow reinsertion of the same request identifier.
 227                 $sth=$dbh->prepare("select identifier from z3950queue
 228                         where identifier=?");
 229                 $sth->execute($requestid);
 230                 if ( ! $sth->rows) {
 231                         $sth=$dbh->prepare("insert into z3950queue (term,type,servers, identifier) values (?, ?, ?, ?)");
 232                         $sth->execute($query, $type, $serverlist, $requestid);
 233                         if ( -r $pidfile ) {
 234                                 # FIXME - Perl is good at opening files. No need to
 235                                 # spawn a separate 'cat' process.
 236                                 my $pid=`cat $pidfile`;
 237                                 chomp $pid;
 238                                 warn "PID : $pid";
 239                                 # Kill -HUP the Z39.50 daemon to tell it to process
 240                                 # this query.
 241                                 my $processcount=kill 1, $pid;
 242                                 if ($processcount==0) {
 243                                         $error.="Z39.50 search daemon error: no process signalled. ";
 244                                 }
 245                         } else {
 246                                 # FIXME - Error-checking like this should go close
 247                                 # to the test.
 248                                 $error.="No Z39.50 search daemon running: no file $pidfile. ";
 249                         } # if $pidfile
 250                 } else {
 251                         # FIXME - Error-checking like this should go close
 252                         # to the test.
 253                         $error.="Duplicate request ID $requestid. ";
 254                 } # if rows
 255         } else {
 256                 # FIXME - Error-checking like this should go close to the
 257                 # test. I.e.,
 258                 #       return "No Z39.50 search servers specified. "
 259                 #               if @serverlist eq ();
 260
 261                 # server list is empty
 262                 $error.="No Z39.50 search servers specified. ";
 263         } # if serverlist empty
 264
 265         return $error;
 266
 267 } # sub addz3950queue
 268
 269 =item &checkz3950searchdone
 270
 271   $numberpending= &     &checkz3950searchdone($random);
 272
 273 Returns the number of pending z3950 requests
 274
 275 C<$random> is the random z3950 query number.
 276
 277 =cut
 278 sub checkz3950searchdone {
 279         my ($z3950random) = @_;
 280         my $dbh = C4::Context->dbh;
 281         # first, check that the deamon already created the requests...
 282         my $sth = $dbh->prepare("select count(*) from z3950queue,z3950results where z3950queue.id = z3950results.queryid and z3950queue.identifier=?");
 283         $sth->execute($z3950random);
 284         my ($result) = $sth->fetchrow;
 285         if ($result eq 0) { # search not yet begun => should be searches to do !
 286                 return "??";
 287         }
 288         # second, count pending requests
 289         $sth = $dbh->prepare("select count(*) from z3950queue,z3950results where z3950queue.id = z3950results.queryid and z3950results.enddate is null and z3950queue.identifier=?");
 290         $sth->execute($z3950random);
 291         ($result) = $sth->fetchrow;
 292         return $result;
 293 }
 294
 295 1;
 296 __END__
 297
 298 =back
 299
 300 =head1 AUTHOR
 301
 302 Koha Developement team <info@koha.org>
 303
 304 =cut
 305
 306 #--------------------------------------
 307 # $Log$
 308 # Revision 1.14  2007/03/09 14:31:47  tipaul
 309 # rel_3_0 moved to HEAD
 310 #
 311 # Revision 1.10.10.1  2006/12/22 15:09:54  toins
 312 # removing C4::Database;
 313 #
 314 # Revision 1.10  2003/10/01 15:08:14  tipaul
 315 # fix fog bug #622 : processz3950queue fails
 316 #
 317 # Revision 1.9  2003/04/29 16:50:51  tipaul
 318 # really proud of this commit :-)
 319 # z3950 search and import seems to works fine.
 320 # Let me explain how :
 321 # * a "search z3950" button is added in the addbiblio template.
 322 # * when clicked, a popup appears and z3950/search.pl is called
 323 # * z3950/search.pl calls addz3950search in the DB
 324 # * the z3950 daemon retrieve the records and stores them in z3950results AND in marc_breeding table.
 325 # * as long as there as searches pending, the popup auto refresh every 2 seconds, and says how many searches are pending.
 326 # * when the user clicks on a z3950 result => the parent popup is called with the requested biblio, and auto-filled
 327 #
 328 # Note :
 329 # * character encoding support : (It's a nightmare...) In the z3950servers table, a "encoding" column has been added. You can put "UNIMARC" or "USMARC" in this column. Depending on this, the char_decode in C4::Biblio.pm replaces marc-char-encode by an iso 8859-1 encoding. Note that in the breeding import this value has been added too, for a better support.
 330 # * the marc_breeding and z3950* tables have been modified : they have an encoding column and the random z3950 number is stored too for convenience => it's the key I use to list only requested biblios in the popup.
 331 #
 332 # Revision 1.8  2003/04/29 08:09:45  tipaul
 333 # z3950 support is coming...
 334 # * adding a syntax column in z3950 table = this column will say wether the z3950 must be called with PerferedRecordsyntax => USMARC or PerferedRecordsyntax => UNIMARC. I tried some french UNIMARC z3950 servers, and some only send USMARC, some only UNIMARC, some can answer with both.
 335 # Note this is a 1st draft. More to follow (today ? I hope).
 336 #
 337 # Revision 1.7  2003/02/19 01:01:06  wolfpac444
 338 # Removed the unecessary $dbh argument from being passed.
 339 # Resolved a few minor FIXMEs.
 340 #
 341 # Revision 1.6  2002/10/13 08:30:53  arensb
 342 # Deleted unused variables.
 343 # Removed trailing whitespace.
 344 #
 345 # Revision 1.5  2002/10/13 06:13:23  arensb
 346 # Removed bogus #! line (this isn't a script!)
 347 # Removed unused global variables.
 348 # Added POD.
 349 # Added some explanatory comments.
 350 # Added some FIXME comments.
 351 #
 352 # Revision 1.4  2002/10/11 12:35:35  arensb
 353 # Replaced &requireDBI with C4::Context->dbh
 354 #
 355 # Revision 1.3  2002/08/14 18:12:52  tonnesen
 356 # Added copyright statement to all .pl and .pm files
 357 #
 358 # Revision 1.2  2002/07/02 20:31:33  tonnesen
 359 # module added from rel-1-2 branch
 360 #
 361 # Revision 1.1.2.5  2002/06/29 17:33:47  amillar
 362 # Allow DEFAULT as input to addz3950search.
 363 # Check for existence of pid file (cat crashed otherwise).
 364 # Return error messages in addz3950search.
 365 #
 366 # Revision 1.1.2.4  2002/06/28 18:07:27  tonnesen
 367 # marcimport.pl will print an error message if it can not signal the
 368 # processz3950queue program.  The message contains instructions for starting the
 369 # daemon.
 370 #
 371 # Revision 1.1.2.3  2002/06/28 17:45:39  tonnesen
 372 # z3950queue now listens for a -HUP signal before processing the queue.  Z3950.pm
 373 # sends the -HUP signal when queries are added to the queue.
 374 #
 375 # Revision 1.1.2.2  2002/06/26 20:54:31  tonnesen
 376 # use warnings breaks on perl 5.005...
 377 #
 378 # Revision 1.1.2.1  2002/06/26 07:26:41  amillar
 379 # New module for Z39.50 searching
 380 #