Open-ILS/src/perlmods/lib/OpenILS/Application/Acq/Order.pm

   1 package OpenILS::Application::Acq::BatchManager;
   2 use OpenILS::Application::Acq::Financials;
   3 use OpenSRF::AppSession;
   4 use OpenSRF::EX qw/:try/;
   5 use strict; use warnings;
   6
   7 sub new {
   8     my($class, %args) = @_;
   9     my $self = bless(\%args, $class);
  10     $self->{args} = {
  11         lid => 0,
  12         li => 0,
  13         vqbr => 0,
  14         copies => 0,
  15         bibs => 0,
  16         progress => 0,
  17         debits_accrued => 0,
  18         purchase_order => undef,
  19         picklist => undef,
  20         complete => 0,
  21         indexed => 0,
  22         queue => undef,
  23         total => 0
  24     };
  25     $self->{cache} = {};
  26     $self->throttle(4) unless $self->throttle;
  27     $self->{post_proc_queue} = [];
  28     $self->{last_respond_progress} = 0;
  29     return $self;
  30 }
  31
  32 sub conn {
  33     my($self, $val) = @_;
  34     $self->{conn} = $val if $val;
  35     return $self->{conn};
  36 }
  37 sub throttle {
  38     my($self, $val) = @_;
  39     $self->{throttle} = $val if $val;
  40     return $self->{throttle};
  41 }
  42 sub respond {
  43     my($self, %other_args) = @_;
  44     if($self->throttle and not %other_args) {
  45         return unless (
  46             ($self->{args}->{progress} - $self->{last_respond_progress}) >= $self->throttle
  47         );
  48     }
  49     $self->conn->respond({ %{$self->{args}}, %other_args });
  50     $self->{last_respond_progress} = $self->{args}->{progress};
  51     $self->throttle($self->throttle * 2) unless $self->throttle >= 256;
  52 }
  53 sub respond_complete {
  54     my($self, %other_args) = @_;
  55     $self->complete;
  56     $self->conn->respond_complete({ %{$self->{args}}, %other_args });
  57     $self->run_post_response_hooks;
  58     return undef;
  59 }
  60
  61 # run the post response hook subs, shifting them off as we go
  62 sub run_post_response_hooks {
  63     my($self) = @_;
  64     (shift @{$self->{post_proc_queue}})->() while @{$self->{post_proc_queue}};
  65 }
  66
  67 # any subs passed to this method will be run after the call to respond_complete
  68 sub post_process {
  69     my($self, $sub) = @_;
  70     push(@{$self->{post_proc_queue}}, $sub);
  71 }
  72
  73 sub total {
  74     my($self, $val) = @_;
  75     $self->{args}->{total} = $val if defined $val;
  76     $self->{args}->{maximum} = $self->{args}->{total};
  77     return $self->{args}->{total};
  78 }
  79 sub purchase_order {
  80     my($self, $val) = @_;
  81     $self->{args}->{purchase_order} = $val if $val;
  82     return $self;
  83 }
  84 sub picklist {
  85     my($self, $val) = @_;
  86     $self->{args}->{picklist} = $val if $val;
  87     return $self;
  88 }
  89 sub add_lid {
  90     my $self = shift;
  91     $self->{args}->{lid} += 1;
  92     $self->{args}->{progress} += 1;
  93     return $self;
  94 }
  95 sub add_li {
  96     my $self = shift;
  97     $self->{args}->{li} += 1;
  98     $self->{args}->{progress} += 1;
  99     return $self;
 100 }
 101 sub add_vqbr {
 102     my $self = shift;
 103     $self->{args}->{vqbr} += 1;
 104     $self->{args}->{progress} += 1;
 105     return $self;
 106 }
 107 sub add_copy {
 108     my $self = shift;
 109     $self->{args}->{copies} += 1;
 110     $self->{args}->{progress} += 1;
 111     return $self;
 112 }
 113 sub add_bib {
 114     my $self = shift;
 115     $self->{args}->{bibs} += 1;
 116     $self->{args}->{progress} += 1;
 117     return $self;
 118 }
 119 sub add_debit {
 120     my($self, $amount) = @_;
 121     $self->{args}->{debits_accrued} += $amount;
 122     $self->{args}->{progress} += 1;
 123     return $self;
 124 }
 125 sub editor {
 126     my($self, $editor) = @_;
 127     $self->{editor} = $editor if defined $editor;
 128     return $self->{editor};
 129 }
 130 sub complete {
 131     my $self = shift;
 132     $self->{args}->{complete} = 1;
 133     return $self;
 134 }
 135
 136 sub cache {
 137     my($self, $org, $key, $val) = @_;
 138     $self->{cache}->{$org} = {} unless $self->{cache}->{org};
 139     $self->{cache}->{$org}->{$key} = $val if defined $val;
 140     return $self->{cache}->{$org}->{$key};
 141 }
 142
 143
 144 package OpenILS::Application::Acq::Order;
 145 use base qw/OpenILS::Application/;
 146 use strict; use warnings;
 147 # ----------------------------------------------------------------------------
 148 # Break up each component of the order process and pieces into managable
 149 # actions that can be shared across different workflows
 150 # ----------------------------------------------------------------------------
 151 use OpenILS::Event;
 152 use OpenSRF::Utils::Logger qw(:logger);
 153 use OpenSRF::Utils::JSON;
 154 use OpenSRF::AppSession;
 155 use OpenILS::Utils::Fieldmapper;
 156 use OpenILS::Utils::CStoreEditor q/:funcs/;
 157 use OpenILS::Utils::Normalize qw/clean_marc/;
 158 use OpenILS::Const qw/:const/;
 159 use OpenSRF::EX q/:try/;
 160 use OpenILS::Application::AppUtils;
 161 use OpenILS::Application::Cat::BibCommon;
 162 use OpenILS::Application::Cat::AssetCommon;
 163 use MARC::Record;
 164 use MARC::Batch;
 165 use MARC::File::XML (BinaryEncoding => 'UTF-8');
 166 use Digest::MD5 qw(md5_hex);
 167 use Data::Dumper;
 168 $Data::Dumper::Indent = 0;
 169 my $U = 'OpenILS::Application::AppUtils';
 170
 171
 172 # ----------------------------------------------------------------------------
 173 # Lineitem
 174 # ----------------------------------------------------------------------------
 175 sub create_lineitem {
 176     my($mgr, %args) = @_;
 177     my $li = Fieldmapper::acq::lineitem->new;
 178     $li->creator($mgr->editor->requestor->id);
 179     $li->selector($li->creator);
 180     $li->editor($li->creator);
 181     $li->create_time('now');
 182     $li->edit_time('now');
 183     $li->state('new');
 184     $li->$_($args{$_}) for keys %args;
 185     $li->clear_id;
 186     $mgr->add_li;
 187     $mgr->editor->create_acq_lineitem($li) or return 0;
 188
 189     unless($li->estimated_unit_price) {
 190         # extract the price from the MARC data
 191         my $price = get_li_price_from_attr($mgr->editor, $li) or return $li;
 192         $li->estimated_unit_price($price);
 193         return update_lineitem($mgr, $li);
 194     }
 195
 196     return $li;
 197 }
 198
 199 sub get_li_price_from_attr {
 200     my($e, $li) = @_;
 201     my $attrs = $li->attributes || $e->search_acq_lineitem_attr({lineitem => $li->id});
 202
 203     for my $attr_type (qw/
 204             lineitem_local_attr_definition
 205             lineitem_prov_attr_definition
 206             lineitem_marc_attr_definition/) {
 207
 208         my ($attr) = grep {
 209             $_->attr_name eq 'estimated_price' and
 210             $_->attr_type eq $attr_type } @$attrs;
 211
 212         return $attr->attr_value if $attr;
 213     }
 214
 215     return undef;
 216 }
 217
 218
 219 sub update_lineitem {
 220     my($mgr, $li) = @_;
 221     $li->edit_time('now');
 222     $li->editor($mgr->editor->requestor->id);
 223     $mgr->add_li;
 224     return $mgr->editor->retrieve_acq_lineitem($mgr->editor->data) if
 225         $mgr->editor->update_acq_lineitem($li);
 226     return undef;
 227 }
 228
 229
 230 # ----------------------------------------------------------------------------
 231 # Create real holds from patron requests for a given lineitem
 232 # ----------------------------------------------------------------------------
 233 sub promote_lineitem_holds {
 234     my($mgr, $li) = @_;
 235
 236     my $requests = $mgr->editor->search_acq_user_request(
 237         { lineitem => $li->id,
 238           '-or' =>
 239             [ { need_before => {'>' => 'now'} },
 240               { need_before => undef }
 241             ]
 242         }
 243     );
 244
 245     for my $request ( @$requests ) {
 246
 247         $request->eg_bib( $li->eg_bib_id );
 248         $mgr->editor->update_acq_user_request( $request ) or return 0;
 249
 250         next unless ($U->is_true( $request->hold ));
 251
 252         my $hold = Fieldmapper::action::hold_request->new;
 253         $hold->usr( $request->usr );
 254         $hold->requestor( $request->usr );
 255         $hold->request_time( $request->request_date );
 256         $hold->pickup_lib( $request->pickup_lib );
 257         $hold->request_lib( $request->pickup_lib );
 258         $hold->selection_ou( $request->pickup_lib );
 259         $hold->phone_notify( $request->phone_notify );
 260         $hold->email_notify( $request->email_notify );
 261         $hold->expire_time( $request->need_before );
 262
 263         if ($request->holdable_formats) {
 264             my $mrm = $mgr->editor->search_metabib_metarecord_source_map( { source => $li->eg_bib_id } )->[0];
 265             if ($mrm) {
 266                 $hold->hold_type( 'M' );
 267                 $hold->holdable_formats( $request->holdable_formats );
 268                 $hold->target( $mrm->metarecord );
 269             }
 270         }
 271
 272         if (!$hold->target) {
 273             $hold->hold_type( 'T' );
 274             $hold->target( $li->eg_bib_id );
 275         }
 276
 277         $mgr->editor->create_action_hold_request( $hold ) or return 0;
 278     }
 279
 280     return $li;
 281 }
 282
 283 sub delete_lineitem {
 284     my($mgr, $li) = @_;
 285     $li = $mgr->editor->retrieve_acq_lineitem($li) unless ref $li;
 286
 287     # delete the attached lineitem_details
 288     my $lid_ids = $mgr->editor->search_acq_lineitem_detail({lineitem => $li->id}, {idlist=>1});
 289     for my $lid_id (@$lid_ids) {
 290         return 0 unless delete_lineitem_detail($mgr, $lid_id);
 291     }
 292
 293     $mgr->add_li;
 294     return $mgr->editor->delete_acq_lineitem($li);
 295 }
 296
 297 # begins and commit transactions as it goes
 298 # bib_only exits before creation of copies and callnumbers
 299 sub create_lineitem_list_assets {
 300     my($mgr, $li_ids, $vandelay, $bib_only) = @_;
 301
 302     if (check_import_li_marc_perms($mgr, $li_ids)) { # event on error
 303         $logger->error("acq-vl: user does not have permission to import acq records");
 304         return undef;
 305     }
 306
 307     my $res = import_li_bibs_via_vandelay($mgr, $li_ids, $vandelay);
 308     return undef unless $res;
 309     return $res if $bib_only;
 310
 311     # create the bibs/volumes/copies for the successfully imported records
 312     for my $li_id (@{$res->{li_ids}}) {
 313         $mgr->editor->xact_begin;
 314         my $data = create_lineitem_assets($mgr, $li_id) or return undef;
 315         $mgr->editor->xact_commit;
 316         $mgr->respond;
 317     }
 318
 319     return $res;
 320 }
 321
 322 sub test_vandelay_import_args {
 323     my $vandelay = shift;
 324
 325     # we need a queue
 326     return 0 unless $vandelay and
 327         ($vandelay->{queue_name} or $vandelay->{existing_queue});
 328
 329     # match-based merge/overlay import
 330     return 2 if $vandelay->{merge_profile} and (
 331         $vandelay->{auto_overlay_exact} or
 332         $vandelay->{auto_overlay_1match} or
 333         $vandelay->{auto_overlay_best_match}
 334     );
 335
 336     # no-match import
 337     return 2 if $vandelay->{import_no_match};
 338
 339     return 1; # queue only
 340 }
 341
 342 sub find_or_create_vandelay_queue {
 343     my ($e, $vandelay) = @_;
 344
 345     my $queue;
 346     if (my $name = $vandelay->{queue_name}) {
 347
 348         # first, see if a queue w/ this name already exists
 349         # for this user.  If so, use that instead.
 350
 351         $queue = $e->search_vandelay_bib_queue(
 352             {name => $name, owner => $e->requestor->id})->[0];
 353
 354         if ($queue) {
 355
 356             $logger->info("acq-vl: using existing queue $name");
 357
 358         } else {
 359
 360             $logger->info("acq-vl: creating new vandelay queue $name");
 361
 362             $queue = new Fieldmapper::vandelay::bib_queue;
 363             $queue->name($name);
 364             $queue->queue_type('acq');
 365             $queue->owner($e->requestor->id);
 366             $queue->match_set($vandelay->{match_set} || undef); # avoid ''
 367             $queue = $e->create_vandelay_bib_queue($queue) or return undef;
 368         }
 369
 370     } else {
 371         $queue = $e->retrieve_vandelay_bib_queue($vandelay->{existing_queue})
 372             or return undef;
 373     }
 374
 375     return $queue;
 376 }
 377
 378
 379 sub import_li_bibs_via_vandelay {
 380     my ($mgr, $li_ids, $vandelay) = @_;
 381     my $res = {li_ids => []};
 382     my $e = $mgr->editor;
 383     $e->xact_begin;
 384
 385     my $needs_importing = $e->search_acq_lineitem(
 386         {id => $li_ids, eg_bib_id => undef},
 387         {idlist => 1}
 388     );
 389
 390     if (!@$needs_importing) {
 391         $logger->info("acq-vl: all records already imported.  no Vandelay work to do");
 392         return {li_ids => $li_ids};
 393     }
 394
 395     # add the already-imported records to the response list
 396     push(@{$res->{li_ids}}, grep { $_ != @$needs_importing } @$li_ids);
 397
 398     $logger->info("acq-vl: processing recs via Vandelay with args: ".Dumper($vandelay));
 399
 400     my $vl_stat = test_vandelay_import_args($vandelay);
 401     if ($vl_stat == 0) {
 402         $logger->error("acq-vl: invalid vandelay arguments for acq import (queue needed)");
 403         return $res;
 404     }
 405
 406     my $queue = find_or_create_vandelay_queue($e, $vandelay) or return $res;
 407     $mgr->{args}->{queue} = $queue;
 408
 409     # load the lineitems into the queue for merge processing
 410     my @vqbr_ids;
 411     my @lis;
 412     for my $li_id (@$needs_importing) {
 413
 414         my $li = $e->retrieve_acq_lineitem($li_id) or return $res;
 415
 416         my $vqbr = Fieldmapper::vandelay::queued_bib_record->new;
 417         $vqbr->marc($li->marc);
 418         $vqbr->queue($queue->id);
 419         $vqbr->bib_source($vandelay->{bib_source} || undef); # avoid ''
 420         $vqbr = $e->create_vandelay_queued_bib_record($vqbr) or return $res;
 421         push(@vqbr_ids, $vqbr->id);
 422         $mgr->add_vqbr;
 423         $mgr->respond;
 424
 425         # tell the acq record which vandelay record it's linked to
 426         $li->queued_record($vqbr->id);
 427         $e->update_acq_lineitem($li) or return $res;
 428         push(@lis, $li);
 429     }
 430
 431     $logger->info("acq-vl: created vandelay records [@vqbr_ids]");
 432
 433     # we have to commit the transaction now since
 434     # vandelay uses its own transactions.
 435     $e->commit;
 436
 437     return $res if $vl_stat == 1; # queue only
 438
 439     # Import the bibs via vandelay.  Note: Vandely will
 440     # update acq.lineitem.eg_bib_id on successful import.
 441
 442     $vandelay->{report_all} = 1;
 443     my $ses = OpenSRF::AppSession->create('open-ils.vandelay');
 444     my $req = $ses->request(
 445         'open-ils.vandelay.bib_record.list.import',
 446         $e->authtoken, \@vqbr_ids, $vandelay);
 447
 448     # pull the responses, noting all that were successfully imported
 449     my @success_lis;
 450     while (my $resp = $req->recv(timeout => 600)) {
 451         my $stat = $resp->content;
 452
 453         if(!$stat or $U->event_code($stat)) { # import failure
 454             $logger->error("acq-vl: error importing vandelay record " . Dumper($stat));
 455             next;
 456         }
 457
 458         # "imported" refers to the vqbr id, not the
 459         # success/failure of the vqbr merge attempt
 460         next unless $stat->{imported};
 461
 462         my ($imported) = grep {$_->queued_record eq $stat->{imported}} @lis;
 463         my $li_id = $imported->id;
 464
 465         if ($stat->{no_import}) {
 466             $logger->info("acq-vl: acq lineitem $li_id did not import");
 467
 468         } else { # successful import
 469
 470             push(@success_lis, $li_id);
 471             $mgr->add_bib;
 472             $mgr->respond;
 473             $logger->info("acq-vl: acq lineitem $li_id successfully merged/imported");
 474         }
 475     }
 476
 477     $ses->kill_me;
 478     $logger->info("acq-vl: successfully imported lineitems [@success_lis]");
 479
 480     # add the successfully imported lineitems to the already-imported lineitems
 481     push (@{$res->{li_ids}}, @success_lis);
 482
 483     return $res;
 484 }
 485
 486 # returns event on error, undef on success
 487 sub check_import_li_marc_perms {
 488     my($mgr, $li_ids) = @_;
 489
 490     # if there are any order records that are not linked to
 491     # in-db bib records, verify staff has perms to import order records
 492     my $order_li = $mgr->editor->search_acq_lineitem(
 493         [{id => $li_ids, eg_bib_id => undef}, {limit => 1}], {idlist => 1})->[0];
 494
 495     if($order_li) {
 496         return $mgr->editor->die_event unless
 497             $mgr->editor->allowed('IMPORT_ACQ_LINEITEM_BIB_RECORD');
 498     }
 499
 500     return undef;
 501 }
 502
 503
 504 # ----------------------------------------------------------------------------
 505 # if all of the lineitem details for this lineitem have
 506 # been received, mark the lineitem as received
 507 # returns 1 on non-received, li on received, 0 on error
 508 # ----------------------------------------------------------------------------
 509
 510 sub describe_affected_po {
 511     my ($e, $po) = @_;
 512
 513     my ($enc, $spent) =
 514         OpenILS::Application::Acq::Financials::build_price_summary(
 515             $e, $po->id
 516         );
 517
 518     +{$po->id => {
 519             "state" => $po->state,
 520             "amount_encumbered" => $enc,
 521             "amount_spent" => $spent
 522         }
 523     };
 524 }
 525
 526 sub check_lineitem_received {
 527     my($mgr, $li_id) = @_;
 528
 529     my $non_recv = $mgr->editor->search_acq_lineitem_detail(
 530         {recv_time => undef, lineitem => $li_id}, {idlist=>1});
 531
 532     return 1 if @$non_recv;
 533
 534     my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
 535     $li->state('received');
 536     return update_lineitem($mgr, $li);
 537 }
 538
 539 sub receive_lineitem {
 540     my($mgr, $li_id, $skip_complete_check) = @_;
 541     my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
 542
 543     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
 544         {lineitem => $li_id, recv_time => undef}, {idlist => 1});
 545
 546     for my $lid_id (@$lid_ids) {
 547        receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
 548     }
 549
 550     $mgr->add_li;
 551     $li->state('received');
 552
 553     $li = update_lineitem($mgr, $li) or return 0;
 554     $mgr->post_process( sub { create_lineitem_status_events($mgr, $li_id, 'aur.received'); });
 555
 556     my $po;
 557     return 0 unless
 558         $skip_complete_check or (
 559             $po = check_purchase_order_received($mgr, $li->purchase_order)
 560         );
 561
 562     my $result = {"li" => {$li->id => {"state" => $li->state}}};
 563     $result->{"po"} = describe_affected_po($mgr->editor, $po) if ref $po;
 564     return $result;
 565 }
 566
 567 sub rollback_receive_lineitem {
 568     my($mgr, $li_id) = @_;
 569     my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
 570
 571     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
 572         {lineitem => $li_id, recv_time => {'!=' => undef}}, {idlist => 1});
 573
 574     for my $lid_id (@$lid_ids) {
 575        rollback_receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
 576     }
 577
 578     $mgr->add_li;
 579     $li->state('on-order');
 580     return update_lineitem($mgr, $li);
 581 }
 582
 583
 584 sub create_lineitem_status_events {
 585     my($mgr, $li_id, $hook) = @_;
 586
 587     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
 588     $ses->connect;
 589     my $user_reqs = $mgr->editor->search_acq_user_request([
 590         {lineitem => $li_id},
 591         {flesh => 1, flesh_fields => {aur => ['usr']}}
 592     ]);
 593
 594     for my $user_req (@$user_reqs) {
 595         my $req = $ses->request('open-ils.trigger.event.autocreate', $hook, $user_req, $user_req->usr->home_ou);
 596         $req->recv;
 597     }
 598
 599     $ses->disconnect;
 600     return undef;
 601 }
 602
 603 # ----------------------------------------------------------------------------
 604 # Lineitem Detail
 605 # ----------------------------------------------------------------------------
 606 sub create_lineitem_detail {
 607     my($mgr, %args) = @_;
 608     my $lid = Fieldmapper::acq::lineitem_detail->new;
 609     $lid->$_($args{$_}) for keys %args;
 610     $lid->clear_id;
 611     $mgr->add_lid;
 612     return $mgr->editor->create_acq_lineitem_detail($lid);
 613 }
 614
 615
 616 # flesh out any required data with default values where appropriate
 617 sub complete_lineitem_detail {
 618     my($mgr, $lid) = @_;
 619     unless($lid->barcode) {
 620         my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_barcode_prefix') || 'ACQ';
 621         $lid->barcode($pfx.$lid->id);
 622     }
 623
 624     unless($lid->cn_label) {
 625         my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_callnumber_prefix') || 'ACQ';
 626         $lid->cn_label($pfx.$lid->id);
 627     }
 628
 629     if(!$lid->location and my $loc = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.default_copy_location')) {
 630         $lid->location($loc);
 631     }
 632
 633     $lid->circ_modifier(get_default_circ_modifier($mgr, $lid->owning_lib))
 634         unless defined $lid->circ_modifier;
 635
 636     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
 637     return $lid;
 638 }
 639
 640 sub get_default_circ_modifier {
 641     my($mgr, $org) = @_;
 642     my $code = $mgr->cache($org, 'def_circ_mod');
 643     $code = $U->ou_ancestor_setting_value($org, 'acq.default_circ_modifier') unless defined $code;
 644     return $mgr->cache($org, 'def_circ_mod', $code) if defined $code;
 645     return undef;
 646 }
 647
 648 sub delete_lineitem_detail {
 649     my($mgr, $lid) = @_;
 650     $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid) unless ref $lid;
 651     return $mgr->editor->delete_acq_lineitem_detail($lid);
 652 }
 653
 654
 655 sub receive_lineitem_detail {
 656     my($mgr, $lid_id, $skip_complete_check) = @_;
 657     my $e = $mgr->editor;
 658
 659     my $lid = $e->retrieve_acq_lineitem_detail([
 660         $lid_id,
 661         {   flesh => 1,
 662             flesh_fields => {
 663                 acqlid => ['fund_debit']
 664             }
 665         }
 666     ]) or return 0;
 667
 668     return 1 if $lid->recv_time;
 669
 670     $lid->receiver($e->requestor->id);
 671     $lid->recv_time('now');
 672     $e->update_acq_lineitem_detail($lid) or return 0;
 673
 674     if ($lid->eg_copy_id) {
 675         my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
 676         $copy->status(OILS_COPY_STATUS_IN_PROCESS);
 677         $copy->edit_date('now');
 678         $copy->editor($e->requestor->id);
 679         $copy->creator($e->requestor->id) if $U->ou_ancestor_setting_value(
 680             $e->requestor->ws_ou, 'acq.copy_creator_uses_receiver', $e);
 681         $e->update_asset_copy($copy) or return 0;
 682     }
 683
 684     $mgr->add_lid;
 685
 686     return 1 if $skip_complete_check;
 687
 688     my $li = check_lineitem_received($mgr, $lid->lineitem) or return 0;
 689     return 1 if $li == 1; # li not received
 690
 691     return check_purchase_order_received($mgr, $li->purchase_order) or return 0;
 692 }
 693
 694
 695 sub rollback_receive_lineitem_detail {
 696     my($mgr, $lid_id) = @_;
 697     my $e = $mgr->editor;
 698
 699     my $lid = $e->retrieve_acq_lineitem_detail([
 700         $lid_id,
 701         {   flesh => 1,
 702             flesh_fields => {
 703                 acqlid => ['fund_debit']
 704             }
 705         }
 706     ]) or return 0;
 707
 708     return 1 unless $lid->recv_time;
 709
 710     $lid->clear_receiver;
 711     $lid->clear_recv_time;
 712     $e->update_acq_lineitem_detail($lid) or return 0;
 713
 714     if ($lid->eg_copy_id) {
 715         my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
 716         $copy->status(OILS_COPY_STATUS_ON_ORDER);
 717         $copy->edit_date('now');
 718         $copy->editor($e->requestor->id);
 719         $e->update_asset_copy($copy) or return 0;
 720     }
 721
 722     $mgr->add_lid;
 723     return $lid;
 724 }
 725
 726 # ----------------------------------------------------------------------------
 727 # Lineitem Attr
 728 # ----------------------------------------------------------------------------
 729 sub set_lineitem_attr {
 730     my($mgr, %args) = @_;
 731     my $attr_type = $args{attr_type};
 732
 733     # first, see if it's already set.  May just need to overwrite it
 734     my $attr = $mgr->editor->search_acq_lineitem_attr({
 735         lineitem => $args{lineitem},
 736         attr_type => $args{attr_type},
 737         attr_name => $args{attr_name}
 738     })->[0];
 739
 740     if($attr) {
 741         $attr->attr_value($args{attr_value});
 742         return $attr if $mgr->editor->update_acq_lineitem_attr($attr);
 743         return undef;
 744
 745     } else {
 746
 747         $attr = Fieldmapper::acq::lineitem_attr->new;
 748         $attr->$_($args{$_}) for keys %args;
 749
 750         unless($attr->definition) {
 751             my $find = "search_acq_$attr_type";
 752             my $attr_def_id = $mgr->editor->$find({code => $attr->attr_name}, {idlist=>1})->[0] or return 0;
 753             $attr->definition($attr_def_id);
 754         }
 755         return $mgr->editor->create_acq_lineitem_attr($attr);
 756     }
 757 }
 758
 759 # ----------------------------------------------------------------------------
 760 # Lineitem Debits
 761 # ----------------------------------------------------------------------------
 762 sub create_lineitem_debits {
 763     my ($mgr, $li, $dry_run) = @_;
 764
 765     unless($li->estimated_unit_price) {
 766         $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PRICE', payload => $li->id));
 767         $mgr->editor->rollback;
 768         return 0;
 769     }
 770
 771     unless($li->provider) {
 772         $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PROVIDER', payload => $li->id));
 773         $mgr->editor->rollback;
 774         return 0;
 775     }
 776
 777     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
 778         {lineitem => $li->id},
 779         {idlist=>1}
 780     );
 781
 782     for my $lid_id (@$lid_ids) {
 783
 784         my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
 785             $lid_id,
 786             {   flesh => 1,
 787                 flesh_fields => {acqlid => ['fund']}
 788             }
 789         ]);
 790
 791         create_lineitem_detail_debit($mgr, $li, $lid, $dry_run) or return 0;
 792     }
 793
 794     return 1;
 795 }
 796
 797
 798 # flesh li->provider
 799 # flesh lid->fund
 800 sub create_lineitem_detail_debit {
 801     my ($mgr, $li, $lid, $dry_run, $no_translate) = @_;
 802
 803     # don't create the debit if one already exists
 804     return $mgr->editor->retrieve_acq_fund_debit($lid->fund_debit) if $lid->fund_debit;
 805
 806     my $li_id = ref($li) ? $li->id : $li;
 807
 808     unless(ref $li and ref $li->provider) {
 809        $li = $mgr->editor->retrieve_acq_lineitem([
 810             $li_id,
 811             {   flesh => 1,
 812                 flesh_fields => {jub => ['provider']},
 813             }
 814         ]);
 815     }
 816
 817     if(ref $lid) {
 818         $lid->fund($mgr->editor->retrieve_acq_fund($lid->fund)) unless(ref $lid->fund);
 819     } else {
 820         $lid = $mgr->editor->retrieve_acq_lineitem_detail([
 821             $lid,
 822             {   flesh => 1,
 823                 flesh_fields => {acqlid => ['fund']}
 824             }
 825         ]);
 826     }
 827
 828     unless ($lid->fund) {
 829         $mgr->editor->event(
 830             new OpenILS::Event("ACQ_FUND_NOT_FOUND") # close enough
 831         );
 832         return 0;
 833     }
 834
 835     my $amount = $li->estimated_unit_price;
 836     if($li->provider->currency_type ne $lid->fund->currency_type and !$no_translate) {
 837
 838         # At Fund debit creation time, translate into the currency of the fund
 839         # TODO: org setting to disable automatic currency conversion at debit create time?
 840
 841         $amount = $mgr->editor->json_query({
 842             from => [
 843                 'acq.exchange_ratio',
 844                 $li->provider->currency_type, # source currency
 845                 $lid->fund->currency_type, # destination currency
 846                 $li->estimated_unit_price # source amount
 847             ]
 848         })->[0]->{'acq.exchange_ratio'};
 849     }
 850
 851     my $debit = create_fund_debit(
 852         $mgr,
 853         $dry_run,
 854         fund => $lid->fund->id,
 855         origin_amount => $li->estimated_unit_price,
 856         origin_currency_type => $li->provider->currency_type,
 857         amount => $amount
 858     ) or return 0;
 859
 860     $lid->fund_debit($debit->id);
 861     $lid->fund($lid->fund->id);
 862     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
 863     return $debit;
 864 }
 865
 866
 867 __PACKAGE__->register_method(
 868         "method" => "fund_exceeds_balance_percent_api",
 869         "api_name" => "open-ils.acq.fund.check_balance_percentages",
 870         "signature" => {
 871         "desc" => q/Determine whether a given fund exceeds its defined
 872             "balance stop and warning percentages"/,
 873         "params" => [
 874             {"desc" => "Authentication token", "type" => "string"},
 875             {"desc" => "Fund ID", "type" => "number"},
 876             {"desc" => "Theoretical debit amount (optional)",
 877                 "type" => "number"}
 878         ],
 879         "return" => {"desc" => q/An array of two values, for stop and warning,
 880             in that order: 1 if fund exceeds that balance percentage, else 0/}
 881     }
 882 );
 883
 884 sub fund_exceeds_balance_percent_api {
 885     my ($self, $conn, $auth, $fund_id, $debit_amount) = @_;
 886
 887     $debit_amount ||= 0;
 888
 889     my $e = new_editor("authtoken" => $auth);
 890     return $e->die_event unless $e->checkauth;
 891
 892     my $fund = $e->retrieve_acq_fund($fund_id) or return $e->die_event;
 893     return $e->die_event unless $e->allowed("VIEW_FUND", $fund->org);
 894
 895     my $result = [
 896         fund_exceeds_balance_percent($fund, $debit_amount, $e, "stop"),
 897         fund_exceeds_balance_percent($fund, $debit_amount, $e, "warning")
 898     ];
 899
 900     $e->disconnect;
 901     return $result;
 902 }
 903
 904 sub fund_exceeds_balance_percent {
 905     my ($fund, $debit_amount, $e, $which) = @_;
 906
 907     my ($method_name, $event_name) = @{{
 908         "warning" => [
 909             "balance_warning_percent", "ACQ_FUND_EXCEEDS_WARN_PERCENT"
 910         ],
 911         "stop" => [
 912             "balance_stop_percent", "ACQ_FUND_EXCEEDS_STOP_PERCENT"
 913         ]
 914     }->{$which}};
 915
 916     if ($fund->$method_name) {
 917         my $balance =
 918             $e->search_acq_fund_combined_balance({"fund" => $fund->id})->[0];
 919         my $allocations =
 920             $e->search_acq_fund_allocation_total({"fund" => $fund->id})->[0];
 921
 922         $balance = ($balance) ? $balance->amount : 0;
 923         $allocations = ($allocations) ? $allocations->amount : 0;
 924
 925         if (
 926             $allocations == 0 || # if no allocations were ever made, assume we have hit the stop percent
 927             ((($allocations - $balance + $debit_amount) / $allocations) * 100) > $fund->$method_name
 928         ) {
 929             $logger->info("fund would hit a limit: " . $fund->id . ", $balance, $debit_amount, $allocations, $method_name");
 930             $e->event(
 931                 new OpenILS::Event(
 932                     $event_name,
 933                     "payload" => {
 934                         "fund" => $fund, "debit_amount" => $debit_amount
 935                     }
 936                 )
 937             );
 938             return 1;
 939         }
 940     }
 941     return 0;
 942 }
 943
 944 # ----------------------------------------------------------------------------
 945 # Fund Debit
 946 # ----------------------------------------------------------------------------
 947 sub create_fund_debit {
 948     my($mgr, $dry_run, %args) = @_;
 949
 950     # Verify the fund is not being spent beyond the hard stop amount
 951     my $fund = $mgr->editor->retrieve_acq_fund($args{fund}) or return 0;
 952
 953     return 0 if
 954         fund_exceeds_balance_percent(
 955             $fund, $args{"amount"}, $mgr->editor, "stop"
 956         );
 957     return 0 if
 958         $dry_run and fund_exceeds_balance_percent(
 959             $fund, $args{"amount"}, $mgr->editor, "warning"
 960         );
 961
 962     my $debit = Fieldmapper::acq::fund_debit->new;
 963     $debit->debit_type('purchase');
 964     $debit->encumbrance('t');
 965     $debit->$_($args{$_}) for keys %args;
 966     $debit->clear_id;
 967     $mgr->add_debit($debit->amount);
 968     return $mgr->editor->create_acq_fund_debit($debit);
 969 }
 970
 971
 972 # ----------------------------------------------------------------------------
 973 # Picklist
 974 # ----------------------------------------------------------------------------
 975 sub create_picklist {
 976     my($mgr, %args) = @_;
 977     my $picklist = Fieldmapper::acq::picklist->new;
 978     $picklist->creator($mgr->editor->requestor->id);
 979     $picklist->owner($picklist->creator);
 980     $picklist->editor($picklist->creator);
 981     $picklist->create_time('now');
 982     $picklist->edit_time('now');
 983     $picklist->org_unit($mgr->editor->requestor->ws_ou);
 984     $picklist->owner($mgr->editor->requestor->id);
 985     $picklist->$_($args{$_}) for keys %args;
 986     $picklist->clear_id;
 987     $mgr->picklist($picklist);
 988     return $mgr->editor->create_acq_picklist($picklist);
 989 }
 990
 991 sub update_picklist {
 992     my($mgr, $picklist) = @_;
 993     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
 994     $picklist->edit_time('now');
 995     $picklist->editor($mgr->editor->requestor->id);
 996     if ($mgr->editor->update_acq_picklist($picklist)) {
 997         $picklist = $mgr->editor->retrieve_acq_picklist($mgr->editor->data);
 998         $mgr->picklist($picklist);
 999         return $picklist;
1000     } else {
1001         return undef;
1002     }
1003 }
1004
1005 sub delete_picklist {
1006     my($mgr, $picklist) = @_;
1007     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
1008
1009     # delete all 'new' lineitems
1010     my $li_ids = $mgr->editor->search_acq_lineitem(
1011         {
1012             picklist => $picklist->id,
1013             "-or" => {state => "new", purchase_order => undef}
1014         },
1015         {idlist => 1}
1016     );
1017     for my $li_id (@$li_ids) {
1018         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
1019         return 0 unless delete_lineitem($mgr, $li);
1020         $mgr->respond;
1021     }
1022
1023     # detach all non-'new' lineitems
1024     $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => {'!=' => 'new'}}, {idlist => 1});
1025     for my $li_id (@$li_ids) {
1026         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
1027         $li->clear_picklist;
1028         return 0 unless update_lineitem($mgr, $li);
1029         $mgr->respond;
1030     }
1031
1032     # remove any picklist-specific object perms
1033     my $ops = $mgr->editor->search_permission_usr_object_perm_map({object_type => 'acqpl', object_id => ''.$picklist->id});
1034     for my $op (@$ops) {
1035         return 0 unless $mgr->editor->delete_usr_object_perm_map($op);
1036     }
1037
1038     return $mgr->editor->delete_acq_picklist($picklist);
1039 }
1040
1041 # ----------------------------------------------------------------------------
1042 # Purchase Order
1043 # ----------------------------------------------------------------------------
1044 sub update_purchase_order {
1045     my($mgr, $po) = @_;
1046     $po = $mgr->editor->retrieve_acq_purchase_order($po) unless ref $po;
1047     $po->editor($mgr->editor->requestor->id);
1048     $po->edit_time('now');
1049     $mgr->purchase_order($po);
1050     return $mgr->editor->retrieve_acq_purchase_order($mgr->editor->data)
1051         if $mgr->editor->update_acq_purchase_order($po);
1052     return undef;
1053 }
1054
1055 sub create_purchase_order {
1056     my($mgr, %args) = @_;
1057
1058     # verify the chosen provider is still active
1059     my $provider = $mgr->editor->retrieve_acq_provider($args{provider}) or return 0;
1060     unless($U->is_true($provider->active)) {
1061         $logger->error("provider is not active.  cannot create PO");
1062         $mgr->editor->event(OpenILS::Event->new('ACQ_PROVIDER_INACTIVE'));
1063         return 0;
1064     }
1065
1066     my $po = Fieldmapper::acq::purchase_order->new;
1067     $po->creator($mgr->editor->requestor->id);
1068     $po->editor($mgr->editor->requestor->id);
1069     $po->owner($mgr->editor->requestor->id);
1070     $po->edit_time('now');
1071     $po->create_time('now');
1072     $po->state('pending');
1073     $po->ordering_agency($mgr->editor->requestor->ws_ou);
1074     $po->$_($args{$_}) for keys %args;
1075     $po->clear_id;
1076     $mgr->purchase_order($po);
1077     return $mgr->editor->create_acq_purchase_order($po);
1078 }
1079
1080 # ----------------------------------------------------------------------------
1081 # if all of the lineitems for this PO are received,
1082 # mark the PO as received
1083 # ----------------------------------------------------------------------------
1084 sub check_purchase_order_received {
1085     my($mgr, $po_id) = @_;
1086
1087     my $non_recv_li = $mgr->editor->search_acq_lineitem(
1088         {   purchase_order => $po_id,
1089             state => {'!=' => 'received'}
1090         }, {idlist=>1});
1091
1092     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id);
1093     return $po if @$non_recv_li;
1094
1095     $po->state('received');
1096     return update_purchase_order($mgr, $po);
1097 }
1098
1099
1100 # ----------------------------------------------------------------------------
1101 # Bib, Callnumber, and Copy data
1102 # ----------------------------------------------------------------------------
1103
1104 sub create_lineitem_assets {
1105     my($mgr, $li_id) = @_;
1106     my $evt;
1107
1108     my $li = $mgr->editor->retrieve_acq_lineitem([
1109         $li_id,
1110         {   flesh => 1,
1111             flesh_fields => {jub => ['purchase_order', 'attributes']}
1112         }
1113     ]) or return 0;
1114
1115     # note: at this point, the bib record this LI links to should already be created
1116
1117     # -----------------------------------------------------------------
1118     # The lineitem is going live, promote user request holds to real holds
1119     # -----------------------------------------------------------------
1120     promote_lineitem_holds($mgr, $li) or return 0;
1121
1122     my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
1123
1124     # -----------------------------------------------------------------
1125     # for each lineitem_detail, create the volume if necessary, create
1126     # a copy, and link them all together.
1127     # -----------------------------------------------------------------
1128     my $first_cn;
1129     for my $lid_id (@{$li_details}) {
1130
1131         my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
1132         next if $lid->eg_copy_id;
1133
1134         # use the same callnumber label for all items within this lineitem
1135         $lid->cn_label($first_cn) if $first_cn and not $lid->cn_label;
1136
1137         # apply defaults if necessary
1138         return 0 unless complete_lineitem_detail($mgr, $lid);
1139
1140         $first_cn = $lid->cn_label unless $first_cn;
1141
1142         my $org = $lid->owning_lib;
1143         my $label = $lid->cn_label;
1144         my $bibid = $li->eg_bib_id;
1145
1146         my $volume = $mgr->cache($org, "cn.$bibid.$label");
1147         unless($volume) {
1148             $volume = create_volume($mgr, $li, $lid) or return 0;
1149             $mgr->cache($org, "cn.$bibid.$label", $volume);
1150         }
1151         create_copy($mgr, $volume, $lid, $li) or return 0;
1152     }
1153
1154     return { li => $li };
1155 }
1156
1157 sub create_volume {
1158     my($mgr, $li, $lid) = @_;
1159
1160     my ($volume, $evt) =
1161         OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1162             $mgr->editor,
1163             $lid->cn_label,
1164             $li->eg_bib_id,
1165             $lid->owning_lib
1166         );
1167
1168     if($evt) {
1169         $mgr->editor->event($evt);
1170         return 0;
1171     }
1172
1173     return $volume;
1174 }
1175
1176 sub create_copy {
1177     my($mgr, $volume, $lid, $li) = @_;
1178     my $copy = Fieldmapper::asset::copy->new;
1179     $copy->isnew(1);
1180     $copy->loan_duration(2);
1181     $copy->fine_level(2);
1182     $copy->status(($lid->recv_time) ? OILS_COPY_STATUS_IN_PROCESS : OILS_COPY_STATUS_ON_ORDER);
1183     $copy->barcode($lid->barcode);
1184     $copy->location($lid->location);
1185     $copy->call_number($volume->id);
1186     $copy->circ_lib($volume->owning_lib);
1187     $copy->circ_modifier($lid->circ_modifier);
1188
1189     # AKA list price.  We might need a $li->list_price field since
1190     # estimated price is not necessarily the same as list price
1191     $copy->price($li->estimated_unit_price);
1192
1193     my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
1194     if($evt) {
1195         $mgr->editor->event($evt);
1196         return 0;
1197     }
1198
1199     $mgr->add_copy;
1200     $lid->eg_copy_id($copy->id);
1201     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
1202 }
1203
1204
1205
1206
1207
1208
1209 # ----------------------------------------------------------------------------
1210 # Workflow: Build a selection list from a Z39.50 search
1211 # ----------------------------------------------------------------------------
1212
1213 __PACKAGE__->register_method(
1214         method => 'zsearch',
1215         api_name => 'open-ils.acq.picklist.search.z3950',
1216     stream => 1,
1217         signature => {
1218         desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
1219         params => [
1220             {desc => 'Authentication token', type => 'string'},
1221             {desc => 'Search definition', type => 'object'},
1222             {desc => 'Picklist name, optional', type => 'string'},
1223         ]
1224     }
1225 );
1226
1227 sub zsearch {
1228     my($self, $conn, $auth, $search, $name, $options) = @_;
1229     my $e = new_editor(authtoken=>$auth);
1230     return $e->event unless $e->checkauth;
1231     return $e->event unless $e->allowed('CREATE_PICKLIST');
1232
1233     $search->{limit} ||= 10;
1234     $options ||= {};
1235
1236     my $ses = OpenSRF::AppSession->create('open-ils.search');
1237     my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
1238
1239     my $first = 1;
1240     my $picklist;
1241     my $mgr;
1242     while(my $resp = $req->recv(timeout=>60)) {
1243
1244         if($first) {
1245             my $e = new_editor(requestor=>$e->requestor, xact=>1);
1246             $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1247             $picklist = zsearch_build_pl($mgr, $name);
1248             $first = 0;
1249         }
1250
1251         my $result = $resp->content;
1252         my $count = $result->{count} || 0;
1253         $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
1254
1255         for my $rec (@{$result->{records}}) {
1256
1257             my $li = create_lineitem($mgr,
1258                 picklist => $picklist->id,
1259                 source_label => $result->{service},
1260                 marc => $rec->{marcxml},
1261                 eg_bib_id => $rec->{bibid}
1262             );
1263
1264             if($$options{respond_li}) {
1265                 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
1266                     if $$options{flesh_attrs};
1267                 $li->clear_marc if $$options{clear_marc};
1268                 $mgr->respond(lineitem => $li);
1269             } else {
1270                 $mgr->respond;
1271             }
1272         }
1273     }
1274
1275     $mgr->editor->commit;
1276     return $mgr->respond_complete;
1277 }
1278
1279 sub zsearch_build_pl {
1280     my($mgr, $name) = @_;
1281     $name ||= '';
1282
1283     my $picklist = $mgr->editor->search_acq_picklist({
1284         owner => $mgr->editor->requestor->id,
1285         name => $name
1286     })->[0];
1287
1288     if($name eq '' and $picklist) {
1289         return 0 unless delete_picklist($mgr, $picklist);
1290         $picklist = undef;
1291     }
1292
1293     return update_picklist($mgr, $picklist) if $picklist;
1294     return create_picklist($mgr, name => $name);
1295 }
1296
1297
1298 # ----------------------------------------------------------------------------
1299 # Workflow: Build a selection list / PO by importing a batch of MARC records
1300 # ----------------------------------------------------------------------------
1301
1302 __PACKAGE__->register_method(
1303     method   => 'upload_records',
1304     api_name => 'open-ils.acq.process_upload_records',
1305     stream   => 1,
1306     max_chunk_count => 1
1307 );
1308
1309 sub upload_records {
1310     my($self, $conn, $auth, $key, $args) = @_;
1311     $args ||= {};
1312
1313         my $e = new_editor(authtoken => $auth, xact => 1);
1314     return $e->die_event unless $e->checkauth;
1315     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1316
1317     my $cache = OpenSRF::Utils::Cache->new;
1318
1319     my $data = $cache->get_cache("vandelay_import_spool_$key");
1320     my $filename        = $data->{path};
1321     my $provider        = $args->{provider};
1322     my $picklist        = $args->{picklist};
1323     my $create_po       = $args->{create_po};
1324     my $activate_po     = $args->{activate_po};
1325     my $vandelay        = $args->{vandelay};
1326     my $ordering_agency = $args->{ordering_agency} || $e->requestor->ws_ou;
1327     my $po;
1328     my $evt;
1329
1330     unless(-r $filename) {
1331         $logger->error("unable to read MARC file $filename");
1332         $e->rollback;
1333         return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
1334     }
1335
1336     $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
1337
1338     if($picklist) {
1339         $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
1340         if($picklist->owner != $e->requestor->id) {
1341             return $e->die_event unless
1342                 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
1343         }
1344         $mgr->picklist($picklist);
1345     }
1346
1347     if($create_po) {
1348         return $e->die_event unless
1349             $e->allowed('CREATE_PURCHASE_ORDER', $ordering_agency);
1350
1351         $po = create_purchase_order($mgr,
1352             ordering_agency => $ordering_agency,
1353             provider => $provider->id,
1354             state => 'pending' # will be updated later if activated
1355         ) or return $mgr->editor->die_event;
1356     }
1357
1358     $logger->info("acq processing MARC file=$filename");
1359
1360         my $batch = new MARC::Batch ('USMARC', $filename);
1361         $batch->strict_off;
1362
1363         my $count = 0;
1364     my @li_list;
1365
1366         while(1) {
1367
1368             my ($err, $xml, $r);
1369                 $count++;
1370
1371                 try {
1372             $r = $batch->next;
1373         } catch Error with {
1374             $err = shift;
1375                         $logger->warn("Proccessing of record $count in set $key failed with error $err.  Skipping this record");
1376         };
1377
1378         next if $err;
1379         last unless $r;
1380
1381                 try {
1382             $xml = clean_marc($r);
1383                 } catch Error with {
1384                         $err = shift;
1385                         $logger->warn("Proccessing XML of record $count in set $key failed with error $err.  Skipping this record");
1386                 };
1387
1388         next if $err or not $xml;
1389
1390         my %args = (
1391             source_label => $provider->code,
1392             provider => $provider->id,
1393             marc => $xml,
1394         );
1395
1396         $args{picklist} = $picklist->id if $picklist;
1397         if($po) {
1398             $args{purchase_order} = $po->id;
1399             $args{state} = 'pending-order';
1400         }
1401
1402         my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
1403         $mgr->respond;
1404         $li->provider($provider); # flesh it, we'll need it later
1405
1406         import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
1407         $mgr->respond;
1408
1409         push(@li_list, $li->id);
1410         $mgr->respond;
1411         }
1412
1413         $e->commit;
1414     unlink($filename);
1415     $cache->delete_cache('vandelay_import_spool_' . $key);
1416
1417     if ($po and $activate_po) {
1418         my $die_event = activate_purchase_order_impl($mgr, $po->id, $vandelay);
1419         return $die_event if $die_event;
1420
1421     } elsif ($vandelay) {
1422         $vandelay->{new_rec_perm} = 'IMPORT_ACQ_LINEITEM_BIB_RECORD_UPLOAD';
1423         create_lineitem_list_assets($mgr, \@li_list, $vandelay,
1424             !$vandelay->{create_assets}) or return $e->die_event;
1425     }
1426
1427     return $mgr->respond_complete;
1428 }
1429
1430 sub import_lineitem_details {
1431     my($mgr, $ordering_agency, $li) = @_;
1432
1433     my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
1434     return 1 unless @$holdings;
1435     my $org_path = $U->get_org_ancestors($ordering_agency);
1436     $org_path = [ reverse (@$org_path) ];
1437     my $price;
1438
1439
1440     my $idx = 1;
1441     while(1) {
1442         # create a lineitem detail for each copy in the data
1443
1444         my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
1445         last unless defined $compiled;
1446         return 0 unless $compiled;
1447
1448         # this takes the price of the last copy and uses it as the lineitem price
1449         # need to determine if a given record would include different prices for the same item
1450         $price = $$compiled{estimated_price};
1451
1452         last unless $$compiled{quantity};
1453
1454         for(1..$$compiled{quantity}) {
1455             my $lid = create_lineitem_detail(
1456                 $mgr,
1457                 lineitem        => $li->id,
1458                 owning_lib      => $$compiled{owning_lib},
1459                 cn_label        => $$compiled{call_number},
1460                 fund            => $$compiled{fund},
1461                 circ_modifier   => $$compiled{circ_modifier},
1462                 note            => $$compiled{note},
1463                 location        => $$compiled{copy_location},
1464                 collection_code => $$compiled{collection_code},
1465                 barcode         => $$compiled{barcode}
1466             ) or return 0;
1467         }
1468
1469         $mgr->respond;
1470         $idx++;
1471     }
1472
1473     $li->estimated_unit_price($price);
1474     update_lineitem($mgr, $li) or return 0;
1475     return 1;
1476 }
1477
1478 # return hash on success, 0 on error, undef on no more holdings
1479 sub extract_lineitem_detail_data {
1480     my($mgr, $org_path, $holdings, $index) = @_;
1481
1482     my @data_list = grep { $_->{holding} eq $index } @$holdings;
1483     return undef unless @data_list;
1484
1485     my %compiled = map { $_->{attr} => $_->{data} } @data_list;
1486     my $base_org = $$org_path[0];
1487
1488     my $killme = sub {
1489         my $msg = shift;
1490         $logger->error("Item import extraction error: $msg");
1491         $logger->error('Holdings Data: ' . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
1492         $mgr->editor->rollback;
1493         $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
1494         return 0;
1495     };
1496
1497     # ---------------------------------------------------------------------
1498     # Fund
1499     if(my $code = $compiled{fund_code}) {
1500
1501         my $fund = $mgr->cache($base_org, "fund.$code");
1502         unless($fund) {
1503             # search up the org tree for the most appropriate fund
1504             for my $org (@$org_path) {
1505                 $fund = $mgr->editor->search_acq_fund(
1506                     {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
1507                 last if $fund;
1508             }
1509         }
1510         return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
1511         $compiled{fund} = $fund;
1512         $mgr->cache($base_org, "fund.$code", $fund);
1513     }
1514
1515
1516     # ---------------------------------------------------------------------
1517     # Owning lib
1518     if(my $sn = $compiled{owning_lib}) {
1519         my $org_id = $mgr->cache($base_org, "orgsn.$sn") ||
1520             $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
1521         return $killme->("invalid owning_lib defined: $sn") unless $org_id;
1522         $compiled{owning_lib} = $org_id;
1523         $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
1524     }
1525
1526
1527     # ---------------------------------------------------------------------
1528     # Circ Modifier
1529     my $code = $compiled{circ_modifier};
1530
1531     if(defined $code) {
1532
1533         # verify this is a valid circ modifier
1534         return $killme->("invlalid circ_modifier $code") unless
1535             defined $mgr->cache($base_org, "mod.$code") or
1536             $mgr->editor->retrieve_config_circ_modifier($code);
1537
1538             # if valid, cache for future tests
1539             $mgr->cache($base_org, "mod.$code", $code);
1540
1541     } else {
1542         $compiled{circ_modifier} = get_default_circ_modifier($mgr, $base_org);
1543     }
1544
1545
1546     # ---------------------------------------------------------------------
1547     # Shelving Location
1548     if( my $name = $compiled{copy_location}) {
1549         my $loc = $mgr->cache($base_org, "copy_loc.$name");
1550         unless($loc) {
1551             for my $org (@$org_path) {
1552                 $loc = $mgr->editor->search_asset_copy_location(
1553                     {owning_lib => $org, name => $name}, {idlist => 1})->[0];
1554                 last if $loc;
1555             }
1556         }
1557         return $killme->("Invalid copy location $name") unless $loc;
1558         $compiled{copy_location} = $loc;
1559         $mgr->cache($base_org, "copy_loc.$name", $loc);
1560     }
1561
1562     return \%compiled;
1563 }
1564
1565
1566
1567 # ----------------------------------------------------------------------------
1568 # Workflow: Given an existing purchase order, import/create the bibs,
1569 # callnumber and copy objects
1570 # ----------------------------------------------------------------------------
1571
1572 __PACKAGE__->register_method(
1573         method => 'create_po_assets',
1574         api_name        => 'open-ils.acq.purchase_order.assets.create',
1575         signature => {
1576         desc => q/Creates assets for each lineitem in the purchase order/,
1577         params => [
1578             {desc => 'Authentication token', type => 'string'},
1579             {desc => 'The purchase order id', type => 'number'},
1580         ],
1581         return => {desc => 'Streams a total versus completed counts object, event on error'}
1582     },
1583     max_chunk_count => 1
1584 );
1585
1586 sub create_po_assets {
1587     my($self, $conn, $auth, $po_id, $args) = @_;
1588     $args ||= {};
1589
1590     my $e = new_editor(authtoken=>$auth, xact=>1);
1591     return $e->die_event unless $e->checkauth;
1592     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1593
1594     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1595
1596     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1597
1598     # it's ugly, but it's fast.  Get the total count of lineitem detail objects to process
1599     my $lid_total = $e->json_query({
1600         select => { acqlid => [{aggregate => 1, transform => 'count', column => 'id'}] },
1601         from => {
1602             acqlid => {
1603                 jub => {
1604                     fkey => 'lineitem',
1605                     field => 'id',
1606                     join => {acqpo => {fkey => 'purchase_order', field => 'id'}}
1607                 }
1608             }
1609         },
1610         where => {'+acqpo' => {id => $po_id}}
1611     })->[0]->{id};
1612
1613     $mgr->total(scalar(@$li_ids) + $lid_total);
1614
1615     create_lineitem_list_assets($mgr, $li_ids, $args->{vandelay})
1616         or return $e->die_event;
1617
1618     $e->xact_begin;
1619     update_purchase_order($mgr, $po) or return $e->die_event;
1620     $e->commit;
1621
1622     return $mgr->respond_complete;
1623 }
1624
1625
1626
1627 __PACKAGE__->register_method(
1628     method    => 'create_purchase_order_api',
1629     api_name  => 'open-ils.acq.purchase_order.create',
1630     signature => {
1631         desc   => 'Creates a new purchase order',
1632         params => [
1633             {desc => 'Authentication token', type => 'string'},
1634             {desc => 'purchase_order to create', type => 'object'}
1635         ],
1636         return => {desc => 'The purchase order id, Event on failure'}
1637     },
1638     max_chunk_count => 1
1639 );
1640
1641 sub create_purchase_order_api {
1642     my($self, $conn, $auth, $po, $args) = @_;
1643     $args ||= {};
1644
1645     my $e = new_editor(xact=>1, authtoken=>$auth);
1646     return $e->die_event unless $e->checkauth;
1647     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1648     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1649
1650     # create the PO
1651     my %pargs = (ordering_agency => $e->requestor->ws_ou); # default
1652     $pargs{provider}            = $po->provider            if $po->provider;
1653     $pargs{ordering_agency}     = $po->ordering_agency     if $po->ordering_agency;
1654     $pargs{prepayment_required} = $po->prepayment_required if $po->prepayment_required;
1655     my $vandelay = $args->{vandelay};
1656
1657     $po = create_purchase_order($mgr, %pargs) or return $e->die_event;
1658
1659     my $li_ids = $$args{lineitems};
1660
1661     if($li_ids) {
1662
1663         for my $li_id (@$li_ids) {
1664
1665             my $li = $e->retrieve_acq_lineitem([
1666                 $li_id,
1667                 {flesh => 1, flesh_fields => {jub => ['attributes']}}
1668             ]) or return $e->die_event;
1669
1670             $li->provider($po->provider);
1671             $li->purchase_order($po->id);
1672             $li->state('pending-order');
1673             update_lineitem($mgr, $li) or return $e->die_event;
1674             $mgr->respond;
1675         }
1676     }
1677
1678     # commit before starting the asset creation
1679     $e->xact_commit;
1680
1681     if($li_ids and $vandelay) {
1682         create_lineitem_list_assets($mgr, $li_ids, $vandelay, !$$args{create_assets}) or return $e->die_event;
1683     }
1684
1685     return $mgr->respond_complete;
1686 }
1687
1688
1689
1690 __PACKAGE__->register_method(
1691     method   => 'update_lineitem_fund_batch',
1692     api_name => 'open-ils.acq.lineitem.fund.update.batch',
1693     stream   => 1,
1694     signature => {
1695         desc => q/Given a set of lineitem IDS, updates the fund for all attached lineitem details/
1696     }
1697 );
1698
1699 sub update_lineitem_fund_batch {
1700     my($self, $conn, $auth, $li_ids, $fund_id) = @_;
1701     my $e = new_editor(xact=>1, authtoken=>$auth);
1702     return $e->die_event unless $e->checkauth;
1703     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1704     for my $li_id (@$li_ids) {
1705         my ($li, $evt) = fetch_and_check_li($e, $li_id, 'write');
1706         return $evt if $evt;
1707         my $li_details = $e->search_acq_lineitem_detail({lineitem => $li_id});
1708         $_->fund($fund_id) and $_->ischanged(1) for @$li_details;
1709         $evt = lineitem_detail_CUD_batch($mgr, $li_details);
1710         return $evt if $evt;
1711         $mgr->add_li;
1712         $mgr->respond;
1713     }
1714     $e->commit;
1715     return $mgr->respond_complete;
1716 }
1717
1718
1719
1720 __PACKAGE__->register_method(
1721     method    => 'lineitem_detail_CUD_batch_api',
1722     api_name  => 'open-ils.acq.lineitem_detail.cud.batch',
1723     stream    => 1,
1724     signature => {
1725         desc   => q/Creates a new purchase order line item detail. / .
1726                   q/Additionally creates the associated fund_debit/,
1727         params => [
1728             {desc => 'Authentication token', type => 'string'},
1729             {desc => 'List of lineitem_details to create', type => 'array'},
1730             {desc => 'Create Debits.  Used for creating post-po-asset-creation debits', type => 'bool'},
1731         ],
1732         return => {desc => 'Streaming response of current position in the array'}
1733     }
1734 );
1735
1736 __PACKAGE__->register_method(
1737     method    => 'lineitem_detail_CUD_batch_api',
1738     api_name  => 'open-ils.acq.lineitem_detail.cud.batch.dry_run',
1739     stream    => 1,
1740     signature => {
1741         desc => q/
1742             Dry run version of open-ils.acq.lineitem_detail.cud.batch.
1743             In dry_run mode, updated fund_debit's the exceed the warning
1744             percent return an event.
1745         /
1746     }
1747 );
1748
1749
1750 sub lineitem_detail_CUD_batch_api {
1751     my($self, $conn, $auth, $li_details, $create_debits) = @_;
1752     my $e = new_editor(xact=>1, authtoken=>$auth);
1753     return $e->die_event unless $e->checkauth;
1754     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1755     my $dry_run = ($self->api_name =~ /dry_run/o);
1756     my $evt = lineitem_detail_CUD_batch($mgr, $li_details, $create_debits, $dry_run);
1757     return $evt if $evt;
1758     $e->commit;
1759     return $mgr->respond_complete;
1760 }
1761
1762
1763 sub lineitem_detail_CUD_batch {
1764     my($mgr, $li_details, $create_debits, $dry_run) = @_;
1765
1766     $mgr->total(scalar(@$li_details));
1767     my $e = $mgr->editor;
1768
1769     my $li;
1770     my %li_cache;
1771     my $fund_cache = {};
1772     my $evt;
1773
1774     for my $lid (@$li_details) {
1775
1776         unless($li = $li_cache{$lid->lineitem}) {
1777             ($li, $evt) = fetch_and_check_li($e, $lid->lineitem, 'write');
1778             return $evt if $evt;
1779         }
1780
1781         if($lid->isnew) {
1782             $lid = create_lineitem_detail($mgr, %{$lid->to_bare_hash}) or return $e->die_event;
1783             if($create_debits) {
1784                 $li->provider($e->retrieve_acq_provider($li->provider)) or return $e->die_event;
1785                 $lid->fund($e->retrieve_acq_fund($lid->fund)) or return $e->die_event;
1786                 create_lineitem_detail_debit($mgr, $li, $lid, 0, 1) or return $e->die_event;
1787             }
1788
1789         } elsif($lid->ischanged) {
1790             return $evt if $evt = handle_changed_lid($e, $lid, $dry_run, $fund_cache);
1791
1792         } elsif($lid->isdeleted) {
1793             delete_lineitem_detail($mgr, $lid) or return $e->die_event;
1794         }
1795
1796         $mgr->respond(li => $li);
1797         $li_cache{$lid->lineitem} = $li;
1798     }
1799
1800     return undef;
1801 }
1802
1803 sub handle_changed_lid {
1804     my($e, $lid, $dry_run, $fund_cache) = @_;
1805
1806     my $orig_lid = $e->retrieve_acq_lineitem_detail($lid->id) or return $e->die_event;
1807
1808     # updating the fund, so update the debit
1809     if($orig_lid->fund_debit and $orig_lid->fund != $lid->fund) {
1810
1811         my $debit = $e->retrieve_acq_fund_debit($orig_lid->fund_debit);
1812         my $new_fund = $$fund_cache{$lid->fund} =
1813             $$fund_cache{$lid->fund} || $e->retrieve_acq_fund($lid->fund);
1814
1815         # check the thresholds
1816         return $e->die_event if
1817             fund_exceeds_balance_percent($new_fund, $debit->amount, $e, "stop");
1818         return $e->die_event if $dry_run and
1819             fund_exceeds_balance_percent($new_fund, $debit->amount, $e, "warning");
1820
1821         $debit->fund($new_fund->id);
1822         $e->update_acq_fund_debit($debit) or return $e->die_event;
1823     }
1824
1825     $e->update_acq_lineitem_detail($lid) or return $e->die_event;
1826     return undef;
1827 }
1828
1829
1830 __PACKAGE__->register_method(
1831     method   => 'receive_po_api',
1832     api_name => 'open-ils.acq.purchase_order.receive'
1833 );
1834
1835 sub receive_po_api {
1836     my($self, $conn, $auth, $po_id) = @_;
1837     my $e = new_editor(xact => 1, authtoken => $auth);
1838     return $e->die_event unless $e->checkauth;
1839     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1840
1841     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1842     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1843
1844     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1845
1846     for my $li_id (@$li_ids) {
1847         receive_lineitem($mgr, $li_id) or return $e->die_event;
1848         $mgr->respond;
1849     }
1850
1851     $po->state('received');
1852     update_purchase_order($mgr, $po) or return $e->die_event;
1853
1854     $e->commit;
1855     return $mgr->respond_complete;
1856 }
1857
1858
1859 # At the moment there's a lack of parallelism between the receive and unreceive
1860 # API methods for POs and the API methods for LIs and LIDs.  The methods for
1861 # POs stream back objects as they act, whereas the methods for LIs and LIDs
1862 # atomically return an object that describes only what changed (in LIs and LIDs
1863 # themselves or in the objects to which to LIs and LIDs belong).
1864 #
1865 # The methods for LIs and LIDs work the way they do to faciliate the UI's
1866 # maintaining correct information about the state of these things when a user
1867 # wants to receive or unreceive these objects without refreshing their whole
1868 # display.  The UI feature for receiving and un-receiving a whole PO just
1869 # refreshes the whole display, so this absence of parallelism in the UI is also
1870 # relected in this module.
1871 #
1872 # This could be neatened in the future by making POs receive and unreceive in
1873 # the same way the LIs and LIDs do.
1874
1875 __PACKAGE__->register_method(
1876         method => 'receive_lineitem_detail_api',
1877         api_name        => 'open-ils.acq.lineitem_detail.receive',
1878         signature => {
1879         desc => 'Mark a lineitem_detail as received',
1880         params => [
1881             {desc => 'Authentication token', type => 'string'},
1882             {desc => 'lineitem detail ID', type => 'number'}
1883         ],
1884         return => {desc =>
1885             "on success, object describing changes to LID and possibly " .
1886             "to LI and PO; on error, Event"
1887         }
1888     }
1889 );
1890
1891 sub receive_lineitem_detail_api {
1892     my($self, $conn, $auth, $lid_id) = @_;
1893
1894     my $e = new_editor(xact=>1, authtoken=>$auth);
1895     return $e->die_event unless $e->checkauth;
1896     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1897
1898     my $fleshing = {
1899         "flesh" => 2, "flesh_fields" => {
1900             "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
1901         }
1902     };
1903
1904     my $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1905
1906     return $e->die_event unless $e->allowed(
1907         'RECEIVE_PURCHASE_ORDER', $lid->lineitem->purchase_order->ordering_agency);
1908
1909     # update ...
1910     my $recvd = receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1911
1912     # .. and re-retrieve
1913     $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1914
1915     # Now build result data structure.
1916     my $result = {"lid" => {$lid->id => {"recv_time" => $lid->recv_time}}};
1917
1918     if (ref $recvd) {
1919         if ($recvd->class_name =~ /::purchase_order/) {
1920             $result->{"po"} = describe_affected_po($e, $recvd);
1921             $result->{"li"} = {
1922                 $lid->lineitem->id => {"state" => $lid->lineitem->state}
1923             };
1924         } elsif ($recvd->class_name =~ /::lineitem/) {
1925             $result->{"li"} = {$recvd->id => {"state" => $recvd->state}};
1926         }
1927     }
1928     $result->{"po"} ||=
1929         describe_affected_po($e, $lid->lineitem->purchase_order);
1930
1931     $e->commit;
1932     return $result;
1933 }
1934
1935 __PACKAGE__->register_method(
1936         method => 'receive_lineitem_api',
1937         api_name        => 'open-ils.acq.lineitem.receive',
1938         signature => {
1939         desc => 'Mark a lineitem as received',
1940         params => [
1941             {desc => 'Authentication token', type => 'string'},
1942             {desc => 'lineitem ID', type => 'number'}
1943         ],
1944         return => {desc =>
1945             "on success, object describing changes to LI and possibly PO; " .
1946             "on error, Event"
1947         }
1948     }
1949 );
1950
1951 sub receive_lineitem_api {
1952     my($self, $conn, $auth, $li_id) = @_;
1953
1954     my $e = new_editor(xact=>1, authtoken=>$auth);
1955     return $e->die_event unless $e->checkauth;
1956     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1957
1958     my $li = $e->retrieve_acq_lineitem([
1959         $li_id, {
1960             flesh => 1,
1961             flesh_fields => {
1962                 jub => ['purchase_order']
1963             }
1964         }
1965     ]) or return $e->die_event;
1966
1967     return $e->die_event unless $e->allowed(
1968         'RECEIVE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1969
1970     my $res = receive_lineitem($mgr, $li_id) or return $e->die_event;
1971     $e->commit;
1972     $conn->respond_complete($res);
1973     $mgr->run_post_response_hooks
1974 }
1975
1976
1977 __PACKAGE__->register_method(
1978     method   => 'rollback_receive_po_api',
1979     api_name => 'open-ils.acq.purchase_order.receive.rollback'
1980 );
1981
1982 sub rollback_receive_po_api {
1983     my($self, $conn, $auth, $po_id) = @_;
1984     my $e = new_editor(xact => 1, authtoken => $auth);
1985     return $e->die_event unless $e->checkauth;
1986     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1987
1988     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1989     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1990
1991     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1992
1993     for my $li_id (@$li_ids) {
1994         rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1995         $mgr->respond;
1996     }
1997
1998     $po->state('on-order');
1999     update_purchase_order($mgr, $po) or return $e->die_event;
2000
2001     $e->commit;
2002     return $mgr->respond_complete;
2003 }
2004
2005
2006 __PACKAGE__->register_method(
2007     method    => 'rollback_receive_lineitem_detail_api',
2008     api_name  => 'open-ils.acq.lineitem_detail.receive.rollback',
2009     signature => {
2010         desc   => 'Mark a lineitem_detail as Un-received',
2011         params => [
2012             {desc => 'Authentication token', type => 'string'},
2013             {desc => 'lineitem detail ID', type => 'number'}
2014         ],
2015         return => {desc =>
2016             "on success, object describing changes to LID and possibly " .
2017             "to LI and PO; on error, Event"
2018         }
2019     }
2020 );
2021
2022 sub rollback_receive_lineitem_detail_api {
2023     my($self, $conn, $auth, $lid_id) = @_;
2024
2025     my $e = new_editor(xact=>1, authtoken=>$auth);
2026     return $e->die_event unless $e->checkauth;
2027     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2028
2029     my $lid = $e->retrieve_acq_lineitem_detail([
2030         $lid_id, {
2031             flesh => 2,
2032             flesh_fields => {
2033                 acqlid => ['lineitem'],
2034                 jub => ['purchase_order']
2035             }
2036         }
2037     ]);
2038     my $li = $lid->lineitem;
2039     my $po = $li->purchase_order;
2040
2041     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
2042
2043     my $result = {};
2044
2045     my $recvd = rollback_receive_lineitem_detail($mgr, $lid_id)
2046         or return $e->die_event;
2047
2048     if (ref $recvd) {
2049         $result->{"lid"} = {$recvd->id => {"recv_time" => $recvd->recv_time}};
2050     } else {
2051         $result->{"lid"} = {$lid->id => {"recv_time" => $lid->recv_time}};
2052     }
2053
2054     if ($li->state eq "received") {
2055         $li->state("on-order");
2056         $li = update_lineitem($mgr, $li) or return $e->die_event;
2057         $result->{"li"} = {$li->id => {"state" => $li->state}};
2058     }
2059
2060     if ($po->state eq "received") {
2061         $po->state("on-order");
2062         $po = update_purchase_order($mgr, $po) or return $e->die_event;
2063     }
2064     $result->{"po"} = describe_affected_po($e, $po);
2065
2066     $e->commit and return $result or return $e->die_event;
2067 }
2068
2069 __PACKAGE__->register_method(
2070     method    => 'rollback_receive_lineitem_api',
2071     api_name  => 'open-ils.acq.lineitem.receive.rollback',
2072     signature => {
2073         desc   => 'Mark a lineitem as Un-received',
2074         params => [
2075             {desc => 'Authentication token', type => 'string'},
2076             {desc => 'lineitem ID',          type => 'number'}
2077         ],
2078         return => {desc =>
2079             "on success, object describing changes to LI and possibly PO; " .
2080             "on error, Event"
2081         }
2082     }
2083 );
2084
2085 sub rollback_receive_lineitem_api {
2086     my($self, $conn, $auth, $li_id) = @_;
2087
2088     my $e = new_editor(xact=>1, authtoken=>$auth);
2089     return $e->die_event unless $e->checkauth;
2090     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2091
2092     my $li = $e->retrieve_acq_lineitem([
2093         $li_id, {
2094             "flesh" => 1, "flesh_fields" => {"jub" => ["purchase_order"]}
2095         }
2096     ]);
2097     my $po = $li->purchase_order;
2098
2099     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
2100
2101     $li = rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
2102
2103     my $result = {"li" => {$li->id => {"state" => $li->state}}};
2104     if ($po->state eq "received") {
2105         $po->state("on-order");
2106         $po = update_purchase_order($mgr, $po) or return $e->die_event;
2107     }
2108     $result->{"po"} = describe_affected_po($e, $po);
2109
2110     $e->commit and return $result or return $e->die_event;
2111 }
2112
2113
2114 __PACKAGE__->register_method(
2115     method    => 'set_lineitem_price_api',
2116     api_name  => 'open-ils.acq.lineitem.price.set',
2117     signature => {
2118         desc   => 'Set lineitem price.  If debits already exist, update them as well',
2119         params => [
2120             {desc => 'Authentication token', type => 'string'},
2121             {desc => 'lineitem ID',          type => 'number'}
2122         ],
2123         return => {desc => 'status blob, Event on error'}
2124     }
2125 );
2126
2127 sub set_lineitem_price_api {
2128     my($self, $conn, $auth, $li_id, $price) = @_;
2129
2130     my $e = new_editor(xact=>1, authtoken=>$auth);
2131     return $e->die_event unless $e->checkauth;
2132     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2133
2134     my ($li, $evt) = fetch_and_check_li($e, $li_id, 'write');
2135     return $evt if $evt;
2136
2137     $li->estimated_unit_price($price);
2138     update_lineitem($mgr, $li) or return $e->die_event;
2139
2140     my $lid_ids = $e->search_acq_lineitem_detail(
2141         {lineitem => $li_id, fund_debit => {'!=' => undef}},
2142         {idlist => 1}
2143     );
2144
2145     for my $lid_id (@$lid_ids) {
2146
2147         my $lid = $e->retrieve_acq_lineitem_detail([
2148             $lid_id, {
2149             flesh => 1, flesh_fields => {acqlid => ['fund', 'fund_debit']}}
2150         ]);
2151
2152         $lid->fund_debit->amount($price);
2153         $e->update_acq_fund_debit($lid->fund_debit) or return $e->die_event;
2154         $mgr->add_lid;
2155         $mgr->respond;
2156     }
2157
2158     $e->commit;
2159     return $mgr->respond_complete;
2160 }
2161
2162
2163 __PACKAGE__->register_method(
2164     method    => 'clone_picklist_api',
2165     api_name  => 'open-ils.acq.picklist.clone',
2166     signature => {
2167         desc   => 'Clones a picklist, including lineitem and lineitem details',
2168         params => [
2169             {desc => 'Authentication token', type => 'string'},
2170             {desc => 'Picklist ID', type => 'number'},
2171             {desc => 'New Picklist Name', type => 'string'}
2172         ],
2173         return => {desc => 'status blob, Event on error'}
2174     }
2175 );
2176
2177 sub clone_picklist_api {
2178     my($self, $conn, $auth, $pl_id, $name) = @_;
2179
2180     my $e = new_editor(xact=>1, authtoken=>$auth);
2181     return $e->die_event unless $e->checkauth;
2182     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2183
2184     my $old_pl = $e->retrieve_acq_picklist($pl_id);
2185     my $new_pl = create_picklist($mgr, %{$old_pl->to_bare_hash}, name => $name) or return $e->die_event;
2186
2187     my $li_ids = $e->search_acq_lineitem({picklist => $pl_id}, {idlist => 1});
2188
2189     # get the current user
2190     my $cloner = $mgr->editor->requestor->id;
2191
2192     for my $li_id (@$li_ids) {
2193
2194         # copy the lineitems' MARC
2195         my $marc = ($e->retrieve_acq_lineitem($li_id))->marc;
2196
2197         # create a skeletal clone of the item
2198         my $li = Fieldmapper::acq::lineitem->new;
2199         $li->creator($cloner);
2200         $li->selector($cloner);
2201         $li->editor($cloner);
2202         $li->marc($marc);
2203
2204         my $new_li = create_lineitem($mgr, %{$li->to_bare_hash}, picklist => $new_pl->id) or return $e->die_event;
2205
2206         $mgr->respond;
2207     }
2208
2209     $e->commit;
2210     return $mgr->respond_complete;
2211 }
2212
2213
2214 __PACKAGE__->register_method(
2215     method    => 'merge_picklist_api',
2216     api_name  => 'open-ils.acq.picklist.merge',
2217     signature => {
2218         desc   => 'Merges 2 or more picklists into a single list',
2219         params => [
2220             {desc => 'Authentication token', type => 'string'},
2221             {desc => 'Lead Picklist ID', type => 'number'},
2222             {desc => 'List of subordinate picklist IDs', type => 'array'}
2223         ],
2224         return => {desc => 'status blob, Event on error'}
2225     }
2226 );
2227
2228 sub merge_picklist_api {
2229     my($self, $conn, $auth, $lead_pl, $pl_list) = @_;
2230
2231     my $e = new_editor(xact=>1, authtoken=>$auth);
2232     return $e->die_event unless $e->checkauth;
2233     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2234
2235     # XXX perms on each picklist modified
2236
2237     $lead_pl = $e->retrieve_acq_picklist($lead_pl) or return $e->die_event;
2238     # point all of the lineitems at the lead picklist
2239     my $li_ids = $e->search_acq_lineitem({picklist => $pl_list}, {idlist => 1});
2240
2241     for my $li_id (@$li_ids) {
2242         my $li = $e->retrieve_acq_lineitem($li_id);
2243         $li->picklist($lead_pl);
2244         update_lineitem($mgr, $li) or return $e->die_event;
2245         $mgr->respond;
2246     }
2247
2248     # now delete the subordinate lists
2249     for my $pl_id (@$pl_list) {
2250         my $pl = $e->retrieve_acq_picklist($pl_id);
2251         $e->delete_acq_picklist($pl) or return $e->die_event;
2252     }
2253
2254     update_picklist($mgr, $lead_pl) or return $e->die_event;
2255
2256     $e->commit;
2257     return $mgr->respond_complete;
2258 }
2259
2260
2261 __PACKAGE__->register_method(
2262     method    => 'delete_picklist_api',
2263     api_name  => 'open-ils.acq.picklist.delete',
2264     signature => {
2265         desc   => q/Deletes a picklist.  It also deletes any lineitems in the "new" state. / .
2266                   q/Other attached lineitems are detached/,
2267         params => [
2268             {desc => 'Authentication token',  type => 'string'},
2269             {desc => 'Picklist ID to delete', type => 'number'}
2270         ],
2271         return => {desc => '1 on success, Event on error'}
2272     }
2273 );
2274
2275 sub delete_picklist_api {
2276     my($self, $conn, $auth, $picklist_id) = @_;
2277     my $e = new_editor(xact=>1, authtoken=>$auth);
2278     return $e->die_event unless $e->checkauth;
2279     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2280     my $pl = $e->retrieve_acq_picklist($picklist_id) or return $e->die_event;
2281     delete_picklist($mgr, $pl) or return $e->die_event;
2282     $e->commit;
2283     return $mgr->respond_complete;
2284 }
2285
2286
2287
2288 __PACKAGE__->register_method(
2289     method   => 'activate_purchase_order',
2290     api_name => 'open-ils.acq.purchase_order.activate.dry_run'
2291 );
2292
2293 __PACKAGE__->register_method(
2294     method    => 'activate_purchase_order',
2295     api_name  => 'open-ils.acq.purchase_order.activate',
2296     signature => {
2297         desc => q/Activates a purchase order.  This updates the status of the PO / .
2298                 q/and Lineitems to 'on-order'.  Activated PO's are ready for EDI delivery if appropriate./,
2299         params => [
2300             {desc => 'Authentication token', type => 'string'},
2301             {desc => 'Purchase ID', type => 'number'}
2302         ],
2303         return => {desc => '1 on success, Event on error'}
2304     }
2305 );
2306
2307 sub activate_purchase_order {
2308     my($self, $conn, $auth, $po_id, $vandelay) = @_;
2309
2310     my $dry_run = ($self->api_name =~ /\.dry_run/) ? 1 : 0;
2311     my $e = new_editor(authtoken=>$auth);
2312     return $e->die_event unless $e->checkauth;
2313     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2314     my $die_event = activate_purchase_order_impl($mgr, $po_id, $vandelay, $dry_run);
2315     return $e->die_event if $die_event;
2316     $conn->respond_complete(1);
2317     $mgr->run_post_response_hooks unless $dry_run;
2318     return undef;
2319 }
2320
2321 # xacts managed within
2322 sub activate_purchase_order_impl {
2323     my ($mgr, $po_id, $vandelay, $dry_run) = @_;
2324
2325     # read-only until lineitem asset creation
2326     my $e = $mgr->editor;
2327     $e->xact_begin;
2328
2329     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
2330     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
2331
2332     return $e->die_event(OpenILS::Event->new('PO_ALREADY_ACTIVATED'))
2333         if $po->order_date; # PO cannot be re-activated
2334
2335     my $provider = $e->retrieve_acq_provider($po->provider);
2336
2337     # find lineitems and create assets for all
2338
2339     my $query = {
2340         purchase_order => $po_id,
2341         state => [qw/pending-order new order-ready/]
2342     };
2343
2344     my $li_ids = $e->search_acq_lineitem($query, {idlist => 1});
2345
2346     my $vl_resp; # imported li's and the queue the managing queue
2347     if (!$dry_run) {
2348         $e->rollback; # read-only thus far
2349         $vl_resp = create_lineitem_list_assets($mgr, $li_ids, $vandelay)
2350             or return OpenILS::Event->new('ACQ_LI_IMPORT_FAILED');
2351         $e->xact_begin;
2352     }
2353
2354     # create fund debits for lineitems
2355
2356     for my $li_id (@$li_ids) {
2357         my $li = $e->retrieve_acq_lineitem($li_id);
2358
2359         if (!$li->eg_bib_id and !$dry_run) {
2360             # we encountered a lineitem that was not successfully imported.
2361             # we cannot continue.  rollback and report.
2362             $e->rollback;
2363             return OpenILS::Event->new('ACQ_LI_IMPORT_FAILED', {queue => $vl_resp->{queue}});
2364         }
2365
2366         $li->state('on-order');
2367         $li->claim_policy($provider->default_claim_policy)
2368             if $provider->default_claim_policy and !$li->claim_policy;
2369         create_lineitem_debits($mgr, $li, $dry_run) or return $e->die_event;
2370         update_lineitem($mgr, $li) or return $e->die_event;
2371         $mgr->post_process( sub { create_lineitem_status_events($mgr, $li->id, 'aur.ordered'); });
2372         $mgr->respond;
2373     }
2374
2375     # create po-item debits
2376
2377     for my $po_item (@{$e->search_acq_po_item({purchase_order => $po_id})}) {
2378
2379         my $debit = create_fund_debit(
2380             $mgr,
2381             $dry_run,
2382             debit_type => 'direct_charge', # to match invoicing
2383             origin_amount => $po_item->estimated_cost,
2384             origin_currency_type => $e->retrieve_acq_fund($po_item->fund)->currency_type,
2385             amount => $po_item->estimated_cost,
2386             fund => $po_item->fund
2387         ) or return $e->die_event;
2388         $po_item->fund_debit($debit->id);
2389         $e->update_acq_po_item($po_item) or return $e->die_event;
2390         $mgr->respond;
2391     }
2392
2393     # mark PO as ordered
2394
2395     $po->state('on-order');
2396     $po->order_date('now');
2397     update_purchase_order($mgr, $po) or return $e->die_event;
2398
2399     # clean up the xact
2400     $dry_run and $e->rollback or $e->commit;
2401
2402     # tell the world we activated a PO
2403     $U->create_events_for_hook('acqpo.activated', $po, $po->ordering_agency) unless $dry_run;
2404
2405     return undef;
2406 }
2407
2408
2409 __PACKAGE__->register_method(
2410     method    => 'split_purchase_order_by_lineitems',
2411     api_name  => 'open-ils.acq.purchase_order.split_by_lineitems',
2412     signature => {
2413         desc   => q/Splits a PO into many POs, 1 per lineitem.  Only works for / .
2414                   q/POs a) with more than one lineitems, and b) in the "pending" state./,
2415         params => [
2416             {desc => 'Authentication token', type => 'string'},
2417             {desc => 'Purchase order ID',    type => 'number'}
2418         ],
2419         return => {desc => 'list of new PO IDs on success, Event on error'}
2420     }
2421 );
2422
2423 sub split_purchase_order_by_lineitems {
2424     my ($self, $conn, $auth, $po_id) = @_;
2425
2426     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2427     return $e->die_event unless $e->checkauth;
2428
2429     my $po = $e->retrieve_acq_purchase_order([
2430         $po_id, {
2431             "flesh" => 1,
2432             "flesh_fields" => {"acqpo" => [qw/lineitems notes/]}
2433         }
2434     ]) or return $e->die_event;
2435
2436     return $e->die_event
2437         unless $e->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2438
2439     unless ($po->state eq "pending") {
2440         $e->rollback;
2441         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_LATE");
2442     }
2443
2444     unless (@{$po->lineitems} > 1) {
2445         $e->rollback;
2446         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_SHORT");
2447     }
2448
2449     # To split an existing PO into many, it seems unwise to just delete the
2450     # original PO, so we'll instead detach all of the original POs' lineitems
2451     # but the first, then create new POs for each of the remaining LIs, and
2452     # then attach the LIs to their new POs.
2453
2454     my @po_ids = ($po->id);
2455     my @moving_li = @{$po->lineitems};
2456     shift @moving_li;    # discard first LI
2457
2458     foreach my $li (@moving_li) {
2459         my $new_po = $po->clone;
2460         $new_po->clear_id;
2461         $new_po->clear_name;
2462         $new_po->creator($e->requestor->id);
2463         $new_po->editor($e->requestor->id);
2464         $new_po->owner($e->requestor->id);
2465         $new_po->edit_time("now");
2466         $new_po->create_time("now");
2467
2468         $new_po = $e->create_acq_purchase_order($new_po);
2469
2470         # Clone any notes attached to the old PO and attach to the new one.
2471         foreach my $note (@{$po->notes}) {
2472             my $new_note = $note->clone;
2473             $new_note->clear_id;
2474             $new_note->edit_time("now");
2475             $new_note->purchase_order($new_po->id);
2476             $e->create_acq_po_note($new_note);
2477         }
2478
2479         $li->edit_time("now");
2480         $li->purchase_order($new_po->id);
2481         $e->update_acq_lineitem($li);
2482
2483         push @po_ids, $new_po->id;
2484     }
2485
2486     $po->edit_time("now");
2487     $e->update_acq_purchase_order($po);
2488
2489     return \@po_ids if $e->commit;
2490     return $e->die_event;
2491 }
2492
2493
2494 sub not_cancelable {
2495     my $o = shift;
2496     (ref $o eq "HASH" and $o->{"textcode"} eq "ACQ_NOT_CANCELABLE");
2497 }
2498
2499 __PACKAGE__->register_method(
2500         method => "cancel_purchase_order_api",
2501         api_name        => "open-ils.acq.purchase_order.cancel",
2502         signature => {
2503         desc => q/Cancels an on-order purchase order/,
2504         params => [
2505             {desc => "Authentication token", type => "string"},
2506             {desc => "PO ID to cancel", type => "number"},
2507             {desc => "Cancel reason ID", type => "number"}
2508         ],
2509         return => {desc => q/Object describing changed POs, LIs and LIDs
2510             on success; Event on error./}
2511     }
2512 );
2513
2514 sub cancel_purchase_order_api {
2515     my ($self, $conn, $auth, $po_id, $cancel_reason) = @_;
2516
2517     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2518     return $e->die_event unless $e->checkauth;
2519     my $mgr = new OpenILS::Application::Acq::BatchManager(
2520         "editor" => $e, "conn" => $conn
2521     );
2522
2523     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2524         return new OpenILS::Event(
2525             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2526         );
2527
2528     my $result = cancel_purchase_order($mgr, $po_id, $cancel_reason) or
2529         return $e->die_event;
2530     if (not_cancelable($result)) { # event not from CStoreEditor
2531         $e->rollback;
2532         return $result;
2533     } elsif ($result == -1) {
2534         $e->rollback;
2535         return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2536     }
2537
2538     $e->commit or return $e->die_event;
2539
2540     # XXX create purchase order status events?
2541
2542     if ($mgr->{post_commit}) {
2543         foreach my $func (@{$mgr->{post_commit}}) {
2544             $func->();
2545         }
2546     }
2547
2548     return $result;
2549 }
2550
2551 sub cancel_purchase_order {
2552     my ($mgr, $po_id, $cancel_reason) = @_;
2553
2554     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id) or return 0;
2555
2556     # XXX is "cancelled" a typo?  It's not correct US spelling, anyway.
2557     # Depending on context, this may not warrant an event.
2558     return -1 if $po->state eq "cancelled";
2559
2560     # But this always does.
2561     return new OpenILS::Event(
2562         "ACQ_NOT_CANCELABLE", "note" => "purchase_order $po_id"
2563     ) unless ($po->state eq "on-order" or $po->state eq "pending");
2564
2565     return 0 unless
2566         $mgr->editor->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2567
2568     $po->state("cancelled");
2569     $po->cancel_reason($cancel_reason->id);
2570
2571     my $li_ids = $mgr->editor->search_acq_lineitem(
2572         {"purchase_order" => $po_id}, {"idlist" => 1}
2573     );
2574
2575     my $result = {"li" => {}, "lid" => {}};
2576     foreach my $li_id (@$li_ids) {
2577         my $li_result = cancel_lineitem($mgr, $li_id, $cancel_reason)
2578             or return 0;
2579
2580         next if $li_result == -1; # already canceled:skip.
2581         return $li_result if not_cancelable($li_result); # not cancelable:stop.
2582
2583         # Merge in each LI result (there's only going to be
2584         # one per call to cancel_lineitem).
2585         my ($k, $v) = each %{$li_result->{"li"}};
2586         $result->{"li"}->{$k} = $v;
2587
2588         # Merge in each LID result (there may be many per call to
2589         # cancel_lineitem).
2590         while (($k, $v) = each %{$li_result->{"lid"}}) {
2591             $result->{"lid"}->{$k} = $v;
2592         }
2593     }
2594
2595     # TODO who/what/where/how do we indicate this change for electronic orders?
2596     # TODO return changes to encumbered/spent
2597     # TODO maybe cascade up from smaller object to container object if last
2598     # smaller object in the container has been canceled?
2599
2600     update_purchase_order($mgr, $po) or return 0;
2601     $result->{"po"} = {
2602         $po_id => {"state" => $po->state, "cancel_reason" => $cancel_reason}
2603     };
2604     return $result;
2605 }
2606
2607
2608 __PACKAGE__->register_method(
2609         method => "cancel_lineitem_api",
2610         api_name        => "open-ils.acq.lineitem.cancel",
2611         signature => {
2612         desc => q/Cancels an on-order lineitem/,
2613         params => [
2614             {desc => "Authentication token", type => "string"},
2615             {desc => "Lineitem ID to cancel", type => "number"},
2616             {desc => "Cancel reason ID", type => "number"}
2617         ],
2618         return => {desc => q/Object describing changed LIs and LIDs on success;
2619             Event on error./}
2620     }
2621 );
2622
2623 __PACKAGE__->register_method(
2624         method => "cancel_lineitem_api",
2625         api_name        => "open-ils.acq.lineitem.cancel.batch",
2626         signature => {
2627         desc => q/Batched version of open-ils.acq.lineitem.cancel/,
2628         return => {desc => q/Object describing changed LIs and LIDs on success;
2629             Event on error./}
2630     }
2631 );
2632
2633 sub cancel_lineitem_api {
2634     my ($self, $conn, $auth, $li_id, $cancel_reason) = @_;
2635
2636     my $batched = $self->api_name =~ /\.batch/;
2637
2638     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2639     return $e->die_event unless $e->checkauth;
2640     my $mgr = new OpenILS::Application::Acq::BatchManager(
2641         "editor" => $e, "conn" => $conn
2642     );
2643
2644     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2645         return new OpenILS::Event(
2646             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2647         );
2648
2649     my ($result, $maybe_event);
2650
2651     if ($batched) {
2652         $result = {"li" => {}, "lid" => {}};
2653         foreach my $one_li_id (@$li_id) {
2654             my $one = cancel_lineitem($mgr, $one_li_id, $cancel_reason) or
2655                 return $e->die_event;
2656             if (not_cancelable($one)) {
2657                 $maybe_event = $one;
2658             } elsif ($result == -1) {
2659                 $maybe_event = new OpenILS::Event("ACQ_ALREADY_CANCELED");
2660             } else {
2661                 my ($k, $v);
2662                 if ($one->{"li"}) {
2663                     while (($k, $v) = each %{$one->{"li"}}) {
2664                         $result->{"li"}->{$k} = $v;
2665                     }
2666                 }
2667                 if ($one->{"lid"}) {
2668                     while (($k, $v) = each %{$one->{"lid"}}) {
2669                         $result->{"lid"}->{$k} = $v;
2670                     }
2671                 }
2672             }
2673         }
2674     } else {
2675         $result = cancel_lineitem($mgr, $li_id, $cancel_reason) or
2676             return $e->die_event;
2677
2678         if (not_cancelable($result)) {
2679             $e->rollback;
2680             return $result;
2681         } elsif ($result == -1) {
2682             $e->rollback;
2683             return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2684         }
2685     }
2686
2687     if ($batched and not scalar keys %{$result->{"li"}}) {
2688         $e->rollback;
2689         return $maybe_event;
2690     } else {
2691         $e->commit or return $e->die_event;
2692         # create_lineitem_status_events should handle array li_id ok
2693         create_lineitem_status_events($mgr, $li_id, "aur.cancelled");
2694
2695         if ($mgr->{post_commit}) {
2696             foreach my $func (@{$mgr->{post_commit}}) {
2697                 $func->();
2698             }
2699         }
2700
2701         return $result;
2702     }
2703 }
2704
2705 sub cancel_lineitem {
2706     my ($mgr, $li_id, $cancel_reason) = @_;
2707     my $li = $mgr->editor->retrieve_acq_lineitem([
2708         $li_id, {flesh => 1, flesh_fields => {jub => ['purchase_order']}}
2709     ]) or return 0;
2710
2711     return 0 unless $mgr->editor->allowed(
2712         "CREATE_PURCHASE_ORDER", $li->purchase_order->ordering_agency
2713     );
2714
2715     # Depending on context, this may not warrant an event.
2716     return -1 if $li->state eq "cancelled";
2717
2718     # But this always does.
2719     return new OpenILS::Event(
2720         "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id"
2721     ) unless (
2722         (! $li->purchase_order) or (
2723             $li->purchase_order and (
2724                 $li->state eq "on-order" or $li->state eq "pending-order"
2725             )
2726         )
2727     );
2728
2729     $li->state("cancelled");
2730     $li->cancel_reason($cancel_reason->id);
2731
2732     my $lids = $mgr->editor->search_acq_lineitem_detail([{
2733         "lineitem" => $li_id
2734     }, {
2735         flesh => 1,
2736         flesh_fields => { acqlid => ['eg_copy_id'] }
2737     }]);
2738
2739     my $result = {"lid" => {}};
2740     my $copies = [];
2741     foreach my $lid (@$lids) {
2742         my $lid_result = cancel_lineitem_detail($mgr, $lid->id, $cancel_reason)
2743             or return 0;
2744
2745         # gathering any real copies for deletion
2746         if ($lid->eg_copy_id) {
2747             $lid->eg_copy_id->isdeleted('t');
2748             push @$copies, $lid->eg_copy_id;
2749         }
2750
2751         next if $lid_result == -1; # already canceled: just skip it.
2752         return $lid_result if not_cancelable($lid_result); # not cxlable: stop.
2753
2754         # Merge in each LID result (there's only going to be one per call to
2755         # cancel_lineitem_detail).
2756         my ($k, $v) = each %{$lid_result->{"lid"}};
2757         $result->{"lid"}->{$k} = $v;
2758     }
2759
2760     # Attempt to delete the gathered copies (this will also handle volume deletion and bib deletion)
2761     # Delete empty bibs according org unit setting
2762     my $force_delete_empty_bib = $U->ou_ancestor_setting_value(
2763         $mgr->editor->requestor->ws_ou, 'cat.bib.delete_on_no_copy_via_acq_lineitem_cancel', $mgr->editor);
2764     if (scalar(@$copies)>0) {
2765         my $override = 1;
2766         my $delete_stats = undef;
2767         my $retarget_holds = [];
2768         my $cat_evt = OpenILS::Application::Cat::AssetCommon->update_fleshed_copies(
2769             $mgr->editor, $override, undef, $copies, $delete_stats, $retarget_holds,$force_delete_empty_bib);
2770
2771         if( $cat_evt ) {
2772             $logger->info("fleshed copy update failed with event: ".OpenSRF::Utils::JSON->perl2JSON($cat_evt));
2773             return new OpenILS::Event(
2774                 "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id", "payload" => $cat_evt
2775             );
2776         }
2777
2778         # We can't do the following and stay within the same transaction, but that's okay, the hold targeter will pick these up later.
2779         #my $ses = OpenSRF::AppSession->create('open-ils.circ');
2780         #$ses->request('open-ils.circ.hold.reset.batch', $auth, $retarget_holds);
2781     }
2782
2783     # if we have a bib, check to see whether it has been deleted.  if so, cancel any active holds targeting that bib
2784     if ($li->eg_bib_id) {
2785         my $bib = $mgr->editor->retrieve_biblio_record_entry($li->eg_bib_id) or return new OpenILS::Event(
2786             "ACQ_NOT_CANCELABLE", "note" => "Could not retrieve bib " . $li->eg_bib_id . " for lineitem $li_id"
2787         );
2788         if ($U->is_true($bib->deleted)) {
2789             my $holds = $mgr->editor->search_action_hold_request(
2790                 {   cancel_time => undef,
2791                     fulfillment_time => undef,
2792                     target => $li->eg_bib_id
2793                 }
2794             );
2795
2796             my %cached_usr_home_ou = ();
2797
2798             for my $hold (@$holds) {
2799
2800                 $logger->info("Cancelling hold ".$hold->id.
2801                     " due to acq lineitem cancellation.");
2802
2803                 $hold->cancel_time('now');
2804                 $hold->cancel_cause(5); # 'Staff forced'--we may want a new hold cancel cause reason for this
2805                 $hold->cancel_note('Corresponding Acquistion Lineitem/Purchase Order was cancelled.');
2806                 unless($mgr->editor->update_action_hold_request($hold)) {
2807                     my $evt = $mgr->editor->event;
2808                     $logger->error("Error updating hold ". $evt->textcode .":". $evt->desc .":". $evt->stacktrace);
2809                     return new OpenILS::Event(
2810                         "ACQ_NOT_CANCELABLE", "note" => "Could not cancel hold " . $hold->id . " for lineitem $li_id", "payload" => $evt
2811                     );
2812                 }
2813                 if (! defined $mgr->{post_commit}) { # we need a mechanism for creating trigger events, but only if the transaction gets committed
2814                     $mgr->{post_commit} = [];
2815                 }
2816                 push @{ $mgr->{post_commit} }, sub {
2817                     my $home_ou = $cached_usr_home_ou{$hold->usr};
2818                     if (! $home_ou) {
2819                         my $user = $mgr->editor->retrieve_actor_user($hold->usr); # FIXME: how do we want to handle failures here?
2820                         $home_ou = $user->home_ou;
2821                         $cached_usr_home_ou{$hold->usr} = $home_ou;
2822                     }
2823                     $U->create_events_for_hook('hold_request.cancel.cancelled_order', $hold, $home_ou);
2824                 };
2825             }
2826         }
2827     }
2828
2829     update_lineitem($mgr, $li) or return 0;
2830     $result->{"li"} = {
2831         $li_id => {
2832             "state" => $li->state,
2833             "cancel_reason" => $cancel_reason
2834         }
2835     };
2836     return $result;
2837 }
2838
2839
2840 __PACKAGE__->register_method(
2841         method => "cancel_lineitem_detail_api",
2842         api_name        => "open-ils.acq.lineitem_detail.cancel",
2843         signature => {
2844         desc => q/Cancels an on-order lineitem detail/,
2845         params => [
2846             {desc => "Authentication token", type => "string"},
2847             {desc => "Lineitem detail ID to cancel", type => "number"},
2848             {desc => "Cancel reason ID", type => "number"}
2849         ],
2850         return => {desc => q/Object describing changed LIDs on success;
2851             Event on error./}
2852     }
2853 );
2854
2855 sub cancel_lineitem_detail_api {
2856     my ($self, $conn, $auth, $lid_id, $cancel_reason) = @_;
2857
2858     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2859     return $e->die_event unless $e->checkauth;
2860     my $mgr = new OpenILS::Application::Acq::BatchManager(
2861         "editor" => $e, "conn" => $conn
2862     );
2863
2864     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2865         return new OpenILS::Event(
2866             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2867         );
2868
2869     my $result = cancel_lineitem_detail($mgr, $lid_id, $cancel_reason) or
2870         return $e->die_event;
2871
2872     if (not_cancelable($result)) {
2873         $e->rollback;
2874         return $result;
2875     } elsif ($result == -1) {
2876         $e->rollback;
2877         return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2878     }
2879
2880     $e->commit or return $e->die_event;
2881
2882     # XXX create lineitem detail status events?
2883     return $result;
2884 }
2885
2886 sub cancel_lineitem_detail {
2887     my ($mgr, $lid_id, $cancel_reason) = @_;
2888     my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
2889         $lid_id, {
2890             "flesh" => 2,
2891             "flesh_fields" => {
2892                 "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
2893             }
2894         }
2895     ]) or return 0;
2896
2897     # Depending on context, this may not warrant an event.
2898     return -1 if $lid->cancel_reason;
2899
2900     # But this always does.
2901     return new OpenILS::Event(
2902         "ACQ_NOT_CANCELABLE", "note" => "lineitem_detail $lid_id"
2903     ) unless (
2904         (! $lid->lineitem->purchase_order) or
2905         (
2906             (not $lid->recv_time) and
2907             $lid->lineitem and
2908             $lid->lineitem->purchase_order and (
2909                 $lid->lineitem->state eq "on-order" or
2910                 $lid->lineitem->state eq "pending-order"
2911             )
2912         )
2913     );
2914
2915     return 0 unless $mgr->editor->allowed(
2916         "CREATE_PURCHASE_ORDER",
2917         $lid->lineitem->purchase_order->ordering_agency
2918     ) or (! $lid->lineitem->purchase_order);
2919
2920     $lid->cancel_reason($cancel_reason->id);
2921
2922     unless($U->is_true($cancel_reason->keep_debits)) {
2923         my $debit_id = $lid->fund_debit;
2924         $lid->clear_fund_debit;
2925
2926         if($debit_id) {
2927             # item is cancelled.  Remove the fund debit.
2928             my $debit = $mgr->editor->retrieve_acq_fund_debit($debit_id);
2929             if (!$U->is_true($debit->encumbrance)) {
2930                 $mgr->editor->rollback;
2931                 return OpenILS::Event->new('ACQ_NOT_CANCELABLE',
2932                     note => "Debit is marked as paid: $debit_id");
2933             }
2934             $mgr->editor->delete_acq_fund_debit($debit) or return $mgr->editor->die_event;
2935         }
2936     }
2937
2938     # XXX LIDs don't have either an editor or a edit_time field. Should we
2939     # update these on the LI when we alter an LID?
2940     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
2941
2942     return {"lid" => {$lid_id => {"cancel_reason" => $cancel_reason}}};
2943 }
2944
2945
2946 __PACKAGE__->register_method(
2947     method    => 'user_requests',
2948     api_name  => 'open-ils.acq.user_request.retrieve.by_user_id',
2949     stream    => 1,
2950     signature => {
2951         desc   => 'Retrieve fleshed user requests and related data for a given user.',
2952         params => [
2953             { desc => 'Authentication token',      type => 'string' },
2954             { desc => 'User ID of the owner, or array of IDs',      },
2955             { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2956               type => 'object'
2957             }
2958         ],
2959         return => {
2960             desc => 'Fleshed user requests and related data',
2961             type => 'object'
2962         }
2963     }
2964 );
2965
2966 __PACKAGE__->register_method(
2967     method    => 'user_requests',
2968     api_name  => 'open-ils.acq.user_request.retrieve.by_home_ou',
2969     stream    => 1,
2970     signature => {
2971         desc   => 'Retrieve fleshed user requests and related data for a given org unit or units.',
2972         params => [
2973             { desc => 'Authentication token',      type => 'string' },
2974             { desc => 'Org unit ID, or array of IDs',               },
2975             { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2976               type => 'object'
2977             }
2978         ],
2979         return => {
2980             desc => 'Fleshed user requests and related data',
2981             type => 'object'
2982         }
2983     }
2984 );
2985
2986 sub user_requests {
2987     my($self, $conn, $auth, $search_value, $options) = @_;
2988     my $e = new_editor(authtoken => $auth);
2989     return $e->event unless $e->checkauth;
2990     my $rid = $e->requestor->id;
2991     $options ||= {};
2992
2993     my $query = {
2994         "select"=>{"aur"=>["id"],"au"=>["home_ou", {column => 'id', alias => 'usr_id'} ]},
2995         "from"=>{ "aur" => { "au" => {}, "jub" => { "type" => "left" } } },
2996         "where"=>{
2997             "+jub"=> {
2998                 "-or" => [
2999                     {"id"=>undef}, # this with the left-join pulls in requests without lineitems
3000                     {"state"=>["new","on-order","pending-order"]} # FIXME - probably needs softcoding
3001                 ]
3002             }
3003         },
3004         "order_by"=>[{"class"=>"aur", "field"=>"request_date", "direction"=>"desc"}]
3005     };
3006
3007     foreach (qw/ order_by limit offset /) {
3008         $query->{$_} = $options->{$_} if defined $options->{$_};
3009     }
3010     if (defined $options->{'state'}) {
3011         $query->{'where'}->{'+jub'}->{'-or'}->[1]->{'state'} = $options->{'state'};
3012     }
3013
3014     if ($self->api_name =~ /by_user_id/) {
3015         $query->{'where'}->{'usr'} = $search_value;
3016     } else {
3017         $query->{'where'}->{'+au'} = { 'home_ou' => $search_value };
3018     }
3019
3020     my $pertinent_ids = $e->json_query($query);
3021
3022     my %perm_test = ();
3023     for my $id_blob (@$pertinent_ids) {
3024         if ($rid != $id_blob->{usr_id}) {
3025             if (!defined $perm_test{ $id_blob->{home_ou} }) {
3026                 $perm_test{ $id_blob->{home_ou} } = $e->allowed( ['user_request.view'], $id_blob->{home_ou} );
3027             }
3028             if (!$perm_test{ $id_blob->{home_ou} }) {
3029                 next; # failed test
3030             }
3031         }
3032         my $aur_obj = $e->retrieve_acq_user_request([
3033             $id_blob->{id},
3034             {flesh => 1, flesh_fields => { "aur" => [ 'lineitem' ] } }
3035         ]);
3036         if (! $aur_obj) { next; }
3037
3038         if ($aur_obj->lineitem()) {
3039             $aur_obj->lineitem()->clear_marc();
3040         }
3041         $conn->respond($aur_obj);
3042     }
3043
3044     return undef;
3045 }
3046
3047 __PACKAGE__->register_method (
3048     method    => 'update_user_request',
3049     api_name  => 'open-ils.acq.user_request.cancel.batch',
3050     stream    => 1,
3051     signature => {
3052         desc   => 'If given a cancel reason, will update the request with that reason, otherwise, this will delete the request altogether.  The '    .
3053                   'intention is for staff interfaces or processes to provide cancel reasons, and for patron interfaces to just delete the requests.' ,
3054         params => [
3055             { desc => 'Authentication token',              type => 'string' },
3056             { desc => 'ID or array of IDs for the user requests to cancel'  },
3057             { desc => 'Cancel Reason ID (optional)',       type => 'string' }
3058         ],
3059         return => {
3060             desc => 'progress object, event on error',
3061         }
3062     }
3063 );
3064 __PACKAGE__->register_method (
3065     method    => 'update_user_request',
3066     api_name  => 'open-ils.acq.user_request.set_no_hold.batch',
3067     stream    => 1,
3068     signature => {
3069         desc   => 'Remove the hold from a user request or set of requests',
3070         params => [
3071             { desc => 'Authentication token',              type => 'string' },
3072             { desc => 'ID or array of IDs for the user requests to modify'  }
3073         ],
3074         return => {
3075             desc => 'progress object, event on error',
3076         }
3077     }
3078 );
3079
3080 sub update_user_request {
3081     my($self, $conn, $auth, $aur_ids, $cancel_reason) = @_;
3082     my $e = new_editor(xact => 1, authtoken => $auth);
3083     return $e->die_event unless $e->checkauth;
3084     my $rid = $e->requestor->id;
3085
3086     my $x = 1;
3087     my %perm_test = ();
3088     for my $id (@$aur_ids) {
3089
3090         my $aur_obj = $e->retrieve_acq_user_request([
3091             $id,
3092             {   flesh => 1,
3093                 flesh_fields => { "aur" => ['lineitem', 'usr'] }
3094             }
3095         ]) or return $e->die_event;
3096
3097         my $context_org = $aur_obj->usr()->home_ou();
3098         $aur_obj->usr( $aur_obj->usr()->id() );
3099
3100         if ($rid != $aur_obj->usr) {
3101             if (!defined $perm_test{ $context_org }) {
3102                 $perm_test{ $context_org } = $e->allowed( ['user_request.update'], $context_org );
3103             }
3104             if (!$perm_test{ $context_org }) {
3105                 next; # failed test
3106             }
3107         }
3108
3109         if($self->api_name =~ /set_no_hold/) {
3110             if ($U->is_true($aur_obj->hold)) {
3111                 $aur_obj->hold(0);
3112                 $e->update_acq_user_request($aur_obj) or return $e->die_event;
3113             }
3114         }
3115
3116         if($self->api_name =~ /cancel/) {
3117             if ( $cancel_reason ) {
3118                 $aur_obj->cancel_reason( $cancel_reason );
3119                 $e->update_acq_user_request($aur_obj) or return $e->die_event;
3120                 create_user_request_events( $e, [ $aur_obj ], 'aur.rejected' );
3121             } else {
3122                 $e->delete_acq_user_request($aur_obj);
3123             }
3124         }
3125
3126         $conn->respond({maximum => scalar(@$aur_ids), progress => $x++});
3127     }
3128
3129     $e->commit;
3130     return {complete => 1};
3131 }
3132
3133 __PACKAGE__->register_method (
3134     method    => 'new_user_request',
3135     api_name  => 'open-ils.acq.user_request.create',
3136     signature => {
3137         desc   => 'Create a new user request object in the DB',
3138         param  => [
3139             { desc => 'Authentication token',   type => 'string' },
3140             { desc => 'User request data hash.  Hash keys match the fields for the "aur" object', type => 'object' }
3141         ],
3142         return => {
3143             desc => 'The created user request object, or event on error'
3144         }
3145     }
3146 );
3147
3148 sub new_user_request {
3149     my($self, $conn, $auth, $form_data) = @_;
3150     my $e = new_editor(xact => 1, authtoken => $auth);
3151     return $e->die_event unless $e->checkauth;
3152     my $rid = $e->requestor->id;
3153     my $target_user_fleshed;
3154     if (! defined $$form_data{'usr'}) {
3155         $$form_data{'usr'} = $rid;
3156     }
3157     if ($$form_data{'usr'} != $rid) {
3158         # See if the requestor can place the request on behalf of a different user.
3159         $target_user_fleshed = $e->retrieve_actor_user($$form_data{'usr'}) or return $e->die_event;
3160         $e->allowed('user_request.create', $target_user_fleshed->home_ou) or return $e->die_event;
3161     } else {
3162         $target_user_fleshed = $e->requestor;
3163         $e->allowed('CREATE_PURCHASE_REQUEST') or return $e->die_event;
3164     }
3165     if (! defined $$form_data{'pickup_lib'}) {
3166         if ($target_user_fleshed->ws_ou) {
3167             $$form_data{'pickup_lib'} = $target_user_fleshed->ws_ou;
3168         } else {
3169             $$form_data{'pickup_lib'} = $target_user_fleshed->home_ou;
3170         }
3171     }
3172     if (! defined $$form_data{'request_type'}) {
3173         $$form_data{'request_type'} = 1; # Books
3174     }
3175     my $aur_obj = new Fieldmapper::acq::user_request;
3176     $aur_obj->isnew(1);
3177     $aur_obj->usr( $$form_data{'usr'} );
3178     $aur_obj->request_date( 'now' );
3179     for my $field ( keys %$form_data ) {
3180         if (defined $$form_data{$field} and $field !~ /^(id|lineitem|eg_bib|request_date|cancel_reason)$/) {
3181             $aur_obj->$field( $$form_data{$field} );
3182         }
3183     }
3184
3185     $aur_obj = $e->create_acq_user_request($aur_obj) or return $e->die_event;
3186
3187     $e->commit and create_user_request_events( $e, [ $aur_obj ], 'aur.created' );
3188
3189     return $aur_obj;
3190 }
3191
3192 sub create_user_request_events {
3193     my($e, $user_reqs, $hook) = @_;
3194
3195     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
3196     $ses->connect;
3197
3198     my %cached_usr_home_ou = ();
3199     for my $user_req (@$user_reqs) {
3200         my $home_ou = $cached_usr_home_ou{$user_req->usr};
3201         if (! $home_ou) {
3202             my $user = $e->retrieve_actor_user($user_req->usr) or return $e->die_event;
3203             $home_ou = $user->home_ou;
3204             $cached_usr_home_ou{$user_req->usr} = $home_ou;
3205         }
3206         my $req = $ses->request('open-ils.trigger.event.autocreate', $hook, $user_req, $home_ou);
3207         $req->recv;
3208     }
3209
3210     $ses->disconnect;
3211     return undef;
3212 }
3213
3214
3215 __PACKAGE__->register_method(
3216         method => "po_note_CUD_batch",
3217         api_name => "open-ils.acq.po_note.cud.batch",
3218     stream => 1,
3219         signature => {
3220         desc => q/Manage purchase order notes/,
3221         params => [
3222             {desc => "Authentication token", type => "string"},
3223             {desc => "List of po_notes to manage", type => "array"},
3224         ],
3225         return => {desc => "Stream of successfully managed objects"}
3226     }
3227 );
3228
3229 sub po_note_CUD_batch {
3230     my ($self, $conn, $auth, $notes) = @_;
3231
3232     my $e = new_editor("xact"=> 1, "authtoken" => $auth);
3233     return $e->die_event unless $e->checkauth;
3234     # XXX perms
3235
3236     my $total = @$notes;
3237     my $count = 0;
3238
3239     foreach my $note (@$notes) {
3240
3241         $note->editor($e->requestor->id);
3242         $note->edit_time("now");
3243
3244         if ($note->isnew) {
3245             $note->creator($e->requestor->id);
3246             $note = $e->create_acq_po_note($note) or return $e->die_event;
3247         } elsif ($note->isdeleted) {
3248             $e->delete_acq_po_note($note) or return $e->die_event;
3249         } elsif ($note->ischanged) {
3250             $e->update_acq_po_note($note) or return $e->die_event;
3251         }
3252
3253         unless ($note->isdeleted) {
3254             $note = $e->retrieve_acq_po_note($note->id) or
3255                 return $e->die_event;
3256         }
3257
3258         $conn->respond(
3259             {"maximum" => $total, "progress" => ++$count, "note" => $note}
3260         );
3261     }
3262
3263     $e->commit and $conn->respond_complete or return $e->die_event;
3264 }
3265
3266
3267 # retrieves a lineitem, fleshes its PO and PL, checks perms
3268 sub fetch_and_check_li {
3269     my $e = shift;
3270     my $li_id = shift;
3271     my $perm_mode = shift || 'read';
3272
3273     my $li = $e->retrieve_acq_lineitem([
3274         $li_id,
3275         {   flesh => 1,
3276             flesh_fields => {jub => ['purchase_order', 'picklist']}
3277         }
3278     ]) or return $e->die_event;
3279
3280     if(my $po = $li->purchase_order) {
3281         my $perms = ($perm_mode eq 'read') ? 'VIEW_PURCHASE_ORDER' : 'CREATE_PURCHASE_ORDER';
3282         return ($li, $e->die_event) unless $e->allowed($perms, $po->ordering_agency);
3283
3284     } elsif(my $pl = $li->picklist) {
3285         my $perms = ($perm_mode eq 'read') ? 'VIEW_PICKLIST' : 'CREATE_PICKLIST';
3286         return ($li, $e->die_event) unless $e->allowed($perms, $pl->org_unit);
3287     }
3288
3289     return ($li);
3290 }
3291
3292
3293 __PACKAGE__->register_method(
3294         method => "clone_distrib_form",
3295         api_name => "open-ils.acq.distribution_formula.clone",
3296     stream => 1,
3297         signature => {
3298         desc => q/Clone a distribution formula/,
3299         params => [
3300             {desc => "Authentication token", type => "string"},
3301             {desc => "Original formula ID", type => 'integer'},
3302             {desc => "Name of new formula", type => 'string'},
3303         ],
3304         return => {desc => "ID of newly created formula"}
3305     }
3306 );
3307
3308 sub clone_distrib_form {
3309     my($self, $client, $auth, $form_id, $new_name) = @_;
3310
3311     my $e = new_editor("xact"=> 1, "authtoken" => $auth);
3312     return $e->die_event unless $e->checkauth;
3313
3314     my $old_form = $e->retrieve_acq_distribution_formula($form_id) or return $e->die_event;
3315     return $e->die_event unless $e->allowed('ADMIN_ACQ_DISTRIB_FORMULA', $old_form->owner);
3316
3317     my $new_form = Fieldmapper::acq::distribution_formula->new;
3318
3319     $new_form->owner($old_form->owner);
3320     $new_form->name($new_name);
3321     $e->create_acq_distribution_formula($new_form) or return $e->die_event;
3322
3323     my $entries = $e->search_acq_distribution_formula_entry({formula => $form_id});
3324     for my $entry (@$entries) {
3325        my $new_entry = Fieldmapper::acq::distribution_formula_entry->new;
3326        $new_entry->$_($entry->$_()) for $entry->real_fields;
3327        $new_entry->formula($new_form->id);
3328        $new_entry->clear_id;
3329        $e->create_acq_distribution_formula_entry($new_entry) or return $e->die_event;
3330     }
3331
3332     $e->commit;
3333     return $new_form->id;
3334 }
3335
3336 __PACKAGE__->register_method(
3337         method => 'add_li_to_po',
3338         api_name        => 'open-ils.acq.purchase_order.add_lineitem',
3339         signature => {
3340         desc => q/Adds a lineitem to an existing purchase order/,
3341         params => [
3342             {desc => 'Authentication token', type => 'string'},
3343             {desc => 'The purchase order id', type => 'number'},
3344             {desc => 'The lineitem ID', type => 'number'},
3345         ],
3346         return => {desc => 'Streams a total versus completed counts object, event on error'}
3347     }
3348 );
3349
3350 sub add_li_to_po {
3351     my($self, $conn, $auth, $po_id, $li_id) = @_;
3352
3353     my $e = new_editor(authtoken => $auth, xact => 1);
3354     return $e->die_event unless $e->checkauth;
3355
3356     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
3357
3358     my $po = $e->retrieve_acq_purchase_order($po_id)
3359         or return $e->die_event;
3360
3361     my $li = $e->retrieve_acq_lineitem($li_id)
3362         or return $e->die_event;
3363
3364     return $e->die_event unless
3365         $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
3366
3367     unless ($po->state =~ /new|pending/) {
3368         $e->rollback;
3369         return {success => 0, po => $po, error => 'bad-po-state'};
3370     }
3371
3372     unless ($li->state =~ /new|order-ready|pending-order/) {
3373         $e->rollback;
3374         return {success => 0, li => $li, error => 'bad-li-state'};
3375     }
3376
3377     $li->purchase_order($po_id);
3378     $li->state('pending-order');
3379     update_lineitem($mgr, $li) or return $e->die_event;
3380
3381     $e->commit;
3382     return {success => 1};
3383 }
3384
3385 1;
3386