Open-ILS/src/perlmods/lib/OpenILS/Application/Vandelay.pm

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