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) = @_;
 648
 649     my $li_id = ref($li) ? $li->id : $li;
 650
 651     unless(ref $li and ref $li->provider) {
 652        $li = $mgr->editor->retrieve_acq_lineitem([
 653             $li_id,
 654             {   flesh => 1,
 655                 flesh_fields => {jub => ['provider']},
 656             }
 657         ]);
 658     }
 659
 660     unless(ref $lid and ref $lid->fund) {
 661         $lid = $mgr->editor->retrieve_acq_lineitem_detail([
 662             $lid,
 663             {   flesh => 1,
 664                 flesh_fields => {acqlid => ['fund']}
 665             }
 666         ]);
 667     }
 668
 669     my $amount = $li->estimated_unit_price;
 670     if($li->provider->currency_type ne $lid->fund->currency_type) {
 671
 672         # At Fund debit creation time, translate into the currency of the fund
 673         # TODO: org setting to disable automatic currency conversion at debit create time?
 674
 675         $amount = $mgr->editor->json_query({
 676             from => [
 677                 'acq.exchange_ratio',
 678                 $li->provider->currency_type, # source currency
 679                 $lid->fund->currency_type, # destination currency
 680                 $li->estimated_unit_price # source amount
 681             ]
 682         })->[0]->{value};
 683     }
 684
 685     my $debit = create_fund_debit(
 686         $mgr,
 687         $dry_run,
 688         fund => $lid->fund->id,
 689         origin_amount => $li->estimated_unit_price,
 690         origin_currency_type => $li->provider->currency_type,
 691         amount => $amount
 692     ) or return 0;
 693
 694     $lid->fund_debit($debit->id);
 695     $lid->fund($lid->fund->id);
 696     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
 697     return $debit;
 698 }
 699
 700
 701 __PACKAGE__->register_method(
 702         "method" => "fund_exceeds_balance_percent_api",
 703         "api_name" => "open-ils.acq.fund.check_balance_percentages",
 704         "signature" => {
 705         "desc" => q/Determine whether a given fund exceeds its defined
 706             "balance stop and warning percentages"/,
 707         "params" => [
 708             {"desc" => "Authentication token", "type" => "string"},
 709             {"desc" => "Fund ID", "type" => "number"},
 710             {"desc" => "Theoretical debit amount (optional)",
 711                 "type" => "number"}
 712         ],
 713         "return" => {"desc" => q/An array of two values, for stop and warning,
 714             in that order: 1 if fund exceeds that balance percentage, else 0/}
 715     }
 716 );
 717
 718 sub fund_exceeds_balance_percent_api {
 719     my ($self, $conn, $auth, $fund_id, $debit_amount) = @_;
 720
 721     $debit_amount ||= 0;
 722
 723     my $e = new_editor("authtoken" => $auth);
 724     return $e->die_event unless $e->checkauth;
 725
 726     my $fund = $e->retrieve_acq_fund($fund_id) or return $e->die_event;
 727     return $e->die_event unless $e->allowed("VIEW_FUND", $fund->org);
 728
 729     my $result = [
 730         fund_exceeds_balance_percent($fund, $debit_amount, $e, "stop"),
 731         fund_exceeds_balance_percent($fund, $debit_amount, $e, "warning")
 732     ];
 733
 734     $e->disconnect;
 735     return $result;
 736 }
 737
 738 sub fund_exceeds_balance_percent {
 739     my ($fund, $debit_amount, $e, $which) = @_;
 740
 741     my ($method_name, $event_name) = @{{
 742         "warning" => [
 743             "balance_warning_percent", "ACQ_FUND_EXCEEDS_WARN_PERCENT"
 744         ],
 745         "stop" => [
 746             "balance_stop_percent", "ACQ_FUND_EXCEEDS_STOP_PERCENT"
 747         ]
 748     }->{$which}};
 749
 750     if ($fund->$method_name) {
 751         my $balance =
 752             $e->search_acq_fund_combined_balance({"fund" => $fund->id})->[0];
 753         my $allocations =
 754             $e->search_acq_fund_allocation_total({"fund" => $fund->id})->[0];
 755
 756         $balance = ($balance) ? $balance->amount : 0;
 757         $allocations = ($allocations) ? $allocations->amount : 0;
 758
 759         if (
 760             $allocations == 0 || # if no allocations were ever made, assume we have hit the stop percent
 761             ((($balance - $debit_amount) / $allocations) * 100) <
 762                 $fund->$method_name
 763         ) {
 764                 $e->event(
 765                     new OpenILS::Event(
 766                         $event_name,
 767                         "payload" => {
 768                             "fund" => $fund,
 769                             "debit_amount" => $debit_amount
 770                         }
 771                     )
 772                 );
 773                 return 1;
 774         }
 775     }
 776     return 0;
 777 }
 778
 779 # ----------------------------------------------------------------------------
 780 # Fund Debit
 781 # ----------------------------------------------------------------------------
 782 sub create_fund_debit {
 783     my($mgr, $dry_run, %args) = @_;
 784
 785     # Verify the fund is not being spent beyond the hard stop amount
 786     my $fund = $mgr->editor->retrieve_acq_fund($args{fund}) or return 0;
 787
 788     return 0 if
 789         fund_exceeds_balance_percent(
 790             $fund, $args{"amount"}, $mgr->editor, "stop"
 791         );
 792     return 0 if
 793         $dry_run and fund_exceeds_balance_percent(
 794             $fund, $args{"amount"}, $mgr->editor, "warning"
 795         );
 796
 797     my $debit = Fieldmapper::acq::fund_debit->new;
 798     $debit->debit_type('purchase');
 799     $debit->encumbrance('t');
 800     $debit->$_($args{$_}) for keys %args;
 801     $debit->clear_id;
 802     $mgr->add_debit($debit->amount);
 803     return $mgr->editor->create_acq_fund_debit($debit);
 804 }
 805
 806
 807 # ----------------------------------------------------------------------------
 808 # Picklist
 809 # ----------------------------------------------------------------------------
 810 sub create_picklist {
 811     my($mgr, %args) = @_;
 812     my $picklist = Fieldmapper::acq::picklist->new;
 813     $picklist->creator($mgr->editor->requestor->id);
 814     $picklist->owner($picklist->creator);
 815     $picklist->editor($picklist->creator);
 816     $picklist->create_time('now');
 817     $picklist->edit_time('now');
 818     $picklist->org_unit($mgr->editor->requestor->ws_ou);
 819     $picklist->owner($mgr->editor->requestor->id);
 820     $picklist->$_($args{$_}) for keys %args;
 821     $picklist->clear_id;
 822     $mgr->picklist($picklist);
 823     return $mgr->editor->create_acq_picklist($picklist);
 824 }
 825
 826 sub update_picklist {
 827     my($mgr, $picklist) = @_;
 828     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
 829     $picklist->edit_time('now');
 830     $picklist->editor($mgr->editor->requestor->id);
 831     $mgr->picklist($picklist);
 832     return $picklist if $mgr->editor->update_acq_picklist($picklist);
 833     return undef;
 834 }
 835
 836 sub delete_picklist {
 837     my($mgr, $picklist) = @_;
 838     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
 839
 840     # delete all 'new' lineitems
 841     my $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => 'new'}, {idlist => 1});
 842     for my $li_id (@$li_ids) {
 843         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
 844         return 0 unless delete_lineitem($mgr, $li);
 845         $mgr->respond;
 846     }
 847
 848     # detach all non-'new' lineitems
 849     $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => {'!=' => 'new'}}, {idlist => 1});
 850     for my $li_id (@$li_ids) {
 851         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
 852         $li->clear_picklist;
 853         return 0 unless update_lineitem($mgr, $li);
 854         $mgr->respond;
 855     }
 856
 857     # remove any picklist-specific object perms
 858     my $ops = $mgr->editor->search_permission_usr_object_perm_map({object_type => 'acqpl', object_id => ''.$picklist->id});
 859     for my $op (@$ops) {
 860         return 0 unless $mgr->editor->delete_usr_object_perm_map($op);
 861     }
 862
 863     return $mgr->editor->delete_acq_picklist($picklist);
 864 }
 865
 866 # ----------------------------------------------------------------------------
 867 # Purchase Order
 868 # ----------------------------------------------------------------------------
 869 sub update_purchase_order {
 870     my($mgr, $po) = @_;
 871     $po = $mgr->editor->retrieve_acq_purchase_order($po) unless ref $po;
 872     $po->editor($mgr->editor->requestor->id);
 873     $po->edit_time('now');
 874     $mgr->purchase_order($po);
 875     return $mgr->editor->retrieve_acq_purchase_order($mgr->editor->data)
 876         if $mgr->editor->update_acq_purchase_order($po);
 877     return undef;
 878 }
 879
 880 sub create_purchase_order {
 881     my($mgr, %args) = @_;
 882
 883     # verify the chosen provider is still active
 884     my $provider = $mgr->editor->retrieve_acq_provider($args{provider}) or return 0;
 885     unless($U->is_true($provider->active)) {
 886         $logger->error("provider is not active.  cannot create PO");
 887         $mgr->editor->event(OpenILS::Event->new('ACQ_PROVIDER_INACTIVE'));
 888         return 0;
 889     }
 890
 891     my $po = Fieldmapper::acq::purchase_order->new;
 892     $po->creator($mgr->editor->requestor->id);
 893     $po->editor($mgr->editor->requestor->id);
 894     $po->owner($mgr->editor->requestor->id);
 895     $po->edit_time('now');
 896     $po->create_time('now');
 897     $po->state('pending');
 898     $po->ordering_agency($mgr->editor->requestor->ws_ou);
 899     $po->$_($args{$_}) for keys %args;
 900     $po->clear_id;
 901     $mgr->purchase_order($po);
 902     return $mgr->editor->create_acq_purchase_order($po);
 903 }
 904
 905 # ----------------------------------------------------------------------------
 906 # if all of the lineitems for this PO are received,
 907 # mark the PO as received
 908 # ----------------------------------------------------------------------------
 909 sub check_purchase_order_received {
 910     my($mgr, $po_id) = @_;
 911
 912     my $non_recv_li = $mgr->editor->search_acq_lineitem(
 913         {   purchase_order => $po_id,
 914             state => {'!=' => 'received'}
 915         }, {idlist=>1});
 916
 917     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id);
 918     return $po if @$non_recv_li;
 919
 920     $po->state('received');
 921     return update_purchase_order($mgr, $po);
 922 }
 923
 924
 925 # ----------------------------------------------------------------------------
 926 # Bib, Callnumber, and Copy data
 927 # ----------------------------------------------------------------------------
 928
 929 sub create_lineitem_assets {
 930     my($mgr, $li_id) = @_;
 931     my $evt;
 932
 933     my $li = $mgr->editor->retrieve_acq_lineitem([
 934         $li_id,
 935         {   flesh => 1,
 936             flesh_fields => {jub => ['purchase_order', 'attributes']}
 937         }
 938     ]) or return 0;
 939
 940     # -----------------------------------------------------------------
 941     # first, create the bib record if necessary
 942     # -----------------------------------------------------------------
 943     my $new_bib = 0;
 944     unless($li->eg_bib_id) {
 945         create_bib($mgr, $li) or return 0;
 946         $new_bib = 1;
 947     }
 948
 949
 950     # -----------------------------------------------------------------
 951     # The lineitem is going live, promote user request holds to real holds
 952     # -----------------------------------------------------------------
 953     promote_lineitem_holds($mgr, $li) or return 0;
 954
 955     my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
 956
 957     # -----------------------------------------------------------------
 958     # for each lineitem_detail, create the volume if necessary, create
 959     # a copy, and link them all together.
 960     # -----------------------------------------------------------------
 961     my $first_cn;
 962     for my $lid_id (@{$li_details}) {
 963
 964         my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
 965         next if $lid->eg_copy_id;
 966
 967         # use the same callnumber label for all items within this lineitem
 968         $lid->cn_label($first_cn) if $first_cn and not $lid->cn_label;
 969
 970         # apply defaults if necessary
 971         return 0 unless complete_lineitem_detail($mgr, $lid);
 972
 973         $first_cn = $lid->cn_label unless $first_cn;
 974
 975         my $org = $lid->owning_lib;
 976         my $label = $lid->cn_label;
 977         my $bibid = $li->eg_bib_id;
 978
 979         my $volume = $mgr->cache($org, "cn.$bibid.$label");
 980         unless($volume) {
 981             $volume = create_volume($mgr, $li, $lid) or return 0;
 982             $mgr->cache($org, "cn.$bibid.$label", $volume);
 983         }
 984         create_copy($mgr, $volume, $lid) or return 0;
 985     }
 986
 987     return { li => $li, new_bib => $new_bib };
 988 }
 989
 990 sub create_bib {
 991     my($mgr, $li) = @_;
 992
 993     my $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
 994         $mgr->editor,
 995         $li->marc,
 996         undef, # bib source
 997         undef,
 998         1, # override tcn collisions
 999     );
1000
1001     if($U->event_code($record)) {
1002         $mgr->editor->event($record);
1003         $mgr->editor->rollback;
1004         return 0;
1005     }
1006
1007     $li->eg_bib_id($record->id);
1008     $mgr->add_bib;
1009     return update_lineitem($mgr, $li);
1010 }
1011
1012 sub create_volume {
1013     my($mgr, $li, $lid) = @_;
1014
1015     my ($volume, $evt) =
1016         OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1017             $mgr->editor,
1018             $lid->cn_label,
1019             $li->eg_bib_id,
1020             $lid->owning_lib
1021         );
1022
1023     if($evt) {
1024         $mgr->editor->event($evt);
1025         return 0;
1026     }
1027
1028     return $volume;
1029 }
1030
1031 sub create_copy {
1032     my($mgr, $volume, $lid) = @_;
1033     my $copy = Fieldmapper::asset::copy->new;
1034     $copy->isnew(1);
1035     $copy->loan_duration(2);
1036     $copy->fine_level(2);
1037     $copy->status(OILS_COPY_STATUS_ON_ORDER);
1038     $copy->barcode($lid->barcode);
1039     $copy->location($lid->location);
1040     $copy->call_number($volume->id);
1041     $copy->circ_lib($volume->owning_lib);
1042     $copy->circ_modifier($lid->circ_modifier);
1043
1044     my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
1045     if($evt) {
1046         $mgr->editor->event($evt);
1047         return 0;
1048     }
1049
1050     $mgr->add_copy;
1051     $lid->eg_copy_id($copy->id);
1052     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
1053 }
1054
1055
1056
1057
1058
1059
1060 # ----------------------------------------------------------------------------
1061 # Workflow: Build a selection list from a Z39.50 search
1062 # ----------------------------------------------------------------------------
1063
1064 __PACKAGE__->register_method(
1065         method => 'zsearch',
1066         api_name => 'open-ils.acq.picklist.search.z3950',
1067     stream => 1,
1068         signature => {
1069         desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
1070         params => [
1071             {desc => 'Authentication token', type => 'string'},
1072             {desc => 'Search definition', type => 'object'},
1073             {desc => 'Picklist name, optional', type => 'string'},
1074         ]
1075     }
1076 );
1077
1078 sub zsearch {
1079     my($self, $conn, $auth, $search, $name, $options) = @_;
1080     my $e = new_editor(authtoken=>$auth);
1081     return $e->event unless $e->checkauth;
1082     return $e->event unless $e->allowed('CREATE_PICKLIST');
1083
1084     $search->{limit} ||= 10;
1085     $options ||= {};
1086
1087     my $ses = OpenSRF::AppSession->create('open-ils.search');
1088     my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
1089
1090     my $first = 1;
1091     my $picklist;
1092     my $mgr;
1093     while(my $resp = $req->recv(timeout=>60)) {
1094
1095         if($first) {
1096             my $e = new_editor(requestor=>$e->requestor, xact=>1);
1097             $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1098             $picklist = zsearch_build_pl($mgr, $name);
1099             $first = 0;
1100         }
1101
1102         my $result = $resp->content;
1103         my $count = $result->{count} || 0;
1104         $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
1105
1106         for my $rec (@{$result->{records}}) {
1107
1108             my $li = create_lineitem($mgr,
1109                 picklist => $picklist->id,
1110                 source_label => $result->{service},
1111                 marc => $rec->{marcxml},
1112                 eg_bib_id => $rec->{bibid}
1113             );
1114
1115             if($$options{respond_li}) {
1116                 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
1117                     if $$options{flesh_attrs};
1118                 $li->clear_marc if $$options{clear_marc};
1119                 $mgr->respond(lineitem => $li);
1120             } else {
1121                 $mgr->respond;
1122             }
1123         }
1124     }
1125
1126     $mgr->editor->commit;
1127     return $mgr->respond_complete;
1128 }
1129
1130 sub zsearch_build_pl {
1131     my($mgr, $name) = @_;
1132     $name ||= '';
1133
1134     my $picklist = $mgr->editor->search_acq_picklist({
1135         owner => $mgr->editor->requestor->id,
1136         name => $name
1137     })->[0];
1138
1139     if($name eq '' and $picklist) {
1140         return 0 unless delete_picklist($mgr, $picklist);
1141         $picklist = undef;
1142     }
1143
1144     return update_picklist($mgr, $picklist) if $picklist;
1145     return create_picklist($mgr, name => $name);
1146 }
1147
1148
1149 # ----------------------------------------------------------------------------
1150 # Workflow: Build a selection list / PO by importing a batch of MARC records
1151 # ----------------------------------------------------------------------------
1152
1153 __PACKAGE__->register_method(
1154     method => 'upload_records',
1155     api_name => 'open-ils.acq.process_upload_records',
1156     stream => 1,
1157 );
1158
1159 sub upload_records {
1160     my($self, $conn, $auth, $key) = @_;
1161
1162         my $e = new_editor(authtoken => $auth, xact => 1);
1163     return $e->die_event unless $e->checkauth;
1164     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1165
1166     my $cache = OpenSRF::Utils::Cache->new;
1167
1168     my $data = $cache->get_cache("vandelay_import_spool_$key");
1169         my $purpose = $data->{purpose};
1170     my $filename = $data->{path};
1171     my $provider = $data->{provider};
1172     my $picklist = $data->{picklist};
1173     my $create_po = $data->{create_po};
1174     my $activate_po = $data->{activate_po};
1175     my $ordering_agency = $data->{ordering_agency};
1176     my $create_assets = $data->{create_assets};
1177     my $po;
1178     my $evt;
1179
1180     unless(-r $filename) {
1181         $logger->error("unable to read MARC file $filename");
1182         $e->rollback;
1183         return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
1184     }
1185
1186     $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
1187
1188     if($picklist) {
1189         $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
1190         if($picklist->owner != $e->requestor->id) {
1191             return $e->die_event unless
1192                 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
1193         }
1194         $mgr->picklist($picklist);
1195     }
1196
1197     if($create_po) {
1198
1199         $po = create_purchase_order($mgr,
1200             ordering_agency => $ordering_agency,
1201             provider => $provider->id,
1202             state => 'on-order'
1203         ) or return $mgr->editor->die_event;
1204     }
1205
1206     $logger->info("acq processing MARC file=$filename");
1207
1208     my $marctype = 'USMARC'; # ?
1209         my $batch = new MARC::Batch ($marctype, $filename);
1210         $batch->strict_off;
1211
1212         my $count = 0;
1213     my @li_list;
1214
1215         while(1) {
1216
1217             my $err;
1218         my $xml;
1219                 $count++;
1220         my $r;
1221
1222                 try {
1223             $r = $batch->next;
1224         } catch Error with {
1225             $err = shift;
1226                         $logger->warn("Proccessing of record $count in set $key failed with error $err.  Skipping this record");
1227         };
1228
1229         next if $err;
1230         last unless $r;
1231
1232                 try {
1233             ($xml = $r->as_xml_record()) =~ s/\n//sog;
1234             $xml =~ s/^<\?xml.+\?\s*>//go;
1235             $xml =~ s/>\s+</></go;
1236             $xml =~ s/\p{Cc}//go;
1237             $xml = $U->entityize($xml);
1238             $xml =~ s/[\x00-\x1f]//go;
1239
1240                 } catch Error with {
1241                         $err = shift;
1242                         $logger->warn("Proccessing XML of record $count in set $key failed with error $err.  Skipping this record");
1243                 };
1244
1245         next if $err or not $xml;
1246
1247         my %args = (
1248             source_label => $provider->code,
1249             provider => $provider->id,
1250             marc => $xml,
1251         );
1252
1253         $args{picklist} = $picklist->id if $picklist;
1254         if($po) {
1255             $args{purchase_order} = $po->id;
1256             $args{state} = 'order-pending';
1257         }
1258
1259         my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
1260         $mgr->respond;
1261         $li->provider($provider); # flesh it, we'll need it later
1262
1263         import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
1264         $mgr->respond;
1265
1266         push(@li_list, $li->id);
1267         $mgr->respond;
1268         }
1269
1270     my $die_event = activate_purchase_order_impl($mgr, $po->id) if $po;;
1271     return $die_event if $die_event;
1272
1273         $e->commit;
1274     unlink($filename);
1275     $cache->delete_cache('vandelay_import_spool_' . $key);
1276
1277     if($create_assets) {
1278         create_lineitem_list_assets($mgr, \@li_list) or return $e->die_event;
1279     }
1280
1281     return $mgr->respond_complete;
1282 }
1283
1284 sub import_lineitem_details {
1285     my($mgr, $ordering_agency, $li) = @_;
1286
1287     my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
1288     return 1 unless @$holdings;
1289     my $org_path = $U->get_org_ancestors($ordering_agency);
1290     $org_path = [ reverse (@$org_path) ];
1291     my $price;
1292
1293     my $idx = 1;
1294     while(1) {
1295         # create a lineitem detail for each copy in the data
1296
1297         my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
1298         last unless defined $compiled;
1299         return 0 unless $compiled;
1300
1301         # this takes the price of the last copy and uses it as the lineitem price
1302         # need to determine if a given record would include different prices for the same item
1303         $price = $$compiled{price};
1304
1305         for(1..$$compiled{quantity}) {
1306             my $lid = create_lineitem_detail($mgr,
1307                 lineitem => $li->id,
1308                 owning_lib => $$compiled{owning_lib},
1309                 cn_label => $$compiled{call_number},
1310                 fund => $$compiled{fund},
1311                 circ_modifier => $$compiled{circ_modifier},
1312                 note => $$compiled{note},
1313                 location => $$compiled{copy_location},
1314                 collection_code => $$compiled{collection_code}
1315             ) or return 0;
1316         }
1317
1318         $mgr->respond;
1319         $idx++;
1320     }
1321
1322     $li->estimated_unit_price($price);
1323     update_lineitem($mgr, $li) or return 0;
1324     return 1;
1325 }
1326
1327 # return hash on success, 0 on error, undef on no more holdings
1328 sub extract_lineitem_detail_data {
1329     my($mgr, $org_path, $holdings, $index) = @_;
1330
1331     my @data_list = grep { $_->{holding} eq $index } @$holdings;
1332     return undef unless @data_list;
1333
1334     my %compiled = map { $_->{attr} => $_->{data} } @data_list;
1335     my $base_org = $$org_path[0];
1336
1337     my $killme = sub {
1338         my $msg = shift;
1339         $logger->error("Item import extraction error: $msg");
1340         $logger->error('Holdings Data: ' . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
1341         $mgr->editor->rollback;
1342         $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
1343         return 0;
1344     };
1345
1346     $compiled{quantity} ||= 1;
1347
1348     # ---------------------------------------------------------------------
1349     # Fund
1350     my $code = $compiled{fund_code};
1351     return $killme->('no fund code provided') unless $code;
1352
1353     my $fund = $mgr->cache($base_org, "fund.$code");
1354     unless($fund) {
1355         # search up the org tree for the most appropriate fund
1356         for my $org (@$org_path) {
1357             $fund = $mgr->editor->search_acq_fund(
1358                 {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
1359             last if $fund;
1360         }
1361     }
1362     return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
1363     $compiled{fund} = $fund;
1364     $mgr->cache($base_org, "fund.$code", $fund);
1365
1366
1367     # ---------------------------------------------------------------------
1368     # Owning lib
1369     my $sn = $compiled{owning_lib};
1370     return $killme->('no owning_lib defined') unless $sn;
1371     my $org_id =
1372         $mgr->cache($base_org, "orgsn.$sn") ||
1373             $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
1374     return $killme->("invalid owning_lib defined: $sn") unless $org_id;
1375     $compiled{owning_lib} = $org_id;
1376     $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
1377
1378
1379     # ---------------------------------------------------------------------
1380     # Circ Modifier
1381     my $mod;
1382     $code = $compiled{circ_modifier};
1383
1384     if($code) {
1385
1386         $mod = $mgr->cache($base_org, "mod.$code") ||
1387             $mgr->editor->retrieve_config_circ_modifier($code);
1388         return $killme->("invlalid circ_modifier $code") unless $mod;
1389         $mgr->cache($base_org, "mod.$code", $mod);
1390
1391     } else {
1392         # try the default
1393         $mod = get_default_circ_modifier($mgr, $base_org)
1394             or return $killme->('no circ_modifier defined');
1395     }
1396
1397     $compiled{circ_modifier} = $mod;
1398
1399
1400     # ---------------------------------------------------------------------
1401     # Shelving Location
1402     my $name = $compiled{copy_location};
1403     if($name) {
1404         my $loc = $mgr->cache($base_org, "copy_loc.$name");
1405         unless($loc) {
1406             for my $org (@$org_path) {
1407                 $loc = $mgr->editor->search_asset_copy_location(
1408                     {owning_lib => $org, name => $name}, {idlist => 1})->[0];
1409                 last if $loc;
1410             }
1411         }
1412         return $killme->("Invalid copy location $name") unless $loc;
1413         $compiled{copy_location} = $loc;
1414         $mgr->cache($base_org, "copy_loc.$name", $loc);
1415     }
1416
1417     return \%compiled;
1418 }
1419
1420
1421
1422 # ----------------------------------------------------------------------------
1423 # Workflow: Given an existing purchase order, import/create the bibs,
1424 # callnumber and copy objects
1425 # ----------------------------------------------------------------------------
1426
1427 __PACKAGE__->register_method(
1428         method => 'create_po_assets',
1429         api_name        => 'open-ils.acq.purchase_order.assets.create',
1430         signature => {
1431         desc => q/Creates assets for each lineitem in the purchase order/,
1432         params => [
1433             {desc => 'Authentication token', type => 'string'},
1434             {desc => 'The purchase order id', type => 'number'},
1435         ],
1436         return => {desc => 'Streams a total versus completed counts object, event on error'}
1437     }
1438 );
1439
1440 sub create_po_assets {
1441     my($self, $conn, $auth, $po_id) = @_;
1442
1443     my $e = new_editor(authtoken=>$auth, xact=>1);
1444     return $e->die_event unless $e->checkauth;
1445     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1446
1447     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1448
1449     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1450
1451     # it's ugly, but it's fast.  Get the total count of lineitem detail objects to process
1452     my $lid_total = $e->json_query({
1453         select => { acqlid => [{aggregate => 1, transform => 'count', column => 'id'}] },
1454         from => {
1455             acqlid => {
1456                 jub => {
1457                     fkey => 'lineitem',
1458                     field => 'id',
1459                     join => {acqpo => {fkey => 'purchase_order', field => 'id'}}
1460                 }
1461             }
1462         },
1463         where => {'+acqpo' => {id => $po_id}}
1464     })->[0]->{id};
1465
1466     $mgr->total(scalar(@$li_ids) + $lid_total);
1467
1468     create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1469
1470     $e->xact_begin;
1471     update_purchase_order($mgr, $po) or return $e->die_event;
1472     $e->commit;
1473
1474     return $mgr->respond_complete;
1475 }
1476
1477
1478
1479 __PACKAGE__->register_method(
1480         method => 'create_purchase_order_api',
1481         api_name        => 'open-ils.acq.purchase_order.create',
1482         signature => {
1483         desc => 'Creates a new purchase order',
1484         params => [
1485             {desc => 'Authentication token', type => 'string'},
1486             {desc => 'purchase_order to create', type => 'object'}
1487         ],
1488         return => {desc => 'The purchase order id, Event on failure'}
1489     }
1490 );
1491
1492 sub create_purchase_order_api {
1493     my($self, $conn, $auth, $po, $args) = @_;
1494     $args ||= {};
1495
1496     my $e = new_editor(xact=>1, authtoken=>$auth);
1497     return $e->die_event unless $e->checkauth;
1498     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1499     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1500
1501     # create the PO
1502     my %pargs = (ordering_agency => $e->requestor->ws_ou); # default
1503     $pargs{provider} = $po->provider if $po->provider;
1504     $pargs{ordering_agency} = $po->ordering_agency if $po->ordering_agency;
1505     $pargs{prepayment_required} = $po->prepayment_required
1506         if $po->prepayment_required;
1507     $po = create_purchase_order($mgr, %pargs) or return $e->die_event;
1508
1509     my $li_ids = $$args{lineitems};
1510
1511     if($li_ids) {
1512
1513         for my $li_id (@$li_ids) {
1514
1515             my $li = $e->retrieve_acq_lineitem([
1516                 $li_id,
1517                 {flesh => 1, flesh_fields => {jub => ['attributes']}}
1518             ]) or return $e->die_event;
1519
1520             $li->provider($po->provider);
1521             $li->purchase_order($po->id);
1522             $li->state('pending-order');
1523             update_lineitem($mgr, $li) or return $e->die_event;
1524             $mgr->respond;
1525         }
1526     }
1527
1528     # commit before starting the asset creation
1529     $e->xact_commit;
1530
1531     if($li_ids and $$args{create_assets}) {
1532         create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1533     }
1534
1535     return $mgr->respond_complete;
1536 }
1537
1538
1539 __PACKAGE__->register_method(
1540         method => 'lineitem_detail_CUD_batch',
1541         api_name => 'open-ils.acq.lineitem_detail.cud.batch',
1542     stream => 1,
1543         signature => {
1544         desc => q/Creates a new purchase order line item detail.
1545             Additionally creates the associated fund_debit/,
1546         params => [
1547             {desc => 'Authentication token', type => 'string'},
1548             {desc => 'List of lineitem_details to create', type => 'array'},
1549         ],
1550         return => {desc => 'Streaming response of current position in the array'}
1551     }
1552 );
1553
1554 sub lineitem_detail_CUD_batch {
1555     my($self, $conn, $auth, $li_details) = @_;
1556
1557     my $e = new_editor(xact=>1, authtoken=>$auth);
1558     return $e->die_event unless $e->checkauth;
1559     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1560
1561     # XXX perms
1562
1563     $mgr->total(scalar(@$li_details));
1564
1565     my %li_cache;
1566
1567     for my $lid (@$li_details) {
1568
1569         my $li = $li_cache{$lid->lineitem} || $e->retrieve_acq_lineitem($lid->lineitem);
1570
1571         if($lid->isnew) {
1572             create_lineitem_detail($mgr, %{$lid->to_bare_hash}) or return $e->die_event;
1573
1574         } elsif($lid->ischanged) {
1575             $e->update_acq_lineitem_detail($lid) or return $e->die_event;
1576
1577         } elsif($lid->isdeleted) {
1578             delete_lineitem_detail($mgr, $lid) or return $e->die_event;
1579         }
1580
1581         $mgr->respond(li => $li);
1582         $li_cache{$lid->lineitem} = $li;
1583     }
1584
1585     $e->commit;
1586     return $mgr->respond_complete;
1587 }
1588
1589
1590 __PACKAGE__->register_method(
1591         method => 'receive_po_api',
1592         api_name        => 'open-ils.acq.purchase_order.receive'
1593 );
1594
1595 sub receive_po_api {
1596     my($self, $conn, $auth, $po_id) = @_;
1597     my $e = new_editor(xact => 1, authtoken => $auth);
1598     return $e->die_event unless $e->checkauth;
1599     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1600
1601     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1602     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1603
1604     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1605
1606     for my $li_id (@$li_ids) {
1607         receive_lineitem($mgr, $li_id) or return $e->die_event;
1608         $mgr->respond;
1609     }
1610
1611     $po->state('received');
1612     update_purchase_order($mgr, $po) or return $e->die_event;
1613
1614     $e->commit;
1615     return $mgr->respond_complete;
1616 }
1617
1618
1619 # At the moment there's a lack of parallelism between the receive and unreceive
1620 # API methods for POs and the API methods for LIs and LIDs.  The methods for
1621 # POs stream back objects as they act, whereas the methods for LIs and LIDs
1622 # atomically return an object that describes only what changed (in LIs and LIDs
1623 # themselves or in the objects to which to LIs and LIDs belong).
1624 #
1625 # The methods for LIs and LIDs work the way they do to faciliate the UI's
1626 # maintaining correct information about the state of these things when a user
1627 # wants to receive or unreceive these objects without refreshing their whole
1628 # display.  The UI feature for receiving and un-receiving a whole PO just
1629 # refreshes the whole display, so this absence of parallelism in the UI is also
1630 # relected in this module.
1631 #
1632 # This could be neatened in the future by making POs receive and unreceive in
1633 # the same way the LIs and LIDs do.
1634
1635 __PACKAGE__->register_method(
1636         method => 'receive_lineitem_detail_api',
1637         api_name        => 'open-ils.acq.lineitem_detail.receive',
1638         signature => {
1639         desc => 'Mark a lineitem_detail as received',
1640         params => [
1641             {desc => 'Authentication token', type => 'string'},
1642             {desc => 'lineitem detail ID', type => 'number'}
1643         ],
1644         return => {desc =>
1645             "on success, object describing changes to LID and possibly " .
1646             "to LI and PO; on error, Event"
1647         }
1648     }
1649 );
1650
1651 sub receive_lineitem_detail_api {
1652     my($self, $conn, $auth, $lid_id) = @_;
1653
1654     my $e = new_editor(xact=>1, authtoken=>$auth);
1655     return $e->die_event unless $e->checkauth;
1656     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1657
1658     my $fleshing = {
1659         "flesh" => 2, "flesh_fields" => {
1660             "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
1661         }
1662     };
1663
1664     my $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1665
1666     return $e->die_event unless $e->allowed(
1667         'RECEIVE_PURCHASE_ORDER', $lid->lineitem->purchase_order->ordering_agency);
1668
1669     # update ...
1670     my $recvd = receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1671
1672     # .. and re-retrieve
1673     $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1674
1675     # Now build result data structure.
1676     my $result = {"lid" => {$lid->id => {"recv_time" => $lid->recv_time}}};
1677
1678     if (ref $recvd) {
1679         if ($recvd->class_name =~ /::purchase_order/) {
1680             $result->{"po"} = describe_affected_po($e, $recvd);
1681             $result->{"li"} = {
1682                 $lid->lineitem->id => {"state" => $lid->lineitem->state}
1683             };
1684         } elsif ($recvd->class_name =~ /::lineitem/) {
1685             $result->{"li"} = {$recvd->id => {"state" => $recvd->state}};
1686         }
1687     }
1688     $result->{"po"} ||=
1689         describe_affected_po($e, $lid->lineitem->purchase_order);
1690
1691     $e->commit;
1692     return $result;
1693 }
1694
1695 __PACKAGE__->register_method(
1696         method => 'receive_lineitem_api',
1697         api_name        => 'open-ils.acq.lineitem.receive',
1698         signature => {
1699         desc => 'Mark a lineitem as received',
1700         params => [
1701             {desc => 'Authentication token', type => 'string'},
1702             {desc => 'lineitem ID', type => 'number'}
1703         ],
1704         return => {desc =>
1705             "on success, object describing changes to LI and possibly PO; " .
1706             "on error, Event"
1707         }
1708     }
1709 );
1710
1711 sub receive_lineitem_api {
1712     my($self, $conn, $auth, $li_id) = @_;
1713
1714     my $e = new_editor(xact=>1, authtoken=>$auth);
1715     return $e->die_event unless $e->checkauth;
1716     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1717
1718     my $li = $e->retrieve_acq_lineitem([
1719         $li_id, {
1720             flesh => 1,
1721             flesh_fields => {
1722                 jub => ['purchase_order']
1723             }
1724         }
1725     ]) or return $e->die_event;
1726
1727     return $e->die_event unless $e->allowed(
1728         'RECEIVE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1729
1730     my $res = receive_lineitem($mgr, $li_id) or return $e->die_event;
1731     $e->commit;
1732     $conn->respond_complete($res);
1733     $mgr->run_post_response_hooks;
1734 }
1735
1736
1737 __PACKAGE__->register_method(
1738         method => 'rollback_receive_po_api',
1739         api_name        => 'open-ils.acq.purchase_order.receive.rollback'
1740 );
1741
1742 sub rollback_receive_po_api {
1743     my($self, $conn, $auth, $po_id) = @_;
1744     my $e = new_editor(xact => 1, authtoken => $auth);
1745     return $e->die_event unless $e->checkauth;
1746     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1747
1748     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1749     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1750
1751     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1752
1753     for my $li_id (@$li_ids) {
1754         rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1755         $mgr->respond;
1756     }
1757
1758     $po->state('on-order');
1759     update_purchase_order($mgr, $po) or return $e->die_event;
1760
1761     $e->commit;
1762     return $mgr->respond_complete;
1763 }
1764
1765
1766 __PACKAGE__->register_method(
1767         method => 'rollback_receive_lineitem_detail_api',
1768         api_name        => 'open-ils.acq.lineitem_detail.receive.rollback',
1769         signature => {
1770         desc => 'Mark a lineitem_detail as Un-received',
1771         params => [
1772             {desc => 'Authentication token', type => 'string'},
1773             {desc => 'lineitem detail ID', type => 'number'}
1774         ],
1775         return => {desc =>
1776             "on success, object describing changes to LID and possibly " .
1777             "to LI and PO; on error, Event"
1778         }
1779     }
1780 );
1781
1782 sub rollback_receive_lineitem_detail_api {
1783     my($self, $conn, $auth, $lid_id) = @_;
1784
1785     my $e = new_editor(xact=>1, authtoken=>$auth);
1786     return $e->die_event unless $e->checkauth;
1787     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1788
1789     my $lid = $e->retrieve_acq_lineitem_detail([
1790         $lid_id, {
1791             flesh => 2,
1792             flesh_fields => {
1793                 acqlid => ['lineitem'],
1794                 jub => ['purchase_order']
1795             }
1796         }
1797     ]);
1798     my $li = $lid->lineitem;
1799     my $po = $li->purchase_order;
1800
1801     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1802
1803     my $result = {};
1804
1805     my $recvd = rollback_receive_lineitem_detail($mgr, $lid_id)
1806         or return $e->die_event;
1807
1808     if (ref $recvd) {
1809         $result->{"lid"} = {$recvd->id => {"recv_time" => $recvd->recv_time}};
1810     } else {
1811         $result->{"lid"} = {$lid->id => {"recv_time" => $lid->recv_time}};
1812     }
1813
1814     if ($li->state eq "received") {
1815         $li->state("on-order");
1816         $li = update_lineitem($mgr, $li) or return $e->die_event;
1817         $result->{"li"} = {$li->id => {"state" => $li->state}};
1818     }
1819
1820     if ($po->state eq "received") {
1821         $po->state("on-order");
1822         $po = update_purchase_order($mgr, $po) or return $e->die_event;
1823     }
1824     $result->{"po"} = describe_affected_po($e, $po);
1825
1826     $e->commit and return $result or return $e->die_event;
1827 }
1828
1829 __PACKAGE__->register_method(
1830         method => 'rollback_receive_lineitem_api',
1831         api_name        => 'open-ils.acq.lineitem.receive.rollback',
1832         signature => {
1833         desc => 'Mark a lineitem as Un-received',
1834         params => [
1835             {desc => 'Authentication token', type => 'string'},
1836             {desc => 'lineitem ID', type => 'number'}
1837         ],
1838         return => {desc =>
1839             "on success, object describing changes to LI and possibly PO; " .
1840             "on error, Event"
1841         }
1842     }
1843 );
1844
1845 sub rollback_receive_lineitem_api {
1846     my($self, $conn, $auth, $li_id) = @_;
1847
1848     my $e = new_editor(xact=>1, authtoken=>$auth);
1849     return $e->die_event unless $e->checkauth;
1850     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1851
1852     my $li = $e->retrieve_acq_lineitem([
1853         $li_id, {
1854             "flesh" => 1, "flesh_fields" => {"jub" => ["purchase_order"]}
1855         }
1856     ]);
1857     my $po = $li->purchase_order;
1858
1859     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1860
1861     $li = rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1862
1863     my $result = {"li" => {$li->id => {"state" => $li->state}}};
1864     if ($po->state eq "received") {
1865         $po->state("on-order");
1866         $po = update_purchase_order($mgr, $po) or return $e->die_event;
1867     }
1868     $result->{"po"} = describe_affected_po($e, $po);
1869
1870     $e->commit and return $result or return $e->die_event;
1871 }
1872
1873
1874 __PACKAGE__->register_method(
1875         method => 'set_lineitem_price_api',
1876         api_name        => 'open-ils.acq.lineitem.price.set',
1877         signature => {
1878         desc => 'Set lineitem price.  If debits already exist, update them as well',
1879         params => [
1880             {desc => 'Authentication token', type => 'string'},
1881             {desc => 'lineitem ID', type => 'number'}
1882         ],
1883         return => {desc => 'status blob, Event on error'}
1884     }
1885 );
1886
1887 sub set_lineitem_price_api {
1888     my($self, $conn, $auth, $li_id, $price) = @_;
1889
1890     my $e = new_editor(xact=>1, authtoken=>$auth);
1891     return $e->die_event unless $e->checkauth;
1892     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1893
1894     my $li = $e->retrieve_acq_lineitem([
1895         $li_id,
1896         {   flesh => 1,
1897             flesh_fields => {jub => ['purchase_order', 'picklist']}
1898         }
1899     ]) or return $e->die_event;
1900
1901     if($li->purchase_order) {
1902         return $e->die_event unless
1903             $e->allowed('CREATE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1904     } else {
1905         return $e->die_event unless
1906             $e->allowed('CREATE_PICKLIST', $li->picklist->org_unit);
1907     }
1908
1909     $li->estimated_unit_price($price);
1910     update_lineitem($mgr, $li) or return $e->die_event;
1911
1912     my $lid_ids = $e->search_acq_lineitem_detail(
1913         {lineitem => $li_id, fund_debit => {'!=' => undef}},
1914         {idlist => 1}
1915     );
1916
1917     for my $lid_id (@$lid_ids) {
1918
1919         my $lid = $e->retrieve_acq_lineitem_detail([
1920             $lid_id, {
1921             flesh => 1, flesh_fields => {acqlid => ['fund', 'fund_debit']}}
1922         ]);
1923
1924         $lid->fund_debit->amount($price);
1925         $e->update_acq_fund_debit($lid->fund_debit) or return $e->die_event;
1926         $mgr->add_lid;
1927         $mgr->respond;
1928     }
1929
1930     $e->commit;
1931     return $mgr->respond_complete;
1932 }
1933
1934
1935 __PACKAGE__->register_method(
1936         method => 'clone_picklist_api',
1937         api_name        => 'open-ils.acq.picklist.clone',
1938         signature => {
1939         desc => 'Clones a picklist, including lineitem and lineitem details',
1940         params => [
1941             {desc => 'Authentication token', type => 'string'},
1942             {desc => 'Picklist ID', type => 'number'},
1943             {desc => 'New Picklist Name', type => 'string'}
1944         ],
1945         return => {desc => 'status blob, Event on error'}
1946     }
1947 );
1948
1949 sub clone_picklist_api {
1950     my($self, $conn, $auth, $pl_id, $name) = @_;
1951
1952     my $e = new_editor(xact=>1, authtoken=>$auth);
1953     return $e->die_event unless $e->checkauth;
1954     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1955
1956     my $old_pl = $e->retrieve_acq_picklist($pl_id);
1957     my $new_pl = create_picklist($mgr, %{$old_pl->to_bare_hash}, name => $name) or return $e->die_event;
1958
1959     my $li_ids = $e->search_acq_lineitem({picklist => $pl_id}, {idlist => 1});
1960
1961     for my $li_id (@$li_ids) {
1962
1963         # copy the lineitems
1964         my $li = $e->retrieve_acq_lineitem($li_id);
1965         my $new_li = create_lineitem($mgr, %{$li->to_bare_hash}, picklist => $new_pl->id) or return $e->die_event;
1966
1967         my $lid_ids = $e->search_acq_lineitem_detail({lineitem => $li_id}, {idlist => 1});
1968         for my $lid_id (@$lid_ids) {
1969
1970             # copy the lineitem details
1971             my $lid = $e->retrieve_acq_lineitem_detail($lid_id);
1972             create_lineitem_detail($mgr, %{$lid->to_bare_hash}, lineitem => $new_li->id) or return $e->die_event;
1973         }
1974
1975         $mgr->respond;
1976     }
1977
1978     $e->commit;
1979     return $mgr->respond_complete;
1980 }
1981
1982
1983 __PACKAGE__->register_method(
1984         method => 'merge_picklist_api',
1985         api_name        => 'open-ils.acq.picklist.merge',
1986         signature => {
1987         desc => 'Merges 2 or more picklists into a single list',
1988         params => [
1989             {desc => 'Authentication token', type => 'string'},
1990             {desc => 'Lead Picklist ID', type => 'number'},
1991             {desc => 'List of subordinate picklist IDs', type => 'array'}
1992         ],
1993         return => {desc => 'status blob, Event on error'}
1994     }
1995 );
1996
1997 sub merge_picklist_api {
1998     my($self, $conn, $auth, $lead_pl, $pl_list) = @_;
1999
2000     my $e = new_editor(xact=>1, authtoken=>$auth);
2001     return $e->die_event unless $e->checkauth;
2002     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2003
2004     # XXX perms on each picklist modified
2005
2006     # point all of the lineitems at the lead picklist
2007     my $li_ids = $e->search_acq_lineitem({picklist => $pl_list}, {idlist => 1});
2008
2009     for my $li_id (@$li_ids) {
2010         my $li = $e->retrieve_acq_lineitem($li_id);
2011         $li->picklist($lead_pl);
2012         update_lineitem($mgr, $li) or return $e->die_event;
2013         $mgr->respond;
2014     }
2015
2016     # now delete the subordinate lists
2017     for my $pl_id (@$pl_list) {
2018         my $pl = $e->retrieve_acq_picklist($pl_id);
2019         $e->delete_acq_picklist($pl) or return $e->die_event;
2020     }
2021
2022     $e->commit;
2023     return $mgr->respond_complete;
2024 }
2025
2026
2027 __PACKAGE__->register_method(
2028         method => 'delete_picklist_api',
2029         api_name        => 'open-ils.acq.picklist.delete',
2030         signature => {
2031         desc => q/Deletes a picklist.  It also deletes any lineitems in the "new" state.
2032             Other attached lineitems are detached'/,
2033         params => [
2034             {desc => 'Authentication token', type => 'string'},
2035             {desc => 'Picklist ID to delete', type => 'number'}
2036         ],
2037         return => {desc => '1 on success, Event on error'}
2038     }
2039 );
2040
2041 sub delete_picklist_api {
2042     my($self, $conn, $auth, $picklist_id) = @_;
2043     my $e = new_editor(xact=>1, authtoken=>$auth);
2044     return $e->die_event unless $e->checkauth;
2045     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2046     my $pl = $e->retrieve_acq_picklist($picklist_id) or return $e->die_event;
2047     delete_picklist($mgr, $pl) or return $e->die_event;
2048     $e->commit;
2049     return $mgr->respond_complete;
2050 }
2051
2052
2053
2054 __PACKAGE__->register_method(
2055         method => 'activate_purchase_order',
2056         api_name        => 'open-ils.acq.purchase_order.activate.dry_run'
2057 );
2058
2059 __PACKAGE__->register_method(
2060         method => 'activate_purchase_order',
2061         api_name        => 'open-ils.acq.purchase_order.activate',
2062         signature => {
2063         desc => q/Activates a purchase order.  This updates the status of the PO
2064             and Lineitems to 'on-order'.  Activated PO's are ready for EDI delivery
2065             if appropriate./,
2066         params => [
2067             {desc => 'Authentication token', type => 'string'},
2068             {desc => 'Purchase ID', type => 'number'}
2069         ],
2070         return => {desc => '1 on success, Event on error'}
2071     }
2072 );
2073
2074 sub activate_purchase_order {
2075     my($self, $conn, $auth, $po_id) = @_;
2076
2077     my $dry_run = ($self->api_name =~ /\.dry_run/) ? 1 : 0;
2078     my $e = new_editor(xact=>1, authtoken=>$auth);
2079     return $e->die_event unless $e->checkauth;
2080     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2081     my $die_event = activate_purchase_order_impl($mgr, $po_id, $dry_run);
2082     return $die_event if $die_event;
2083     if ($dry_run) {
2084         $e->rollback;
2085     } else {
2086         $e->commit;
2087     }
2088     $conn->respond_complete(1);
2089     $mgr->run_post_response_hooks;
2090     return undef;
2091 }
2092
2093 sub activate_purchase_order_impl {
2094     my ($mgr, $po_id, $dry_run) = @_;
2095     my $e = $mgr->editor;
2096
2097     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
2098     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
2099
2100     $po->state('on-order');
2101     $po->order_date('now');
2102     update_purchase_order($mgr, $po) or return $e->die_event;
2103
2104     my $query = [
2105         {purchase_order => $po_id, state => 'pending-order'},
2106         {limit => 1}
2107     ];
2108
2109     while( my $li = $e->search_acq_lineitem($query)->[0] ) {
2110         $li->state('on-order');
2111         create_lineitem_debits($mgr, $li, $dry_run) or return $e->die_event;
2112         update_lineitem($mgr, $li) or return $e->die_event;
2113         $mgr->post_process( sub { create_lineitem_status_events($mgr, $li->id, 'aur.ordered'); });
2114         $mgr->respond;
2115     }
2116
2117     return undef;
2118 }
2119
2120
2121 __PACKAGE__->register_method(
2122         method => 'split_purchase_order_by_lineitems',
2123         api_name        => 'open-ils.acq.purchase_order.split_by_lineitems',
2124         signature => {
2125         desc => q/Splits a PO into many POs, 1 per lineitem.  Only works for
2126         POs a) with more than one lineitems, and b) in the "pending" state./,
2127         params => [
2128             {desc => 'Authentication token', type => 'string'},
2129             {desc => 'Purchase order ID', type => 'number'}
2130         ],
2131         return => {desc => 'list of new PO IDs on success, Event on error'}
2132     }
2133 );
2134
2135 sub split_purchase_order_by_lineitems {
2136     my ($self, $conn, $auth, $po_id) = @_;
2137
2138     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2139     return $e->die_event unless $e->checkauth;
2140
2141     my $po = $e->retrieve_acq_purchase_order([
2142         $po_id, {
2143             "flesh" => 1,
2144             "flesh_fields" => {"acqpo" => [qw/lineitems notes/]}
2145         }
2146     ]) or return $e->die_event;
2147
2148     return $e->die_event
2149         unless $e->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2150
2151     unless ($po->state eq "pending") {
2152         $e->rollback;
2153         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_LATE");
2154     }
2155
2156     unless (@{$po->lineitems} > 1) {
2157         $e->rollback;
2158         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_SHORT");
2159     }
2160
2161     # To split an existing PO into many, it seems unwise to just delete the
2162     # original PO, so we'll instead detach all of the original POs' lineitems
2163     # but the first, then create new POs for each of the remaining LIs, and
2164     # then attach the LIs to their new POs.
2165
2166     my @po_ids = ($po->id);
2167     my @moving_li = @{$po->lineitems};
2168     shift @moving_li;    # discard first LI
2169
2170     foreach my $li (@moving_li) {
2171         my $new_po = $po->clone;
2172         $new_po->clear_id;
2173         $new_po->clear_name;
2174         $new_po->creator($e->requestor->id);
2175         $new_po->editor($e->requestor->id);
2176         $new_po->owner($e->requestor->id);
2177         $new_po->edit_time("now");
2178         $new_po->create_time("now");
2179
2180         $new_po = $e->create_acq_purchase_order($new_po);
2181
2182         # Clone any notes attached to the old PO and attach to the new one.
2183         foreach my $note (@{$po->notes}) {
2184             my $new_note = $note->clone;
2185             $new_note->clear_id;
2186             $new_note->edit_time("now");
2187             $new_note->purchase_order($new_po->id);
2188             $e->create_acq_po_note($new_note);
2189         }
2190
2191         $li->edit_time("now");
2192         $li->purchase_order($new_po->id);
2193         $e->update_acq_lineitem($li);
2194
2195         push @po_ids, $new_po->id;
2196     }
2197
2198     $po->edit_time("now");
2199     $e->update_acq_purchase_order($po);
2200
2201     return \@po_ids if $e->commit;
2202     return $e->die_event;
2203 }
2204
2205
2206 sub not_cancelable {
2207     my $o = shift;
2208     (ref $o eq "HASH" and $o->{"textcode"} eq "ACQ_NOT_CANCELABLE");
2209 }
2210
2211 __PACKAGE__->register_method(
2212         method => "cancel_purchase_order_api",
2213         api_name        => "open-ils.acq.purchase_order.cancel",
2214         signature => {
2215         desc => q/Cancels an on-order purchase order/,
2216         params => [
2217             {desc => "Authentication token", type => "string"},
2218             {desc => "PO ID to cancel", type => "number"},
2219             {desc => "Cancel reason ID", type => "number"}
2220         ],
2221         return => {desc => q/Object describing changed POs, LIs and LIDs
2222             on success; Event on error./}
2223     }
2224 );
2225
2226 sub cancel_purchase_order_api {
2227     my ($self, $conn, $auth, $po_id, $cancel_reason) = @_;
2228
2229     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2230     return $e->die_event unless $e->checkauth;
2231     my $mgr = new OpenILS::Application::Acq::BatchManager(
2232         "editor" => $e, "conn" => $conn
2233     );
2234
2235     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2236         return new OpenILS::Event(
2237             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2238         );
2239
2240     my $result = cancel_purchase_order($mgr, $po_id, $cancel_reason) or
2241         return $e->die_event;
2242     if (not_cancelable($result)) { # event not from CStoreEditor
2243         $e->rollback;
2244         return $result;
2245     } elsif ($result == -1) {
2246         $e->rollback;
2247         return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2248     }
2249
2250     $e->commit or return $e->die_event;
2251
2252     # XXX create purchase order status events?
2253
2254     if ($mgr->{post_commit}) {
2255         foreach my $func (@{$mgr->{post_commit}}) {
2256             $func->();
2257         }
2258     }
2259
2260     return $result;
2261 }
2262
2263 sub cancel_purchase_order {
2264     my ($mgr, $po_id, $cancel_reason) = @_;
2265
2266     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id) or return 0;
2267
2268     # XXX is "cancelled" a typo?  It's not correct US spelling, anyway.
2269     # Depending on context, this may not warrant an event.
2270     return -1 if $po->state eq "cancelled";
2271
2272     # But this always does.
2273     return new OpenILS::Event(
2274         "ACQ_NOT_CANCELABLE", "note" => "purchase_order $po_id"
2275     ) unless ($po->state eq "on-order" or $po->state eq "pending");
2276
2277     return 0 unless
2278         $mgr->editor->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2279
2280     $po->state("cancelled");
2281     $po->cancel_reason($cancel_reason);
2282
2283     my $li_ids = $mgr->editor->search_acq_lineitem(
2284         {"purchase_order" => $po_id}, {"idlist" => 1}
2285     );
2286
2287     my $result = {"li" => {}, "lid" => {}};
2288     foreach my $li_id (@$li_ids) {
2289         my $li_result = cancel_lineitem($mgr, $li_id, $cancel_reason)
2290             or return 0;
2291
2292         next if $li_result == -1; # already canceled:skip.
2293         return $li_result if not_cancelable($li_result); # not cancelable:stop.
2294
2295         # Merge in each LI result (there's only going to be
2296         # one per call to cancel_lineitem).
2297         my ($k, $v) = each %{$li_result->{"li"}};
2298         $result->{"li"}->{$k} = $v;
2299
2300         # Merge in each LID result (there may be many per call to
2301         # cancel_lineitem).
2302         while (($k, $v) = each %{$li_result->{"lid"}}) {
2303             $result->{"lid"}->{$k} = $v;
2304         }
2305     }
2306
2307     # TODO who/what/where/how do we indicate this change for electronic orders?
2308     # TODO return changes to encumbered/spent
2309     # TODO maybe cascade up from smaller object to container object if last
2310     # smaller object in the container has been canceled?
2311
2312     update_purchase_order($mgr, $po) or return 0;
2313     $result->{"po"} = {
2314         $po_id => {"state" => $po->state, "cancel_reason" => $cancel_reason}
2315     };
2316     return $result;
2317 }
2318
2319
2320 __PACKAGE__->register_method(
2321         method => "cancel_lineitem_api",
2322         api_name        => "open-ils.acq.lineitem.cancel",
2323         signature => {
2324         desc => q/Cancels an on-order lineitem/,
2325         params => [
2326             {desc => "Authentication token", type => "string"},
2327             {desc => "Lineitem ID to cancel", type => "number"},
2328             {desc => "Cancel reason ID", type => "number"}
2329         ],
2330         return => {desc => q/Object describing changed LIs and LIDs on success;
2331             Event on error./}
2332     }
2333 );
2334
2335 __PACKAGE__->register_method(
2336         method => "cancel_lineitem_api",
2337         api_name        => "open-ils.acq.lineitem.cancel.batch",
2338         signature => {
2339         desc => q/Batched version of open-ils.acq.lineitem.cancel/,
2340         return => {desc => q/Object describing changed LIs and LIDs on success;
2341             Event on error./}
2342     }
2343 );
2344
2345 sub cancel_lineitem_api {
2346     my ($self, $conn, $auth, $li_id, $cancel_reason) = @_;
2347
2348     my $batched = $self->api_name =~ /\.batch/;
2349
2350     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2351     return $e->die_event unless $e->checkauth;
2352     my $mgr = new OpenILS::Application::Acq::BatchManager(
2353         "editor" => $e, "conn" => $conn
2354     );
2355
2356     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2357         return new OpenILS::Event(
2358             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2359         );
2360
2361     my ($result, $maybe_event);
2362
2363     if ($batched) {
2364         $result = {"li" => {}, "lid" => {}};
2365         foreach my $one_li_id (@$li_id) {
2366             my $one = cancel_lineitem($mgr, $one_li_id, $cancel_reason) or
2367                 return $e->die_event;
2368             if (not_cancelable($one)) {
2369                 $maybe_event = $one;
2370             } elsif ($result == -1) {
2371                 $maybe_event = new OpenILS::Event("ACQ_ALREADY_CANCELED");
2372             } else {
2373                 my ($k, $v);
2374                 if ($one->{"li"}) {
2375                     while (($k, $v) = each %{$one->{"li"}}) {
2376                         $result->{"li"}->{$k} = $v;
2377                     }
2378                 }
2379                 if ($one->{"lid"}) {
2380                     while (($k, $v) = each %{$one->{"lid"}}) {
2381                         $result->{"lid"}->{$k} = $v;
2382                     }
2383                 }
2384             }
2385         }
2386     } else {
2387         $result = cancel_lineitem($mgr, $li_id, $cancel_reason) or
2388             return $e->die_event;
2389
2390         if (not_cancelable($result)) {
2391             $e->rollback;
2392             return $result;
2393         } elsif ($result == -1) {
2394             $e->rollback;
2395             return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2396         }
2397     }
2398
2399     if ($batched and not scalar keys %{$result->{"li"}}) {
2400         $e->rollback;
2401         return $maybe_event;
2402     } else {
2403         $e->commit or return $e->die_event;
2404         # create_lineitem_status_events should handle array li_id ok
2405         create_lineitem_status_events($mgr, $li_id, "aur.cancelled");
2406
2407         if ($mgr->{post_commit}) {
2408             foreach my $func (@{$mgr->{post_commit}}) {
2409                 $func->();
2410             }
2411         }
2412
2413         return $result;
2414     }
2415 }
2416
2417 sub cancel_lineitem {
2418     my ($mgr, $li_id, $cancel_reason) = @_;
2419     my $li = $mgr->editor->retrieve_acq_lineitem([
2420         $li_id, {flesh => 1, flesh_fields => {jub => ['purchase_order']}}
2421     ]) or return 0;
2422
2423     return 0 unless $mgr->editor->allowed(
2424         "CREATE_PURCHASE_ORDER", $li->purchase_order->ordering_agency
2425     );
2426
2427     # Depending on context, this may not warrant an event.
2428     return -1 if $li->state eq "cancelled";
2429
2430     # But this always does.
2431     return new OpenILS::Event(
2432         "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id"
2433     ) unless (
2434         (! $li->purchase_order) or (
2435             $li->purchase_order and (
2436                 $li->state eq "on-order" or $li->state eq "pending-order"
2437             )
2438         )
2439     );
2440
2441     $li->state("cancelled");
2442     $li->cancel_reason($cancel_reason);
2443
2444     my $lids = $mgr->editor->search_acq_lineitem_detail([{
2445         "lineitem" => $li_id
2446     }, {
2447         flesh => 1,
2448         flesh_fields => { acqlid => ['eg_copy_id'] }
2449     }]);
2450
2451     my $result = {"lid" => {}};
2452     my $copies = [];
2453     foreach my $lid (@$lids) {
2454         my $lid_result = cancel_lineitem_detail($mgr, $lid->id, $cancel_reason)
2455             or return 0;
2456
2457         # gathering any real copies for deletion
2458         if ($lid->eg_copy_id) {
2459             $lid->eg_copy_id->isdeleted('t');
2460             push @$copies, $lid->eg_copy_id;
2461         }
2462
2463         next if $lid_result == -1; # already canceled: just skip it.
2464         return $lid_result if not_cancelable($lid_result); # not cxlable: stop.
2465
2466         # Merge in each LID result (there's only going to be one per call to
2467         # cancel_lineitem_detail).
2468         my ($k, $v) = each %{$lid_result->{"lid"}};
2469         $result->{"lid"}->{$k} = $v;
2470     }
2471
2472     # Attempt to delete the gathered copies (this will also handle volume deletion and bib deletion)
2473     # Another edge case, if we have a bib but not copies, are we supposed to delete the bib?
2474     if (scalar(@$copies)>0) {
2475         my $override = 0;
2476         my $delete_stats = undef;
2477         my $retarget_holds = [];
2478         my $cat_evt = OpenILS::Application::Cat::AssetCommon->update_fleshed_copies(
2479             $mgr->editor, $override, undef, $copies, $delete_stats, $retarget_holds);
2480
2481         if( $cat_evt ) {
2482             $logger->info("fleshed copy update failed with event: ".OpenSRF::Utils::JSON->perl2JSON($cat_evt));
2483             return new OpenILS::Event(
2484                 "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id", "payload" => $cat_evt
2485             );
2486         }
2487
2488         # We can't do the following and stay within the same transaction, but that's okay, the hold targeter will pick these up later.
2489         #my $ses = OpenSRF::AppSession->create('open-ils.circ');
2490         #$ses->request('open-ils.circ.hold.reset.batch', $auth, $retarget_holds);
2491     }
2492
2493     # if we have a bib, check to see whether it has been deleted.  if so, cancel any active holds targeting that bib
2494     if ($li->eg_bib_id) {
2495         my $bib = $mgr->editor->retrieve_biblio_record_entry($li->eg_bib_id) or return new OpenILS::Event(
2496             "ACQ_NOT_CANCELABLE", "note" => "Could not retrieve bib " . $li->eg_bib_id . " for lineitem $li_id"
2497         );
2498         if ($U->is_true($bib->deleted)) {
2499             my $holds = $mgr->editor->search_action_hold_request(
2500                 {   cancel_time => undef,
2501                     fulfillment_time => undef,
2502                     target => $li->eg_bib_id
2503                 }
2504             );
2505
2506             my %cached_usr_home_ou = ();
2507
2508             for my $hold (@$holds) {
2509
2510                 $logger->info("Cancelling hold ".$hold->id.
2511                     " due to acq lineitem cancellation.");
2512
2513                 $hold->cancel_time('now');
2514                 $hold->cancel_cause(5); # 'Staff forced'--we may want a new hold cancel cause reason for this
2515                 $hold->cancel_note('Corresponding Acquistion Lineitem/Purchase Order was cancelled.');
2516                 unless($mgr->editor->update_action_hold_request($hold)) {
2517                     my $evt = $mgr->editor->event;
2518                     $logger->error("Error updating hold ". $evt->textcode .":". $evt->desc .":". $evt->stacktrace);
2519                     return new OpenILS::Event(
2520                         "ACQ_NOT_CANCELABLE", "note" => "Could not cancel hold " . $hold->id . " for lineitem $li_id", "payload" => $evt
2521                     );
2522                 }
2523                 if (! defined $mgr->{post_commit}) { # we need a mechanism for creating trigger events, but only if the transaction gets committed
2524                     $mgr->{post_commit} = [];
2525                 }
2526                 push @{ $mgr->{post_commit} }, sub {
2527                     my $home_ou = $cached_usr_home_ou{$hold->usr};
2528                     if (! $home_ou) {
2529                         my $user = $mgr->editor->retrieve_actor_user($hold->usr); # FIXME: how do we want to handle failures here?
2530                         $home_ou = $user->home_ou;
2531                         $cached_usr_home_ou{$hold->usr} = $home_ou;
2532                     }
2533                     $U->create_events_for_hook('hold_request.cancel.cancelled_order', $hold, $home_ou);
2534                 };
2535             }
2536         }
2537     }
2538
2539     # TODO delete the associated fund debits?
2540     # TODO who/what/where/how do we indicate this change for electronic orders?
2541
2542     update_lineitem($mgr, $li) or return 0;
2543     $result->{"li"} = {
2544         $li_id => {
2545             "state" => $li->state,
2546             "cancel_reason" => $cancel_reason
2547         }
2548     };
2549     return $result;
2550 }
2551
2552
2553 __PACKAGE__->register_method(
2554         method => "cancel_lineitem_detail_api",
2555         api_name        => "open-ils.acq.lineitem_detail.cancel",
2556         signature => {
2557         desc => q/Cancels an on-order lineitem detail/,
2558         params => [
2559             {desc => "Authentication token", type => "string"},
2560             {desc => "Lineitem detail ID to cancel", type => "number"},
2561             {desc => "Cancel reason ID", type => "number"}
2562         ],
2563         return => {desc => q/Object describing changed LIDs on success;
2564             Event on error./}
2565     }
2566 );
2567
2568 sub cancel_lineitem_detail_api {
2569     my ($self, $conn, $auth, $lid_id, $cancel_reason) = @_;
2570
2571     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2572     return $e->die_event unless $e->checkauth;
2573     my $mgr = new OpenILS::Application::Acq::BatchManager(
2574         "editor" => $e, "conn" => $conn
2575     );
2576
2577     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2578         return new OpenILS::Event(
2579             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2580         );
2581
2582     my $result = cancel_lineitem_detail($mgr, $lid_id, $cancel_reason) or
2583         return $e->die_event;
2584
2585     if (not_cancelable($result)) {
2586         $e->rollback;
2587         return $result;
2588     } elsif ($result == -1) {
2589         $e->rollback;
2590         return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2591     }
2592
2593     $e->commit or return $e->die_event;
2594
2595     # XXX create lineitem detail status events?
2596     return $result;
2597 }
2598
2599 sub cancel_lineitem_detail {
2600     my ($mgr, $lid_id, $cancel_reason) = @_;
2601     my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
2602         $lid_id, {
2603             "flesh" => 2,
2604             "flesh_fields" => {
2605                 "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
2606             }
2607         }
2608     ]) or return 0;
2609
2610     # Depending on context, this may not warrant an event.
2611     return -1 if $lid->cancel_reason;
2612
2613     # But this always does.
2614     return new OpenILS::Event(
2615         "ACQ_NOT_CANCELABLE", "note" => "lineitem_detail $lid_id"
2616     ) unless (
2617         (! $lid->lineitem->purchase_order) or
2618         (
2619             (not $lid->recv_time) and
2620             $lid->lineitem and
2621             $lid->lineitem->purchase_order and (
2622                 $lid->lineitem->state eq "on-order" or
2623                 $lid->lineitem->state eq "pending-order"
2624             )
2625         )
2626     );
2627
2628     return 0 unless $mgr->editor->allowed(
2629         "CREATE_PURCHASE_ORDER",
2630         $lid->lineitem->purchase_order->ordering_agency
2631     ) or (! $lid->lineitem->purchase_order);
2632
2633     $lid->cancel_reason($cancel_reason);
2634
2635     # TODO who/what/where/how do we indicate this change for electronic orders?
2636
2637     # XXX LIDs don't have either an editor or a edit_time field. Should we
2638     # update these on the LI when we alter an LID?
2639     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
2640     return {"lid" => {$lid_id => {"cancel_reason" => $cancel_reason}}};
2641 }
2642
2643
2644 __PACKAGE__->register_method(
2645     method    => 'user_requests',
2646     api_name  => 'open-ils.acq.user_request.retrieve.by_user_id',
2647     stream    => 1,
2648     signature => {
2649         desc   => 'Retrieve fleshed user requests and related data for a given user.',
2650         params => [
2651             { desc => 'Authentication token',      type => 'string' },
2652             { desc => 'User ID of the owner, or array of IDs',      },
2653             { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2654               type => 'object'
2655             }
2656         ],
2657         return => {
2658             desc => 'Fleshed user requests and related data',
2659             type => 'object'
2660         }
2661     }
2662 );
2663
2664 __PACKAGE__->register_method(
2665     method    => 'user_requests',
2666     api_name  => 'open-ils.acq.user_request.retrieve.by_home_ou',
2667     stream    => 1,
2668     signature => {
2669         desc   => 'Retrieve fleshed user requests and related data for a given org unit or units.',
2670         params => [
2671             { desc => 'Authentication token',      type => 'string' },
2672             { desc => 'Org unit ID, or array of IDs',               },
2673             { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2674               type => 'object'
2675             }
2676         ],
2677         return => {
2678             desc => 'Fleshed user requests and related data',
2679             type => 'object'
2680         }
2681     }
2682 );
2683
2684 sub user_requests {
2685     my($self, $conn, $auth, $search_value, $options) = @_;
2686     my $e = new_editor(authtoken => $auth);
2687     return $e->event unless $e->checkauth;
2688     my $rid = $e->requestor->id;
2689     $options ||= {};
2690
2691     my $query = {
2692         "select"=>{"aur"=>["id"],"au"=>["home_ou", {column => 'id', alias => 'usr_id'} ]},
2693         "from"=>{ "aur" => { "au" => {}, "jub" => { "type" => "left" } } },
2694         "where"=>{
2695             "+jub"=> {
2696                 "-or" => [
2697                     {"id"=>undef}, # this with the left-join pulls in requests without lineitems
2698                     {"state"=>["new","on-order","pending-order"]} # FIXME - probably needs softcoding
2699                 ]
2700             }
2701         },
2702         "order_by"=>[{"class"=>"aur", "field"=>"request_date", "direction"=>"desc"}]
2703     };
2704
2705     foreach (qw/ order_by limit offset /) {
2706         $query->{$_} = $options->{$_} if defined $options->{$_};
2707     }
2708     if (defined $options->{'state'}) {
2709         $query->{'where'}->{'+jub'}->{'-or'}->[1]->{'state'} = $options->{'state'};
2710     }
2711
2712     if ($self->api_name =~ /by_user_id/) {
2713         $query->{'where'}->{'usr'} = $search_value;
2714     } else {
2715         $query->{'where'}->{'+au'} = { 'home_ou' => $search_value };
2716     }
2717
2718     my $pertinent_ids = $e->json_query($query);
2719
2720     my %perm_test = ();
2721     for my $id_blob (@$pertinent_ids) {
2722         if ($rid != $id_blob->{usr_id}) {
2723             if (!defined $perm_test{ $id_blob->{home_ou} }) {
2724                 $perm_test{ $id_blob->{home_ou} } = $e->allowed( ['user_request.view'], $id_blob->{home_ou} );
2725             }
2726             if (!$perm_test{ $id_blob->{home_ou} }) {
2727                 next; # failed test
2728             }
2729         }
2730         my $aur_obj = $e->retrieve_acq_user_request([
2731             $id_blob->{id},
2732             {flesh => 1, flesh_fields => { "aur" => [ 'lineitem' ] } }
2733         ]);
2734         if (! $aur_obj) { next; }
2735
2736         if ($aur_obj->lineitem()) {
2737             $aur_obj->lineitem()->clear_marc();
2738         }
2739         $conn->respond($aur_obj);
2740     }
2741
2742     return undef;
2743 }
2744
2745 __PACKAGE__->register_method (
2746     method    => 'update_user_request',
2747     api_name  => 'open-ils.acq.user_request.cancel.batch',
2748     stream    => 1,
2749     signature => {
2750         desc   => 'If given a cancel reason, will update the request with that reason, otherwise, this will delete the request altogether.  The '    .
2751                   'intention is for staff interfaces or processes to provide cancel reasons, and for patron interfaces to just delete the requests.' ,
2752         params => [
2753             { desc => 'Authentication token',              type => 'string' },
2754             { desc => 'ID or array of IDs for the user requests to cancel'  },
2755             { desc => 'Cancel Reason ID (optional)',       type => 'string' }
2756         ],
2757         return => {
2758             desc => 'progress object, event on error',
2759         }
2760     }
2761 );
2762 __PACKAGE__->register_method (
2763     method    => 'update_user_request',
2764     api_name  => 'open-ils.acq.user_request.set_no_hold.batch',
2765     stream    => 1,
2766     signature => {
2767         desc   => 'Remove the hold from a user request or set of requests',
2768         params => [
2769             { desc => 'Authentication token',              type => 'string' },
2770             { desc => 'ID or array of IDs for the user requests to modify'  }
2771         ],
2772         return => {
2773             desc => 'progress object, event on error',
2774         }
2775     }
2776 );
2777
2778 sub update_user_request {
2779     my($self, $conn, $auth, $aur_ids, $cancel_reason) = @_;
2780     my $e = new_editor(xact => 1, authtoken => $auth);
2781     return $e->die_event unless $e->checkauth;
2782     my $rid = $e->requestor->id;
2783
2784     my $x = 1;
2785     my %perm_test = ();
2786     for my $id (@$aur_ids) {
2787
2788         my $aur_obj = $e->retrieve_acq_user_request([
2789             $id,
2790             {   flesh => 1,
2791                 flesh_fields => { "aur" => ['lineitem', 'usr'] }
2792             }
2793         ]) or return $e->die_event;
2794
2795         my $context_org = $aur_obj->usr()->home_ou();
2796         $aur_obj->usr( $aur_obj->usr()->id() );
2797
2798         if ($rid != $aur_obj->usr) {
2799             if (!defined $perm_test{ $context_org }) {
2800                 $perm_test{ $context_org } = $e->allowed( ['user_request.update'], $context_org );
2801             }
2802             if (!$perm_test{ $context_org }) {
2803                 next; # failed test
2804             }
2805         }
2806
2807         if($self->api_name =~ /set_no_hold/) {
2808             if ($U->is_true($aur_obj->hold)) {
2809                 $aur_obj->hold(0);
2810                 $e->update_acq_user_request($aur_obj) or return $e->die_event;
2811             }
2812         }
2813
2814         if($self->api_name =~ /cancel/) {
2815             if ( $cancel_reason ) {
2816                 $aur_obj->cancel_reason( $cancel_reason );
2817                 $e->update_acq_user_request($aur_obj) or return $e->die_event;
2818                 create_user_request_events( $e, [ $aur_obj ], 'aur.rejected' );
2819             } else {
2820                 $e->delete_acq_user_request($aur_obj);
2821             }
2822         }
2823
2824         $conn->respond({maximum => scalar(@$aur_ids), progress => $x++});
2825     }
2826
2827     $e->commit;
2828     return {complete => 1};
2829 }
2830
2831 __PACKAGE__->register_method (
2832     method    => 'new_user_request',
2833     api_name  => 'open-ils.acq.user_request.create',
2834     signature => {
2835         desc   => 'Create a new user request object in the DB',
2836         param  => [
2837             { desc => 'Authentication token',   type => 'string' },
2838             { desc => 'User request data hash.  Hash keys match the fields for the "aur" object', type => 'object' }
2839         ],
2840         return => {
2841             desc => 'The created user request object, or event on error'
2842         }
2843     }
2844 );
2845
2846 sub new_user_request {
2847     my($self, $conn, $auth, $form_data) = @_;
2848     my $e = new_editor(xact => 1, authtoken => $auth);
2849     return $e->die_event unless $e->checkauth;
2850     my $rid = $e->requestor->id;
2851     my $target_user_fleshed;
2852     if (! defined $$form_data{'usr'}) {
2853         $$form_data{'usr'} = $rid;
2854     }
2855     if ($$form_data{'usr'} != $rid) {
2856         # See if the requestor can place the request on behalf of a different user.
2857         $target_user_fleshed = $e->retrieve_actor_user($$form_data{'usr'}) or return $e->die_event;
2858         $e->allowed('user_request.create', $target_user_fleshed->home_ou) or return $e->die_event;
2859     } else {
2860         $target_user_fleshed = $e->requestor;
2861         $e->allowed('CREATE_PURCHASE_REQUEST') or return $e->die_event;
2862     }
2863     if (! defined $$form_data{'pickup_lib'}) {
2864         if ($target_user_fleshed->ws_ou) {
2865             $$form_data{'pickup_lib'} = $target_user_fleshed->ws_ou;
2866         } else {
2867             $$form_data{'pickup_lib'} = $target_user_fleshed->home_ou;
2868         }
2869     }
2870     if (! defined $$form_data{'request_type'}) {
2871         $$form_data{'request_type'} = 1; # Books
2872     }
2873     my $aur_obj = new Fieldmapper::acq::user_request;
2874     $aur_obj->isnew(1);
2875     $aur_obj->usr( $$form_data{'usr'} );
2876     $aur_obj->request_date( 'now' );
2877     for my $field ( keys %$form_data ) {
2878         if (defined $$form_data{$field} and $field !~ /^(id|lineitem|eg_bib|request_date|cancel_reason)$/) {
2879             $aur_obj->$field( $$form_data{$field} );
2880         }
2881     }
2882
2883     $aur_obj = $e->create_acq_user_request($aur_obj) or return $e->die_event;
2884
2885     $e->commit and create_user_request_events( $e, [ $aur_obj ], 'aur.created' );
2886
2887     return $aur_obj;
2888 }
2889
2890 sub create_user_request_events {
2891     my($e, $user_reqs, $hook) = @_;
2892
2893     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
2894     $ses->connect;
2895
2896     my %cached_usr_home_ou = ();
2897     for my $user_req (@$user_reqs) {
2898         my $home_ou = $cached_usr_home_ou{$user_req->usr};
2899         if (! $home_ou) {
2900             my $user = $e->retrieve_actor_user($user_req->usr) or return $e->die_event;
2901             $home_ou = $user->home_ou;
2902             $cached_usr_home_ou{$user_req->usr} = $home_ou;
2903         }
2904         my $req = $ses->request('open-ils.trigger.event.autocreate', $hook, $user_req, $home_ou);
2905         $req->recv;
2906     }
2907
2908     $ses->disconnect;
2909     return undef;
2910 }
2911
2912
2913 __PACKAGE__->register_method(
2914         method => "po_note_CUD_batch",
2915         api_name => "open-ils.acq.po_note.cud.batch",
2916     stream => 1,
2917         signature => {
2918         desc => q/Manage purchase order notes/,
2919         params => [
2920             {desc => "Authentication token", type => "string"},
2921             {desc => "List of po_notes to manage", type => "array"},
2922         ],
2923         return => {desc => "Stream of successfully managed objects"}
2924     }
2925 );
2926
2927 sub po_note_CUD_batch {
2928     my ($self, $conn, $auth, $notes) = @_;
2929
2930     my $e = new_editor("xact"=> 1, "authtoken" => $auth);
2931     return $e->die_event unless $e->checkauth;
2932     # XXX perms
2933
2934     my $total = @$notes;
2935     my $count = 0;
2936
2937     foreach my $note (@$notes) {
2938
2939         $note->editor($e->requestor->id);
2940         $note->edit_time("now");
2941
2942         if ($note->isnew) {
2943             $note->creator($e->requestor->id);
2944             $note = $e->create_acq_po_note($note) or return $e->die_event;
2945         } elsif ($note->isdeleted) {
2946             $e->delete_acq_po_note($note) or return $e->die_event;
2947         } elsif ($note->ischanged) {
2948             $e->update_acq_po_note($note) or return $e->die_event;
2949         }
2950
2951         unless ($note->isdeleted) {
2952             $note = $e->retrieve_acq_po_note($note->id) or
2953                 return $e->die_event;
2954         }
2955
2956         $conn->respond(
2957             {"maximum" => $total, "progress" => ++$count, "note" => $note}
2958         );
2959     }
2960
2961     $e->commit and $conn->respond_complete or return $e->die_event;
2962 }
2963
2964 1;