Patch from Mike Rylander to support load-from-file as an alternative to load-from...
[working/Evergreen.git] / Open-ILS / src / support-scripts / marc_stream_importer.pl
1 #!/usr/bin/perl
2 # Copyright (C) 2008-2010 Equinox Software, Inc.
3 # Author: Bill Erickson <erickson@esilibrary.com>
4 #
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14
15
16 use strict; use warnings;
17 use Net::Server::PreFork;
18 use base qw/Net::Server::PreFork/;
19 use MARC::Record;
20 use MARC::Batch;
21 use MARC::File::XML ( BinaryEncoding => 'UTF-8' );
22 use MARC::File::USMARC;
23
24 use Data::Dumper;
25 use File::Basename qw/fileparse/;
26 use File::Temp;
27 use Getopt::Long qw(:DEFAULT GetOptionsFromArray);
28 use Pod::Usage;
29 use Socket;
30
31 use OpenSRF::Utils::Logger qw/$logger/;
32 use OpenSRF::AppSession;
33 use OpenSRF::EX qw/:try/;
34 use OpenILS::Utils::Cronscript;
35 use OpenSRF::Transport::PeerHandle;
36 require 'oils_header.pl';
37 use vars qw/$apputils/;
38
39 my $vl_ses;
40
41 my $debug = 0;
42
43 my %defaults = (
44     'buffsize=i'    => 4096,
45     'merge-profile=i' => 0,
46     'source=i'      => 1,
47 #    'osrf-config=s' => '/openils/conf/opensrf_core.xml',
48     'user=s'        => 'admin',
49     'password=s'    => '',
50     'tempdir=s'     => '',
51     'spoolfile=s'   => '',
52     'nolockfile'    => 1,
53     'queue=i'       => 1,
54     'noqueue'       => 0,
55     'nodaemon'      => 0,
56     'wait=i'        => 5,
57     'import-by-queue' => 0
58 );
59
60 $OpenILS::Utils::Cronscript::debug=1 if $debug;
61 $Getopt::Long::debug=1 if $debug > 1;
62 my $o = OpenILS::Utils::Cronscript->new(\%defaults);
63
64 my @script_args = ();
65
66 if (grep {$_ eq '--'} @ARGV) {
67     print "Splitting options into groups\n" if $debug;
68     while (@ARGV) {
69         $_ = shift @ARGV;
70         $_ eq '--' and last;    # stop at the first --
71         push @script_args, $_;
72     }
73 } else {
74     @script_args = @ARGV;
75     @ARGV = ();
76 }
77
78 print "Calling MyGetOptions ",
79     (@script_args ? "with options: " . join(' ', @script_args) : 'without options from command line'),
80     "\n" if $debug;
81
82 my $real_opts = $o->MyGetOptions(\@script_args);
83 $o->bootstrap;
84 # GetOptionsFromArray(\@script_args, \%defaults, %defaults); # similar to
85
86 $real_opts->{tempdir} ||= tempdir_setting();    # This doesn't go in defaults because it reads config, must come after bootstrap
87
88 my $bufsize       = $real_opts->{buffsize};
89 my $bib_source    = $real_opts->{source};
90 my $osrf_config   = $real_opts->{'osrf-config'};
91 my $oils_username = $real_opts->{user};
92 my $oils_password = $real_opts->{password};
93 my $help          = $real_opts->{help};
94 my $merge_profile = $real_opts->{'merge-profile'};
95 my $queue_id      = $real_opts->{queue};
96 my $tempdir       = $real_opts->{tempdir};
97 my $import_by_queue  = $real_opts->{'import-by-queue'};
98    $debug        += $real_opts->{debug};
99
100 foreach (keys %$real_opts) {
101     print("real_opt->{$_} = ", $real_opts->{$_}, "\n") if $real_opts->{debug} or $debug;
102 }
103 my $wait_time     = $real_opts->{wait};
104 my $authtoken     = '';
105
106 # DEFAULTS for Net::Server
107 my $filename   = fileparse($0, '.pl');
108 my $conf_file  = (-r "$filename.conf") ? "$filename.conf" : undef;
109 # $conf_file is the Net::Server config for THIS script (not EG), if it exists and is readable
110
111
112 # FEEDBACK
113
114 pod2usage(1) if $help;
115 unless ($oils_password) {
116     print STDERR "\nERROR: password option required for session login\n\n";
117     # pod2usage(1);
118 }
119
120 print Dumper($o) if $debug;
121
122 if ($debug) {
123     foreach my $ref (qw/bufsize bib_source osrf_config oils_username oils_password help conf_file debug/) {
124         no strict 'refs';
125         printf "%16s => %s\n", $ref, (eval("\$$ref") || '');
126     }
127 }
128
129 print warning();
130 print Dumper($real_opts);
131
132 # SUBS
133
134 sub tempdir_setting {
135     my $ret = $apputils->simplereq( qw# opensrf.settings opensrf.settings.xpath.get
136         /opensrf/default/apps/open-ils.vandelay/app_settings/databases/importer # );
137     return $ret->[0] || '/tmp';
138 }
139
140 sub warning {
141     return <<WARNING;
142
143 WARNING:  This script provides no security layer.  Any client that has 
144 access to the server+port can inject MARC records into the system.  
145
146 WARNING
147 }
148
149 sub xml_import {
150     return $apputils->simplereq(
151         'open-ils.cat', 
152         'open-ils.cat.biblio.record.xml.import',
153         @_
154     );
155 }
156
157 sub old_process_batch_data {
158     my $data = shift or $logger->error("process_batch_data called without any data");
159     my $isfile = shift;
160     $data or return;
161
162     my $handle;
163     if ($isfile) {
164         $handle = $data;
165     } else {
166         open $handle, '<', \$data; 
167     }
168
169     my $batch = MARC::Batch->new('USMARC', $handle);
170     $batch->strict_off;
171
172     my $index = 0;
173     my $imported = 0;
174     my $failed = 0;
175
176     while (1) {
177         my $rec;
178         $index++;
179
180         eval { $rec = $batch->next; };
181
182         if ($@) {
183             $logger->error("Failed parsing MARC record $index");
184             $failed++;
185             next;
186         }
187         last unless $rec;   # The only way out
188
189         my $resp = xml_import($authtoken, $rec->as_xml_record, $bib_source);
190
191         # has the session timed out?
192         if (oils_event_equals($resp, 'NO_SESSION')) {
193             new_auth_token();
194             $resp = xml_import($authtoken, $rec->as_xml_record, $bib_source);   # try again w/ new token
195         }
196         oils_event_die($resp);
197         $imported++;
198     }
199
200     return ($imported, $failed);
201 }
202
203 sub process_spool { # filename
204
205     my $marcfile = shift;
206     my @rec_ids;
207
208     if($import_by_queue) {
209
210         # don't collect the record IDs, just spool the queue
211
212         $apputils->simplereq(
213             'open-ils.vandelay', 
214             'open-ils.vandelay.bib.process_spool', 
215             $authtoken, 
216             undef, 
217             $queue_id, 
218             'import', 
219             $marcfile,
220             $bib_source 
221         );
222
223     } else {
224
225         # collect the newly queued record IDs for processing
226
227         my $req = $vl_ses->request(
228             'open-ils.vandelay.bib.process_spool.stream_results',
229             $authtoken, 
230             undef, # cache key not needed
231             $queue_id, 
232             'import', 
233             $marcfile, 
234             $bib_source 
235         );
236     
237         while(my $resp = $req->recv) {
238
239             if($req->failed) {
240                 $logger->error("Error spooling MARC data: $resp");
241
242             } elsif($resp->content) {
243                 push(@rec_ids, $resp->content);
244             }
245         }
246     }
247
248     return \@rec_ids;
249 }
250
251 sub bib_queue_import {
252     my $rec_ids = shift;
253     my $extra = {auto_overlay_exact => 1};
254     $extra->{merge_profile} = $merge_profile if $merge_profile;
255
256     my $req;
257     my @cleanup_recs;
258
259     if($import_by_queue) {
260         # import by queue
261
262         $req = $vl_ses->request(
263             'open-ils.vandelay.bib_queue.import', 
264             $authtoken, 
265             $queue_id, 
266             $extra 
267         );
268
269     } else {
270         # import explicit record IDs
271
272         $req = $vl_ses->request(
273             'open-ils.vandelay.bib_record.list.import', 
274             $authtoken, 
275             $rec_ids, 
276             $extra 
277         );
278     }
279
280     # collect the successfully imported vandelay records
281     my $failed = 0;
282     while(my $resp = $req->recv) {
283          if($req->failed) {
284             $logger->error("Error importing MARC data: $resp");
285
286         } elsif(my $data = $resp->content) {
287
288             if($data->{err_event}) {
289
290                 $logger->error(Dumper($data->{err_event}));
291                 $failed++;
292
293             } else {
294                 push(@cleanup_recs, $data->{imported}) if $data->{imported};
295             }
296         }
297     }
298
299     # clean up the successfully imported vandelay records to prevent queue bloat
300     my $pcrud = OpenSRF::AppSession->create('open-ils.pcrud');
301     $pcrud->connect;
302     $pcrud->request('open-ils.pcrud.transaction.begin', $authtoken)->recv;
303     my $err;
304
305     foreach (@cleanup_recs) {
306
307         try { 
308
309             $pcrud->request('open-ils.pcrud.delete.vqbr', $authtoken, $_)->recv;
310
311         } catch Error with {
312             $err = shift;
313             $logger->error("Error deleteing queued bib record $_: $err");
314         };
315     }
316
317     $pcrud->request('open-ils.pcrud.transaction.commit', $authtoken)->recv unless $err;
318     $pcrud->disconnect;
319
320     $logger->info("imported queued vandelay records: @cleanup_recs");
321     return (scalar(@cleanup_recs), $failed);
322 }
323
324 sub process_batch_data {
325     my $data = shift or $logger->error("process_batch_data called without any data");
326     my $isfile = shift;
327     $data or return;
328
329     $vl_ses = OpenSRF::AppSession->create('open-ils.vandelay');
330
331     my ($handle, $tempfile);
332     if (!$isfile) {
333         ($handle, $tempfile) = File::Temp->tempfile("$0_XXXX", DIR => $tempdir) or die "Cannot write tempfile in $tempdir";
334         print $handle $data;
335         close $handle;
336     } else {
337         $tempfile = $data;
338     }
339        
340     $logger->info("Calling process_spool on tempfile $tempfile (queue: $queue_id; source: $bib_source)");
341     my $rec_ids = process_spool($tempfile);
342
343     if (oils_event_equals($rec_ids, 'NO_SESSION')) {  # has the session timed out?
344         new_auth_token();
345         $rec_ids = process_spool($tempfile);                # try again w/ new token
346     }
347
348     my ($imported, $failed) = bib_queue_import($rec_ids);
349
350     if (oils_event_equals($imported, 'NO_SESSION')) {  # has the session timed out?
351         new_auth_token();
352         ($imported, $failed) = bib_queue_import();                # try again w/ new token
353     }
354
355     oils_event_die($imported);
356
357     return ($imported, $failed);
358 }
359
360 sub process_request {   # The core Net::Server method
361     my $self = shift;
362     my $client = $self->{server}->{client};
363
364     my $sockname = getpeername($client);
365     my ($port, $ip_addr) = unpack_sockaddr_in($sockname);
366     $logger->info("stream parser received contact from ".inet_ntoa($ip_addr));
367
368     my $ph = OpenSRF::Transport::PeerHandle->retrieve;
369     if(!$ph->flush_socket()) {
370         $logger->error("We received a request, bu we are no longer connected to opensrf.  ".
371             "Exiting and dropping request from $client");
372         exit;
373     }
374
375     my $data = '';
376     eval {
377         local $SIG{ALRM} = sub { die "alarm\n" };
378         alarm $wait_time; # prevent accidental tie ups of backend processes
379         local $/ = "\x1D"; # MARC record separator
380         while (my $newline = <STDIN>) {
381             $data .= $newline;
382             alarm $wait_time; # prevent accidental tie ups of backend processes
383         }
384         alarm 0;
385     };
386
387     if($@) {
388         $logger->error("reading from STDIN failed or timed out: $@");
389         return;
390     } 
391
392     $logger->info("stream parser read " . length($data) . " bytes");
393
394     my ($imported, $failed) = (0, 0);
395
396     new_auth_token(); # login
397
398     if ($real_opts->{noqueue}) {
399         ($imported, $failed) = old_process_batch_data($data);
400     } else {
401         ($imported, $failed) = process_batch_data($data);
402     }
403
404     my $profile = (!$merge_profile) ? '' :
405         $apputils->simplereq(
406             'open-ils.pcrud', 
407             'open-ils.pcrud.retrieve.vmp', 
408             $authtoken, 
409             $merge_profile)->name;
410
411     my $msg = '';
412     $msg .= "Successfully imported $imported records using merge profile '$profile'\n" if $imported;
413     $msg .= "Failed to import $failed records\n" if $failed;
414     $msg .= "\x00";
415     print $client $msg;
416
417     clear_auth_token(); # logout
418 }
419
420 sub standalone_process_request {   # The command line version
421     my $file = shift;
422     
423     $logger->info("stream parser received file processing request for $file");
424
425     my $ph = OpenSRF::Transport::PeerHandle->retrieve;
426     if(!$ph->flush_socket()) {
427         $logger->error("We received a request, bu we are no longer connected to opensrf.  ".
428             "Exiting and dropping request for $file");
429         exit;
430     }
431
432     my ($imported, $failed) = (0, 0);
433
434     new_auth_token(); # login
435
436     if ($real_opts->{noqueue}) {
437         ($imported, $failed) = old_process_batch_data($file, 1);
438     } else {
439         ($imported, $failed) = process_batch_data($file, 1);
440     }
441
442     my $profile = (!$merge_profile) ? '' :
443         $apputils->simplereq(
444             'open-ils.pcrud', 
445             'open-ils.pcrud.retrieve.vmp', 
446             $authtoken, 
447             $merge_profile)->name;
448
449     my $msg = '';
450     $msg .= "Successfully imported $imported records using merge profile '$profile'\n" if $imported;
451     $msg .= "Failed to import $failed records\n" if $failed;
452     $msg .= "\x00";
453     print $msg;
454
455     clear_auth_token(); # logout
456 }
457
458
459 # the authtoken will timeout after the configured inactivity period.
460 # When that happens, get a new one.
461 sub new_auth_token {
462     $authtoken = oils_login($oils_username, $oils_password, 'staff') 
463         or die "Unable to login to Evergreen as user $oils_username";
464     return $authtoken;
465 }
466
467 sub clear_auth_token {
468     $apputils->simplereq(
469         'open-ils.auth',
470         'open-ils.auth.session.delete',
471         $authtoken
472     );
473 }
474
475 ##### MAIN ######
476
477 osrf_connect($osrf_config);
478 if ($real_opts->{nodaemon}) {
479     if (!$real_opts->{spoolfile}) {
480         print " --nodaemon mode requested, but no --spoolfile supplied!\n";
481         exit;
482     }
483     standalone_process_request($real_opts->{spoolfile});
484 } else {
485     print "Calling Net::Server run ", (@ARGV ? "with command-line options: " . join(' ', @ARGV) : ''), "\n";
486     __PACKAGE__->run(conf_file => $conf_file);
487 }
488
489 __END__
490
491 =head1 NAME
492
493 marc_stream_importer.pl - Import MARC records via bare socket connection.
494
495 =head1 SYNOPSIS
496
497 ./marc_stream_importer.pl [common opts ...] [script opts ...] -- [Net::Server opts ...] &
498
499 This script uses the EG common options from B<Cronscript>.  See --help output for those.
500
501 Run C<perldoc marc_stream_importer.pl> for full documentation.
502
503 Note the extra C<--> to separate options for the script wrapper from options for the
504 underlying L<Net::Server> options.  
505
506 Note: this script has to be run in the same directory as B<oils_header.pl>.
507
508 Typical server-style execution will include a trailing C<&> to run in the background.
509
510 =head1 DESCRIPTION
511
512 This script is a L<Net::Server::PreFork> instance for shoving records into Evergreen from a remote system.
513
514 =head1 OPTIONS
515
516 The only required option is --password
517
518  --password         =<eg_password>
519  --user             =<eg_username>  default: admin
520  --source           =<bib_source>   default: 1         Integer
521  --merge-profile    =<i>            default: 0
522  --tempdir          =</temp/dir/>   default: from L<opensrf.conf> <open-ils.vandelay/app_settings/databases/importer>
523  --source           =<i>            default: 1
524  --import-by-queue  =<i>            default: 0
525  --spoolfile        =<import_file>  default: NONE      File to import in --nodaemon mode
526  --nodaemon                         default: OFF       When used with --spoolfile, turns off Net::Server mode and runs this utility in the foreground
527
528
529 =head2 Old style: --noqueue and associated options
530
531 To bypass vandelay queue processing and push directly into the database (as the old style)
532
533  --noqueue         default: OFF
534  --buffsize =<i>   default: 4096    Buffer size.  Only used by --noqueue
535  --wait     =<i>   default: 5       Seconds to read socket before processing.  Only used by --noqueue
536
537 =head2 Net::Server Options
538
539 By default, the script will use the Net::Server configuration file B<marc_stream_importer.conf>.  You can 
540 override this by passing a filepath with the --conf_file option.
541
542 Other Net::Server options include: --port=<port> --min_servers=<X> --max_servers=<Y> and --log_file=[path/to/file]
543
544 See L<Net::Server> for a complete list.
545
546 =head2 Configuration
547
548 =head3 OCLC Connexion
549
550 To use this script with OCLC Connexion, configure the client as follows:
551
552 Under Tools -> Options -> Export (tab)
553    Create -> Choose Connection -> OK -> Leave translation at "None" 
554        -> Create -> Create -> choose TCP/IP (internet) 
555        -> Enter hostname and Port, leave 'Use Telnet Protocol' checked 
556        -> Create/OK your way out of the dialogs
557    Record Characteristics (button) -> Choose 'UTF-8 Unicode' for the Character Set
558    
559
560 OCLC and Connexion are trademark/service marks of OCLC Online Computer Library Center, Inc.
561
562 =head1 CAVEATS
563
564 WARNING: This script provides no inherent security layer.  Any client that has 
565 access to the server+port can inject MARC records into the system.  
566 Use the available options (like allow/deny) in the Net::Server config file 
567 or via the command line to restrict access as necessary.
568
569 =head1 EXAMPLES
570
571 ./marc_stream_importer.pl  \
572     admin open-ils connexion --port 5555 --min_servers 2 \
573     --max_servers=20 --log_file=/openils/var/log/marc_net_importer.log &
574
575 ./marc_stream_importer.pl  \
576     admin open-ils connexion --port 5555 --min_servers 2 \
577     --max_servers=20 --log_file=/openils/var/log/marc_net_importer.log &
578
579 =head1 SEE ALSO
580
581 L<Net::Server::PreFork>, L<marc_stream_importer.conf>
582
583 =head1 AUTHORS
584
585     Bill Erickson <erickson@esilibrary.com>
586     Joe Atzberger <jatzberger@esilibrary.com>
587     Mike Rylander <miker@esilibrary.com> (nodaemon+spoolfile mode)
588
589 =cut