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