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