4134e8389832df31f9113bc7cda7c04bdf25ab61
[Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Vandelay.pm
1 package OpenILS::Application::Vandelay;
2 use strict; use warnings;
3 use OpenILS::Application;
4 use base qw/OpenILS::Application/;
5 use Unicode::Normalize;
6 use OpenSRF::EX qw/:try/;
7 use OpenSRF::AppSession;
8 use OpenSRF::Utils::SettingsClient;
9 use OpenSRF::Utils::Cache;
10 use OpenILS::Utils::Fieldmapper;
11 use OpenILS::Utils::CStoreEditor qw/:funcs/;
12 use MARC::Batch;
13 use MARC::Record;
14 use MARC::File::XML ( BinaryEncoding => 'UTF-8' );
15 use OpenILS::Utils::Fieldmapper;
16 use Time::HiRes qw(time);
17 use OpenSRF::Utils::Logger qw/$logger/;
18 use MIME::Base64;
19 use OpenILS::Const qw/:const/;
20 use OpenILS::Application::AppUtils;
21 use OpenILS::Application::Cat::BibCommon;
22 use OpenILS::Application::Cat::AuthCommon;
23 use OpenILS::Application::Cat::AssetCommon;
24 my $U = 'OpenILS::Application::AppUtils';
25
26 # A list of LDR/06 values from http://loc.gov/marc
27 my %record_types = (
28         a => 'bib',
29         c => 'bib',
30         d => 'bib',
31         e => 'bib',
32         f => 'bib',
33         g => 'bib',
34         i => 'bib',
35         j => 'bib',
36         k => 'bib',
37         m => 'bib',
38         o => 'bib',
39         p => 'bib',
40         r => 'bib',
41         t => 'bib',
42         u => 'holdings',
43         v => 'holdings',
44         x => 'holdings',
45         y => 'holdings',
46         z => 'auth',
47       ' ' => 'bib',
48 );
49
50 sub initialize {}
51 sub child_init {}
52
53 # --------------------------------------------------------------------------------
54 # Biblio ingest
55
56 sub create_bib_queue {
57     my $self = shift;
58     my $client = shift;
59     my $auth = shift;
60     my $name = shift;
61     my $owner = shift;
62     my $type = shift;
63     my $match_set = shift;
64     my $import_def = shift;
65
66     my $e = new_editor(authtoken => $auth, xact => 1);
67
68     return $e->die_event unless $e->checkauth;
69     return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
70     $owner ||= $e->requestor->id;
71
72     if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
73         $e->rollback;
74         return OpenILS::Event->new('BIB_QUEUE_EXISTS') 
75     }
76
77     my $queue = new Fieldmapper::vandelay::bib_queue();
78     $queue->name( $name );
79     $queue->owner( $owner );
80     $queue->queue_type( $type ) if ($type);
81     $queue->item_attr_def( $import_def ) if ($import_def);
82     $queue->match_set($match_set) if $match_set;
83
84     my $new_q = $e->create_vandelay_bib_queue( $queue );
85     return $e->die_event unless ($new_q);
86     $e->commit;
87
88     return $new_q;
89 }
90 __PACKAGE__->register_method(  
91     api_name   => "open-ils.vandelay.bib_queue.create",
92     method     => "create_bib_queue",
93     api_level  => 1,
94     argc       => 4,
95 );                      
96
97
98 sub create_auth_queue {
99     my $self = shift;
100     my $client = shift;
101     my $auth = shift;
102     my $name = shift;
103     my $owner = shift;
104     my $type = shift;
105     my $match_set = shift;
106
107     my $e = new_editor(authtoken => $auth, xact => 1);
108
109     return $e->die_event unless $e->checkauth;
110     return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
111     $owner ||= $e->requestor->id;
112
113     if ($e->search_vandelay_bib_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
114         $e->rollback;
115         return OpenILS::Event->new('AUTH_QUEUE_EXISTS') 
116     }
117
118     my $queue = new Fieldmapper::vandelay::authority_queue();
119     $queue->name( $name );
120     $queue->owner( $owner );
121     $queue->queue_type( $type ) if ($type);
122
123     my $new_q = $e->create_vandelay_authority_queue( $queue );
124     $e->die_event unless ($new_q);
125     $e->commit;
126
127     return $new_q;
128 }
129 __PACKAGE__->register_method(  
130     api_name   => "open-ils.vandelay.authority_queue.create",
131     method     => "create_auth_queue",
132     api_level  => 1,
133     argc       => 3,
134 );                      
135
136 sub add_record_to_bib_queue {
137     my $self = shift;
138     my $client = shift;
139     my $auth = shift;
140     my $queue = shift;
141     my $marc = shift;
142     my $purpose = shift;
143     my $bib_source = shift;
144
145     my $e = new_editor(authtoken => $auth, xact => 1);
146
147     $queue = $e->retrieve_vandelay_bib_queue($queue);
148
149     return $e->die_event unless $e->checkauth;
150     return $e->die_event unless
151         ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
152          $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
153
154     my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
155
156     return $e->die_event unless ($new_rec);
157     $e->commit;
158     return $new_rec;
159 }
160 __PACKAGE__->register_method(  
161     api_name   => "open-ils.vandelay.queued_bib_record.create",
162     method     => "add_record_to_bib_queue",
163     api_level  => 1,
164     argc       => 3,
165 );                      
166
167 sub _add_bib_rec {
168     my $e = shift;
169     my $marc = shift;
170     my $queue = shift;
171     my $purpose = shift;
172     my $bib_source = shift;
173
174     my $rec = new Fieldmapper::vandelay::queued_bib_record();
175     $rec->marc( $marc );
176     $rec->queue( $queue );
177     $rec->purpose( $purpose ) if ($purpose);
178     $rec->bib_source($bib_source);
179
180     return $e->create_vandelay_queued_bib_record( $rec );
181 }
182
183 sub add_record_to_authority_queue {
184     my $self = shift;
185     my $client = shift;
186     my $auth = shift;
187     my $queue = shift;
188     my $marc = shift;
189     my $purpose = shift;
190
191     my $e = new_editor(authtoken => $auth, xact => 1);
192
193     $queue = $e->retrieve_vandelay_authority_queue($queue);
194
195     return $e->die_event unless $e->checkauth;
196     return $e->die_event unless
197         ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
198          $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
199
200     my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
201
202     return $e->die_event unless ($new_rec);
203     $e->commit;
204     return $new_rec;
205 }
206 __PACKAGE__->register_method(
207     api_name   => "open-ils.vandelay.queued_authority_record.create",
208     method     => "add_record_to_authority_queue",
209     api_level  => 1,
210     argc       => 3,
211 );
212
213 sub _add_auth_rec {
214     my $e = shift;
215     my $marc = shift;
216     my $queue = shift;
217     my $purpose = shift;
218
219     my $rec = new Fieldmapper::vandelay::queued_authority_record();
220     $rec->marc( $marc );
221     $rec->queue( $queue );
222     $rec->purpose( $purpose ) if ($purpose);
223
224     return $e->create_vandelay_queued_authority_record( $rec );
225 }
226
227 sub process_spool {
228     my $self = shift;
229     my $client = shift;
230     my $auth = shift;
231     my $fingerprint = shift || '';
232     my $queue_id = shift;
233     my $purpose = shift;
234     my $filename = shift;
235     my $bib_source = shift;
236
237     my $e = new_editor(authtoken => $auth, xact => 1);
238     return $e->die_event unless $e->checkauth;
239
240     my $queue;
241     my $type = $self->{record_type};
242
243     if($type eq 'bib') {
244         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
245     } else {
246         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
247     }
248
249     my $evt = check_queue_perms($e, $type, $queue);
250     return $evt if ($evt);
251
252     my $cache = new OpenSRF::Utils::Cache();
253
254     if($fingerprint) {
255         my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
256         $purpose = $data->{purpose};
257         $filename = $data->{path};
258         $bib_source = $data->{bib_source};
259     }
260
261     unless(-r $filename) {
262         $logger->error("unable to read MARC file $filename");
263         return -1; # make this an event XXX
264     }
265
266     $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
267
268     my $marctype = 'USMARC'; 
269
270     open F, $filename;
271     $marctype = 'XML' if (getc(F) =~ /^\D/o);
272     close F;
273
274     my $batch = new MARC::Batch ($marctype, $filename);
275     $batch->strict_off;
276
277     my $response_scale = 10;
278     my $count = 0;
279     my $r = -1;
280     while (try { $r = $batch->next } otherwise { $r = -1 }) {
281         if ($r == -1) {
282             $logger->warn("Processing of record $count in set $filename failed.  Skipping this record");
283             $count++;
284         }
285
286         $logger->info("processing record $count");
287
288         try {
289             (my $xml = $r->as_xml_record()) =~ s/\n//sog;
290             $xml =~ s/^<\?xml.+\?\s*>//go;
291             $xml =~ s/>\s+</></go;
292             $xml =~ s/\p{Cc}//go;
293             $xml = $U->entityize($xml);
294             $xml =~ s/[\x00-\x1f]//go;
295
296             my $qrec;
297             # Check the leader to ensure we've got something resembling the expected
298             # Allow spaces to give records the benefit of the doubt
299             my $ldr_type = substr($r->leader(), 6, 1);
300             if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
301                 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
302             } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
303                 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
304             } else {
305                 # I don't know how to handle this type; rock on
306                 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
307                 next;
308             }
309
310             if($self->api_name =~ /stream_results/ and $qrec) {
311                 $client->respond($qrec->id)
312             } else {
313                 $client->respond($count) if (++$count % $response_scale) == 0;
314                 $response_scale *= 10 if ($count == ($response_scale * 10));
315             }
316         } catch Error with {
317             my $error = shift;
318             $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
319         }
320     }
321
322     $e->commit;
323     unlink($filename);
324     $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
325     return $count;
326 }
327
328 __PACKAGE__->register_method(  
329     api_name    => "open-ils.vandelay.bib.process_spool",
330     method      => "process_spool",
331     api_level   => 1,
332     argc        => 3,
333     max_chunk_size => 0,
334     record_type => 'bib'
335 );                      
336 __PACKAGE__->register_method(  
337     api_name    => "open-ils.vandelay.auth.process_spool",
338     method      => "process_spool",
339     api_level   => 1,
340     argc        => 3,
341     max_chunk_size => 0,
342     record_type => 'auth'
343 );                      
344
345 __PACKAGE__->register_method(  
346     api_name    => "open-ils.vandelay.bib.process_spool.stream_results",
347     method      => "process_spool",
348     api_level   => 1,
349     argc        => 3,
350     stream      => 1,
351     max_chunk_size => 0,
352     record_type => 'bib'
353 );                      
354 __PACKAGE__->register_method(  
355     api_name    => "open-ils.vandelay.auth.process_spool.stream_results",
356     method      => "process_spool",
357     api_level   => 1,
358     argc        => 3,
359     stream      => 1,
360     max_chunk_size => 0,
361     record_type => 'auth'
362 );
363
364 __PACKAGE__->register_method(  
365     api_name    => "open-ils.vandelay.bib_queue.records.retrieve",
366     method      => 'retrieve_queued_records',
367     api_level   => 1,
368     argc        => 2,
369     stream      => 1,
370     record_type => 'bib'
371 );
372 __PACKAGE__->register_method(
373     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.export.print",
374     method      => 'retrieve_queued_records',
375     api_level   => 1,
376     argc        => 2,
377     stream      => 1,
378     record_type => 'bib'
379 );
380 __PACKAGE__->register_method(
381     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.export.csv",
382     method      => 'retrieve_queued_records',
383     api_level   => 1,
384     argc        => 2,
385     stream      => 1,
386     record_type => 'bib'
387 );
388 __PACKAGE__->register_method(
389     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.export.email",
390     method      => 'retrieve_queued_records',
391     api_level   => 1,
392     argc        => 2,
393     stream      => 1,
394     record_type => 'bib'
395 );
396
397 __PACKAGE__->register_method(  
398     api_name    => "open-ils.vandelay.auth_queue.records.retrieve",
399     method      => 'retrieve_queued_records',
400     api_level   => 1,
401     argc        => 2,
402     stream      => 1,
403     record_type => 'auth'
404 );
405 __PACKAGE__->register_method(
406     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.export.print",
407     method      => 'retrieve_queued_records',
408     api_level   => 1,
409     argc        => 2,
410     stream      => 1,
411     record_type => 'auth'
412 );
413 __PACKAGE__->register_method(
414     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.export.csv",
415     method      => 'retrieve_queued_records',
416     api_level   => 1,
417     argc        => 2,
418     stream      => 1,
419     record_type => 'auth'
420 );
421 __PACKAGE__->register_method(
422     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.export.email",
423     method      => 'retrieve_queued_records',
424     api_level   => 1,
425     argc        => 2,
426     stream      => 1,
427     record_type => 'auth'
428 );
429
430 __PACKAGE__->register_method(  
431     api_name    => "open-ils.vandelay.bib_queue.records.matches.retrieve",
432     method      => 'retrieve_queued_records',
433     api_level   => 1,
434     argc        => 2,
435     stream      => 1,
436     record_type => 'bib',
437     signature   => {
438         desc => q/Only retrieve queued bib records that have matches against existing records/
439     }
440 );
441 __PACKAGE__->register_method(  
442     api_name    => "open-ils.vandelay.auth_queue.records.matches.retrieve",
443     method      => 'retrieve_queued_records',
444     api_level   => 1,
445     argc        => 2,
446     stream      => 1,
447     record_type => 'auth',
448     signature   => {
449         desc => q/Only retrieve queued authority records that have matches against existing records/
450     }
451 );
452
453 sub retrieve_queued_records {
454     my($self, $conn, $auth, $queue_id, $options) = @_;
455
456     $options ||= {};
457     my $limit = $$options{limit} || 20;
458     my $offset = $$options{offset} || 0;
459     my $type = $self->{record_type};
460
461     my $e = new_editor(authtoken => $auth, xact => 1);
462     return $e->die_event unless $e->checkauth;
463
464     my $queue;
465     if($type eq 'bib') {
466         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
467     } else {
468         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
469     }
470     my $evt = check_queue_perms($e, $type, $queue);
471     return $evt if ($evt);
472
473     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
474     my $query = {
475         select => {$class => ['id']},
476         from => $class,
477         where => {queue => $queue_id},
478         distinct => 1,
479         order_by => {$class => ['id']}, 
480         limit => $limit,
481         offset => $offset,
482     };
483     if($self->api_name =~ /export/) {
484         delete $query->{limit};
485         delete $query->{offset};
486     }
487
488     $query->{where}->{import_time} = undef if $$options{non_imported};
489
490     if($$options{with_import_error}) {
491
492         $query->{from} = {$class => {vii => {type => 'right'}}};
493         $query->{where}->{'-or'} = [
494             {'+vqbr' => {import_error => {'!=' => undef}}},
495             {'+vii' => {import_error => {'!=' => undef}}}
496         ];
497
498     } else {
499         
500         if($$options{with_rec_import_error}) {
501             $query->{where}->{import_error} = {'!=' => undef};
502
503         } elsif( $$options{with_item_import_error} and $type eq 'bib') {
504
505             $query->{from} = {$class => 'vii'};
506             $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
507         }
508     }
509
510     if($self->api_name =~ /matches/) {
511         # find only records that have matches
512         my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
513         $query->{from} = {$class => {$mclass => {type => 'right'}}};
514     } 
515
516     my $record_ids = $e->json_query($query);
517
518     my $retrieve = ($type eq 'bib') ? 
519         'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
520
521     if ($self->api_name =~ /export/) {
522         if ($self->api_name =~ /print/) {
523
524             $e->rollback;
525             return $U->fire_object_event(
526                 undef,
527                 'vandelay.queued_'.$type.'_record.print',
528                 [map {$_->{id}} @$record_ids],
529                 $e->requestor->ws_ou
530             );
531
532         } elsif ($self->api_name =~ /csv/) {
533
534             $e->rollback;
535             return $U->fire_object_event(
536                 undef,
537                 'vandelay.queued_'.$type.'_record.csv',
538                 [map {$_->{id}} @$record_ids],
539                 $e->requestor->ws_ou
540             );
541
542         } elsif ($self->api_name =~ /email/) {
543
544             $conn->respond_complete(1);
545
546             for my $rec_id (@$record_ids) {
547                 $U->create_events_for_hook(
548                     'vandelay.queued_'.$type.'_record.email',
549                     $rec_id->{id},
550                     $e->requestor->home_ou,
551                     undef,
552                     undef,
553                     1
554                 );
555             }
556
557         }
558     } else {
559         for my $rec_id (@$record_ids) {
560             my $flesh = ['attributes', 'matches'];
561             push(@$flesh, 'import_items') if $$options{flesh_import_items};
562             my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
563             my $rec = $e->$retrieve([$rec_id->{id}, $params]);
564             $rec->clear_marc if $$options{clear_marc};
565             $conn->respond($rec);
566         }
567     }
568
569     $e->rollback;
570     return undef;
571 }
572
573 __PACKAGE__->register_method(  
574     api_name    => 'open-ils.vandelay.import_item.queue.retrieve',
575     method      => 'retrieve_queue_import_items',
576     api_level   => 1,
577     argc        => 2,
578     stream      => 1,
579     authoritative => 1,
580     signature => q/
581         Returns Import Item (vii) objects for the selected queue.
582         Filter options:
583             with_import_error : only return items that failed to import
584     /
585 );
586 __PACKAGE__->register_method(
587     api_name    => 'open-ils.vandelay.import_item.queue.export.print',
588     method      => 'retrieve_queue_import_items',
589     api_level   => 1,
590     argc        => 2,
591     stream      => 1,
592     authoritative => 1,
593     signature => q/
594         Returns template-generated printable output of Import Item (vii) objects for the selected queue.
595         Filter options:
596             with_import_error : only return items that failed to import
597     /
598 );
599 __PACKAGE__->register_method(
600     api_name    => 'open-ils.vandelay.import_item.queue.export.csv',
601     method      => 'retrieve_queue_import_items',
602     api_level   => 1,
603     argc        => 2,
604     stream      => 1,
605     authoritative => 1,
606     signature => q/
607         Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
608         Filter options:
609             with_import_error : only return items that failed to import
610     /
611 );
612 __PACKAGE__->register_method(
613     api_name    => 'open-ils.vandelay.import_item.queue.export.email',
614     method      => 'retrieve_queue_import_items',
615     api_level   => 1,
616     argc        => 2,
617     stream      => 1,
618     authoritative => 1,
619     signature => q/
620         Emails template-generated output of Import Item (vii) objects for the selected queue.
621         Filter options:
622             with_import_error : only return items that failed to import
623     /
624 );
625
626 sub retrieve_queue_import_items {
627     my($self, $conn, $auth, $q_id, $options) = @_;
628
629     $options ||= {};
630     my $limit = $$options{limit} || 20;
631     my $offset = $$options{offset} || 0;
632
633     my $e = new_editor(authtoken => $auth);
634     return $e->event unless $e->checkauth;
635
636     my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
637     my $evt = check_queue_perms($e, 'bib', $queue);
638     return $evt if $evt;
639
640     my $query = {
641         select => {vii => ['id']},
642         from => {
643             vii => {
644                 vqbr => {
645                     join => {
646                         'vbq' => {
647                             field => 'id',
648                             fkey => 'queue',
649                             filter => {id => $q_id}
650                         }
651                     }
652                 }
653             }
654         },
655         order_by => {'vii' => ['record','id']},
656         limit => $limit,
657         offset => $offset
658     };
659     if($self->api_name =~ /export/) {
660         delete $query->{limit};
661         delete $query->{offset};
662     }
663
664     $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
665         if $$options{with_import_error};
666
667     my $items = $e->json_query($query);
668     if ($self->api_name =~ /export/) {
669         if ($self->api_name =~ /print/) {
670
671             return $U->fire_object_event(
672                 undef,
673                 'vandelay.import_items.print',
674                 [map {$_->{id}} @$items],
675                 $e->requestor->ws_ou
676             );
677
678         } elsif ($self->api_name =~ /csv/) {
679
680             return $U->fire_object_event(
681                 undef,
682                 'vandelay.import_items.csv',
683                 [map {$_->{id}} @$items],
684                 $e->requestor->ws_ou
685             );
686
687         } elsif ($self->api_name =~ /email/) {
688
689             $conn->respond_complete(1);
690
691             for my $item (@$items) {
692                 $U->create_events_for_hook(
693                     'vandelay.import_items.email',
694                     $item->{id},
695                     $e->requestor->home_ou,
696                     undef,
697                     undef,
698                     1
699                 );
700             }
701
702         }
703     } else {
704         for my $item (@$items) {
705             $conn->respond($e->retrieve_vandelay_import_item($item->{id}));
706         }
707     }
708
709     return undef;
710 }
711
712 sub check_queue_perms {
713     my($e, $type, $queue) = @_;
714     if ($type eq 'bib') {
715         return $e->die_event unless
716             ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
717              $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
718     } else {
719         return $e->die_event unless
720             ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
721              $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
722     }
723
724     return undef;
725 }
726
727 __PACKAGE__->register_method(  
728     api_name    => "open-ils.vandelay.bib_record.list.import",
729     method      => 'import_record_list',
730     api_level   => 1,
731     argc        => 2,
732     stream      => 1,
733     record_type => 'bib'
734 );
735
736 __PACKAGE__->register_method(  
737     api_name    => "open-ils.vandelay.auth_record.list.import",
738     method      => 'import_record_list',
739     api_level   => 1,
740     argc        => 2,
741     stream      => 1,
742     record_type => 'auth'
743 );
744
745 sub import_record_list {
746     my($self, $conn, $auth, $rec_ids, $args) = @_;
747     my $e = new_editor(authtoken => $auth, xact => 1);
748     return $e->die_event unless $e->checkauth;
749     $args ||= {};
750     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
751     try {$e->rollback} otherwise {}; 
752     return $err if $err;
753     return {complete => 1};
754 }
755
756
757 __PACKAGE__->register_method(  
758     api_name    => "open-ils.vandelay.bib_queue.import",
759     method      => 'import_queue',
760     api_level   => 1,
761     argc        => 2,
762     stream      => 1,
763     max_chunk_size => 0,
764     record_type => 'bib'
765 );
766
767 __PACKAGE__->register_method(  
768     api_name    => "open-ils.vandelay.auth_queue.import",
769     method      => 'import_queue',
770     api_level   => 1,
771     argc        => 2,
772     stream      => 1,
773     max_chunk_size => 0,
774     record_type => 'auth'
775 );
776 __PACKAGE__->register_method(  
777     api_name    => "open-ils.vandelay.bib_queue.nomatch.import",
778     method      => 'import_queue',
779     api_level   => 1,
780     argc        => 2,
781     stream      => 1,
782     signature   => {
783         desc => q/Only import records that have no collisions/
784     },
785     max_chunk_size => 0,
786     record_type => 'bib'
787 );
788
789 __PACKAGE__->register_method(  
790     api_name    => "open-ils.vandelay.auth_queue.nomatch.import",
791     method      => 'import_queue',
792     api_level   => 1,
793     argc        => 2,
794     stream      => 1,
795     signature   => {
796         desc => q/Only import records that have no collisions/
797     },
798     max_chunk_size => 0,
799     record_type => 'auth'
800 );
801 sub import_queue {
802     my($self, $conn, $auth, $q_id, $options) = @_;
803     my $e = new_editor(authtoken => $auth, xact => 1);
804     return $e->die_event unless $e->checkauth;
805     $options ||= {};
806     my $type = $self->{record_type};
807     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
808
809     my $query = {queue => $q_id, import_time => undef};
810
811     if($self->api_name =~ /nomatch/) {
812         my $matched_recs = queued_records_with_matches($e, $type, $q_id, undef, undef, {import_time => undef});
813         $query->{id} = {'not in' => $matched_recs} if @$matched_recs;
814     }
815
816     my $search = ($type eq 'bib') ? 
817         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
818     my $rec_ids = $e->$search($query, {idlist => 1});
819     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
820     try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
821     return $err if $err;
822     return {complete => 1};
823 }
824
825 # returns a list of queued record IDs for a given queue that 
826 # have at least one entry in the match table
827 sub queued_records_with_matches {
828     my($e, $type, $q_id, $limit, $offset, $filter) = @_;
829
830     my $match_class = 'vbm';
831     my $rec_class = 'vqbr';
832     if($type eq 'auth') {
833         $match_class = 'vam';
834          $rec_class = 'vqar';
835     }
836
837     $filter ||= {};
838     $filter->{queue} = $q_id;
839
840     my $query = {
841         distinct => 1, 
842         select => {$match_class => ['queued_record']}, 
843         from => {
844             $match_class => {
845                 $rec_class => {
846                     field => 'id',
847                     fkey => 'queued_record',
848                     filter => $filter,
849                 }
850             }
851         }
852     };        
853
854     if($limit or defined $offset) {
855         $limit ||= 20;
856         $offset ||= 0;
857         $query->{limit} = $limit;
858         $query->{offset} = $offset;
859     }
860
861     my $data = $e->json_query($query);
862     return [ map {$_->{queued_record}} @$data ];
863 }
864
865
866 sub import_record_list_impl {
867     my($self, $conn, $rec_ids, $requestor, $args) = @_;
868
869     my $overlay_map = $args->{overlay_map} || {};
870     my $type = $self->{record_type};
871     my %queues;
872
873     my $report_args = {
874         progress => 1,
875         step => 1,
876         conn => $conn,
877         total => scalar(@$rec_ids),
878         report_all => $$args{report_all}
879     };
880
881     my $auto_overlay_exact = $$args{auto_overlay_exact};
882     my $auto_overlay_1match = $$args{auto_overlay_1match};
883     my $auto_overlay_best = $$args{auto_overlay_best_match};
884     my $match_quality_ratio = $$args{match_quality_ratio};
885     my $merge_profile = $$args{merge_profile};
886     my $bib_source = $$args{bib_source};
887     my $import_no_match = $$args{import_no_match};
888
889     my $overlay_func = 'vandelay.overlay_bib_record';
890     my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
891     my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best'; # XXX bib-only
892     my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
893     my $update_func = 'update_vandelay_queued_bib_record';
894     my $search_func = 'search_vandelay_queued_bib_record';
895     my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
896     my $update_queue_func = 'update_vandelay_bib_queue';
897     my $rec_class = 'vqbr';
898
899     my $editor = new_editor();
900
901     my %bib_sources;
902     my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
903     $bib_sources{$_->id} = $_->source for @$sources;
904
905     if($type eq 'auth') {
906         $overlay_func =~ s/bib/auth/o;
907         $auto_overlay_func = s/bib/auth/o;
908         $retrieve_func =~ s/bib/authority/o;
909         $retrieve_queue_func =~ s/bib/authority/o;
910         $update_queue_func =~ s/bib/authority/o;
911         $update_func =~ s/bib/authority/o;
912         $search_func =~ s/bib/authority/o;
913         $rec_class = 'vqar';
914     }
915
916     my @success_rec_ids;
917     for my $rec_id (@$rec_ids) {
918
919         my $error = 0;
920         my $overlay_target = $overlay_map->{$rec_id};
921
922         my $e = new_editor(xact => 1);
923         $e->requestor($requestor);
924
925         $$report_args{e} = $e;
926         $$report_args{import_error} = undef;
927         $$report_args{evt} = undef;
928
929         my $rec = $e->$retrieve_func([
930             $rec_id,
931             {   flesh => 1,
932                 flesh_fields => { $rec_class => ['matches']},
933             }
934         ]);
935
936         unless($rec) {
937             $$report_args{evt} = $e->event;
938             finish_rec_import_attempt($report_args);
939             next;
940         }
941
942         $$report_args{rec} = $rec;
943
944         if($rec->import_time) {
945             $e->rollback;
946             next;
947         }
948
949         $queues{$rec->queue} = 1;
950
951         my $record;
952         my $imported = 0;
953
954         if(defined $overlay_target) {
955             # Caller chose an explicit overlay target
956
957             my $res = $e->json_query(
958                 {
959                     from => [
960                         $overlay_func,
961                         $rec->id, 
962                         $overlay_target, 
963                         $merge_profile
964                     ]
965                 }
966             );
967
968             if($res and ($res = $res->[0])) {
969
970                 if($res->{$overlay_func} eq 't') {
971                     $logger->info("vl: $type direct overlay succeeded for queued rec " . 
972                         $rec->id . " and overlay target $overlay_target");
973                     $imported = 1;
974                 }
975
976             } else {
977                 $error = 1;
978                 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
979             }
980
981         } else {
982
983             if($auto_overlay_1match) { 
984                 # caller says to overlay if there is exactly 1 match
985
986                 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
987
988                 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
989
990                     my $res = $e->json_query(
991                         {
992                             from => [
993                                 $overlay_func,
994                                 $rec->id, 
995                                 $rec->matches->[0]->eg_record,
996                                 $merge_profile
997                             ]
998                         }
999                     );
1000
1001                     if($res and ($res = $res->[0])) {
1002     
1003                         if($res->{$overlay_func} eq 't') {
1004                             $logger->info("vl: $type overlay-1match succeeded for queued rec " . $rec->id);
1005                             $imported = 1;
1006                         }
1007
1008                     } else {
1009                         $error = 1;
1010                         $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1011                     }
1012                 }
1013             }
1014
1015             if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1016                 
1017                 # caller says to overlay if there is an /exact/ match
1018
1019                 my $res = $e->json_query(
1020                     {
1021                         from => [
1022                             $auto_overlay_func,
1023                             $rec->id, 
1024                             $merge_profile
1025                         ]
1026                     }
1027                 );
1028
1029                 if($res and ($res = $res->[0])) {
1030
1031                     if($res->{$auto_overlay_func} eq 't') {
1032                         $logger->info("vl: $type auto-overlay succeeded for queued rec " . $rec->id);
1033                         $imported = 1;
1034                     } else {
1035                         $logger->info("vl: $type auto-overlay failed for queued rec " . $rec->id);
1036                     }
1037
1038                 } else {
1039                     $error = 1;
1040                     $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1041                 }
1042             }
1043
1044             if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1045
1046                 # caller says to overlay the best match
1047
1048                 my $res = $e->json_query(
1049                     {
1050                         from => [
1051                             $auto_overlay_best_func,
1052                             $rec->id, 
1053                             $merge_profile,
1054                             $match_quality_ratio
1055                         ]
1056                     }
1057                 );
1058
1059                 if($res and ($res = $res->[0])) {
1060
1061                     if($res->{$auto_overlay_best_func} eq 't') {
1062                         $logger->info("vl: $type auto-overlay-best succeeded for queued rec " . $rec->id);
1063                         $imported = 1;
1064                     } else {
1065                         $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1066                         $logger->info("vl: $type auto-overlay-best failed for queued rec " . $rec->id);
1067                     }
1068
1069                 } else {
1070                     $error = 1;
1071                     $logger->error("vl: Error attempting overlay with func=$auto_overlay_best_func, ".
1072                         "quality_ratio=$match_quality_ratio, profile=$merge_profile, record=$rec_id");
1073                 }
1074             }
1075
1076             if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1077             
1078                 # No overlay / merge occurred.  Do a traditional record import by creating a new record
1079             
1080                 $logger->info("vl: creating new $type record for queued record $rec_id");
1081                 if($type eq 'bib') {
1082                     $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import($e, $rec->marc, $bib_sources{$rec->bib_source});
1083                 } else {
1084
1085                     $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1086                 }
1087
1088                 if($U->event_code($record)) {
1089                     $$report_args{import_error} = 'import.duplicate.tcn' if $record->{textcode} eq 'TCN_EXISTS';
1090                     $$report_args{evt} = $record;
1091
1092                 } else {
1093
1094                     $logger->info("vl: successfully imported new $type record");
1095                     $rec->imported_as($record->id);
1096                     $rec->import_time('now');
1097                     $rec->clear_import_error;
1098                     $rec->clear_error_detail;
1099                     $imported = 1 if $e->$update_func($rec);
1100                 }
1101             }
1102         }
1103
1104         if($imported) {
1105             push @success_rec_ids, $rec_id;
1106             finish_rec_import_attempt($report_args);
1107
1108         } else {
1109             # Send an update whenever there's an error
1110             $$report_args{evt} = $e->event unless $$report_args{evt};
1111             finish_rec_import_attempt($report_args);
1112         }
1113     }
1114
1115     # see if we need to mark any queues as complete
1116     for my $q_id (keys %queues) {
1117
1118         my $e = new_editor(xact => 1);
1119         my $remaining = $e->$search_func(
1120             [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1121
1122         unless(@$remaining) {
1123             my $queue = $e->$retrieve_queue_func($q_id);
1124
1125             unless($U->is_true($queue->complete)) {
1126                 $queue->complete('t');
1127                 $e->$update_queue_func($queue) or return $e->die_event;
1128                 $e->commit;
1129                 next;
1130             }
1131         } 
1132         $e->rollback;
1133     }
1134
1135     # import the copies
1136     import_record_asset_list_impl($conn, \@success_rec_ids, $requestor);
1137
1138     $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1139     return undef;
1140 }
1141
1142 # tracks any import errors, commits the current xact, responds to the client
1143 sub finish_rec_import_attempt {
1144     my $args = shift;
1145     my $evt = $$args{evt};
1146     my $rec = $$args{rec};
1147     my $e = $$args{e};
1148
1149     my $error = $$args{import_error};
1150     $error = 'general.unknown' if $evt and not $error;
1151
1152     # error tracking
1153     if($rec) {
1154
1155         if($error or $evt) {
1156             # failed import
1157             # since an error occurred, there's no guarantee the transaction wasn't 
1158             # rolled back.  force a rollback and create a new editor.
1159             $e->rollback;
1160             $e = new_editor(xact => 1);
1161             $rec->import_error($error);
1162
1163             if($evt) {
1164                 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1165                 $rec->error_detail($detail);
1166             }
1167
1168             my $method = 'update_vandelay_queued_bib_record';
1169             $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1170             $e->$method($rec) and $e->commit or $e->rollback;
1171
1172         } else {
1173             # commit the successful import
1174             $e->commit;
1175         }
1176
1177     } else {
1178         # requested queued record was not found
1179         $e->rollback;
1180     }
1181         
1182     # respond to client
1183     if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1184         $$args{conn}->respond({
1185             total => $$args{total}, 
1186             progress => $$args{progress}, 
1187             imported => ($rec) ? $rec->id : undef,
1188             err_event => $evt
1189         });
1190         $$args{step} *= 2 unless $$args{step} == 256;
1191     }
1192
1193     $$args{progress}++;
1194 }
1195
1196
1197
1198
1199
1200 __PACKAGE__->register_method(  
1201     api_name    => "open-ils.vandelay.bib_queue.owner.retrieve",
1202     method      => 'owner_queue_retrieve',
1203     api_level   => 1,
1204     argc        => 2,
1205     stream      => 1,
1206     record_type => 'bib'
1207 );
1208 __PACKAGE__->register_method(  
1209     api_name    => "open-ils.vandelay.authority_queue.owner.retrieve",
1210     method      => 'owner_queue_retrieve',
1211     api_level   => 1,
1212     argc        => 2,
1213     stream      => 1,
1214     record_type => 'auth'
1215 );
1216
1217 sub owner_queue_retrieve {
1218     my($self, $conn, $auth, $owner_id, $filters) = @_;
1219     my $e = new_editor(authtoken => $auth, xact => 1);
1220     return $e->die_event unless $e->checkauth;
1221     $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1222     my $queues;
1223     $filters ||= {};
1224     my $search = {owner => $owner_id};
1225     $search->{$_} = $filters->{$_} for keys %$filters;
1226
1227     if($self->{record_type} eq 'bib') {
1228         $queues = $e->search_vandelay_bib_queue(
1229             [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1230     } else {
1231         $queues = $e->search_vandelay_authority_queue(
1232             [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1233     }
1234     $conn->respond($_) for @$queues;
1235     $e->rollback;
1236     return undef;
1237 }
1238
1239 __PACKAGE__->register_method(  
1240     api_name    => "open-ils.vandelay.bib_queue.delete",
1241     method      => "delete_queue",
1242     api_level   => 1,
1243     argc        => 2,
1244     record_type => 'bib'
1245 );            
1246 __PACKAGE__->register_method(  
1247     api_name    => "open-ils.vandelay.auth_queue.delete",
1248     method      => "delete_queue",
1249     api_level   => 1,
1250     argc        => 2,
1251     record_type => 'auth'
1252 );  
1253
1254 sub delete_queue {
1255     my($self, $conn, $auth, $q_id) = @_;
1256     my $e = new_editor(xact => 1, authtoken => $auth);
1257     return $e->die_event unless $e->checkauth;
1258     if($self->{record_type} eq 'bib') {
1259         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1260         my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1261             or return $e->die_event;
1262         $e->delete_vandelay_bib_queue($queue)
1263             or return $e->die_event;
1264     } else {
1265            return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1266         my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1267             or return $e->die_event;
1268         $e->delete_vandelay_authority_queue($queue)
1269             or return $e->die_event;
1270     }
1271     $e->commit;
1272     return 1;
1273 }
1274
1275
1276 __PACKAGE__->register_method(  
1277     api_name    => "open-ils.vandelay.queued_bib_record.html",
1278     method      => 'queued_record_html',
1279     api_level   => 1,
1280     argc        => 2,
1281     stream      => 1,
1282     record_type => 'bib'
1283 );
1284 __PACKAGE__->register_method(  
1285     api_name    => "open-ils.vandelay.queued_authority_record.html",
1286     method      => 'queued_record_html',
1287     api_level   => 1,
1288     argc        => 2,
1289     stream      => 1,
1290     record_type => 'auth'
1291 );
1292
1293 sub queued_record_html {
1294     my($self, $conn, $auth, $rec_id) = @_;
1295     my $e = new_editor(xact=>1,authtoken => $auth);
1296     return $e->die_event unless $e->checkauth;
1297     my $rec;
1298     if($self->{record_type} eq 'bib') {
1299         $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1300             or return $e->die_event;
1301     } else {
1302         $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1303             or return $e->die_event;
1304     }
1305
1306     $e->rollback;
1307     return $U->simplereq(
1308         'open-ils.search',
1309         'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1310 }
1311
1312
1313 __PACKAGE__->register_method(  
1314     api_name    => "open-ils.vandelay.bib_queue.summary.retrieve", 
1315     method      => 'retrieve_queue_summary',
1316     api_level   => 1,
1317     argc        => 2,
1318     stream      => 1,
1319     record_type => 'bib'
1320 );
1321 __PACKAGE__->register_method(  
1322     api_name    => "open-ils.vandelay.auth_queue.summary.retrieve",
1323     method      => 'retrieve_queue_summary',
1324     api_level   => 1,
1325     argc        => 2,
1326     stream      => 1,
1327     record_type => 'auth'
1328 );
1329
1330 sub retrieve_queue_summary {
1331     my($self, $conn, $auth, $queue_id) = @_;
1332     my $e = new_editor(xact=>1, authtoken => $auth);
1333     return $e->die_event unless $e->checkauth;
1334
1335     my $queue;
1336     my $type = $self->{record_type};
1337     if($type eq 'bib') {
1338         $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1339             or return $e->die_event;
1340     } else {
1341         $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1342             or return $e->die_event;
1343     }
1344
1345     my $evt = check_queue_perms($e, $type, $queue);
1346     return $evt if $evt;
1347
1348     my $search = 'search_vandelay_queued_bib_record';
1349     $search =~ s/bib/authority/ if $type ne 'bib';
1350
1351     my $summary = {
1352         queue => $queue,
1353         total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1354         imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1355     };
1356
1357     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1358     $summary->{rec_import_errors} = $e->json_query({
1359         select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1360         from => $class,
1361         where => {queue => $queue_id, import_error => {'!=' => undef}}
1362     })->[0]->{count};
1363
1364     if($type eq 'bib') {
1365         
1366         my $query = {
1367             select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1368             from => 'vii',
1369             where => {
1370                 record => {
1371                     in => {
1372                         select => {vqbr => ['id']},
1373                         from => 'vqbr',
1374                         where => {queue => $queue_id}
1375                     }
1376                 }
1377             }
1378         };
1379
1380         $summary->{total_items} = $e->json_query($query)->[0]->{count};
1381         $query->{where}->{import_error} = {'!=' => undef};
1382         $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1383     }
1384
1385     return $summary;
1386 }
1387
1388 # --------------------------------------------------------------------------------
1389 # Given a list of queued record IDs, imports all items attached to those records
1390 # --------------------------------------------------------------------------------
1391 sub import_record_asset_list_impl {
1392     my($conn, $rec_ids, $requestor) = @_;
1393
1394     my $roe = new_editor(xact=> 1, requestor => $requestor);
1395
1396     # for speed, filter out any records have not been 
1397     # imported or have no import items to load
1398     $rec_ids = $roe->json_query({
1399         select => {vqbr => ['id']},
1400         from => {vqbr => 'vii'},
1401         where => {'+vqbr' => {import_time => {'!=' => undef}}},
1402         distinct => 1
1403     });
1404     $rec_ids = [map {$_->{id}} @$rec_ids];
1405
1406     my $report_args = {
1407         conn => $conn,
1408         total => scalar(@$rec_ids),
1409         step => 1, # how often to respond
1410         progress => 1,
1411         in_count => 0,
1412     };
1413
1414     for my $rec_id (@$rec_ids) {
1415         my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1416         my $item_ids = $roe->search_vandelay_import_item({record => $rec->id}, {idlist=>1});
1417
1418         for my $item_id (@$item_ids) {
1419             my $e = new_editor(requestor => $requestor, xact => 1);
1420             my $item = $e->retrieve_vandelay_import_item($item_id);
1421             $$report_args{import_item} = $item;
1422             $$report_args{e} = $e;
1423             $$report_args{import_error} = undef;
1424             $$report_args{evt} = undef;
1425
1426             # --------------------------------------------------------------------------------
1427             # Find or create the volume
1428             # --------------------------------------------------------------------------------
1429             my ($vol, $evt) =
1430                 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1431                     $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1432
1433             if($evt) {
1434
1435                 $$report_args{evt} = $evt;
1436                 respond_with_status($report_args);
1437                 next;
1438             }
1439
1440             # --------------------------------------------------------------------------------
1441             # Create the new copy
1442             # --------------------------------------------------------------------------------
1443             my $copy = Fieldmapper::asset::copy->new;
1444             $copy->loan_duration(2);
1445             $copy->fine_level(2);
1446             $copy->barcode($item->barcode);
1447             $copy->location($item->location);
1448             $copy->circ_lib($item->circ_lib || $item->owning_lib);
1449             $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1450             $copy->circulate($item->circulate);
1451             $copy->deposit($item->deposit);
1452             $copy->deposit_amount($item->deposit_amount);
1453             $copy->ref($item->ref);
1454             $copy->holdable($item->holdable);
1455             $copy->price($item->price);
1456             $copy->circ_as_type($item->circ_as_type);
1457             $copy->alert_message($item->alert_message);
1458             $copy->opac_visible($item->opac_visible);
1459             $copy->circ_modifier($item->circ_modifier);
1460
1461             # --------------------------------------------------------------------------------
1462             # see if a valid circ_modifier was provided
1463             # --------------------------------------------------------------------------------
1464             if($copy->circ_modifier and not $e->search_config_circ_modifier({code=>$item->circ_modifier})->[0]) {
1465                 $$report_args{evt} = $e->die_event;
1466                 $$report_args{import_error} = 'import.item.invalid.circ_modifier';
1467                 respond_with_status($report_args);
1468                 next;
1469             }
1470
1471             if($copy->location and not $e->retrieve_asset_copy_location($copy->location)) {
1472                 $$report_args{evt} = $e->die_event;
1473                 $$report_args{import_error} = 'import.item.invalid.location';
1474                 respond_with_status($report_args);
1475                 next;
1476             }
1477
1478             if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1479                 $$report_args{evt} = $evt;
1480                 $$report_args{import_error} = 'import.item.duplicate.barcode'
1481                     if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1482                 respond_with_status($report_args);
1483                 next;
1484             }
1485
1486             # --------------------------------------------------------------------------------
1487             # create copy notes
1488             # --------------------------------------------------------------------------------
1489             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1490                 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1491
1492             if($evt) {
1493                 $$report_args{evt} = $evt;
1494                 respond_with_status($report_args);
1495                 next;
1496             }
1497
1498             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1499                 $e, $copy, '', $item->priv_note, 1) if $item->priv_note;
1500
1501             if($evt) {
1502                 $$report_args{evt} = $evt;
1503                 respond_with_status($report_args);
1504                 next;
1505             }
1506
1507             # --------------------------------------------------------------------------------
1508             # Item import succeeded
1509             # --------------------------------------------------------------------------------
1510             $e->commit;
1511             $$report_args{in_count}++;
1512             respond_with_status($report_args);
1513             $logger->info("vl: successfully imported item " . $item->barcode);
1514         }
1515
1516     }
1517
1518     $roe->rollback;
1519     return undef;
1520 }
1521
1522
1523 sub respond_with_status {
1524     my $args = shift;
1525     my $e = $$args{e};
1526
1527     #  If the import failed, track the failure reason
1528
1529     my $error = $$args{import_error};
1530     my $evt = $$args{evt};
1531
1532     if($error or $evt) {
1533
1534         my $item = $$args{import_item};
1535         $logger->info("vl: unable to import item " . $item->barcode);
1536
1537         $error ||= 'general.unknown';
1538         $item->import_error($error);
1539
1540         if($evt) {
1541             my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1542             $item->error_detail($detail);
1543         }
1544
1545         # state of the editor is unknown at this point.  Force a rollback and start over.
1546         $e->rollback;
1547         $e = new_editor(xact => 1);
1548         $e->update_vandelay_import_item($item);
1549         $e->commit;
1550     }
1551
1552     if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1553         $$args{conn}->respond({
1554             map { $_ => $args->{$_} } qw/total progress success_count/,
1555             err_event => $evt
1556         });
1557         $$args{step} *= 2 unless $$args{step} == 256;
1558     }
1559
1560     $$args{progress}++;
1561 }
1562
1563 __PACKAGE__->register_method(  
1564     api_name    => "open-ils.vandelay.match_set.get_tree",
1565     method      => "match_set_get_tree",
1566     api_level   => 1,
1567     argc        => 2,
1568     signature   => {
1569         desc    => q/For a given vms object, return a tree of match set points
1570                     represented by a vmsp object with recursively fleshed
1571                     children./
1572     }
1573 );
1574
1575 sub match_set_get_tree {
1576     my ($self, $conn, $authtoken, $match_set_id) = @_;
1577
1578     $match_set_id = int($match_set_id) or return;
1579
1580     my $e = new_editor("authtoken" => $authtoken);
1581     $e->checkauth or return $e->die_event;
1582
1583     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1584         return $e->die_event;
1585
1586     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1587         return $e->die_event;
1588
1589     my $tree = $e->search_vandelay_match_set_point([
1590         {"match_set" => $match_set_id, "parent" => undef},
1591         {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1592     ]) or return $e->die_event;
1593
1594     return pop @$tree;
1595 }
1596
1597
1598 __PACKAGE__->register_method(
1599     api_name    => "open-ils.vandelay.match_set.update",
1600     method      => "match_set_update_tree",
1601     api_level   => 1,
1602     argc        => 3,
1603     signature   => {
1604         desc => q/Replace any vmsp objects associated with a given (by ID) vms
1605                 with the given objects (recursively fleshed vmsp tree)./
1606     }
1607 );
1608
1609 sub _walk_new_vmsp {
1610     my ($e, $match_set_id, $node, $parent_id) = @_;
1611
1612     my $point = new Fieldmapper::vandelay::match_set_point;
1613     $point->parent($parent_id);
1614     $point->match_set($match_set_id);
1615     $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1616
1617     $e->create_vandelay_match_set_point($point) or return $e->die_event;
1618
1619     $parent_id = $e->data->id;
1620     if ($node->children && @{$node->children}) {
1621         for (@{$node->children}) {
1622             return $e->die_event if
1623                 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1624         }
1625     }
1626
1627     return;
1628 }
1629
1630 sub match_set_update_tree {
1631     my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1632
1633     my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1634     $e->checkauth or return $e->die_event;
1635
1636     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1637         return $e->die_event;
1638
1639     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1640         return $e->die_event;
1641
1642     my $existing = $e->search_vandelay_match_set_point([
1643         {"match_set" => $match_set_id},
1644         {"order_by" => {"vmsp" => "id DESC"}}
1645     ]) or return $e->die_event;
1646
1647     # delete points, working up from leaf points to the root
1648     while(@$existing) {
1649         for my $point (shift @$existing) {
1650             if( grep {$_->parent eq $point->id} @$existing) {
1651                 push(@$existing, $point);
1652             } else {
1653                 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
1654             }
1655         }
1656     }
1657
1658     _walk_new_vmsp($e, $match_set_id, $tree);
1659
1660     $e->commit or return $e->die_event;
1661 }
1662
1663 1;