Open-ILS/src/perlmods/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;
  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 sub initialize {}
  27 sub child_init {}
  28
  29 # --------------------------------------------------------------------------------
  30 # Biblio ingest
  31
  32 sub create_bib_queue {
  33         my $self = shift;
  34         my $client = shift;
  35         my $auth = shift;
  36         my $name = shift;
  37         my $owner = shift;
  38         my $type = shift;
  39         my $import_def = shift;
  40
  41         my $e = new_editor(authtoken => $auth, xact => 1);
  42
  43         return $e->die_event unless $e->checkauth;
  44         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
  45     $owner ||= $e->requestor->id;
  46
  47     return OpenILS::Event->new('BIB_QUEUE_EXISTS')
  48         if $e->search_vandelay_bib_queue(
  49             {name => $name, owner => $owner, queue_type => $type})->[0];
  50
  51         my $queue = new Fieldmapper::vandelay::bib_queue();
  52         $queue->name( $name );
  53         $queue->owner( $owner );
  54         $queue->queue_type( $type ) if ($type);
  55         $queue->item_attr_def( $import_def ) if ($import_def);
  56
  57         my $new_q = $e->create_vandelay_bib_queue( $queue );
  58         return $e->die_event unless ($new_q);
  59         $e->commit;
  60
  61     return $new_q;
  62 }
  63 __PACKAGE__->register_method(
  64         api_name        => "open-ils.vandelay.bib_queue.create",
  65         method          => "create_bib_queue",
  66         api_level       => 1,
  67         argc            => 4,
  68 );
  69
  70
  71 sub create_auth_queue {
  72         my $self = shift;
  73         my $client = shift;
  74         my $auth = shift;
  75         my $name = shift;
  76         my $owner = shift;
  77         my $type = shift;
  78
  79         my $e = new_editor(authtoken => $auth, xact => 1);
  80
  81         return $e->die_event unless $e->checkauth;
  82         return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
  83     $owner ||= $e->requestor->id;
  84
  85     return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
  86         if $e->search_vandelay_bib_queue(
  87             {name => $name, owner => $owner, queue_type => $type})->[0];
  88
  89         my $queue = new Fieldmapper::vandelay::authority_queue();
  90         $queue->name( $name );
  91         $queue->owner( $owner );
  92         $queue->queue_type( $type ) if ($type);
  93
  94         my $new_q = $e->create_vandelay_authority_queue( $queue );
  95         $e->die_event unless ($new_q);
  96         $e->commit;
  97
  98     return $new_q;
  99 }
 100 __PACKAGE__->register_method(
 101         api_name        => "open-ils.vandelay.authority_queue.create",
 102         method          => "create_auth_queue",
 103         api_level       => 1,
 104         argc            => 3,
 105 );
 106
 107 sub add_record_to_bib_queue {
 108         my $self = shift;
 109         my $client = shift;
 110         my $auth = shift;
 111         my $queue = shift;
 112         my $marc = shift;
 113         my $purpose = shift;
 114     my $bib_source = shift;
 115
 116         my $e = new_editor(authtoken => $auth, xact => 1);
 117
 118         $queue = $e->retrieve_vandelay_bib_queue($queue);
 119
 120         return $e->die_event unless $e->checkauth;
 121         return $e->die_event unless
 122                 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
 123                  $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
 124
 125         my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
 126
 127         return $e->die_event unless ($new_rec);
 128         $e->commit;
 129     return $new_rec;
 130 }
 131 __PACKAGE__->register_method(
 132         api_name        => "open-ils.vandelay.queued_bib_record.create",
 133         method          => "add_record_to_bib_queue",
 134         api_level       => 1,
 135         argc            => 3,
 136 );
 137
 138 sub _add_bib_rec {
 139         my $e = shift;
 140         my $marc = shift;
 141         my $queue = shift;
 142         my $purpose = shift;
 143     my $bib_source = shift;
 144
 145         my $rec = new Fieldmapper::vandelay::queued_bib_record();
 146         $rec->marc( $marc );
 147         $rec->queue( $queue );
 148         $rec->purpose( $purpose ) if ($purpose);
 149     $rec->bib_source($bib_source);
 150
 151         return $e->create_vandelay_queued_bib_record( $rec );
 152 }
 153
 154 sub add_record_to_authority_queue {
 155         my $self = shift;
 156         my $client = shift;
 157         my $auth = shift;
 158         my $queue = shift;
 159         my $marc = shift;
 160         my $purpose = shift;
 161
 162         my $e = new_editor(authtoken => $auth, xact => 1);
 163
 164         $queue = $e->retrieve_vandelay_authority_queue($queue);
 165
 166         return $e->die_event unless $e->checkauth;
 167         return $e->die_event unless
 168                 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
 169                  $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
 170
 171         my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
 172
 173         return $e->die_event unless ($new_rec);
 174         $e->commit;
 175     return $new_rec;
 176 }
 177 __PACKAGE__->register_method(
 178         api_name        => "open-ils.vandelay.queued_authority_record.create",
 179         method          => "add_record_to_authority_queue",
 180         api_level       => 1,
 181         argc            => 3,
 182 );
 183
 184 sub _add_auth_rec {
 185         my $e = shift;
 186         my $marc = shift;
 187         my $queue = shift;
 188     my $purpose = shift;
 189
 190         my $rec = new Fieldmapper::vandelay::queued_authority_record();
 191         $rec->marc( $marc );
 192         $rec->queue( $queue );
 193         $rec->purpose( $purpose ) if ($purpose);
 194
 195         return $e->create_vandelay_queued_authority_record( $rec );
 196 }
 197
 198 sub process_spool {
 199         my $self = shift;
 200         my $client = shift;
 201         my $auth = shift;
 202         my $fingerprint = shift || '';
 203         my $queue_id = shift;
 204     my $purpose = shift;
 205     my $filename = shift;
 206     my $bib_source = shift;
 207
 208         my $e = new_editor(authtoken => $auth, xact => 1);
 209     return $e->die_event unless $e->checkauth;
 210
 211     my $queue;
 212     my $type = $self->{record_type};
 213
 214     if($type eq 'bib') {
 215         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
 216     } else {
 217         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
 218     }
 219
 220     my $evt = check_queue_perms($e, $type, $queue);
 221     return $evt if $evt;
 222
 223     my $cache = new OpenSRF::Utils::Cache();
 224
 225     if($fingerprint) {
 226         my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
 227             $purpose = $data->{purpose};
 228         $filename = $data->{path};
 229         $bib_source = $data->{bib_source};
 230     }
 231
 232     unless(-r $filename) {
 233         $logger->error("unable to read MARC file $filename");
 234         return -1; # make this an event XXX
 235     }
 236
 237     $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
 238
 239     my $marctype = 'USMARC';
 240
 241     open F, $filename;
 242     $marctype = 'XML' if (getc(F) =~ /^\D/o);
 243     close F;
 244
 245         my $batch = new MARC::Batch ($marctype, $filename);
 246         $batch->strict_off;
 247
 248         my $response_scale = 10;
 249         my $count = 0;
 250         my $r = -1;
 251         while (try { $r = $batch->next } otherwise { $r = -1 }) {
 252                 if ($r == -1) {
 253                         $logger->warn("Proccessing of record $count in set $filename failed.  Skipping this record");
 254                         $count++;
 255                 }
 256
 257                 $logger->info("processing record $count");
 258
 259                 try {
 260                         (my $xml = $r->as_xml_record()) =~ s/\n//sog;
 261                         $xml =~ s/^<\?xml.+\?\s*>//go;
 262                         $xml =~ s/>\s+</></go;
 263                         $xml =~ s/\p{Cc}//go;
 264                         $xml = $U->entityize($xml);
 265                         $xml =~ s/[\x00-\x1f]//go;
 266
 267             my $qrec;
 268                         if ($type eq 'bib') {
 269                                 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
 270                         } else {
 271                                 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
 272                         }
 273
 274             if($self->api_name =~ /stream_results/ and $qrec) {
 275                             $client->respond($qrec->id)
 276             } else {
 277                             $client->respond($count) if (++$count % $response_scale) == 0;
 278                             $response_scale *= 10 if ($count == ($response_scale * 10));
 279             }
 280                 } catch Error with {
 281                         my $error = shift;
 282                         $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
 283                 }
 284         }
 285
 286         $e->commit;
 287     unlink($filename);
 288     $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
 289         return $count;
 290 }
 291
 292 __PACKAGE__->register_method(
 293         api_name        => "open-ils.vandelay.bib.process_spool",
 294         method          => "process_spool",
 295         api_level       => 1,
 296         argc            => 3,
 297         record_type     => 'bib'
 298 );
 299 __PACKAGE__->register_method(
 300         api_name        => "open-ils.vandelay.auth.process_spool",
 301         method          => "process_spool",
 302         api_level       => 1,
 303         argc            => 3,
 304         record_type     => 'auth'
 305 );
 306
 307 __PACKAGE__->register_method(
 308         api_name        => "open-ils.vandelay.bib.process_spool.stream_results",
 309         method          => "process_spool",
 310         api_level       => 1,
 311         argc            => 3,
 312     stream      => 1,
 313         record_type     => 'bib'
 314 );
 315 __PACKAGE__->register_method(
 316         api_name        => "open-ils.vandelay.auth.process_spool.stream_results",
 317         method          => "process_spool",
 318         api_level       => 1,
 319         argc            => 3,
 320     stream      => 1,
 321         record_type     => 'auth'
 322 );
 323
 324 __PACKAGE__->register_method(
 325         api_name        => "open-ils.vandelay.bib_queue.records.retrieve",
 326         method          => 'retrieve_queued_records',
 327         api_level       => 1,
 328         argc            => 2,
 329     stream      => 1,
 330         record_type     => 'bib'
 331 );
 332 __PACKAGE__->register_method(
 333         api_name        => "open-ils.vandelay.auth_queue.records.retrieve",
 334         method          => 'retrieve_queued_records',
 335         api_level       => 1,
 336         argc            => 2,
 337     stream      => 1,
 338         record_type     => 'auth'
 339 );
 340
 341 __PACKAGE__->register_method(
 342         api_name        => "open-ils.vandelay.bib_queue.records.matches.retrieve",
 343         method          => 'retrieve_queued_records',
 344         api_level       => 1,
 345         argc            => 2,
 346     stream      => 1,
 347         record_type     => 'bib',
 348     signature   => {
 349         desc => q/Only retrieve queued bib records that have matches against existing records/
 350     }
 351 );
 352 __PACKAGE__->register_method(
 353         api_name        => "open-ils.vandelay.auth_queue.records.matches.retrieve",
 354         method          => 'retrieve_queued_records',
 355         api_level       => 1,
 356         argc            => 2,
 357     stream      => 1,
 358         record_type     => 'auth',
 359     signature   => {
 360         desc => q/Only retrieve queued authority records that have matches against existing records/
 361     }
 362
 363 );
 364
 365 sub retrieve_queued_records {
 366     my($self, $conn, $auth, $queue_id, $options) = @_;
 367     my $e = new_editor(authtoken => $auth);
 368     return $e->event unless $e->checkauth;
 369     $options ||= {};
 370     my $limit = $$options{limit} || 20;
 371     my $offset = $$options{offset} || 0;
 372
 373     my $type = $self->{record_type};
 374     my $queue;
 375     if($type eq 'bib') {
 376         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
 377     } else {
 378         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
 379     }
 380     my $evt = check_queue_perms($e, $type, $queue);
 381     return $evt if $evt;
 382
 383     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
 384     my $search = ($type eq 'bib') ?
 385         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
 386     my $retrieve = ($type eq 'bib') ?
 387         'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
 388
 389     my $filter = ($$options{non_imported}) ? {import_time => undef} : {};
 390
 391     my $record_ids;
 392     if($self->api_name =~ /matches/) {
 393         # fetch only matched records
 394         $record_ids = queued_records_with_matches($e, $type, $queue_id, $limit, $offset, $filter);
 395     } else {
 396         # fetch all queue records
 397         $record_ids = $e->$search([
 398                 {queue => $queue_id, %$filter},
 399                 {order_by => {$class => 'id'}, limit => $limit, offset => $offset}
 400             ],
 401             {idlist => 1}
 402         );
 403     }
 404
 405
 406     for my $rec_id (@$record_ids) {
 407         my $params = {
 408             flesh => 1,
 409             flesh_fields => {$class => ['attributes', 'matches']},
 410         };
 411         my $rec = $e->$retrieve([$rec_id, $params]);
 412         $rec->clear_marc if $$options{clear_marc};
 413         $conn->respond($rec);
 414     }
 415     return undef;
 416 }
 417
 418 sub check_queue_perms {
 419     my($e, $type, $queue) = @_;
 420         if ($type eq 'bib') {
 421                 return $e->die_event unless
 422                         ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
 423                          $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
 424         } else {
 425                 return $e->die_event unless
 426                         ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
 427                          $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
 428         }
 429
 430     return undef;
 431 }
 432
 433 __PACKAGE__->register_method(
 434         api_name        => "open-ils.vandelay.bib_record.list.import",
 435         method          => 'import_record_list',
 436         api_level       => 1,
 437         argc            => 2,
 438     stream      => 1,
 439         record_type     => 'bib'
 440 );
 441
 442 __PACKAGE__->register_method(
 443         api_name        => "open-ils.vandelay.auth_record.list.import",
 444         method          => 'import_record_list',
 445         api_level       => 1,
 446         argc            => 2,
 447     stream      => 1,
 448         record_type     => 'auth'
 449 );
 450
 451 sub import_record_list {
 452     my($self, $conn, $auth, $rec_ids, $args) = @_;
 453     my $e = new_editor(authtoken => $auth);
 454     return $e->event unless $e->checkauth;
 455     $args ||= {};
 456     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
 457     return $err if $err;
 458     return {complete => 1};
 459 }
 460
 461
 462 __PACKAGE__->register_method(
 463         api_name        => "open-ils.vandelay.bib_queue.import",
 464         method          => 'import_queue',
 465         api_level       => 1,
 466         argc            => 2,
 467     stream      => 1,
 468         record_type     => 'bib'
 469 );
 470
 471 __PACKAGE__->register_method(
 472         api_name        => "open-ils.vandelay.auth_queue.import",
 473         method          => 'import_queue',
 474         api_level       => 1,
 475         argc            => 2,
 476     stream      => 1,
 477         record_type     => 'auth'
 478 );
 479 __PACKAGE__->register_method(
 480         api_name        => "open-ils.vandelay.bib_queue.nomatch.import",
 481         method          => 'import_queue',
 482         api_level       => 1,
 483         argc            => 2,
 484     stream      => 1,
 485     signature   => {
 486         desc => q/Only import records that have no collisions/
 487     },
 488         record_type     => 'bib'
 489 );
 490
 491 __PACKAGE__->register_method(
 492         api_name        => "open-ils.vandelay.auth_queue.nomatch.import",
 493         method          => 'import_queue',
 494         api_level       => 1,
 495         argc            => 2,
 496     stream      => 1,
 497     signature   => {
 498         desc => q/Only import records that have no collisions/
 499     },
 500         record_type     => 'auth'
 501 );
 502 sub import_queue {
 503     my($self, $conn, $auth, $q_id, $options) = @_;
 504     my $e = new_editor(authtoken => $auth);
 505     return $e->event unless $e->checkauth;
 506     $options ||= {};
 507     my $type = $self->{record_type};
 508     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
 509
 510     my $query = {queue => $q_id, import_time => undef};
 511
 512     if($self->api_name =~ /nomatch/) {
 513         my $matched_recs = queued_records_with_matches($e, $type, $q_id, undef, undef, {import_time => undef});
 514         $query->{id} = {'not in' => $matched_recs} if @$matched_recs;
 515     }
 516
 517     my $search = ($type eq 'bib') ?
 518         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
 519     my $rec_ids = $e->$search($query, {idlist => 1});
 520     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
 521     return $err if $err;
 522     return {complete => 1};
 523 }
 524
 525 # returns a list of queued record IDs for a given queue that
 526 # have at least one entry in the match table
 527 sub queued_records_with_matches {
 528     my($e, $type, $q_id, $limit, $offset, $filter) = @_;
 529
 530     my $match_class = 'vbm';
 531     my $rec_class = 'vqbr';
 532     if($type eq 'auth') {
 533         $match_class = 'vam';
 534          $rec_class = 'vqar';
 535     }
 536
 537     $filter ||= {};
 538     $filter->{queue} = $q_id;
 539
 540     my $query = {
 541         distinct => 1,
 542         select => {$match_class => ['queued_record']},
 543         from => {
 544             $match_class => {
 545                 $rec_class => {
 546                     field => 'id',
 547                     fkey => 'queued_record',
 548                     filter => $filter,
 549                 }
 550             }
 551         }
 552     };
 553
 554     if($limit or defined $offset) {
 555         $limit ||= 20;
 556         $offset ||= 0;
 557         $query->{limit} = $limit;
 558         $query->{offset} = $offset;
 559     }
 560
 561     my $data = $e->json_query($query);
 562     return [ map {$_->{queued_record}} @$data ];
 563 }
 564
 565 sub import_record_list_impl {
 566     my($self, $conn, $rec_ids, $requestor, $args) = @_;
 567
 568     my $overlay_map = $args->{overlay_map} || {};
 569     my $type = $self->{record_type};
 570     my $total = @$rec_ids;
 571     my $count = 0;
 572     my %queues;
 573     my @ingest_queue;
 574     my $auto_overlay_exact = $$args{auto_overlay_exact};
 575     my $auto_overlay_1match = $$args{auto_overlay_1match};
 576     my $merge_profile = $$args{merge_profile};
 577     my $bib_source = $$args{bib_source};
 578
 579     my $overlay_func = 'vandelay.overlay_bib_record';
 580     my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
 581     my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
 582     my $update_func = 'update_vandelay_queued_bib_record';
 583     my $search_func = 'search_vandelay_queued_bib_record';
 584     my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
 585     my $update_queue_func = 'update_vandelay_bib_queue';
 586     my $rec_class = 'vqbr';
 587
 588     if($type eq 'auth') {
 589         $overlay_func =~ s/bib/auth/o;
 590         $auto_overlay_func = s/bib/auth/o;
 591         $retrieve_func =~ s/bib/authority/o;
 592         $retrieve_queue_func =~ s/bib/authority/o;
 593         $update_queue_func =~ s/bib/authority/o;
 594         $update_func =~ s/bib/authority/o;
 595         $search_func =~ s/bib/authority/o;
 596         $rec_class = 'vqar';
 597     }
 598
 599     my $ingest_ses = OpenSRF::AppSession->connect('open-ils.ingest');
 600
 601     for my $rec_id (@$rec_ids) {
 602
 603         my $overlay_target = $overlay_map->{$rec_id};
 604
 605         my $e = new_editor(xact => 1);
 606         $e->requestor($requestor);
 607
 608         my $rec = $e->$retrieve_func([
 609             $rec_id,
 610             {   flesh => 1,
 611                 flesh_fields => { $rec_class => ['matches']},
 612             }
 613         ]);
 614
 615         unless($rec) {
 616             $conn->respond({total => $total, progress => ++$count, imported => $rec_id, err_event => $e->die_event});
 617             $e->rollback;
 618             next;
 619         }
 620
 621         if($rec->import_time) {
 622             $e->rollback;
 623             next;
 624         }
 625
 626         $queues{$rec->queue} = 1;
 627
 628         my $record;
 629         my $imported = 0;
 630
 631         if(defined $overlay_target) {
 632             # Caller chose an explicit overlay target
 633
 634             my $res = $e->json_query(
 635                 {
 636                     from => [
 637                         $overlay_func,
 638                         $rec->id,
 639                         $overlay_target,
 640                         $merge_profile
 641                     ]
 642                 }
 643             )->[0];
 644
 645             if($res->{$overlay_func} eq 't') {
 646                 $logger->info("vl: $type direct overlay succeeded for queued rec " .
 647                     $rec->id . " and overlay target $overlay_target");
 648                 $imported = 1;
 649             }
 650
 651         } else {
 652
 653             if($auto_overlay_1match) {
 654                 # caller says to overlay if there is exactly 1 match
 655
 656                 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
 657
 658                 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
 659
 660                     my $res = $e->json_query(
 661                         {
 662                             from => [
 663                                 $overlay_func,
 664                                 $rec->id,
 665                                 $rec->matches->[0]->eg_record,
 666                                 $merge_profile
 667                             ]
 668                         }
 669                     )->[0];
 670
 671                     if($res->{$overlay_func} eq 't') {
 672                         $logger->info("vl: $type overlay-1match succeeded for queued rec " . $rec->id);
 673                         $imported = 1;
 674                     }
 675                 }
 676             }
 677
 678             if(!$imported and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
 679
 680                 # caller says to overlay if there is an /exact/ match
 681
 682                 my $res = $e->json_query(
 683                     {
 684                         from => [
 685                             $auto_overlay_func,
 686                             $rec->id,
 687                             $merge_profile
 688                         ]
 689                     }
 690                 )->[0];
 691
 692                 if($res->{$auto_overlay_func} eq 't') {
 693                     $logger->info("vl: $type auto-overlay succeeded for queued rec " . $rec->id);
 694                     $imported = 1;
 695                 }
 696             }
 697
 698             if(!$imported) {
 699
 700                 # No overlay / merge occured.  Do a traditional record import by creating a new record
 701
 702                 if($type eq 'bib') {
 703                     $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import($e, $rec->marc); #$rec->bib_source
 704
 705                 } else {
 706
 707                     $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
 708                     push @ingest_queue, {
 709                         req => $ingest_ses->request('open-ils.ingest.full.authority.record', $record->id),
 710                         rec_id => $record->id
 711                     };
 712                 }
 713
 714                 if($U->event_code($record)) {
 715
 716                     $e->event($record);
 717
 718                 } else {
 719
 720                     $logger->info("vl: successfully importid new $type record");
 721                     $rec->imported_as($record->id);
 722                     $rec->import_time('now');
 723
 724                     $imported = 1 if $e->$update_func($rec);
 725                 }
 726             }
 727         }
 728
 729         if($imported) {
 730
 731             $e->commit;
 732             $conn->respond({total => $total, progress => ++$count, imported => $rec_id});
 733
 734         } else {
 735
 736             $e->rollback;
 737             $conn->respond({total => $total, progress => ++$count, imported => $rec_id, err_event => $e->die_event});
 738         }
 739
 740         $conn->respond({total => $total, progress => $count, imported => $rec_id}) if (++$count % 10) == 0;
 741     }
 742
 743     # see if we need to mark any queues as complete
 744     my $e = new_editor(xact => 1);
 745     for my $q_id (keys %queues) {
 746
 747         my $remaining = $e->$search_func(
 748             [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
 749
 750         unless(@$remaining) {
 751             my $queue = $e->$retrieve_queue_func($q_id);
 752
 753             unless($U->is_true($queue->complete)) {
 754                 $queue->complete('t');
 755                 $e->$update_queue_func($queue) or return $e->die_event;
 756                 $e->commit;
 757                 last
 758             }
 759
 760         }
 761     }
 762     $e->rollback;
 763
 764     $count = 0;
 765     for my $ingest (@ingest_queue) {
 766         try { $ingest->{req}->gather(1); } otherwise {};
 767         $conn->respond({total => $total, progress => $count, imported => $ingest->{rec_id}}) if (++$count % 10) == 0;
 768     }
 769
 770     $ingest_ses->disconnect();
 771     return undef;
 772 }
 773
 774
 775 __PACKAGE__->register_method(
 776         api_name        => "open-ils.vandelay.bib_queue.owner.retrieve",
 777         method          => 'owner_queue_retrieve',
 778         api_level       => 1,
 779         argc            => 2,
 780     stream      => 1,
 781         record_type     => 'bib'
 782 );
 783 __PACKAGE__->register_method(
 784         api_name        => "open-ils.vandelay.authority_queue.owner.retrieve",
 785         method          => 'owner_queue_retrieve',
 786         api_level       => 1,
 787         argc            => 2,
 788     stream      => 1,
 789         record_type     => 'auth'
 790 );
 791
 792 sub owner_queue_retrieve {
 793     my($self, $conn, $auth, $owner_id, $filters) = @_;
 794     my $e = new_editor(authtoken => $auth);
 795     return $e->die_event unless $e->checkauth;
 796     $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
 797     my $queues;
 798     $filters ||= {};
 799     my $search = {owner => $owner_id};
 800     $search->{$_} = $filters->{$_} for keys %$filters;
 801
 802     if($self->{record_type} eq 'bib') {
 803         $queues = $e->search_vandelay_bib_queue(
 804             [$search, {order_by => {vbq => 'lower(name)'}}]);
 805     } else {
 806         $queues = $e->search_vandelay_authority_queue(
 807             [$search, {order_by => {vaq => 'lower(name)'}}]);
 808     }
 809     $conn->respond($_) for @$queues;
 810     return undef;
 811 }
 812
 813 __PACKAGE__->register_method(
 814         api_name        => "open-ils.vandelay.bib_queue.delete",
 815         method          => "delete_queue",
 816         api_level       => 1,
 817         argc            => 2,
 818         record_type     => 'bib'
 819 );
 820 __PACKAGE__->register_method(
 821         api_name        => "open-ils.vandelay.auth_queue.delete",
 822         method          => "delete_queue",
 823         api_level       => 1,
 824         argc            => 2,
 825         record_type     => 'auth'
 826 );
 827
 828 sub delete_queue {
 829     my($self, $conn, $auth, $q_id) = @_;
 830     my $e = new_editor(xact => 1, authtoken => $auth);
 831     return $e->die_event unless $e->checkauth;
 832     if($self->{record_type} eq 'bib') {
 833             return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
 834         my $queue = $e->retrieve_vandelay_bib_queue($q_id)
 835             or return $e->die_event;
 836         $e->delete_vandelay_bib_queue($queue)
 837             or return $e->die_event;
 838     } else {
 839             return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
 840         my $queue = $e->retrieve_vandelay_authority_queue($q_id)
 841             or return $e->die_event;
 842         $e->delete_vandelay_authority_queue($queue)
 843             or return $e->die_event;
 844     }
 845     $e->commit;
 846     return 1;
 847 }
 848
 849
 850 __PACKAGE__->register_method(
 851         api_name        => "open-ils.vandelay.queued_bib_record.html",
 852         method          => 'queued_record_html',
 853         api_level       => 1,
 854         argc            => 2,
 855     stream      => 1,
 856         record_type     => 'bib'
 857 );
 858 __PACKAGE__->register_method(
 859         api_name        => "open-ils.vandelay.queued_authority_record.html",
 860         method          => 'queued_record_html',
 861         api_level       => 1,
 862         argc            => 2,
 863     stream      => 1,
 864         record_type     => 'auth'
 865 );
 866
 867 sub queued_record_html {
 868     my($self, $conn, $auth, $rec_id) = @_;
 869     my $e = new_editor(authtoken => $auth);
 870     return $e->event unless $e->checkauth;
 871     my $rec;
 872     if($self->{record_type} eq 'bib') {
 873         $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
 874             or return $e->event;
 875     } else {
 876         $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
 877             or return $e->event;
 878     }
 879
 880     return $U->simplereq(
 881         'open-ils.search',
 882         'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
 883 }
 884
 885
 886 __PACKAGE__->register_method(
 887         api_name        => "open-ils.vandelay.bib_queue.summary.retrieve",
 888         method          => 'retrieve_queue_summary',
 889         api_level       => 1,
 890         argc            => 2,
 891     stream      => 1,
 892         record_type     => 'bib'
 893 );
 894 __PACKAGE__->register_method(
 895         api_name        => "open-ils.vandelay.auth_queue.summary.retrieve",
 896         method          => 'retrieve_queue_summary',
 897         api_level       => 1,
 898         argc            => 2,
 899     stream      => 1,
 900         record_type     => 'auth'
 901 );
 902
 903 sub retrieve_queue_summary {
 904     my($self, $conn, $auth, $queue_id) = @_;
 905     my $e = new_editor(authtoken => $auth);
 906     return $e->event unless $e->checkauth;
 907
 908     my $queue;
 909     my $type = $self->{record_type};
 910     if($type eq 'bib') {
 911         $queue = $e->retrieve_vandelay_bib_queue($queue_id)
 912             or return $e->event;
 913     } else {
 914         $queue = $e->retrieve_vandelay_authority_queue($queue_id)
 915             or return $e->event;
 916     }
 917
 918     my $evt = check_queue_perms($e, $type, $queue);
 919     return $evt if $evt;
 920
 921     my $search = 'search_vandelay_queued_bib_record';
 922     $search =~ s/bib/authority/ if $type ne 'bib';
 923
 924     return {
 925         queue => $queue,
 926         total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
 927         imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
 928     };
 929 }
 930
 931
 932 __PACKAGE__->register_method(
 933         api_name        => "open-ils.vandelay.bib_record.list.asset.import",
 934         method          => 'import_record_list_assets',
 935         api_level       => 1,
 936         argc            => 2,
 937     stream      => 1,
 938         record_type     => 'bib'
 939 );
 940 __PACKAGE__->register_method(
 941         api_name        => "open-ils.vandelay.bib_record.queue.asset.import",
 942         method          => 'import_record_queue_assets',
 943         api_level       => 1,
 944         argc            => 2,
 945     stream      => 1,
 946         record_type     => 'bib'
 947 );
 948
 949 sub import_record_list_assets {
 950     my($self, $conn, $auth, $import_def, $rec_ids) = @_;
 951     my $e = new_editor(authtoken => $auth);
 952     return $e->event unless $e->checkauth;
 953     my $err = import_record_asset_list_impl($conn, $import_def, $rec_ids, $e->requestor);
 954     return $err if $err;
 955     return {complete => 1};
 956 }
 957
 958 sub import_record_queue_assets {
 959     my($self, $conn, $auth, $import_def, $q_id) = @_;
 960     my $e = new_editor(authtoken => $auth);
 961     return $e->event unless $e->checkauth;
 962     my $rec_ids = $e->search_vandelay_queued_bib_record(
 963         {queue => $q_id, import_time => {'!=' => undef}}, {idlist => 1});
 964     my $err = import_record_asset_list_impl($conn, $import_def, $rec_ids, $e->requestor);
 965     return $err if $err;
 966     return {complete => 1};
 967 }
 968
 969 # --------------------------------------------------------------------------------
 970 # Given a list of queued record IDs, imports all items attached to those records
 971 # --------------------------------------------------------------------------------
 972 sub import_record_asset_list_impl {
 973     my($conn, $import_def, $rec_ids, $requestor) = @_;
 974
 975     my $total = @$rec_ids;
 976     my $try_count = 0;
 977     my $in_count = 0;
 978     my $roe = new_editor(requestor => $requestor);
 979
 980     for my $rec_id (@$rec_ids) {
 981         my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
 982         next unless $rec and $rec->import_time;
 983         my $item_ids = $roe->search_vandelay_import_item({definition => $import_def, record => $rec->id}, {idlist=>1});
 984
 985         for my $item_id (@$item_ids) {
 986             my $e = new_editor(requestor => $requestor, xact => 1);
 987             my $item = $e->retrieve_vandelay_import_item($item_id);
 988             $try_count++;
 989
 990             # --------------------------------------------------------------------------------
 991             # Find or create the volume
 992             # --------------------------------------------------------------------------------
 993             my ($vol, $evt) =
 994                 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
 995                     $e, $item->call_number, $rec->imported_as, $item->owning_lib);
 996
 997             if($evt) {
 998                 respond_with_status($conn, $total, $try_count, $in_count, $evt);
 999                 $e->rollback;
1000                 next;
1001             }
1002
1003             # --------------------------------------------------------------------------------
1004             # Create the new copy
1005             # --------------------------------------------------------------------------------
1006             my $copy = Fieldmapper::asset::copy->new;
1007             $copy->loan_duration(2);
1008             $copy->fine_level(2);
1009             $copy->barcode($item->barcode);
1010             $copy->location($item->location);
1011             $copy->circ_lib($item->circ_lib || $item->owning_lib);
1012             $copy->status($item->status || OILS_COPY_STATUS_IN_PROCESS);
1013             $copy->circulate($item->circulate);
1014             $copy->deposit($item->deposit);
1015             $copy->deposit_amount($item->deposit_amount);
1016             $copy->ref($item->ref);
1017             $copy->holdable($item->holdable);
1018             $copy->price($item->price);
1019             $copy->circ_as_type($item->circ_as_type);
1020             $copy->alert_message($item->alert_message);
1021             $copy->opac_visible($item->opac_visible);
1022             $copy->circ_modifier($item->circ_modifier);
1023
1024             # --------------------------------------------------------------------------------
1025             # see if a valid circ_modifier was provided
1026             # --------------------------------------------------------------------------------
1027             #if($copy->circ_modifier and not $e->retrieve_config_circ_modifier($item->circ_modifier)) {
1028             if($copy->circ_modifier and not $e->search_config_circ_modifier({code=>$item->circ_modifier})->[0]) {
1029                 respond_with_status($conn, $total, $try_count, $in_count, $e->die_event);
1030                 $e->rollback;
1031                 next;
1032             }
1033
1034             if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1035                 $e->rollback;
1036                 respond_with_status($conn, $total, $try_count, $in_count, $evt);
1037                 next;
1038             }
1039
1040             # --------------------------------------------------------------------------------
1041             # create copy notes
1042             # --------------------------------------------------------------------------------
1043             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1044                 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1045
1046             if($evt) {
1047                 respond_with_status($conn, $total, $try_count, $in_count, $evt);
1048                 $e->rollback;
1049                 next;
1050             }
1051
1052             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1053                 $e, $copy, '', $item->priv_note, 1) if $item->priv_note;
1054
1055             if($evt) {
1056                 respond_with_status($conn, $total, $try_count, $in_count, $evt);
1057                 $e->rollback;
1058                 next;
1059             }
1060
1061             # --------------------------------------------------------------------------------
1062             # Item import succeeded
1063             # --------------------------------------------------------------------------------
1064             $e->commit;
1065             respond_with_status($conn, $total, $try_count, ++$in_count, undef, imported_as => $copy->id);
1066         }
1067     }
1068     return undef;
1069 }
1070
1071
1072 sub respond_with_status {
1073     my($conn, $total, $try_count, $success_count, $err, %args) = @_;
1074     $conn->respond({
1075         total => $total,
1076         progress => $try_count,
1077         err_event => $err,
1078         success_count => $success_count, %args }) if $err or ($try_count % 5 == 0);
1079 }
1080
1081
1082 1;