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.atomic.export.print",
 374     method      => 'retrieve_queued_records',
 375     api_level   => 1,
 376     argc        => 2,
 377     record_type => 'bib'
 378 );
 379 __PACKAGE__->register_method(
 380     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.atomic.export.csv",
 381     method      => 'retrieve_queued_records',
 382     api_level   => 1,
 383     argc        => 2,
 384     record_type => 'bib'
 385 );
 386 __PACKAGE__->register_method(
 387     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.atomic.export.email",
 388     method      => 'retrieve_queued_records',
 389     api_level   => 1,
 390     argc        => 2,
 391     record_type => 'bib'
 392 );
 393
 394 __PACKAGE__->register_method(
 395     api_name    => "open-ils.vandelay.auth_queue.records.retrieve",
 396     method      => 'retrieve_queued_records',
 397     api_level   => 1,
 398     argc        => 2,
 399     stream      => 1,
 400     record_type => 'auth'
 401 );
 402 __PACKAGE__->register_method(
 403     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.atomic.export.print",
 404     method      => 'retrieve_queued_records',
 405     api_level   => 1,
 406     argc        => 2,
 407     record_type => 'auth'
 408 );
 409 __PACKAGE__->register_method(
 410     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.atomic.export.csv",
 411     method      => 'retrieve_queued_records',
 412     api_level   => 1,
 413     argc        => 2,
 414     record_type => 'auth'
 415 );
 416 __PACKAGE__->register_method(
 417     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.atomic.export.email",
 418     method      => 'retrieve_queued_records',
 419     api_level   => 1,
 420     argc        => 2,
 421     record_type => 'auth'
 422 );
 423
 424 __PACKAGE__->register_method(
 425     api_name    => "open-ils.vandelay.bib_queue.records.matches.retrieve",
 426     method      => 'retrieve_queued_records',
 427     api_level   => 1,
 428     argc        => 2,
 429     stream      => 1,
 430     record_type => 'bib',
 431     signature   => {
 432         desc => q/Only retrieve queued bib records that have matches against existing records/
 433     }
 434 );
 435 __PACKAGE__->register_method(
 436     api_name    => "open-ils.vandelay.auth_queue.records.matches.retrieve",
 437     method      => 'retrieve_queued_records',
 438     api_level   => 1,
 439     argc        => 2,
 440     stream      => 1,
 441     record_type => 'auth',
 442     signature   => {
 443         desc => q/Only retrieve queued authority records that have matches against existing records/
 444     }
 445 );
 446
 447 sub retrieve_queued_records {
 448     my($self, $conn, $auth, $queue_id, $options) = @_;
 449
 450     $options ||= {};
 451     my $limit = $$options{limit} || 20;
 452     my $offset = $$options{offset} || 0;
 453     my $type = $self->{record_type};
 454
 455     my $e = new_editor(authtoken => $auth, xact => 1);
 456     return $e->die_event unless $e->checkauth;
 457
 458     my $queue;
 459     if($type eq 'bib') {
 460         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
 461     } else {
 462         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
 463     }
 464     my $evt = check_queue_perms($e, $type, $queue);
 465     return $evt if ($evt);
 466
 467     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
 468     my $query = {
 469         select => {$class => ['id']},
 470         from => $class,
 471         where => {queue => $queue_id},
 472         distinct => 1,
 473         order_by => {$class => ['id']},
 474         limit => $limit,
 475         offset => $offset,
 476     };
 477     if($self->api_name =~ /export/) {
 478         delete $query->{limit};
 479         delete $query->{offset};
 480     }
 481
 482     $query->{where}->{import_time} = undef if $$options{non_imported};
 483
 484     if($$options{with_import_error}) {
 485
 486         $query->{from} = {$class => {vii => {type => 'right'}}};
 487         $query->{where}->{'-or'} = [
 488             {'+vqbr' => {import_error => {'!=' => undef}}},
 489             {'+vii' => {import_error => {'!=' => undef}}}
 490         ];
 491
 492     } else {
 493
 494         if($$options{with_rec_import_error}) {
 495             $query->{where}->{import_error} = {'!=' => undef};
 496
 497         } elsif( $$options{with_item_import_error} and $type eq 'bib') {
 498
 499             $query->{from} = {$class => 'vii'};
 500             $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
 501         }
 502     }
 503
 504     if($self->api_name =~ /matches/) {
 505         # find only records that have matches
 506         my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
 507         $query->{from} = {$class => {$mclass => {type => 'right'}}};
 508     }
 509
 510     my $record_ids = $e->json_query($query);
 511
 512     my $retrieve = ($type eq 'bib') ?
 513         'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
 514
 515     for my $rec_id (@$record_ids) {
 516         my $flesh = ['attributes', 'matches'];
 517         push(@$flesh, 'import_items') if $$options{flesh_import_items};
 518         my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
 519         my $rec = $e->$retrieve([$rec_id->{id}, $params]);
 520         $rec->clear_marc if $$options{clear_marc};
 521         $conn->respond($rec);
 522     }
 523
 524     $e->rollback;
 525     return undef;
 526 }
 527
 528 __PACKAGE__->register_method(
 529     api_name    => 'open-ils.vandelay.import_item.queue.retrieve',
 530     method      => 'retrieve_queue_import_items',
 531     api_level   => 1,
 532     argc        => 2,
 533     stream      => 1,
 534     authoritative => 1,
 535     signature => q/
 536         Returns Import Item (vii) objects for the selected queue.
 537         Filter options:
 538             with_import_error : only return items that failed to import
 539     /
 540 );
 541 __PACKAGE__->register_method(
 542     api_name    => 'open-ils.vandelay.import_item.queue.export.print',
 543     method      => 'retrieve_queue_import_items',
 544     api_level   => 1,
 545     argc        => 2,
 546     authoritative => 1,
 547     signature => q/
 548         Returns template-generated printable output of Import Item (vii) objects for the selected queue.
 549         Filter options:
 550             with_import_error : only return items that failed to import
 551     /
 552 );
 553 __PACKAGE__->register_method(
 554     api_name    => 'open-ils.vandelay.import_item.queue.export.csv',
 555     method      => 'retrieve_queue_import_items',
 556     api_level   => 1,
 557     argc        => 2,
 558     authoritative => 1,
 559     signature => q/
 560         Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
 561         Filter options:
 562             with_import_error : only return items that failed to import
 563     /
 564 );
 565 __PACKAGE__->register_method(
 566     api_name    => 'open-ils.vandelay.import_item.queue.export.email',
 567     method      => 'retrieve_queue_import_items',
 568     api_level   => 1,
 569     argc        => 2,
 570     authoritative => 1,
 571     signature => q/
 572         Emails template-generated output of Import Item (vii) objects for the selected queue.
 573         Filter options:
 574             with_import_error : only return items that failed to import
 575     /
 576 );
 577
 578 sub retrieve_queue_import_items {
 579     my($self, $conn, $auth, $q_id, $options) = @_;
 580
 581     $options ||= {};
 582     my $limit = $$options{limit} || 20;
 583     my $offset = $$options{offset} || 0;
 584
 585     my $e = new_editor(authtoken => $auth);
 586     return $e->event unless $e->checkauth;
 587
 588     my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
 589     my $evt = check_queue_perms($e, 'bib', $queue);
 590     return $evt if $evt;
 591
 592     my $query = {
 593         select => {vii => ['id']},
 594         from => {
 595             vii => {
 596                 vqbr => {
 597                     join => {
 598                         'vbq' => {
 599                             field => 'id',
 600                             fkey => 'queue',
 601                             filter => {id => $q_id}
 602                         }
 603                     }
 604                 }
 605             }
 606         },
 607         order_by => {'vii' => ['record','id']},
 608         limit => $limit,
 609         offset => $offset
 610     };
 611     if($self->api_name =~ /export/) {
 612         delete $query->{limit};
 613         delete $query->{offset};
 614     }
 615
 616     $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
 617         if $$options{with_import_error};
 618
 619     my $items = $e->json_query($query);
 620     for my $item (@$items) {
 621         $conn->respond($e->retrieve_vandelay_import_item($item->{id}));
 622     }
 623
 624     return undef;
 625 }
 626
 627 sub check_queue_perms {
 628     my($e, $type, $queue) = @_;
 629     if ($type eq 'bib') {
 630         return $e->die_event unless
 631             ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
 632              $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
 633     } else {
 634         return $e->die_event unless
 635             ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
 636              $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
 637     }
 638
 639     return undef;
 640 }
 641
 642 __PACKAGE__->register_method(
 643     api_name    => "open-ils.vandelay.bib_record.list.import",
 644     method      => 'import_record_list',
 645     api_level   => 1,
 646     argc        => 2,
 647     stream      => 1,
 648     record_type => 'bib'
 649 );
 650
 651 __PACKAGE__->register_method(
 652     api_name    => "open-ils.vandelay.auth_record.list.import",
 653     method      => 'import_record_list',
 654     api_level   => 1,
 655     argc        => 2,
 656     stream      => 1,
 657     record_type => 'auth'
 658 );
 659
 660 sub import_record_list {
 661     my($self, $conn, $auth, $rec_ids, $args) = @_;
 662     my $e = new_editor(authtoken => $auth, xact => 1);
 663     return $e->die_event unless $e->checkauth;
 664     $args ||= {};
 665     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
 666     try {$e->rollback} otherwise {};
 667     return $err if $err;
 668     return {complete => 1};
 669 }
 670
 671
 672 __PACKAGE__->register_method(
 673     api_name    => "open-ils.vandelay.bib_queue.import",
 674     method      => 'import_queue',
 675     api_level   => 1,
 676     argc        => 2,
 677     stream      => 1,
 678     max_chunk_size => 0,
 679     record_type => 'bib'
 680 );
 681
 682 __PACKAGE__->register_method(
 683     api_name    => "open-ils.vandelay.auth_queue.import",
 684     method      => 'import_queue',
 685     api_level   => 1,
 686     argc        => 2,
 687     stream      => 1,
 688     max_chunk_size => 0,
 689     record_type => 'auth'
 690 );
 691 __PACKAGE__->register_method(
 692     api_name    => "open-ils.vandelay.bib_queue.nomatch.import",
 693     method      => 'import_queue',
 694     api_level   => 1,
 695     argc        => 2,
 696     stream      => 1,
 697     signature   => {
 698         desc => q/Only import records that have no collisions/
 699     },
 700     max_chunk_size => 0,
 701     record_type => 'bib'
 702 );
 703
 704 __PACKAGE__->register_method(
 705     api_name    => "open-ils.vandelay.auth_queue.nomatch.import",
 706     method      => 'import_queue',
 707     api_level   => 1,
 708     argc        => 2,
 709     stream      => 1,
 710     signature   => {
 711         desc => q/Only import records that have no collisions/
 712     },
 713     max_chunk_size => 0,
 714     record_type => 'auth'
 715 );
 716 sub import_queue {
 717     my($self, $conn, $auth, $q_id, $options) = @_;
 718     my $e = new_editor(authtoken => $auth, xact => 1);
 719     return $e->die_event unless $e->checkauth;
 720     $options ||= {};
 721     my $type = $self->{record_type};
 722     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
 723
 724     my $query = {queue => $q_id, import_time => undef};
 725
 726     if($self->api_name =~ /nomatch/) {
 727         my $matched_recs = queued_records_with_matches($e, $type, $q_id, undef, undef, {import_time => undef});
 728         $query->{id} = {'not in' => $matched_recs} if @$matched_recs;
 729     }
 730
 731     my $search = ($type eq 'bib') ?
 732         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
 733     my $rec_ids = $e->$search($query, {idlist => 1});
 734     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
 735     try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
 736     return $err if $err;
 737     return {complete => 1};
 738 }
 739
 740 # returns a list of queued record IDs for a given queue that
 741 # have at least one entry in the match table
 742 sub queued_records_with_matches {
 743     my($e, $type, $q_id, $limit, $offset, $filter) = @_;
 744
 745     my $match_class = 'vbm';
 746     my $rec_class = 'vqbr';
 747     if($type eq 'auth') {
 748         $match_class = 'vam';
 749          $rec_class = 'vqar';
 750     }
 751
 752     $filter ||= {};
 753     $filter->{queue} = $q_id;
 754
 755     my $query = {
 756         distinct => 1,
 757         select => {$match_class => ['queued_record']},
 758         from => {
 759             $match_class => {
 760                 $rec_class => {
 761                     field => 'id',
 762                     fkey => 'queued_record',
 763                     filter => $filter,
 764                 }
 765             }
 766         }
 767     };
 768
 769     if($limit or defined $offset) {
 770         $limit ||= 20;
 771         $offset ||= 0;
 772         $query->{limit} = $limit;
 773         $query->{offset} = $offset;
 774     }
 775
 776     my $data = $e->json_query($query);
 777     return [ map {$_->{queued_record}} @$data ];
 778 }
 779
 780
 781 sub import_record_list_impl {
 782     my($self, $conn, $rec_ids, $requestor, $args) = @_;
 783
 784     my $overlay_map = $args->{overlay_map} || {};
 785     my $type = $self->{record_type};
 786     my %queues;
 787
 788     my $report_args = {
 789         progress => 1,
 790         step => 1,
 791         conn => $conn,
 792         total => scalar(@$rec_ids),
 793         report_all => $$args{report_all}
 794     };
 795
 796     my $auto_overlay_exact = $$args{auto_overlay_exact};
 797     my $auto_overlay_1match = $$args{auto_overlay_1match};
 798     my $auto_overlay_best = $$args{auto_overlay_best_match};
 799     my $match_quality_ratio = $$args{match_quality_ratio};
 800     my $merge_profile = $$args{merge_profile};
 801     my $bib_source = $$args{bib_source};
 802     my $import_no_match = $$args{import_no_match};
 803
 804     my $overlay_func = 'vandelay.overlay_bib_record';
 805     my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
 806     my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best'; # XXX bib-only
 807     my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
 808     my $update_func = 'update_vandelay_queued_bib_record';
 809     my $search_func = 'search_vandelay_queued_bib_record';
 810     my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
 811     my $update_queue_func = 'update_vandelay_bib_queue';
 812     my $rec_class = 'vqbr';
 813
 814     my $editor = new_editor();
 815
 816     my %bib_sources;
 817     my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
 818     $bib_sources{$_->id} = $_->source for @$sources;
 819
 820     if($type eq 'auth') {
 821         $overlay_func =~ s/bib/auth/o;
 822         $auto_overlay_func = s/bib/auth/o;
 823         $retrieve_func =~ s/bib/authority/o;
 824         $retrieve_queue_func =~ s/bib/authority/o;
 825         $update_queue_func =~ s/bib/authority/o;
 826         $update_func =~ s/bib/authority/o;
 827         $search_func =~ s/bib/authority/o;
 828         $rec_class = 'vqar';
 829     }
 830
 831     my @success_rec_ids;
 832     for my $rec_id (@$rec_ids) {
 833
 834         my $error = 0;
 835         my $overlay_target = $overlay_map->{$rec_id};
 836
 837         my $e = new_editor(xact => 1);
 838         $e->requestor($requestor);
 839
 840         $$report_args{e} = $e;
 841         $$report_args{import_error} = undef;
 842         $$report_args{evt} = undef;
 843
 844         my $rec = $e->$retrieve_func([
 845             $rec_id,
 846             {   flesh => 1,
 847                 flesh_fields => { $rec_class => ['matches']},
 848             }
 849         ]);
 850
 851         unless($rec) {
 852             $$report_args{evt} = $e->event;
 853             finish_rec_import_attempt($report_args);
 854             next;
 855         }
 856
 857         $$report_args{rec} = $rec;
 858
 859         if($rec->import_time) {
 860             $e->rollback;
 861             next;
 862         }
 863
 864         $queues{$rec->queue} = 1;
 865
 866         my $record;
 867         my $imported = 0;
 868
 869         if(defined $overlay_target) {
 870             # Caller chose an explicit overlay target
 871
 872             my $res = $e->json_query(
 873                 {
 874                     from => [
 875                         $overlay_func,
 876                         $rec->id,
 877                         $overlay_target,
 878                         $merge_profile
 879                     ]
 880                 }
 881             );
 882
 883             if($res and ($res = $res->[0])) {
 884
 885                 if($res->{$overlay_func} eq 't') {
 886                     $logger->info("vl: $type direct overlay succeeded for queued rec " .
 887                         $rec->id . " and overlay target $overlay_target");
 888                     $imported = 1;
 889                 }
 890
 891             } else {
 892                 $error = 1;
 893                 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
 894             }
 895
 896         } else {
 897
 898             if($auto_overlay_1match) {
 899                 # caller says to overlay if there is exactly 1 match
 900
 901                 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
 902
 903                 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
 904
 905                     my $res = $e->json_query(
 906                         {
 907                             from => [
 908                                 $overlay_func,
 909                                 $rec->id,
 910                                 $rec->matches->[0]->eg_record,
 911                                 $merge_profile
 912                             ]
 913                         }
 914                     );
 915
 916                     if($res and ($res = $res->[0])) {
 917
 918                         if($res->{$overlay_func} eq 't') {
 919                             $logger->info("vl: $type overlay-1match succeeded for queued rec " . $rec->id);
 920                             $imported = 1;
 921                         }
 922
 923                     } else {
 924                         $error = 1;
 925                         $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
 926                     }
 927                 }
 928             }
 929
 930             if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
 931
 932                 # caller says to overlay if there is an /exact/ match
 933
 934                 my $res = $e->json_query(
 935                     {
 936                         from => [
 937                             $auto_overlay_func,
 938                             $rec->id,
 939                             $merge_profile
 940                         ]
 941                     }
 942                 );
 943
 944                 if($res and ($res = $res->[0])) {
 945
 946                     if($res->{$auto_overlay_func} eq 't') {
 947                         $logger->info("vl: $type auto-overlay succeeded for queued rec " . $rec->id);
 948                         $imported = 1;
 949                     } else {
 950                         $logger->info("vl: $type auto-overlay failed for queued rec " . $rec->id);
 951                     }
 952
 953                 } else {
 954                     $error = 1;
 955                     $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
 956                 }
 957             }
 958
 959             if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
 960
 961                 # caller says to overlay the best match
 962
 963                 my $res = $e->json_query(
 964                     {
 965                         from => [
 966                             $auto_overlay_best_func,
 967                             $rec->id,
 968                             $merge_profile,
 969                             $match_quality_ratio
 970                         ]
 971                     }
 972                 );
 973
 974                 if($res and ($res = $res->[0])) {
 975
 976                     if($res->{$auto_overlay_best_func} eq 't') {
 977                         $logger->info("vl: $type auto-overlay-best succeeded for queued rec " . $rec->id);
 978                         $imported = 1;
 979                     } else {
 980                         $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
 981                         $logger->info("vl: $type auto-overlay-best failed for queued rec " . $rec->id);
 982                     }
 983
 984                 } else {
 985                     $error = 1;
 986                     $logger->error("vl: Error attempting overlay with func=$auto_overlay_best_func, ".
 987                         "quality_ratio=$match_quality_ratio, profile=$merge_profile, record=$rec_id");
 988                 }
 989             }
 990
 991             if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
 992
 993                 # No overlay / merge occurred.  Do a traditional record import by creating a new record
 994
 995                 $logger->info("vl: creating new $type record for queued record $rec_id");
 996                 if($type eq 'bib') {
 997                     $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import($e, $rec->marc, $bib_sources{$rec->bib_source});
 998                 } else {
 999
1000                     $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1001                 }
1002
1003                 if($U->event_code($record)) {
1004                     $$report_args{import_error} = 'import.duplicate.tcn' if $record->{textcode} eq 'TCN_EXISTS';
1005                     $$report_args{evt} = $record;
1006
1007                 } else {
1008
1009                     $logger->info("vl: successfully imported new $type record");
1010                     $rec->imported_as($record->id);
1011                     $rec->import_time('now');
1012                     $rec->clear_import_error;
1013                     $rec->clear_error_detail;
1014                     $imported = 1 if $e->$update_func($rec);
1015                 }
1016             }
1017         }
1018
1019         if($imported) {
1020             push @success_rec_ids, $rec_id;
1021             finish_rec_import_attempt($report_args);
1022
1023         } else {
1024             # Send an update whenever there's an error
1025             $$report_args{evt} = $e->event unless $$report_args{evt};
1026             finish_rec_import_attempt($report_args);
1027         }
1028     }
1029
1030     # see if we need to mark any queues as complete
1031     for my $q_id (keys %queues) {
1032
1033         my $e = new_editor(xact => 1);
1034         my $remaining = $e->$search_func(
1035             [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1036
1037         unless(@$remaining) {
1038             my $queue = $e->$retrieve_queue_func($q_id);
1039
1040             unless($U->is_true($queue->complete)) {
1041                 $queue->complete('t');
1042                 $e->$update_queue_func($queue) or return $e->die_event;
1043                 $e->commit;
1044                 next;
1045             }
1046         }
1047         $e->rollback;
1048     }
1049
1050     # import the copies
1051     import_record_asset_list_impl($conn, \@success_rec_ids, $requestor);
1052
1053     $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1054     return undef;
1055 }
1056
1057 # tracks any import errors, commits the current xact, responds to the client
1058 sub finish_rec_import_attempt {
1059     my $args = shift;
1060     my $evt = $$args{evt};
1061     my $rec = $$args{rec};
1062     my $e = $$args{e};
1063
1064     my $error = $$args{import_error};
1065     $error = 'general.unknown' if $evt and not $error;
1066
1067     # error tracking
1068     if($rec) {
1069
1070         if($error or $evt) {
1071             # failed import
1072             # since an error occurred, there's no guarantee the transaction wasn't
1073             # rolled back.  force a rollback and create a new editor.
1074             $e->rollback;
1075             $e = new_editor(xact => 1);
1076             $rec->import_error($error);
1077
1078             if($evt) {
1079                 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1080                 $rec->error_detail($detail);
1081             }
1082
1083             my $method = 'update_vandelay_queued_bib_record';
1084             $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1085             $e->$method($rec) and $e->commit or $e->rollback;
1086
1087         } else {
1088             # commit the successful import
1089             $e->commit;
1090         }
1091
1092     } else {
1093         # requested queued record was not found
1094         $e->rollback;
1095     }
1096
1097     # respond to client
1098     if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1099         $$args{conn}->respond({
1100             total => $$args{total},
1101             progress => $$args{progress},
1102             imported => ($rec) ? $rec->id : undef,
1103             err_event => $evt
1104         });
1105         $$args{step} *= 2 unless $$args{step} == 256;
1106     }
1107
1108     $$args{progress}++;
1109 }
1110
1111
1112
1113
1114
1115 __PACKAGE__->register_method(
1116     api_name    => "open-ils.vandelay.bib_queue.owner.retrieve",
1117     method      => 'owner_queue_retrieve',
1118     api_level   => 1,
1119     argc        => 2,
1120     stream      => 1,
1121     record_type => 'bib'
1122 );
1123 __PACKAGE__->register_method(
1124     api_name    => "open-ils.vandelay.authority_queue.owner.retrieve",
1125     method      => 'owner_queue_retrieve',
1126     api_level   => 1,
1127     argc        => 2,
1128     stream      => 1,
1129     record_type => 'auth'
1130 );
1131
1132 sub owner_queue_retrieve {
1133     my($self, $conn, $auth, $owner_id, $filters) = @_;
1134     my $e = new_editor(authtoken => $auth, xact => 1);
1135     return $e->die_event unless $e->checkauth;
1136     $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1137     my $queues;
1138     $filters ||= {};
1139     my $search = {owner => $owner_id};
1140     $search->{$_} = $filters->{$_} for keys %$filters;
1141
1142     if($self->{record_type} eq 'bib') {
1143         $queues = $e->search_vandelay_bib_queue(
1144             [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1145     } else {
1146         $queues = $e->search_vandelay_authority_queue(
1147             [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1148     }
1149     $conn->respond($_) for @$queues;
1150     $e->rollback;
1151     return undef;
1152 }
1153
1154 __PACKAGE__->register_method(
1155     api_name    => "open-ils.vandelay.bib_queue.delete",
1156     method      => "delete_queue",
1157     api_level   => 1,
1158     argc        => 2,
1159     record_type => 'bib'
1160 );
1161 __PACKAGE__->register_method(
1162     api_name    => "open-ils.vandelay.auth_queue.delete",
1163     method      => "delete_queue",
1164     api_level   => 1,
1165     argc        => 2,
1166     record_type => 'auth'
1167 );
1168
1169 sub delete_queue {
1170     my($self, $conn, $auth, $q_id) = @_;
1171     my $e = new_editor(xact => 1, authtoken => $auth);
1172     return $e->die_event unless $e->checkauth;
1173     if($self->{record_type} eq 'bib') {
1174         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1175         my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1176             or return $e->die_event;
1177         $e->delete_vandelay_bib_queue($queue)
1178             or return $e->die_event;
1179     } else {
1180            return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1181         my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1182             or return $e->die_event;
1183         $e->delete_vandelay_authority_queue($queue)
1184             or return $e->die_event;
1185     }
1186     $e->commit;
1187     return 1;
1188 }
1189
1190
1191 __PACKAGE__->register_method(
1192     api_name    => "open-ils.vandelay.queued_bib_record.html",
1193     method      => 'queued_record_html',
1194     api_level   => 1,
1195     argc        => 2,
1196     stream      => 1,
1197     record_type => 'bib'
1198 );
1199 __PACKAGE__->register_method(
1200     api_name    => "open-ils.vandelay.queued_authority_record.html",
1201     method      => 'queued_record_html',
1202     api_level   => 1,
1203     argc        => 2,
1204     stream      => 1,
1205     record_type => 'auth'
1206 );
1207
1208 sub queued_record_html {
1209     my($self, $conn, $auth, $rec_id) = @_;
1210     my $e = new_editor(xact=>1,authtoken => $auth);
1211     return $e->die_event unless $e->checkauth;
1212     my $rec;
1213     if($self->{record_type} eq 'bib') {
1214         $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1215             or return $e->die_event;
1216     } else {
1217         $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1218             or return $e->die_event;
1219     }
1220
1221     $e->rollback;
1222     return $U->simplereq(
1223         'open-ils.search',
1224         'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1225 }
1226
1227
1228 __PACKAGE__->register_method(
1229     api_name    => "open-ils.vandelay.bib_queue.summary.retrieve",
1230     method      => 'retrieve_queue_summary',
1231     api_level   => 1,
1232     argc        => 2,
1233     stream      => 1,
1234     record_type => 'bib'
1235 );
1236 __PACKAGE__->register_method(
1237     api_name    => "open-ils.vandelay.auth_queue.summary.retrieve",
1238     method      => 'retrieve_queue_summary',
1239     api_level   => 1,
1240     argc        => 2,
1241     stream      => 1,
1242     record_type => 'auth'
1243 );
1244
1245 sub retrieve_queue_summary {
1246     my($self, $conn, $auth, $queue_id) = @_;
1247     my $e = new_editor(xact=>1, authtoken => $auth);
1248     return $e->die_event unless $e->checkauth;
1249
1250     my $queue;
1251     my $type = $self->{record_type};
1252     if($type eq 'bib') {
1253         $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1254             or return $e->die_event;
1255     } else {
1256         $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1257             or return $e->die_event;
1258     }
1259
1260     my $evt = check_queue_perms($e, $type, $queue);
1261     return $evt if $evt;
1262
1263     my $search = 'search_vandelay_queued_bib_record';
1264     $search =~ s/bib/authority/ if $type ne 'bib';
1265
1266     my $summary = {
1267         queue => $queue,
1268         total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1269         imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1270     };
1271
1272     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1273     $summary->{rec_import_errors} = $e->json_query({
1274         select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1275         from => $class,
1276         where => {queue => $queue_id, import_error => {'!=' => undef}}
1277     })->[0]->{count};
1278
1279     if($type eq 'bib') {
1280
1281         my $query = {
1282             select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1283             from => 'vii',
1284             where => {
1285                 record => {
1286                     in => {
1287                         select => {vqbr => ['id']},
1288                         from => 'vqbr',
1289                         where => {queue => $queue_id}
1290                     }
1291                 }
1292             }
1293         };
1294
1295         $summary->{total_items} = $e->json_query($query)->[0]->{count};
1296         $query->{where}->{import_error} = {'!=' => undef};
1297         $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1298     }
1299
1300     return $summary;
1301 }
1302
1303 # --------------------------------------------------------------------------------
1304 # Given a list of queued record IDs, imports all items attached to those records
1305 # --------------------------------------------------------------------------------
1306 sub import_record_asset_list_impl {
1307     my($conn, $rec_ids, $requestor) = @_;
1308
1309     my $roe = new_editor(xact=> 1, requestor => $requestor);
1310
1311     # for speed, filter out any records have not been
1312     # imported or have no import items to load
1313     $rec_ids = $roe->json_query({
1314         select => {vqbr => ['id']},
1315         from => {vqbr => 'vii'},
1316         where => {'+vqbr' => {import_time => {'!=' => undef}}},
1317         distinct => 1
1318     });
1319     $rec_ids = [map {$_->{id}} @$rec_ids];
1320
1321     my $report_args = {
1322         conn => $conn,
1323         total => scalar(@$rec_ids),
1324         step => 1, # how often to respond
1325         progress => 1,
1326         in_count => 0,
1327     };
1328
1329     for my $rec_id (@$rec_ids) {
1330         my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1331         my $item_ids = $roe->search_vandelay_import_item({record => $rec->id}, {idlist=>1});
1332
1333         for my $item_id (@$item_ids) {
1334             my $e = new_editor(requestor => $requestor, xact => 1);
1335             my $item = $e->retrieve_vandelay_import_item($item_id);
1336             $$report_args{import_item} = $item;
1337             $$report_args{e} = $e;
1338             $$report_args{import_error} = undef;
1339             $$report_args{evt} = undef;
1340
1341             # --------------------------------------------------------------------------------
1342             # Find or create the volume
1343             # --------------------------------------------------------------------------------
1344             my ($vol, $evt) =
1345                 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1346                     $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1347
1348             if($evt) {
1349
1350                 $$report_args{evt} = $evt;
1351                 respond_with_status($report_args);
1352                 next;
1353             }
1354
1355             # --------------------------------------------------------------------------------
1356             # Create the new copy
1357             # --------------------------------------------------------------------------------
1358             my $copy = Fieldmapper::asset::copy->new;
1359             $copy->loan_duration(2);
1360             $copy->fine_level(2);
1361             $copy->barcode($item->barcode);
1362             $copy->location($item->location);
1363             $copy->circ_lib($item->circ_lib || $item->owning_lib);
1364             $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1365             $copy->circulate($item->circulate);
1366             $copy->deposit($item->deposit);
1367             $copy->deposit_amount($item->deposit_amount);
1368             $copy->ref($item->ref);
1369             $copy->holdable($item->holdable);
1370             $copy->price($item->price);
1371             $copy->circ_as_type($item->circ_as_type);
1372             $copy->alert_message($item->alert_message);
1373             $copy->opac_visible($item->opac_visible);
1374             $copy->circ_modifier($item->circ_modifier);
1375
1376             # --------------------------------------------------------------------------------
1377             # see if a valid circ_modifier was provided
1378             # --------------------------------------------------------------------------------
1379             if($copy->circ_modifier and not $e->search_config_circ_modifier({code=>$item->circ_modifier})->[0]) {
1380                 $$report_args{evt} = $e->die_event;
1381                 $$report_args{import_error} = 'import.item.invalid.circ_modifier';
1382                 respond_with_status($report_args);
1383                 next;
1384             }
1385
1386             if($copy->location and not $e->retrieve_asset_copy_location($copy->location)) {
1387                 $$report_args{evt} = $e->die_event;
1388                 $$report_args{import_error} = 'import.item.invalid.location';
1389                 respond_with_status($report_args);
1390                 next;
1391             }
1392
1393             if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1394                 $$report_args{evt} = $evt;
1395                 $$report_args{import_error} = 'import.item.duplicate.barcode'
1396                     if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1397                 respond_with_status($report_args);
1398                 next;
1399             }
1400
1401             # --------------------------------------------------------------------------------
1402             # create copy notes
1403             # --------------------------------------------------------------------------------
1404             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1405                 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1406
1407             if($evt) {
1408                 $$report_args{evt} = $evt;
1409                 respond_with_status($report_args);
1410                 next;
1411             }
1412
1413             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1414                 $e, $copy, '', $item->priv_note, 1) if $item->priv_note;
1415
1416             if($evt) {
1417                 $$report_args{evt} = $evt;
1418                 respond_with_status($report_args);
1419                 next;
1420             }
1421
1422             # --------------------------------------------------------------------------------
1423             # Item import succeeded
1424             # --------------------------------------------------------------------------------
1425             $e->commit;
1426             $$report_args{in_count}++;
1427             respond_with_status($report_args);
1428             $logger->info("vl: successfully imported item " . $item->barcode);
1429         }
1430
1431     }
1432
1433     $roe->rollback;
1434     return undef;
1435 }
1436
1437
1438 sub respond_with_status {
1439     my $args = shift;
1440     my $e = $$args{e};
1441
1442     #  If the import failed, track the failure reason
1443
1444     my $error = $$args{import_error};
1445     my $evt = $$args{evt};
1446
1447     if($error or $evt) {
1448
1449         my $item = $$args{import_item};
1450         $logger->info("vl: unable to import item " . $item->barcode);
1451
1452         $error ||= 'general.unknown';
1453         $item->import_error($error);
1454
1455         if($evt) {
1456             my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1457             $item->error_detail($detail);
1458         }
1459
1460         # state of the editor is unknown at this point.  Force a rollback and start over.
1461         $e->rollback;
1462         $e = new_editor(xact => 1);
1463         $e->update_vandelay_import_item($item);
1464         $e->commit;
1465     }
1466
1467     if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1468         $$args{conn}->respond({
1469             map { $_ => $args->{$_} } qw/total progress success_count/,
1470             err_event => $evt
1471         });
1472         $$args{step} *= 2 unless $$args{step} == 256;
1473     }
1474
1475     $$args{progress}++;
1476 }
1477
1478 __PACKAGE__->register_method(
1479     api_name    => "open-ils.vandelay.match_set.get_tree",
1480     method      => "match_set_get_tree",
1481     api_level   => 1,
1482     argc        => 2,
1483     signature   => {
1484         desc    => q/For a given vms object, return a tree of match set points
1485                     represented by a vmsp object with recursively fleshed
1486                     children./
1487     }
1488 );
1489
1490 sub match_set_get_tree {
1491     my ($self, $conn, $authtoken, $match_set_id) = @_;
1492
1493     $match_set_id = int($match_set_id) or return;
1494
1495     my $e = new_editor("authtoken" => $authtoken);
1496     $e->checkauth or return $e->die_event;
1497
1498     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1499         return $e->die_event;
1500
1501     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1502         return $e->die_event;
1503
1504     my $tree = $e->search_vandelay_match_set_point([
1505         {"match_set" => $match_set_id, "parent" => undef},
1506         {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1507     ]) or return $e->die_event;
1508
1509     return pop @$tree;
1510 }
1511
1512
1513 __PACKAGE__->register_method(
1514     api_name    => "open-ils.vandelay.match_set.update",
1515     method      => "match_set_update_tree",
1516     api_level   => 1,
1517     argc        => 3,
1518     signature   => {
1519         desc => q/Replace any vmsp objects associated with a given (by ID) vms
1520                 with the given objects (recursively fleshed vmsp tree)./
1521     }
1522 );
1523
1524 sub _walk_new_vmsp {
1525     my ($e, $match_set_id, $node, $parent_id) = @_;
1526
1527     my $point = new Fieldmapper::vandelay::match_set_point;
1528     $point->parent($parent_id);
1529     $point->match_set($match_set_id);
1530     $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1531
1532     $e->create_vandelay_match_set_point($point) or return $e->die_event;
1533
1534     $parent_id = $e->data->id;
1535     if ($node->children && @{$node->children}) {
1536         for (@{$node->children}) {
1537             return $e->die_event if
1538                 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1539         }
1540     }
1541
1542     return;
1543 }
1544
1545 sub match_set_update_tree {
1546     my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1547
1548     my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1549     $e->checkauth or return $e->die_event;
1550
1551     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1552         return $e->die_event;
1553
1554     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1555         return $e->die_event;
1556
1557     my $existing = $e->search_vandelay_match_set_point([
1558         {"match_set" => $match_set_id},
1559         {"order_by" => {"vmsp" => "id DESC"}}
1560     ]) or return $e->die_event;
1561
1562     # delete points, working up from leaf points to the root
1563     while(@$existing) {
1564         for my $point (shift @$existing) {
1565             if( grep {$_->parent eq $point->id} @$existing) {
1566                 push(@$existing, $point);
1567             } else {
1568                 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
1569             }
1570         }
1571     }
1572
1573     _walk_new_vmsp($e, $match_set_id, $tree);
1574
1575     $e->commit or return $e->die_event;
1576 }
1577
1578 1;