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