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 OpenILS::Utils::Normalize qw/clean_marc/;
  13 use MARC::Batch;
  14 use MARC::Record;
  15 use MARC::File::XML ( BinaryEncoding => 'UTF-8' );
  16 use Time::HiRes qw(time);
  17 use OpenSRF::Utils::Logger qw/$logger/;
  18 use MIME::Base64;
  19 use OpenILS::Const qw/:const/;
  20 use OpenILS::Application::AppUtils;
  21 use OpenILS::Application::Cat::BibCommon;
  22 use OpenILS::Application::Cat::AuthCommon;
  23 use OpenILS::Application::Cat::AssetCommon;
  24 my $U = 'OpenILS::Application::AppUtils';
  25
  26 # A list of LDR/06 values from http://loc.gov/marc
  27 my %record_types = (
  28         a => 'bib',
  29         c => 'bib',
  30         d => 'bib',
  31         e => 'bib',
  32         f => 'bib',
  33         g => 'bib',
  34         i => 'bib',
  35         j => 'bib',
  36         k => 'bib',
  37         m => 'bib',
  38         o => 'bib',
  39         p => 'bib',
  40         r => 'bib',
  41         t => 'bib',
  42         u => 'holdings',
  43         v => 'holdings',
  44         x => 'holdings',
  45         y => 'holdings',
  46         z => 'auth',
  47       ' ' => 'bib',
  48 );
  49
  50 sub initialize {}
  51 sub child_init {}
  52
  53 # --------------------------------------------------------------------------------
  54 # Biblio ingest
  55
  56 sub create_bib_queue {
  57     my $self = shift;
  58     my $client = shift;
  59     my $auth = shift;
  60     my $name = shift;
  61     my $owner = shift;
  62     my $type = shift;
  63     my $match_set = shift;
  64     my $import_def = shift;
  65
  66     my $e = new_editor(authtoken => $auth, xact => 1);
  67
  68     return $e->die_event unless $e->checkauth;
  69     return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
  70     $owner ||= $e->requestor->id;
  71
  72     if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
  73         $e->rollback;
  74         return OpenILS::Event->new('BIB_QUEUE_EXISTS')
  75     }
  76
  77     my $queue = new Fieldmapper::vandelay::bib_queue();
  78     $queue->name( $name );
  79     $queue->owner( $owner );
  80     $queue->queue_type( $type ) if ($type);
  81     $queue->item_attr_def( $import_def ) if ($import_def);
  82     $queue->match_set($match_set) if $match_set;
  83
  84     my $new_q = $e->create_vandelay_bib_queue( $queue );
  85     return $e->die_event unless ($new_q);
  86     $e->commit;
  87
  88     return $new_q;
  89 }
  90 __PACKAGE__->register_method(
  91     api_name   => "open-ils.vandelay.bib_queue.create",
  92     method     => "create_bib_queue",
  93     api_level  => 1,
  94     argc       => 4,
  95 );
  96
  97
  98 sub create_auth_queue {
  99     my $self = shift;
 100     my $client = shift;
 101     my $auth = shift;
 102     my $name = shift;
 103     my $owner = shift;
 104     my $type = shift;
 105     my $match_set = shift;
 106
 107     my $e = new_editor(authtoken => $auth, xact => 1);
 108
 109     return $e->die_event unless $e->checkauth;
 110     return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
 111     $owner ||= $e->requestor->id;
 112
 113     if ($e->search_vandelay_bib_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
 114         $e->rollback;
 115         return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
 116     }
 117
 118     my $queue = new Fieldmapper::vandelay::authority_queue();
 119     $queue->name( $name );
 120     $queue->owner( $owner );
 121     $queue->queue_type( $type ) if ($type);
 122
 123     my $new_q = $e->create_vandelay_authority_queue( $queue );
 124     $e->die_event unless ($new_q);
 125     $e->commit;
 126
 127     return $new_q;
 128 }
 129 __PACKAGE__->register_method(
 130     api_name   => "open-ils.vandelay.authority_queue.create",
 131     method     => "create_auth_queue",
 132     api_level  => 1,
 133     argc       => 3,
 134 );
 135
 136 sub add_record_to_bib_queue {
 137     my $self = shift;
 138     my $client = shift;
 139     my $auth = shift;
 140     my $queue = shift;
 141     my $marc = shift;
 142     my $purpose = shift;
 143     my $bib_source = shift;
 144
 145     my $e = new_editor(authtoken => $auth, xact => 1);
 146
 147     $queue = $e->retrieve_vandelay_bib_queue($queue);
 148
 149     return $e->die_event unless $e->checkauth;
 150     return $e->die_event unless
 151         ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
 152          $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
 153
 154     my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
 155
 156     return $e->die_event unless ($new_rec);
 157     $e->commit;
 158     return $new_rec;
 159 }
 160 __PACKAGE__->register_method(
 161     api_name   => "open-ils.vandelay.queued_bib_record.create",
 162     method     => "add_record_to_bib_queue",
 163     api_level  => 1,
 164     argc       => 3,
 165 );
 166
 167 sub _add_bib_rec {
 168     my $e = shift;
 169     my $marc = shift;
 170     my $queue = shift;
 171     my $purpose = shift;
 172     my $bib_source = shift;
 173
 174     my $rec = new Fieldmapper::vandelay::queued_bib_record();
 175     $rec->marc( $marc );
 176     $rec->queue( $queue );
 177     $rec->purpose( $purpose ) if ($purpose);
 178     $rec->bib_source($bib_source);
 179
 180     return $e->create_vandelay_queued_bib_record( $rec );
 181 }
 182
 183 sub add_record_to_authority_queue {
 184     my $self = shift;
 185     my $client = shift;
 186     my $auth = shift;
 187     my $queue = shift;
 188     my $marc = shift;
 189     my $purpose = shift;
 190
 191     my $e = new_editor(authtoken => $auth, xact => 1);
 192
 193     $queue = $e->retrieve_vandelay_authority_queue($queue);
 194
 195     return $e->die_event unless $e->checkauth;
 196     return $e->die_event unless
 197         ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
 198          $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
 199
 200     my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
 201
 202     return $e->die_event unless ($new_rec);
 203     $e->commit;
 204     return $new_rec;
 205 }
 206 __PACKAGE__->register_method(
 207     api_name   => "open-ils.vandelay.queued_authority_record.create",
 208     method     => "add_record_to_authority_queue",
 209     api_level  => 1,
 210     argc       => 3,
 211 );
 212
 213 sub _add_auth_rec {
 214     my $e = shift;
 215     my $marc = shift;
 216     my $queue = shift;
 217     my $purpose = shift;
 218
 219     my $rec = new Fieldmapper::vandelay::queued_authority_record();
 220     $rec->marc( $marc );
 221     $rec->queue( $queue );
 222     $rec->purpose( $purpose ) if ($purpose);
 223
 224     return $e->create_vandelay_queued_authority_record( $rec );
 225 }
 226
 227 sub process_spool {
 228     my $self = shift;
 229     my $client = shift;
 230     my $auth = shift;
 231     my $fingerprint = shift || '';
 232     my $queue_id = shift;
 233     my $purpose = shift;
 234     my $filename = shift;
 235     my $bib_source = shift;
 236
 237     my $e = new_editor(authtoken => $auth, xact => 1);
 238     return $e->die_event unless $e->checkauth;
 239
 240     my $queue;
 241     my $type = $self->{record_type};
 242
 243     if($type eq 'bib') {
 244         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
 245     } else {
 246         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
 247     }
 248
 249     my $evt = check_queue_perms($e, $type, $queue);
 250     return $evt if ($evt);
 251
 252     my $cache = new OpenSRF::Utils::Cache();
 253
 254     if($fingerprint) {
 255         my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
 256         $purpose = $data->{purpose};
 257         $filename = $data->{path};
 258         $bib_source = $data->{bib_source};
 259     }
 260
 261     unless(-r $filename) {
 262         $logger->error("unable to read MARC file $filename");
 263         return -1; # make this an event XXX
 264     }
 265
 266     $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
 267
 268     my $marctype = 'USMARC';
 269
 270     open F, $filename;
 271     $marctype = 'XML' if (getc(F) =~ /^\D/o);
 272     close F;
 273
 274     my $batch = new MARC::Batch ($marctype, $filename);
 275     $batch->strict_off;
 276
 277     my $response_scale = 10;
 278     my $count = 0;
 279     my $r = -1;
 280     while (try { $r = $batch->next } otherwise { $r = -1 }) {
 281         if ($r == -1) {
 282             $logger->warn("Processing of record $count in set $filename failed.  Skipping this record");
 283             $count++;
 284         }
 285
 286         $logger->info("processing record $count");
 287
 288         try {
 289             my $xml = clean_marc($r);
 290
 291             my $qrec;
 292             # Check the leader to ensure we've got something resembling the expected
 293             # Allow spaces to give records the benefit of the doubt
 294             my $ldr_type = substr($r->leader(), 6, 1);
 295             if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
 296                 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
 297             } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
 298                 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
 299             } else {
 300                 # I don't know how to handle this type; rock on
 301                 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
 302                 next;
 303             }
 304
 305             if($self->api_name =~ /stream_results/ and $qrec) {
 306                 $client->respond($qrec->id)
 307             } else {
 308                 $client->respond($count) if (++$count % $response_scale) == 0;
 309                 $response_scale *= 10 if ($count == ($response_scale * 10));
 310             }
 311         } catch Error with {
 312             my $error = shift;
 313             $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
 314         }
 315     }
 316
 317     $e->commit;
 318     unlink($filename);
 319     $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
 320     return $count;
 321 }
 322
 323 __PACKAGE__->register_method(
 324     api_name    => "open-ils.vandelay.bib.process_spool",
 325     method      => "process_spool",
 326     api_level   => 1,
 327     argc        => 3,
 328     max_chunk_size => 0,
 329     record_type => 'bib'
 330 );
 331 __PACKAGE__->register_method(
 332     api_name    => "open-ils.vandelay.auth.process_spool",
 333     method      => "process_spool",
 334     api_level   => 1,
 335     argc        => 3,
 336     max_chunk_size => 0,
 337     record_type => 'auth'
 338 );
 339
 340 __PACKAGE__->register_method(
 341     api_name    => "open-ils.vandelay.bib.process_spool.stream_results",
 342     method      => "process_spool",
 343     api_level   => 1,
 344     argc        => 3,
 345     stream      => 1,
 346     max_chunk_size => 0,
 347     record_type => 'bib'
 348 );
 349 __PACKAGE__->register_method(
 350     api_name    => "open-ils.vandelay.auth.process_spool.stream_results",
 351     method      => "process_spool",
 352     api_level   => 1,
 353     argc        => 3,
 354     stream      => 1,
 355     max_chunk_size => 0,
 356     record_type => 'auth'
 357 );
 358
 359 __PACKAGE__->register_method(
 360     api_name    => "open-ils.vandelay.bib_queue.records.retrieve",
 361     method      => 'retrieve_queued_records',
 362     api_level   => 1,
 363     argc        => 2,
 364     stream      => 1,
 365     record_type => 'bib'
 366 );
 367 __PACKAGE__->register_method(
 368     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.export.print",
 369     method      => 'retrieve_queued_records',
 370     api_level   => 1,
 371     argc        => 2,
 372     stream      => 1,
 373     record_type => 'bib'
 374 );
 375 __PACKAGE__->register_method(
 376     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.export.csv",
 377     method      => 'retrieve_queued_records',
 378     api_level   => 1,
 379     argc        => 2,
 380     stream      => 1,
 381     record_type => 'bib'
 382 );
 383 __PACKAGE__->register_method(
 384     api_name    => "open-ils.vandelay.bib_queue.records.retrieve.export.email",
 385     method      => 'retrieve_queued_records',
 386     api_level   => 1,
 387     argc        => 2,
 388     stream      => 1,
 389     record_type => 'bib'
 390 );
 391
 392 __PACKAGE__->register_method(
 393     api_name    => "open-ils.vandelay.auth_queue.records.retrieve",
 394     method      => 'retrieve_queued_records',
 395     api_level   => 1,
 396     argc        => 2,
 397     stream      => 1,
 398     record_type => 'auth'
 399 );
 400 __PACKAGE__->register_method(
 401     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.export.print",
 402     method      => 'retrieve_queued_records',
 403     api_level   => 1,
 404     argc        => 2,
 405     stream      => 1,
 406     record_type => 'auth'
 407 );
 408 __PACKAGE__->register_method(
 409     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.export.csv",
 410     method      => 'retrieve_queued_records',
 411     api_level   => 1,
 412     argc        => 2,
 413     stream      => 1,
 414     record_type => 'auth'
 415 );
 416 __PACKAGE__->register_method(
 417     api_name    => "open-ils.vandelay.auth_queue.records.retrieve.export.email",
 418     method      => 'retrieve_queued_records',
 419     api_level   => 1,
 420     argc        => 2,
 421     stream      => 1,
 422     record_type => 'auth'
 423 );
 424
 425 __PACKAGE__->register_method(
 426     api_name    => "open-ils.vandelay.bib_queue.records.matches.retrieve",
 427     method      => 'retrieve_queued_records',
 428     api_level   => 1,
 429     argc        => 2,
 430     stream      => 1,
 431     record_type => 'bib',
 432     signature   => {
 433         desc => q/Only retrieve queued bib records that have matches against existing records/
 434     }
 435 );
 436 __PACKAGE__->register_method(
 437     api_name    => "open-ils.vandelay.auth_queue.records.matches.retrieve",
 438     method      => 'retrieve_queued_records',
 439     api_level   => 1,
 440     argc        => 2,
 441     stream      => 1,
 442     record_type => 'auth',
 443     signature   => {
 444         desc => q/Only retrieve queued authority records that have matches against existing records/
 445     }
 446 );
 447
 448 sub retrieve_queued_records {
 449     my($self, $conn, $auth, $queue_id, $options) = @_;
 450
 451     $options ||= {};
 452     my $limit = $$options{limit} || 20;
 453     my $offset = $$options{offset} || 0;
 454     my $type = $self->{record_type};
 455
 456     my $e = new_editor(authtoken => $auth, xact => 1);
 457     return $e->die_event unless $e->checkauth;
 458
 459     my $queue;
 460     if($type eq 'bib') {
 461         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
 462     } else {
 463         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
 464     }
 465     my $evt = check_queue_perms($e, $type, $queue);
 466     return $evt if ($evt);
 467
 468     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
 469     my $query = {
 470         select => {$class => ['id']},
 471         from => $class,
 472         where => {queue => $queue_id},
 473         distinct => 1,
 474         order_by => {$class => ['id']},
 475         limit => $limit,
 476         offset => $offset,
 477     };
 478     if($self->api_name =~ /export/) {
 479         delete $query->{limit};
 480         delete $query->{offset};
 481     }
 482
 483     $query->{where}->{import_time} = undef if $$options{non_imported};
 484
 485     if($$options{with_import_error}) {
 486
 487         $query->{from} = {$class => {vii => {type => 'left'}}};
 488         $query->{where}->{'-or'} = [
 489             {'+vqbr' => {import_error => {'!=' => undef}}},
 490             {'+vii' => {import_error => {'!=' => undef}}}
 491         ];
 492
 493     } else {
 494
 495         if($$options{with_rec_import_error}) {
 496             $query->{where}->{import_error} = {'!=' => undef};
 497
 498         } elsif( $$options{with_item_import_error} and $type eq 'bib') {
 499
 500             $query->{from} = {$class => 'vii'};
 501             $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
 502         }
 503     }
 504
 505     if($self->api_name =~ /matches/) {
 506         # find only records that have matches
 507         my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
 508         $query->{from} = {$class => {$mclass => {type => 'right'}}};
 509     }
 510
 511     my $record_ids = $e->json_query($query);
 512
 513     my $retrieve = ($type eq 'bib') ?
 514         'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
 515     my $search = ($type eq 'bib') ?
 516         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
 517
 518     if ($self->api_name =~ /export/) {
 519         my $rec_list = $e->$search({id => [map { $_->{id} } @$record_ids]}, {substream => 1});
 520         if ($self->api_name =~ /print/) {
 521
 522             $e->rollback;
 523             return $U->fire_object_event(
 524                 undef,
 525                 'vandelay.queued_'.$type.'_record.print',
 526                 $rec_list,
 527                 $e->requestor->ws_ou
 528             );
 529
 530         } elsif ($self->api_name =~ /csv/) {
 531
 532             $e->rollback;
 533             return $U->fire_object_event(
 534                 undef,
 535                 'vandelay.queued_'.$type.'_record.csv',
 536                 $rec_list,
 537                 $e->requestor->ws_ou
 538             );
 539
 540         } elsif ($self->api_name =~ /email/) {
 541
 542             $conn->respond_complete(1);
 543
 544             for my $rec (@$rec_list) {
 545                 $U->create_events_for_hook(
 546                     'vandelay.queued_'.$type.'_record.email',
 547                     $rec,
 548                     $e->requestor->home_ou,
 549                     undef,
 550                     undef,
 551                     1
 552                 );
 553             }
 554
 555         }
 556     } else {
 557         for my $rec_id (@$record_ids) {
 558             my $flesh = ['attributes', 'matches'];
 559             push(@$flesh, 'import_items') if $$options{flesh_import_items};
 560             my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
 561             my $rec = $e->$retrieve([$rec_id->{id}, $params]);
 562             $rec->clear_marc if $$options{clear_marc};
 563             $conn->respond($rec);
 564         }
 565     }
 566
 567     $e->rollback;
 568     return undef;
 569 }
 570
 571 __PACKAGE__->register_method(
 572     api_name    => 'open-ils.vandelay.import_item.queue.retrieve',
 573     method      => 'retrieve_queue_import_items',
 574     api_level   => 1,
 575     argc        => 2,
 576     stream      => 1,
 577     authoritative => 1,
 578     signature => q/
 579         Returns Import Item (vii) objects for the selected queue.
 580         Filter options:
 581             with_import_error : only return items that failed to import
 582     /
 583 );
 584 __PACKAGE__->register_method(
 585     api_name    => 'open-ils.vandelay.import_item.queue.export.print',
 586     method      => 'retrieve_queue_import_items',
 587     api_level   => 1,
 588     argc        => 2,
 589     stream      => 1,
 590     authoritative => 1,
 591     signature => q/
 592         Returns template-generated printable output of Import Item (vii) objects for the selected queue.
 593         Filter options:
 594             with_import_error : only return items that failed to import
 595     /
 596 );
 597 __PACKAGE__->register_method(
 598     api_name    => 'open-ils.vandelay.import_item.queue.export.csv',
 599     method      => 'retrieve_queue_import_items',
 600     api_level   => 1,
 601     argc        => 2,
 602     stream      => 1,
 603     authoritative => 1,
 604     signature => q/
 605         Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
 606         Filter options:
 607             with_import_error : only return items that failed to import
 608     /
 609 );
 610 __PACKAGE__->register_method(
 611     api_name    => 'open-ils.vandelay.import_item.queue.export.email',
 612     method      => 'retrieve_queue_import_items',
 613     api_level   => 1,
 614     argc        => 2,
 615     stream      => 1,
 616     authoritative => 1,
 617     signature => q/
 618         Emails template-generated output of Import Item (vii) objects for the selected queue.
 619         Filter options:
 620             with_import_error : only return items that failed to import
 621     /
 622 );
 623
 624 sub retrieve_queue_import_items {
 625     my($self, $conn, $auth, $q_id, $options) = @_;
 626
 627     $options ||= {};
 628     my $limit = $$options{limit} || 20;
 629     my $offset = $$options{offset} || 0;
 630
 631     my $e = new_editor(authtoken => $auth);
 632     return $e->event unless $e->checkauth;
 633
 634     my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
 635     my $evt = check_queue_perms($e, 'bib', $queue);
 636     return $evt if $evt;
 637
 638     my $query = {
 639         select => {vii => ['id']},
 640         from => {
 641             vii => {
 642                 vqbr => {
 643                     join => {
 644                         'vbq' => {
 645                             field => 'id',
 646                             fkey => 'queue',
 647                             filter => {id => $q_id}
 648                         }
 649                     }
 650                 }
 651             }
 652         },
 653         order_by => {'vii' => ['record','id']},
 654         limit => $limit,
 655         offset => $offset
 656     };
 657     if($self->api_name =~ /export/) {
 658         delete $query->{limit};
 659         delete $query->{offset};
 660     }
 661
 662     $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
 663         if $$options{with_import_error};
 664
 665     my $items = $e->json_query($query);
 666     my $item_list = $e->search_vandelay_import_item({id => [map { $_->{id} } @$items]});
 667     if ($self->api_name =~ /export/) {
 668         if ($self->api_name =~ /print/) {
 669
 670             return $U->fire_object_event(
 671                 undef,
 672                 'vandelay.import_items.print',
 673                 $item_list,
 674                 $e->requestor->ws_ou
 675             );
 676
 677         } elsif ($self->api_name =~ /csv/) {
 678
 679             return $U->fire_object_event(
 680                 undef,
 681                 'vandelay.import_items.csv',
 682                 $item_list,
 683                 $e->requestor->ws_ou
 684             );
 685
 686         } elsif ($self->api_name =~ /email/) {
 687
 688             $conn->respond_complete(1);
 689
 690             for my $item (@$item_list) {
 691                 $U->create_events_for_hook(
 692                     'vandelay.import_items.email',
 693                     $item,
 694                     $e->requestor->home_ou,
 695                     undef,
 696                     undef,
 697                     1
 698                 );
 699             }
 700
 701         }
 702     } else {
 703         for my $item (@$item_list) {
 704             $conn->respond($item);
 705         }
 706     }
 707
 708     return undef;
 709 }
 710
 711 sub check_queue_perms {
 712     my($e, $type, $queue) = @_;
 713     if ($type eq 'bib') {
 714         return $e->die_event unless
 715             ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
 716              $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
 717     } else {
 718         return $e->die_event unless
 719             ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
 720              $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
 721     }
 722
 723     return undef;
 724 }
 725
 726 __PACKAGE__->register_method(
 727     api_name    => "open-ils.vandelay.bib_record.list.import",
 728     method      => 'import_record_list',
 729     api_level   => 1,
 730     argc        => 2,
 731     stream      => 1,
 732     record_type => 'bib'
 733 );
 734
 735 __PACKAGE__->register_method(
 736     api_name    => "open-ils.vandelay.auth_record.list.import",
 737     method      => 'import_record_list',
 738     api_level   => 1,
 739     argc        => 2,
 740     stream      => 1,
 741     record_type => 'auth'
 742 );
 743
 744 sub import_record_list {
 745     my($self, $conn, $auth, $rec_ids, $args) = @_;
 746     my $e = new_editor(authtoken => $auth, xact => 1);
 747     return $e->die_event unless $e->checkauth;
 748     $args ||= {};
 749     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
 750     try {$e->rollback} otherwise {};
 751     return $err if $err;
 752     return {complete => 1};
 753 }
 754
 755
 756 __PACKAGE__->register_method(
 757     api_name    => "open-ils.vandelay.bib_queue.import",
 758     method      => 'import_queue',
 759     api_level   => 1,
 760     argc        => 2,
 761     stream      => 1,
 762     max_chunk_size => 0,
 763     record_type => 'bib',
 764     signature => {
 765         desc => q/
 766             Attempts to import all non-imported records for the selected queue.
 767             Will also attempt import of all non-imported items.
 768         /
 769     }
 770 );
 771
 772 __PACKAGE__->register_method(
 773     api_name    => "open-ils.vandelay.auth_queue.import",
 774     method      => 'import_queue',
 775     api_level   => 1,
 776     argc        => 2,
 777     stream      => 1,
 778     max_chunk_size => 0,
 779     record_type => 'auth'
 780 );
 781
 782 sub import_queue {
 783     my($self, $conn, $auth, $q_id, $options) = @_;
 784     my $e = new_editor(authtoken => $auth, xact => 1);
 785     return $e->die_event unless $e->checkauth;
 786     $options ||= {};
 787     my $type = $self->{record_type};
 788     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
 789
 790     # First, collect the not-yet-imported records
 791     my $query = {queue => $q_id, import_time => undef};
 792     my $search = ($type eq 'bib') ?
 793         'search_vandelay_queued_bib_record' :
 794         'search_vandelay_queued_authority_record';
 795     my $rec_ids = $e->$search($query, {idlist => 1});
 796
 797     # Now add any imported records that have un-imported items
 798
 799     if($type eq 'bib') {
 800         my $item_recs = $e->json_query({
 801             select => {vqbr => ['id']},
 802             from => {vqbr => 'vii'},
 803             where => {
 804                 '+vqbr' => {
 805                     queue => $q_id,
 806                     import_time => {'!=' => undef}
 807                 },
 808                 '+vii' => {import_time => undef}
 809             },
 810             distinct => 1
 811         });
 812         push(@$rec_ids, map {$_->{id}} @$item_recs);
 813     }
 814
 815     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
 816     try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
 817     return $err if $err;
 818     return {complete => 1};
 819 }
 820
 821 # returns a list of queued record IDs for a given queue that
 822 # have at least one entry in the match table
 823 # XXX DEPRECATED?
 824 sub queued_records_with_matches {
 825     my($e, $type, $q_id, $limit, $offset, $filter) = @_;
 826
 827     my $match_class = 'vbm';
 828     my $rec_class = 'vqbr';
 829     if($type eq 'auth') {
 830         $match_class = 'vam';
 831          $rec_class = 'vqar';
 832     }
 833
 834     $filter ||= {};
 835     $filter->{queue} = $q_id;
 836
 837     my $query = {
 838         distinct => 1,
 839         select => {$match_class => ['queued_record']},
 840         from => {
 841             $match_class => {
 842                 $rec_class => {
 843                     field => 'id',
 844                     fkey => 'queued_record',
 845                     filter => $filter,
 846                 }
 847             }
 848         }
 849     };
 850
 851     if($limit or defined $offset) {
 852         $limit ||= 20;
 853         $offset ||= 0;
 854         $query->{limit} = $limit;
 855         $query->{offset} = $offset;
 856     }
 857
 858     my $data = $e->json_query($query);
 859     return [ map {$_->{queued_record}} @$data ];
 860 }
 861
 862
 863 sub import_record_list_impl {
 864     my($self, $conn, $rec_ids, $requestor, $args) = @_;
 865
 866     my $overlay_map = $args->{overlay_map} || {};
 867     my $type = $self->{record_type};
 868     my %queues;
 869
 870     my $report_args = {
 871         progress => 1,
 872         step => 1,
 873         conn => $conn,
 874         total => scalar(@$rec_ids),
 875         report_all => $$args{report_all}
 876     };
 877
 878     my $auto_overlay_exact = $$args{auto_overlay_exact};
 879     my $auto_overlay_1match = $$args{auto_overlay_1match};
 880     my $auto_overlay_best = $$args{auto_overlay_best_match};
 881     my $match_quality_ratio = $$args{match_quality_ratio};
 882     my $merge_profile = $$args{merge_profile};
 883     my $ft_merge_profile = $$args{fall_through_merge_profile};
 884     my $bib_source = $$args{bib_source};
 885     my $import_no_match = $$args{import_no_match};
 886
 887     my $overlay_func = 'vandelay.overlay_bib_record';
 888     my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
 889     my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best'; # XXX bib-only
 890     my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
 891     my $update_func = 'update_vandelay_queued_bib_record';
 892     my $search_func = 'search_vandelay_queued_bib_record';
 893     my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
 894     my $update_queue_func = 'update_vandelay_bib_queue';
 895     my $rec_class = 'vqbr';
 896
 897     my $editor = new_editor();
 898
 899     my %bib_sources;
 900     my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
 901     $bib_sources{$_->id} = $_->source for @$sources;
 902
 903     if($type eq 'auth') {
 904         $overlay_func =~ s/bib/auth/o;
 905         $auto_overlay_func = s/bib/auth/o;
 906         $retrieve_func =~ s/bib/authority/o;
 907         $retrieve_queue_func =~ s/bib/authority/o;
 908         $update_queue_func =~ s/bib/authority/o;
 909         $update_func =~ s/bib/authority/o;
 910         $search_func =~ s/bib/authority/o;
 911         $rec_class = 'vqar';
 912     }
 913
 914     my @success_rec_ids;
 915     for my $rec_id (@$rec_ids) {
 916
 917         my $error = 0;
 918         my $overlay_target = $overlay_map->{$rec_id};
 919
 920         my $e = new_editor(xact => 1);
 921         $e->requestor($requestor);
 922
 923         $$report_args{e} = $e;
 924         $$report_args{evt} = undef;
 925         $$report_args{import_error} = undef;
 926
 927         my $rec = $e->$retrieve_func([
 928             $rec_id,
 929             {   flesh => 1,
 930                 flesh_fields => { $rec_class => ['matches']},
 931             }
 932         ]);
 933
 934         unless($rec) {
 935             $$report_args{evt} = $e->event;
 936             finish_rec_import_attempt($report_args);
 937             next;
 938         }
 939
 940         if($rec->import_time) {
 941             # if the record is already imported, that means it may have
 942             # un-imported copies.  Add to success list for later processing.
 943             push(@success_rec_ids, $rec_id);
 944             $e->rollback;
 945             next;
 946         }
 947
 948         $$report_args{rec} = $rec;
 949         $queues{$rec->queue} = 1;
 950
 951         my $record;
 952         my $imported = 0;
 953
 954         if(defined $overlay_target) {
 955             # Caller chose an explicit overlay target
 956
 957             my $res = $e->json_query(
 958                 {
 959                     from => [
 960                         $overlay_func,
 961                         $rec_id,
 962                         $overlay_target,
 963                         $merge_profile
 964                     ]
 965                 }
 966             );
 967
 968             if($res and ($res = $res->[0])) {
 969
 970                 if($res->{$overlay_func} eq 't') {
 971                     $logger->info("vl: $type direct overlay succeeded for queued rec ".
 972                         "$rec_id and overlay target $overlay_target");
 973                     $imported = 1;
 974                 }
 975
 976             } else {
 977                 $error = 1;
 978                 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
 979             }
 980
 981         } else {
 982
 983             if($auto_overlay_1match) { # overlay if there is exactly 1 match
 984
 985                 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
 986
 987                 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
 988
 989                     ($imported, $error, $rec) = try_auto_overlay(
 990                         $e, $type,
 991                         $report_args,
 992                         $auto_overlay_best_func,
 993                         $retrieve_func,
 994                         $rec_class,
 995                         $rec_id,
 996                         $match_quality_ratio,
 997                         $merge_profile,
 998                         $ft_merge_profile
 999                     );
1000                 }
1001             }
1002
1003             if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1004
1005                 # caller says to overlay if there is an /exact/ match
1006                 # $auto_overlay_func only proceeds and returns true on exact matches
1007
1008                 my $res = $e->json_query(
1009                     {
1010                         from => [
1011                             $auto_overlay_func,
1012                             $rec_id,
1013                             $merge_profile
1014                         ]
1015                     }
1016                 );
1017
1018                 if($res and ($res = $res->[0])) {
1019
1020                     if($res->{$auto_overlay_func} eq 't') {
1021                         $logger->info("vl: $type auto-overlay succeeded for queued rec $rec_id");
1022                         $imported = 1;
1023
1024                         # re-fetch the record to pick up the imported_as value from the DB
1025                         $$report_args{rec} = $rec = $e->$retrieve_func([
1026                             $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1027
1028                     } else {
1029                         $logger->info("vl: $type auto-overlay failed for queued rec $rec_id");
1030                     }
1031
1032                 } else {
1033                     $error = 1;
1034                     $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1035                 }
1036             }
1037
1038             if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1039                 # caller says to overlay the best match
1040
1041                 ($imported, $error, $rec) = try_auto_overlay(
1042                     $e, $type,
1043                     $report_args,
1044                     $auto_overlay_best_func,
1045                     $retrieve_func,
1046                     $rec_class,
1047                     $rec_id,
1048                     $match_quality_ratio,
1049                     $merge_profile,
1050                     $ft_merge_profile
1051                 );
1052             }
1053
1054             if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1055
1056                 # No overlay / merge occurred.  Do a traditional record import by creating a new record
1057
1058                 $logger->info("vl: creating new $type record for queued record $rec_id");
1059                 if($type eq 'bib') {
1060                     $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1061                         $e, $rec->marc, $bib_sources{$rec->bib_source}, undef, 1);
1062                 } else {
1063
1064                     $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1065                 }
1066
1067                 if($U->event_code($record)) {
1068                     $$report_args{import_error} = 'import.duplicate.tcn'
1069                         if $record->{textcode} eq 'OPEN_TCN_NOT_FOUND';
1070                     $$report_args{evt} = $record;
1071
1072                 } else {
1073
1074                     $logger->info("vl: successfully imported new $type record");
1075                     $rec->imported_as($record->id);
1076                     $imported = 1;
1077                 }
1078             }
1079         }
1080
1081         if($imported) {
1082
1083             $rec->import_time('now');
1084             $rec->clear_import_error;
1085             $rec->clear_error_detail;
1086
1087             if($e->$update_func($rec)) {
1088
1089                 push @success_rec_ids, $rec_id;
1090                 finish_rec_import_attempt($report_args);
1091
1092             } else {
1093                 $imported = 0;
1094             }
1095         }
1096
1097         if(!$imported) {
1098             $logger->info("vl: record $rec_id was not imported");
1099             $$report_args{evt} = $e->event unless $$report_args{evt};
1100             finish_rec_import_attempt($report_args);
1101         }
1102     }
1103
1104     # see if we need to mark any queues as complete
1105     for my $q_id (keys %queues) {
1106
1107         my $e = new_editor(xact => 1);
1108         my $remaining = $e->$search_func(
1109             [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1110
1111         unless(@$remaining) {
1112             my $queue = $e->$retrieve_queue_func($q_id);
1113
1114             unless($U->is_true($queue->complete)) {
1115                 $queue->complete('t');
1116                 $e->$update_queue_func($queue) or return $e->die_event;
1117                 $e->commit;
1118                 next;
1119             }
1120         }
1121         $e->rollback;
1122     }
1123
1124     # import the copies
1125     import_record_asset_list_impl($conn, \@success_rec_ids, $requestor) if @success_rec_ids;
1126
1127     $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1128     return undef;
1129 }
1130
1131
1132 sub try_auto_overlay {
1133     my $e = shift;
1134     my $type = shift;
1135     my $report_args = shift;
1136     my $overlay_func  = shift;
1137     my $retrieve_func = shift;
1138     my $rec_class = shift;
1139     my $rec_id  = shift;
1140     my $match_quality_ratio = shift;
1141     my $merge_profile  = shift;
1142     my $ft_merge_profile = shift;
1143
1144     my $imported = 0;
1145     my $error = 0;
1146
1147     # Find the best match and overlay if the quality ratio allows it.
1148     my $res = $e->json_query(
1149         {
1150             from => [
1151                 $overlay_func,
1152                 $rec_id,
1153                 $merge_profile,
1154                 $match_quality_ratio
1155             ]
1156         }
1157     );
1158
1159     if($res and ($res = $res->[0])) {
1160
1161         if($res->{$overlay_func} eq 't') {
1162
1163             # first attempt succeeded
1164             $imported = 1;
1165
1166         } else {
1167
1168             # quality-limited merge failed with insufficient quality.  If there is a
1169             # fall-through merge profile, re-do the merge with the alternate profile
1170             # and no quality restriction.
1171
1172             if($ft_merge_profile and $match_quality_ratio > 0) {
1173
1174                 $logger->info("vl: $type auto-merge failed with profile $merge_profile; ".
1175                     "re-merging with fall-through profile $ft_merge_profile");
1176
1177                 my $res = $e->json_query(
1178                     {
1179                         from => [
1180                             $overlay_func,
1181                             $rec_id,
1182                             $ft_merge_profile,
1183                             0 # minimum quality not required
1184                         ]
1185                     }
1186                 );
1187
1188                 if($res and ($res = $res->[0])) {
1189
1190                     if($res->{$overlay_func} eq 't') {
1191
1192                         # second attempt succeeded
1193                         $imported = 1;
1194
1195                     } else {
1196
1197                         # failed to merge on second attempt
1198                         $logger->info("vl: $type auto-merge with fall-through failed for queued rec $rec_id");
1199                     }
1200                 } else {
1201
1202                     # second attempt died
1203                     $error = 1;
1204                     $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1205                 }
1206
1207             } else {
1208
1209                 # failed to merge on first attempt, no fall-through was provided
1210                 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1211                 $logger->info("vl: $type auto-merge failed for queued rec $rec_id");
1212             }
1213         }
1214
1215     } else {
1216
1217         # first attempt died
1218         $error = 1;
1219         $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1220     }
1221
1222     if($imported) {
1223
1224         # at least 1 of the attempts succeeded
1225         $logger->info("vl: $type auto-merge succeeded for queued rec $rec_id");
1226
1227         # re-fetch the record to pick up the imported_as value from the DB
1228         $$report_args{rec} = $e->$retrieve_func([
1229             $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1230     }
1231
1232     return ($imported, $error, $$report_args{rec});
1233 }
1234
1235
1236 # tracks any import errors, commits the current xact, responds to the client
1237 sub finish_rec_import_attempt {
1238     my $args = shift;
1239     my $evt = $$args{evt};
1240     my $rec = $$args{rec};
1241     my $e = $$args{e};
1242
1243     my $error = $$args{import_error};
1244     $error = 'general.unknown' if $evt and not $error;
1245
1246     # error tracking
1247     if($rec) {
1248
1249         if($error or $evt) {
1250             # failed import
1251             # since an error occurred, there's no guarantee the transaction wasn't
1252             # rolled back.  force a rollback and create a new editor.
1253             $e->rollback;
1254             $e = new_editor(xact => 1);
1255             $rec->import_error($error);
1256
1257             if($evt) {
1258                 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1259                 $rec->error_detail($detail);
1260             }
1261
1262             my $method = 'update_vandelay_queued_bib_record';
1263             $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1264             $e->$method($rec) and $e->commit or $e->rollback;
1265
1266         } else {
1267             # commit the successful import
1268             $e->commit;
1269         }
1270
1271     } else {
1272         # requested queued record was not found
1273         $e->rollback;
1274     }
1275
1276     # respond to client
1277     if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1278         $$args{conn}->respond({
1279             total => $$args{total},
1280             progress => $$args{progress},
1281             imported => ($rec) ? $rec->id : undef,
1282             err_event => $evt
1283         });
1284         $$args{step} *= 2 unless $$args{step} == 256;
1285     }
1286
1287     $$args{progress}++;
1288 }
1289
1290
1291
1292
1293
1294 __PACKAGE__->register_method(
1295     api_name    => "open-ils.vandelay.bib_queue.owner.retrieve",
1296     method      => 'owner_queue_retrieve',
1297     api_level   => 1,
1298     argc        => 2,
1299     stream      => 1,
1300     record_type => 'bib'
1301 );
1302 __PACKAGE__->register_method(
1303     api_name    => "open-ils.vandelay.authority_queue.owner.retrieve",
1304     method      => 'owner_queue_retrieve',
1305     api_level   => 1,
1306     argc        => 2,
1307     stream      => 1,
1308     record_type => 'auth'
1309 );
1310
1311 sub owner_queue_retrieve {
1312     my($self, $conn, $auth, $owner_id, $filters) = @_;
1313     my $e = new_editor(authtoken => $auth, xact => 1);
1314     return $e->die_event unless $e->checkauth;
1315     $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1316     my $queues;
1317     $filters ||= {};
1318     my $search = {owner => $owner_id};
1319     $search->{$_} = $filters->{$_} for keys %$filters;
1320
1321     if($self->{record_type} eq 'bib') {
1322         $queues = $e->search_vandelay_bib_queue(
1323             [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1324     } else {
1325         $queues = $e->search_vandelay_authority_queue(
1326             [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1327     }
1328     $conn->respond($_) for @$queues;
1329     $e->rollback;
1330     return undef;
1331 }
1332
1333 __PACKAGE__->register_method(
1334     api_name    => "open-ils.vandelay.bib_queue.delete",
1335     method      => "delete_queue",
1336     api_level   => 1,
1337     argc        => 2,
1338     record_type => 'bib'
1339 );
1340 __PACKAGE__->register_method(
1341     api_name    => "open-ils.vandelay.auth_queue.delete",
1342     method      => "delete_queue",
1343     api_level   => 1,
1344     argc        => 2,
1345     record_type => 'auth'
1346 );
1347
1348 sub delete_queue {
1349     my($self, $conn, $auth, $q_id) = @_;
1350     my $e = new_editor(xact => 1, authtoken => $auth);
1351     return $e->die_event unless $e->checkauth;
1352     if($self->{record_type} eq 'bib') {
1353         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1354         my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1355             or return $e->die_event;
1356         $e->delete_vandelay_bib_queue($queue)
1357             or return $e->die_event;
1358     } else {
1359            return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1360         my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1361             or return $e->die_event;
1362         $e->delete_vandelay_authority_queue($queue)
1363             or return $e->die_event;
1364     }
1365     $e->commit;
1366     return 1;
1367 }
1368
1369
1370 __PACKAGE__->register_method(
1371     api_name    => "open-ils.vandelay.queued_bib_record.html",
1372     method      => 'queued_record_html',
1373     api_level   => 1,
1374     argc        => 2,
1375     stream      => 1,
1376     record_type => 'bib'
1377 );
1378 __PACKAGE__->register_method(
1379     api_name    => "open-ils.vandelay.queued_authority_record.html",
1380     method      => 'queued_record_html',
1381     api_level   => 1,
1382     argc        => 2,
1383     stream      => 1,
1384     record_type => 'auth'
1385 );
1386
1387 sub queued_record_html {
1388     my($self, $conn, $auth, $rec_id) = @_;
1389     my $e = new_editor(xact=>1,authtoken => $auth);
1390     return $e->die_event unless $e->checkauth;
1391     my $rec;
1392     if($self->{record_type} eq 'bib') {
1393         $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1394             or return $e->die_event;
1395     } else {
1396         $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1397             or return $e->die_event;
1398     }
1399
1400     $e->rollback;
1401     return $U->simplereq(
1402         'open-ils.search',
1403         'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1404 }
1405
1406
1407 __PACKAGE__->register_method(
1408     api_name    => "open-ils.vandelay.bib_queue.summary.retrieve",
1409     method      => 'retrieve_queue_summary',
1410     api_level   => 1,
1411     argc        => 2,
1412     stream      => 1,
1413     record_type => 'bib'
1414 );
1415 __PACKAGE__->register_method(
1416     api_name    => "open-ils.vandelay.auth_queue.summary.retrieve",
1417     method      => 'retrieve_queue_summary',
1418     api_level   => 1,
1419     argc        => 2,
1420     stream      => 1,
1421     record_type => 'auth'
1422 );
1423
1424 sub retrieve_queue_summary {
1425     my($self, $conn, $auth, $queue_id) = @_;
1426     my $e = new_editor(xact=>1, authtoken => $auth);
1427     return $e->die_event unless $e->checkauth;
1428
1429     my $queue;
1430     my $type = $self->{record_type};
1431     if($type eq 'bib') {
1432         $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1433             or return $e->die_event;
1434     } else {
1435         $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1436             or return $e->die_event;
1437     }
1438
1439     my $evt = check_queue_perms($e, $type, $queue);
1440     return $evt if $evt;
1441
1442     my $search = 'search_vandelay_queued_bib_record';
1443     $search =~ s/bib/authority/ if $type ne 'bib';
1444
1445     my $summary = {
1446         queue => $queue,
1447         total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1448         imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1449     };
1450
1451     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1452     $summary->{rec_import_errors} = $e->json_query({
1453         select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1454         from => $class,
1455         where => {queue => $queue_id, import_error => {'!=' => undef}}
1456     })->[0]->{count};
1457
1458     if($type eq 'bib') {
1459
1460         # count of all items attached to records in the queue in question
1461         my $query = {
1462             select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1463             from => 'vii',
1464             where => {
1465                 record => {
1466                     in => {
1467                         select => {vqbr => ['id']},
1468                         from => 'vqbr',
1469                         where => {queue => $queue_id}
1470                     }
1471                 }
1472             }
1473         };
1474         $summary->{total_items} = $e->json_query($query)->[0]->{count};
1475
1476         # count of items we attempted to import, but errored, attached to records in the queue in question
1477         $query->{where}->{import_error} = {'!=' => undef};
1478         $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1479
1480         # count of items we successfully imported attached to records in the queue in question
1481         delete $query->{where}->{import_error};
1482         $query->{where}->{import_time} = {'!=' => undef};
1483         $summary->{total_items_imported} = $e->json_query($query)->[0]->{count};
1484     }
1485
1486     return $summary;
1487 }
1488
1489 # --------------------------------------------------------------------------------
1490 # Given a list of queued record IDs, imports all items attached to those records
1491 # --------------------------------------------------------------------------------
1492 sub import_record_asset_list_impl {
1493     my($conn, $rec_ids, $requestor) = @_;
1494
1495     my $roe = new_editor(xact=> 1, requestor => $requestor);
1496
1497     # for speed, filter out any records have not been
1498     # imported or have no import items to load
1499     $rec_ids = $roe->json_query({
1500         select => {vqbr => ['id']},
1501         from => {vqbr => 'vii'},
1502         where => {'+vqbr' => {
1503             id => $rec_ids,
1504             import_time => {'!=' => undef}
1505         }},
1506         distinct => 1
1507     });
1508     $rec_ids = [map {$_->{id}} @$rec_ids];
1509
1510     my $report_args = {
1511         conn => $conn,
1512         total => scalar(@$rec_ids),
1513         step => 1, # how often to respond
1514         progress => 1,
1515         in_count => 0,
1516     };
1517
1518     for my $rec_id (@$rec_ids) {
1519         my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1520         my $item_ids = $roe->search_vandelay_import_item(
1521             {record => $rec->id, import_error => undef},
1522             {idlist=>1}
1523         );
1524
1525         for my $item_id (@$item_ids) {
1526             my $e = new_editor(requestor => $requestor, xact => 1);
1527             my $item = $e->retrieve_vandelay_import_item($item_id);
1528             $$report_args{import_item} = $item;
1529             $$report_args{e} = $e;
1530             $$report_args{import_error} = undef;
1531             $$report_args{evt} = undef;
1532
1533             # --------------------------------------------------------------------------------
1534             # Find or create the volume
1535             # --------------------------------------------------------------------------------
1536             my ($vol, $evt) =
1537                 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1538                     $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1539
1540             if($evt) {
1541
1542                 $$report_args{evt} = $evt;
1543                 respond_with_status($report_args);
1544                 next;
1545             }
1546
1547             # --------------------------------------------------------------------------------
1548             # Create the new copy
1549             # --------------------------------------------------------------------------------
1550             my $copy = Fieldmapper::asset::copy->new;
1551             $copy->loan_duration(2);
1552             $copy->fine_level(2);
1553             $copy->barcode($item->barcode);
1554             $copy->location($item->location);
1555             $copy->circ_lib($item->circ_lib || $item->owning_lib);
1556             $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1557             $copy->circulate($item->circulate);
1558             $copy->deposit($item->deposit);
1559             $copy->deposit_amount($item->deposit_amount);
1560             $copy->ref($item->ref);
1561             $copy->holdable($item->holdable);
1562             $copy->price($item->price);
1563             $copy->circ_as_type($item->circ_as_type);
1564             $copy->alert_message($item->alert_message);
1565             $copy->opac_visible($item->opac_visible);
1566             $copy->circ_modifier($item->circ_modifier);
1567
1568             # --------------------------------------------------------------------------------
1569             # Check for dupe barcode
1570             # --------------------------------------------------------------------------------
1571             if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1572                 $$report_args{evt} = $evt;
1573                 $$report_args{import_error} = 'import.item.duplicate.barcode'
1574                     if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1575                 respond_with_status($report_args);
1576                 next;
1577             }
1578
1579             # --------------------------------------------------------------------------------
1580             # create copy notes
1581             # --------------------------------------------------------------------------------
1582             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1583                 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1584
1585             if($evt) {
1586                 $$report_args{evt} = $evt;
1587                 respond_with_status($report_args);
1588                 next;
1589             }
1590
1591             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1592                 $e, $copy, '', $item->priv_note) if $item->priv_note;
1593
1594             if($evt) {
1595                 $$report_args{evt} = $evt;
1596                 respond_with_status($report_args);
1597                 next;
1598             }
1599
1600             # set the import data on the import item
1601             $item->imported_as($copy->id); # $copy->id is set by create_copy() ^--
1602             $item->import_time('now');
1603
1604             unless($e->update_vandelay_import_item($item)) {
1605                 $$report_args{evt} = $e->die_event;
1606                 respond_with_status($report_args);
1607                 next;
1608             }
1609
1610             # --------------------------------------------------------------------------------
1611             # Item import succeeded
1612             # --------------------------------------------------------------------------------
1613             $e->commit;
1614             $$report_args{in_count}++;
1615             respond_with_status($report_args);
1616             $logger->info("vl: successfully imported item " . $item->barcode);
1617         }
1618
1619     }
1620
1621     $roe->rollback;
1622     return undef;
1623 }
1624
1625
1626 sub respond_with_status {
1627     my $args = shift;
1628     my $e = $$args{e};
1629
1630     #  If the import failed, track the failure reason
1631
1632     my $error = $$args{import_error};
1633     my $evt = $$args{evt};
1634
1635     if($error or $evt) {
1636
1637         my $item = $$args{import_item};
1638         $logger->info("vl: unable to import item " . $item->barcode);
1639
1640         $error ||= 'general.unknown';
1641         $item->import_error($error);
1642
1643         if($evt) {
1644             my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1645             $item->error_detail($detail);
1646         }
1647
1648         # state of the editor is unknown at this point.  Force a rollback and start over.
1649         $e->rollback;
1650         $e = new_editor(xact => 1);
1651         $e->update_vandelay_import_item($item);
1652         $e->commit;
1653     }
1654
1655     if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1656         $$args{conn}->respond({
1657             total => $$args{total},
1658             progress => $$args{progress},
1659             success_count => $$args{success_count},
1660             err_event => $evt
1661         });
1662         $$args{step} *= 2 unless $$args{step} == 256;
1663     }
1664
1665     $$args{progress}++;
1666 }
1667
1668 __PACKAGE__->register_method(
1669     api_name    => "open-ils.vandelay.match_set.get_tree",
1670     method      => "match_set_get_tree",
1671     api_level   => 1,
1672     argc        => 2,
1673     signature   => {
1674         desc    => q/For a given vms object, return a tree of match set points
1675                     represented by a vmsp object with recursively fleshed
1676                     children./
1677     }
1678 );
1679
1680 sub match_set_get_tree {
1681     my ($self, $conn, $authtoken, $match_set_id) = @_;
1682
1683     $match_set_id = int($match_set_id) or return;
1684
1685     my $e = new_editor("authtoken" => $authtoken);
1686     $e->checkauth or return $e->die_event;
1687
1688     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1689         return $e->die_event;
1690
1691     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1692         return $e->die_event;
1693
1694     my $tree = $e->search_vandelay_match_set_point([
1695         {"match_set" => $match_set_id, "parent" => undef},
1696         {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1697     ]) or return $e->die_event;
1698
1699     return pop @$tree;
1700 }
1701
1702
1703 __PACKAGE__->register_method(
1704     api_name    => "open-ils.vandelay.match_set.update",
1705     method      => "match_set_update_tree",
1706     api_level   => 1,
1707     argc        => 3,
1708     signature   => {
1709         desc => q/Replace any vmsp objects associated with a given (by ID) vms
1710                 with the given objects (recursively fleshed vmsp tree)./
1711     }
1712 );
1713
1714 sub _walk_new_vmsp {
1715     my ($e, $match_set_id, $node, $parent_id) = @_;
1716
1717     my $point = new Fieldmapper::vandelay::match_set_point;
1718     $point->parent($parent_id);
1719     $point->match_set($match_set_id);
1720     $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1721
1722     $e->create_vandelay_match_set_point($point) or return $e->die_event;
1723
1724     $parent_id = $e->data->id;
1725     if ($node->children && @{$node->children}) {
1726         for (@{$node->children}) {
1727             return $e->die_event if
1728                 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1729         }
1730     }
1731
1732     return;
1733 }
1734
1735 sub match_set_update_tree {
1736     my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1737
1738     my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1739     $e->checkauth or return $e->die_event;
1740
1741     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1742         return $e->die_event;
1743
1744     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1745         return $e->die_event;
1746
1747     my $existing = $e->search_vandelay_match_set_point([
1748         {"match_set" => $match_set_id},
1749         {"order_by" => {"vmsp" => "id DESC"}}
1750     ]) or return $e->die_event;
1751
1752     # delete points, working up from leaf points to the root
1753     while(@$existing) {
1754         for my $point (shift @$existing) {
1755             if( grep {$_->parent eq $point->id} @$existing) {
1756                 push(@$existing, $point);
1757             } else {
1758                 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
1759             }
1760         }
1761     }
1762
1763     _walk_new_vmsp($e, $match_set_id, $tree);
1764
1765     $e->commit or return $e->die_event;
1766 }
1767
1768 __PACKAGE__->register_method(
1769     api_name    => 'open-ils.vandelay.bib_queue.to_bucket',
1770     method      => 'bib_queue_to_bucket',
1771     api_level   => 1,
1772     argc        => 2,
1773     signature   => {
1774         desc    => q/Add to or create a new bib container (bucket) with the successfully
1775                     imported contents of a vandelay queue.  Any user that has Vandelay
1776                     queue create permissions can append or create buckets from his-her own queues./,
1777         params  => [
1778             {desc => 'Authtoken', type => 'string'},
1779             {desc => 'Queue ID', type => 'number'},
1780             {desc => 'Bucket Name', type => 'string'}
1781         ],
1782         return  => {desc => q/
1783             {bucket => $bucket, addcount => number-of-items-added-to-bucket, item_count => total-bucket-item-count} on success,
1784             {add_count => 0} if there is nothing to do, and Event on error/}
1785     }
1786 );
1787
1788 sub bib_queue_to_bucket {
1789     my ($self, $conn, $auth, $q_id, $bucket_name) = @_;
1790
1791     my $e = new_editor(xact => 1, authtoken => $auth);
1792     return $e->die_event unless $e->checkauth;
1793
1794     my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1795         or return $e->die_event;
1796
1797     return OpenILS::Event->new('BAD_PARAMS',
1798         note => q/Bucket creator must be queue owner/)
1799         unless $queue->owner == $e->requestor->id;
1800
1801     # find the bib IDs that will go into the bucket
1802     my $bib_ids = $e->json_query({
1803         select => {vqbr => ['imported_as']},
1804         from => 'vqbr',
1805         where => {queue => $q_id, imported_as => {'!=' => undef}}
1806     });
1807
1808     if (!@$bib_ids) { # no records to add
1809         $e->rollback;
1810         return {add_count => 0};
1811     }
1812
1813     # allow user to add to an existing bucket by name
1814     my $bucket = $e->search_container_biblio_record_entry_bucket({
1815         owner => $e->requestor->id,
1816         name => $bucket_name,
1817         btype => 'vandelay_queue'
1818     })->[0];
1819
1820     # if the bucket does not exist, create a new one
1821     if (!$bucket) {
1822         $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
1823         $bucket->name($bucket_name);
1824         $bucket->owner($e->requestor->id);
1825         $bucket->btype('vandelay_queue');
1826
1827         $e->create_container_biblio_record_entry_bucket($bucket)
1828             or return $e->die_event;
1829     }
1830
1831     # create the new bucket items
1832     for my $bib_id ( map {$_->{imported_as}} @$bib_ids ) {
1833         my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
1834         $item->target_biblio_record_entry($bib_id);
1835         $item->bucket($bucket->id);
1836         $e->create_container_biblio_record_entry_bucket_item($item)
1837             or return $e->die_event;
1838     }
1839
1840     # re-fetch the bucket to pick up the correct create_time
1841     $bucket = $e->retrieve_container_biblio_record_entry_bucket($bucket->id)
1842         or return $e->die_event;
1843
1844     # get the total count of items in this bucket
1845     my $count = $e->json_query({
1846         select => {cbrebi => [{
1847             aggregate =>  1,
1848             transform => 'count',
1849             alias => 'count',
1850             column => 'id'
1851         }]},
1852         from => 'cbrebi',
1853         where => {bucket => $bucket->id}
1854     })->[0];
1855
1856     $e->commit;
1857
1858     return {
1859         bucket => $bucket,
1860         add_count => scalar(@$bib_ids), # items added to the bucket
1861         item_count => $count->{count} # total items in buckets
1862     };
1863 }
1864
1865 1;