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