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