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